diff options
| author | w0rp <devw0rp@gmail.com> | 2020-11-21 01:18:27 +0000 |
|---|---|---|
| committer | w0rp <devw0rp@gmail.com> | 2020-11-21 01:18:27 +0000 |
| commit | 7c04ee5c200b64ef0886677216fbec1303ec9475 (patch) | |
| tree | 0f0af86e0fde0992818fdd057ea5745c47e8205c /doc | |
| parent | 48fe0dd4f629bb1282277ba8a6757a84c13a4dda (diff) | |
| download | ale-7c04ee5c200b64ef0886677216fbec1303ec9475.zip | |
Close #1466 - Add GVIM refactor menu support
Code actions and ALERename now appear in the right click context menu
for GVim by default.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale.txt | 35 |
1 files changed, 33 insertions, 2 deletions
diff --git a/doc/ale.txt b/doc/ale.txt index 013b39f9..20baf355 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -673,13 +673,31 @@ for a full list of options. ------------------------------------------------------------------------------- 5.7 Refactoring: Rename, Actions *ale-refactor* -ALE supports renaming symbols in symbols in code such as variables or class -names with the |ALERename| command. +ALE supports renaming symbols in code such as variables or class names with +the |ALERename| command. |ALECodeAction| will execute actions on the cursor or applied to a visual range selection, such as automatically fixing errors. +Actions will appear in the right click mouse menu by default for GUI versions +of Vim, unless disabled by setting |g:ale_popup_menu_enabled| to `0`. +Make sure to set your Vim to move the cursor position whenever you right +click, and enable the mouse menu: > + + set mouse=a + set mousemodel=popup_setpos +< +You may wish to remove some other menu items you don't want to see: > + + silent! aunmenu PopUp.Select\ Word + silent! aunmenu PopUp.Select\ Sentence + silent! aunmenu PopUp.Select\ Paragraph + silent! aunmenu PopUp.Select\ Line + silent! aunmenu PopUp.Select\ Block + silent! aunmenu PopUp.Select\ Blockwise + silent! aunmenu PopUp.Select\ All +< =============================================================================== 6. Global Options *ale-options* @@ -1784,6 +1802,19 @@ g:ale_pattern_options_enabled *g:ale_pattern_options_enabled* will not set buffer variables per |g:ale_pattern_options|. +g:ale_popup_menu_enabled *g:ale_popup_menu_enabled* + + Type: |Number| + Default: `has('gui')` + + When this option is set to `1`, ALE will show code actions and rename + capabilities in the right click mouse menu when there's a LSP server or + tsserver available. See |ale-refactor|. + + This setting must be set to `1` before ALE is loaded for this behavior + to be enabled. See |ale-lint-settings-on-startup|. + + g:ale_rename_tsserver_find_in_comments *g:ale_rename_tsserver_find_in_comments* Type: |Number| |