Skip to content

Commit 16a58b6

Browse files
nickspoonsnickspoons
committed
Refactor documentation
1 parent 3325317 commit 16a58b6

File tree

1 file changed

+137
-130
lines changed

1 file changed

+137
-130
lines changed

‎doc/omnisharp-vim.txt

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

469395
*g:OmniSharp_selector_ui*
470396
Use this option to specify a selector UI for choosing code actions and
@@ -525,7 +451,7 @@ Use this option to enable syntastic integration >
525451
let g:syntastic_cs_checkers = ['code_checker']
526452
<
527453
-------------------------------------------------------------------------------
528-
3.7 MISCELLANEOUS *omnisharp-miscellaneous-options*
454+
3.6 MISCELLANEOUS *omnisharp-miscellaneous-options*
529455

530456
*g:OmniSharp_filename_modifiers*
531457
File paths returned from the server are normalized using Vim
@@ -573,7 +499,7 @@ the |:OmniSharpDocumentation| command. Default: 1 >
573499
let g:omnicomplete_fetch_full_documentation = 1
574500
<
575501
===============================================================================
576-
4. COMMANDS *omnisharp-commands*
502+
4. GENERAL COMMANDS *omnisharp-commands*
577503

578504
Most of the OmniSharp-vim commands have associated plug mappings defined, for
579505
convenient user re-mapping. These can be used like so: >
@@ -591,8 +517,8 @@ convenient user re-mapping. These can be used like so: >
591517
:OmniSharpGotoDefinition vsplit
592518
:OmniSharpGotoDefinition tabedit
593519
<
594-
*:OmniSharpGotoTypeDefinition*
595-
*<Plug>(omnisharp_go_to_type_definition)*
520+
*:OmniSharpGotoTypeDefinition*
521+
*<Plug>(omnisharp_go_to_type_definition)*
596522
:OmniSharpGotoTypeDefinition [{cmd}]
597523
Navigates to the type definition of the symbol under the cursor.
598524
By default the definition is opened in the current window. To open it in a
@@ -677,48 +603,6 @@ convenient user re-mapping. These can be used like so: >
677603
:OmniSharpNavigateDown
678604
Navigates to next method or class
679605

680-
*:OmniSharpRunTest*
681-
*<Plug>(omnisharp_run_test)*
682-
*<Plug>(omnisharp_run_test_no_build)*
683-
:OmniSharpRunTest[!]
684-
Run the current unit test. The cursor can be anywhere in the test method.
685-
The |omnisharp-testrunner| window will be opened to display the test
686-
status and results.
687-
If the test fails, the failure message and location will be displayed in
688-
the testrunner, or optionally (see |g:OmniSharp_runtests_quickfix|) in the
689-
quickfix list, along with the error stack trace if one exists.
690-
691-
When called with ! or the |<Plug>(omnisharp_run_test_no_build)| mapping, the
692-
project is not built before running the test.
693-
694-
*:OmniSharpDebugTest*
695-
*<Plug>(omnisharp_debug_test)*
696-
*<Plug>(omnisharp_debug_test_no_build)*
697-
:OmniSharpDebugTest[!]
698-
Debug the current unit test with Vimspector. The cursor can be anywhere in
699-
the test method.
700-
701-
When called with ! or the |<Plug>(omnisharp_debug_test_no_build)| mapping,
702-
the project is not built before starting the debugger.
703-
704-
*:OmniSharpRunTestsInFile*
705-
*<Plug>(omnisharp_run_tests_in_file)*
706-
*<Plug>(omnisharp_run_tests_in_file_no_build)*
707-
:OmniSharpRunTestsInFile[!]
708-
Run all unit tests in the current file. When |g:OmniSharp_runtests_quickfix|
709-
is enabled, the quickfix list will be populated with the results of all
710-
tests.
711-
Optionally accepts one or more filenames of files to run tests for.
712-
>
713-
" Run all unit tests in the current file
714-
:OmniSharpRunTestsInFile
715-
716-
" Run all unit tests in the current file, and file `tests/test1.cs`
717-
:OmniSharpRunTestsInFile % tests/test1.cs
718-
<
719-
When called with ! or the |<Plug>(omnisharp_run_tests_in_file_no_build)|
720-
mapping, the project is not built before running the tests.
721-
722606
*:OmniSharpOpenLog*
723607
*<Plug>(omnisharp_open_log)*
724608
:OmniSharpOpenLog [{cmd}]
@@ -731,9 +615,6 @@ convenient user re-mapping. These can be used like so: >
731615
:OmniSharpOpenLog vsplit
732616
:OmniSharpOpenLog tabedit
733617
<
734-
*:OmniSharpOpenTestRunner*
735-
Open the |omnisharp-testrunner| window
736-
737618
*:OmniSharpGetCodeActions*
738619
*<Plug>(omnisharp_code_actions)*
739620
:OmniSharpGetCodeActions
@@ -882,7 +763,7 @@ with the test status (running/passed/failed/not run) and any outputs that may
882763
be produced (exceptions and Console output).
883764

884765
Open the test runner window by either running a test (with e.g.
885-
|:OmniSharpRunTest|) or with the |:OmniSharpOpenTestRunner| command.
766+
|:OmniSharpRunTest|) or with the |:OmniSharpTestRunner| command.
886767

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

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

0 commit comments

Comments
 (0)