Skip to content

Commit 2ee078c

Browse files
nickspoonsnickspoons
committed
Refactor documentation
1 parent cbd13c4 commit 2ee078c

File tree

1 file changed

+137
-130
lines changed

1 file changed

+137
-130
lines changed

‎doc/omnisharp-vim.txt

+137-130
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,14 @@ CONTENTS *omnisharp-contents
2020
3.2 Diagnostics ......................... |omnisharp-diagnostic-options|
2121
3.3 Highlights .......................... |omnisharp-highlight-options|
2222
3.4 Popups .............................. |omnisharp-popup-options|
23-
3.5 Tests ............................... |omnisharp-test-options|
2423
3.6 Integrations ........................ |omnisharp-integration-options|
2524
3.7 Miscellaneous ....................... |omnisharp-miscellaneous-options|
26-
4. Commands ............................... |omnisharp-commands|
25+
4. General Commands ....................... |omnisharp-commands|
2726
5. Autocmds ............................... |omnisharp-autocmds|
2827
6. Test runner ............................ |omnisharp-testrunner|
29-
6.1 Mappings ............................ |omnisharp-testrunner-mappings|
28+
6.1 Options ............................. |omnisharp-test-options|
29+
6.1 Commands ............................ |omnisharp-testrunner-commands|
30+
6.2 Mappings ............................ |omnisharp-testrunner-mappings|
3031
7. Integrations ........................... |omnisharp-integrations|
3132

3233
===============================================================================
@@ -373,82 +374,7 @@ Default: atcursor >
373374
let g:OmniSharp_popup_position = 'peek'
374375
<
375376
-------------------------------------------------------------------------------
376-
3.5 TESTS *omnisharp-test-options*
377-
378-
*g:OmniSharp_runtests_echo_output*
379-
When running unit tests with |:OmniSharpRunTest| and |:OmniSharpRunTestsInFile|
380-
or from the |omnisharp-testrunner|, echo all test runner output to the
381-
|message-history|, so it can be viewed with |:messages|.
382-
Default: 0
383-
384-
*g:OmniSharp_runtests_parallel*
385-
When running multiple unit test files with |:OmniSharpRunTestsInFile|, run
386-
tests in all files simultaneously - this is the fastest way to run multiple
387-
test files. The disadvantage is that when |g:OmniSharp_runtests_echo_output|
388-
is set to 1, tests from multiple files will be interspersed, and therefore
389-
difficult to read. Set |g:OmniSharp_runtests_parallel| to 0 in order to run
390-
test files in sequence instead, resulting in readable output in the
391-
|message-history|.
392-
Default: 1
393-
394-
*g:OmniSharp_runtests_quickfix*
395-
When running unit tests with |:OmniSharpRunTest| and |:OmniSharpRunTestsInFile|
396-
or from the |omnisharp-testrunner|, populate the quickfix list with test
397-
results.
398-
When a single test is run and an exception occurs, the quickfix will be
399-
populated with the exception stack trace.
400-
When multiple tests are run then each test will get a quickfix location:
401-
failed test locations point to the failed assertion; successful test locations
402-
point to the test method declaration.
403-
Default: 0
404-
405-
*g:OmniSharp_testrunner*
406-
Open the |omnisharp-testrunner| automatically when running tests.
407-
Default: 1
408-
409-
*g:OmniSharp_testrunner_banner*
410-
Display the |omnisharp-testrunner| help/introduction banner when opening the
411-
testrunner. When this option is set to 0, the banner may still be toggled with
412-
the <F1> (default) toggle mapping.
413-
Default: 1
414-
415-
*g:OmniSharp_testrunner_glyph*
416-
Display a passed/failed "glyph" string beside completed test results in the
417-
|omnisharp-testrunner|.
418-
Default: 1
419-
420-
*g:OmniSharp_testrunner_glyph_failed*
421-
The "glyph" string to display beside failed completed tests in the testrunner.
422-
Default: ✘
423-
424-
*g:OmniSharp_testrunner_glyph_passed*
425-
The "glyph" string to display beside passed completed tests in the testrunner.
426-
Default: ✔
427-
428-
*g:OmniSharp_testrunner_loglevel*
429-
The type of build and test logs to output in the |omnisharp-testrunner|.
430-
431-
all All build output and test runner output is displayed.
432-
433-
error When a build error occurs, the error message and stack
434-
trace are output.
435-
436-
none Only build error messages will be output.
437-
438-
Default: error >
439-
let g:OmniSharp_testrunner_loglevel = 'all'
440-
<
441-
*g:OmniSharp_testrunner_spinner*
442-
Display a "running" spinner animation when running tests in the testrunner.
443-
Default: 1
444-
445-
*g:OmniSharp_testrunner_spinnersteps*
446-
A list of "step" strings to be displayed as the |omnisharp-testrunner|
447-
"spinner" animation.
448-
Default: ['∙∙∙', '●∙∙', '∙●∙', '∙∙●', '∙∙∙']
449-
450-
-------------------------------------------------------------------------------
451-
3.6 INTEGRATIONS *omnisharp-integration-options*
377+
3.5 INTEGRATIONS *omnisharp-integration-options*
452378

