diff options
Diffstat (limited to 'doc/ale.txt')
| -rw-r--r-- | doc/ale.txt | 54 |
1 files changed, 27 insertions, 27 deletions
diff --git a/doc/ale.txt b/doc/ale.txt index 56669be6..0e658f3c 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1793,6 +1793,33 @@ g:ale_set_signs *g:ale_set_signs* To limit the number of signs ALE will set, see |g:ale_max_signs|. +g:ale_shell *g:ale_shell* + + Type: |String| + Default: not set + + Override the shell used by ALE for executing commands. ALE uses 'shell' by + default, but falls back in `/bin/sh` if the default shell looks like `fish` + or `pwsh`, which are not compatible with all of the commands run by ALE. The + shell specified with this option will be used even if it might not work in + all cases. + + For Windows, ALE uses `cmd` when this option isn't set. Setting this option + will apply shell escaping to the command string, even on Windows. + + NOTE: Consider setting |g:ale_shell_arguments| if this option is defined. + + +g:ale_shell_arguments *g:ale_shell_arguments* + + Type: |String| + Default: not set + + This option specifies the arguments to use for executing a command with a + custom shell, per |g:ale_shell|. If this option is not set, 'shellcmdflag' + will be used instead. + + g:ale_sign_column_always *g:ale_sign_column_always* Type: |Number| @@ -2000,33 +2027,6 @@ g:ale_windows_node_executable_path *g:ale_windows_node_executable_path* scripts are executed with whatever executable is configured with this setting. -g:ale_shell *g:ale_shell* - - Type: |String| - Default: not set - - This variable is used to determine which shell ale will use to execute - commands. By default this variable is undefined, meaning that ALE will use - it's default behavior. Which is to run shells via the shell determined by - the `&shell` vim variable, with the arguments `&shellcmdflag`. Ale will fall - back to using `/bin/sh`if it detects the underlying `&shell`is either `fish` - or `pwsh`. However, if you set this variable ALE will no longer fall back to - other shells, meaning if you wanted to use `fish` you could do so via this - option. For example if `$SHELL == '/bin/bash'`, but you want to use zsh, - set `g:ale_shell = '/bin/zsh'. - - Please note - if you are using this option you should consider additionally - setting `g:ale``g:ale_shell_arguments` since the default values for that - option might be incompatable with the newly set shell. - -g:ale_shell_arguments *g:ale_shell_arguments* - - Type: |String| - Default: not set - - This variable is used to determine what commands vim will pass to the shell - to execute it's commands. If this command is not set, but g:ale_shell is - set, ale will use `&shellcmdflag` as command arguments. ------------------------------------------------------------------------------- 6.1. Highlights *ale-highlights* |