453379
*g:OmniSharp_selector_ui*
454380
Use this option to specify a selector UI for choosing code actions and
@@ -509,7 +435,7 @@ Use this option to enable syntastic integration >
509435
let g:syntastic_cs_checkers = ['code_checker']
510436
<
511437
-------------------------------------------------------------------------------
512-
3.7 MISCELLANEOUS *omnisharp-miscellaneous-options*
438+
3.6 MISCELLANEOUS *omnisharp-miscellaneous-options*
513439

514440
*g:OmniSharp_filename_modifiers*
515441
File paths returned from the server are normalized using Vim
@@ -557,7 +483,7 @@ the |:OmniSharpDocumentation| command. Default: 1 >
557483
let g:omnicomplete_fetch_full_documentation = 1
558484
<
559485
===============================================================================
560-
4. COMMANDS *omnisharp-commands*
486+
4. GENERAL COMMANDS *omnisharp-commands*
561487

562488
Most of the OmniSharp-vim commands have associated plug mappings defined, for
563489
convenient user re-mapping. These can be used like so: >
@@ -575,8 +501,8 @@ convenient user re-mapping. These can be used like so: >
575501
:OmniSharpGotoDefinition vsplit
576502
:OmniSharpGotoDefinition tabedit
577503
<
578-
*:OmniSharpGotoTypeDefinition*
579-
*<Plug>(omnisharp_go_to_type_definition)*
504+
*:OmniSharpGotoTypeDefinition*
505+
*<Plug>(omnisharp_go_to_type_definition)*
580506
:OmniSharpGotoTypeDefinition [{cmd}]
581507
Navigates to the type definition of the symbol under the cursor.
582508
By default the definition is opened in the current window. To open it in a
@@ -661,48 +587,6 @@ convenient user re-mapping. These can be used like so: >
661587
:OmniSharpNavigateDown
662588
Navigates to next method or class
663589

664-
*:OmniSharpRunTest*
665-
*<Plug>(omnisharp_run_test)*
666-
*<Plug>(omnisharp_run_test_no_build)*
667-
:OmniSharpRunTest[!]
668-
Run the current unit test. The cursor can be anywhere in the test method.
669-
The |omnisharp-testrunner| window will be opened to display the test
670-
status and results.
671-
If the test fails, the failure message and location will be displayed in
672-
the testrunner, or optionally (see |g:OmniSharp_runtests_quickfix|) in the
673-
quickfix list, along with the error stack trace if one exists.
674-
675-
When called with ! or the |<Plug>(omnisharp_run_test_no_build)| mapping, the
676-
project is not built before running the test.
677-
678-
*:OmniSharpDebugTest*
679-
*<Plug>(omnisharp_debug_test)*
680-
*<Plug>(omnisharp_debug_test_no_build)*
681-
:OmniSharpDebugTest[!]
682-
Debug the current unit test with Vimspector. The cursor can be anywhere in
683-
the test method.
684-
685-
When called with ! or the |<Plug>(omnisharp_debug_test_no_build)| mapping,
686-
the project is not built before starting the debugger.
687-
688-
*:OmniSharpRunTestsInFile*
689-
*<Plug>(omnisharp_run_tests_in_file)*
690-
*<Plug>(omnisharp_run_tests_in_file_no_build)*
691-
:OmniSharpRunTestsInFile[!]
692-
Run all unit tests in the current file. When |g:OmniSharp_runtests_quickfix|
693-
is enabled, the quickfix list will be populated with the results of all
694-
tests.
695-
Optionally accepts one or more filenames of files to run tests for.
696-
>
697-
" Run all unit tests in the current file
698-
:OmniSharpRunTestsInFile
699-
700-
" Run all unit tests in the current file, and file `tests/test1.cs`
701-
:OmniSharpRunTestsInFile % tests/test1.cs
702-
<
703-
When called with ! or the |<Plug>(omnisharp_run_tests_in_file_no_build)|
704-
mapping, the project is not built before running the tests.
705-
706590
*:OmniSharpOpenLog*
707591
*<Plug>(omnisharp_open_log)*
708592
:OmniSharpOpenLog [{cmd}]
@@ -715,9 +599,6 @@ convenient user re-mapping. These can be used like so: >
715599
:OmniSharpOpenLog vsplit
716600
:OmniSharpOpenLog tabedit
717601
<
718-
*:OmniSharpOpenTestRunner*
719-
Open the |omnisharp-testrunner| window
720-
721602
*:OmniSharpGetCodeActions*
722603
*<Plug>(omnisharp_code_actions)*
723604
:OmniSharpGetCodeActions
@@ -866,7 +747,7 @@ with the test status (running/passed/failed/not run) and any outputs that may
866747
be produced (exceptions and Console output).
867748

868749
Open the test runner window by either running a test (with e.g.
869-
|:OmniSharpRunTest|) or with the |:OmniSharpOpenTestRunner| command.
750+
|:OmniSharpRunTest|) or with the |:OmniSharpTestRunner| command.
870751

871752
Any time a new test is run, it (along with all other tests in the same file)
872753
is added to the runner. Tests remain visible in the test runner window until
@@ -883,7 +764,133 @@ display test results, use the following settings: >
883764
let g:OmniSharp_runtests_quickfix = 1
884765
<
885766
-------------------------------------------------------------------------------
886-
6.1 MAPPINGS *omnisharp-testrunner-mappings*
767+
6.1 OPTIONS *omnisharp-test-options*
768+
769+
*g:OmniSharp_runtests_echo_output*
770+
When running unit tests with |:OmniSharpRunTest| and |:OmniSharpRunTestsInFile|
771+
or from the |omnisharp-testrunner|, echo all test runner output to the
772+
|message-history|, so it can be viewed with |:messages|.
773+
Default: 0
774+
775+
*g:OmniSharp_runtests_parallel*
776+
When running multiple unit test files with |:OmniSharpRunTestsInFile|, run
777+
tests in all files simultaneously - this is the fastest way to run multiple
778+
test files. The disadvantage is that when |g:OmniSharp_runtests_echo_output|
779+
is set to 1, tests from multiple files will be interspersed, and therefore
780+
difficult to read. Set |g:OmniSharp_runtests_parallel| to 0 in order to run
781+
test files in sequence instead, resulting in readable output in the
782+
|message-history|.
783+
Default: 1
784+
785+
*g:OmniSharp_runtests_quickfix*
786+
When running unit tests with |:OmniSharpRunTest| and |:OmniSharpRunTestsInFile|
787+
or from the |omnisharp-testrunner|, populate the quickfix list with test
788+
results.
789+
When a single test is run and an exception occurs, the quickfix will be
790+
populated with the exception stack trace.
791+
When multiple tests are run then each test will get a quickfix location:
792+
failed test locations point to the failed assertion; successful test locations
793+
point to the test method declaration.
794+
Default: 0
795+
796+
*g:OmniSharp_testrunner*
797+
Open the |omnisharp-testrunner| automatically when running tests.
798+
Default: 1
799+
800+
*g:OmniSharp_testrunner_banner*
801+
Display the |omnisharp-testrunner| help/introduction banner when opening the
802+
testrunner. When this option is set to 0, the banner may still be toggled with
803+
the <F1> (default) toggle mapping.
804+
Default: 1
805+
806+
*g:OmniSharp_testrunner_glyph*
807+
Display a passed/failed "glyph" string beside completed test results in the
808+
|omnisharp-testrunner|.
809+
Default: 1
810+
811+
*g:OmniSharp_testrunner_glyph_failed*
812+
The "glyph" string to display beside failed completed tests in the testrunner.
813+
Default: ✘
814+
815+
*g:OmniSharp_testrunner_glyph_passed*
816+
The "glyph" string to display beside passed completed tests in the testrunner.
817+
Default: ✔
818+
819+
*g:OmniSharp_testrunner_loglevel*
820+
The type of build and test logs to output in the |omnisharp-testrunner|.
821+
822+
all All build output and test runner output is displayed.
823+
824+
error When a build error occurs, the error message and stack
825+
trace are output.
826+
827+
none Only build error messages will be output.
828+
829+
Default: error >
830+
let g:OmniSharp_testrunner_loglevel = 'all'
831+
<
832+
*g:OmniSharp_testrunner_spinner*
833+
Display a "running" spinner animation when running tests in the testrunner.
834+
Default: 1
835+
836+
*g:OmniSharp_testrunner_spinnersteps*
837+
A list of "step" strings to be displayed as the |omnisharp-testrunner|
838+
"spinner" animation.
839+
Default: ['∙∙∙', '●∙∙', '∙●∙', '∙∙●', '∙∙∙']
840+
841+
-------------------------------------------------------------------------------
842+
6.2 COMMANDS *omnisharp-testrunner-commands*
843+
844+
*:OmniSharpRunTest*
845+
*<Plug>(omnisharp_run_test)*
846+
*<Plug>(omnisharp_run_test_no_build)*
847+
:OmniSharpRunTest[!]
848+
Run the current unit test. The cursor can be anywhere in the test method.
849+
The |omnisharp-testrunner| window will be opened to display the test
850+
status and results.
851+
If the test fails, the failure message and location will be displayed in
852+
the testrunner, or optionally (see |g:OmniSharp_runtests_quickfix|) in the
853+
quickfix list, along with the error stack trace if one exists.
854+
855+
When called with ! or the |<Plug>(omnisharp_run_test_no_build)| mapping, the
856+
project is not built before running the test.
857+
858+
*:OmniSharpDebugTest*
859+
*<Plug>(omnisharp_debug_test)*
860+
*<Plug>(omnisharp_debug_test_no_build)*
861+
:OmniSharpDebugTest[!]
862+
Debug the current unit test with Vimspector. The cursor can be anywhere in
863+
the test method.
864+
865+
When called with ! or the |<Plug>(omnisharp_debug_test_no_build)| mapping,
866+
the project is not built before starting the debugger.
867+
868+
*:OmniSharpRunTestsInFile*
869+
*<Plug>(omnisharp_run_tests_in_file)*
870+
*<Plug>(omnisharp_run_tests_in_file_no_build)*
871+
:OmniSharpRunTestsInFile[!]
872+
Run all unit tests in the current file. When |g:OmniSharp_runtests_quickfix|
873+
is enabled, the quickfix list will be populated with the results of all
874+
tests.
875+
Optionally accepts one or more filenames of files to run tests for.
876+
>
877+
" Run all unit tests in the current file
878+
:OmniSharpRunTestsInFile
879+
880+
" Run all unit tests in the current file, and file `tests/test1.cs`
881+
:OmniSharpRunTestsInFile % tests/test1.cs
882+
<
883+
When called with ! or the |<Plug>(omnisharp_run_tests_in_file_no_build)|
884+
mapping, the project is not built before running the tests.
885+
886+
*:OmniSharpTestRunner*
887+
Open the |omnisharp-testrunner| window
888+
889+
*:OmniSharpTestRunnerReset*
890+
Forget all test history and clear the test runner window
891+
892+
-------------------------------------------------------------------------------
893+
6.3 MAPPINGS *omnisharp-testrunner-mappings*
887894

888895
The following |<Plug>| mappings and associated default recursive mappings are
889896
provided in the test runner window.

0 commit comments

Comments
 (0)