diff options
Diffstat (limited to 'doc/ale.txt')
| -rw-r--r-- | doc/ale.txt | 105 |
1 files changed, 59 insertions, 46 deletions
diff --git a/doc/ale.txt b/doc/ale.txt index d7c5d25e..e27c5af1 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -11,13 +11,14 @@ CONTENTS *ale-contents* 3. Global Options.............................|ale-options| 4. Linter Specific Options....................|ale-linter-options| 4.1. eslint.................................|ale-linter-options-eslint| - 4.2. phpcs..................................|ale-linter-options-phpcs| - 4.3. c-gcc..................................|ale-linter-options-c-gcc| - 4.4. cpp-gcc................................|ale-linter-options-cpp-gcc| - 4.5. shell..................................|ale-linter-options-shell| - 4.6. fortran-gcc............................|ale-linter-options-fortran-gcc| - 4.7. html-tidy..............................|ale-linter-options-html-tidy| - 4.8. jshint.................................|ale-linter-options-jshint| + 4.2. jshint.................................|ale-linter-options-jshint| + 4.3. phpcs..................................|ale-linter-options-phpcs| + 4.4. html-tidy..............................|ale-linter-options-html-tidy| + 4.5. c-gcc..................................|ale-linter-options-c-gcc| + 4.6. cpp-gcc................................|ale-linter-options-cpp-gcc| + 4.7. fortran-gcc............................|ale-linter-options-fortran-gcc| + 4.8. shell..................................|ale-linter-options-shell| + 4.9. shellcheck.............................|ale-linter-options-shellcheck| 5. API........................................|ale-api| 6. Contact....................................|ale-contact| @@ -333,7 +334,18 @@ g:ale_javascript_eslint_executable *g:ale_javascript_eslint_executable* ------------------------------------------------------------------------------- -4.2. phpcs *ale-linter-options-phpcs* +4.2. jshint *ale-linter-options-jshint* + +g:ale_javascript_jshint_executable *g:ale_javascript_jshint_executable* + + Type: |String| + Default: `'jshint'` + + This variable can be changed to change the path to jshint. + + +------------------------------------------------------------------------------- +4.3. phpcs *ale-linter-options-phpcs* g:ale_php_phpcs_standard *g:ale_php_phpcs_standard* @@ -346,45 +358,47 @@ g:ale_php_phpcs_standard *g:ale_php_phpcs_standard* ------------------------------------------------------------------------------- -4.3. c-gcc *ale-linter-options-c-gcc* +4.4. html-tidy *ale-linter-options-html-tidy* -g:ale_c_gcc_options *g:ale_c_gcc_options* +g:ale_html_tidy_executable *g:ale_html_tidy_executable* Type: |String| - Default: `'-Wall'` - - This variable can be change to modify flags given to gcc. + Default: `'tidy'` + This variable can be changed to change the path to tidy. -------------------------------------------------------------------------------- -4.4. cpp-gcc *ale-linter-options-cpp-gcc* -g:ale_cpp_gcc_options *g:ale_cpp_gcc_options* +g:ale_html_tidy_args *g:ale_html_tidy_args* Type: |String| - Default: `'-Wall'` + Default: `'-q -e -language en'` - This variable can be changed to modify flags given to gcc. + This variable can be changed to change the arguments provided to the + executable. + + ALE will attempt to automatically detect the appropriate file encoding to + provide to html-tidy, and fall back to UTF-8 when encoding detection fails. + + The recognized file encodings are as follows: ascii, big5, cp1252 (win1252), + cp850 (ibm858), cp932 (shiftjis), iso-2022-jp (iso-2022), latin1, macroman + (mac), sjis (shiftjis), utf-16le, utf-16, utf-8 ------------------------------------------------------------------------------- -4.5. shell *ale-linter-options-shell* +4.5. c-gcc *ale-linter-options-c-gcc* -g:ale_linters_sh_shell_default_shell *g:ale_linters_sh_shell_default_shell* +g:ale_c_gcc_options *g:ale_c_gcc_options* Type: |String| - Default: The current shell (`$SHELL`) or `'bash'` if that cannot be read. + Default: `'-Wall'` - When ALE runs the linter for shells with the `-n` flag, it will attempt to - read the shell from the shebang (`#!`) line from the shell script to - determine the shell program to run. When this detection fails, this variable - will be used instead. + This variable can be change to modify flags given to gcc. ------------------------------------------------------------------------------- -4.6. fortran-gcc *ale-linter-options-fortran-gcc* +4.6. cpp-gcc *ale-linter-options-cpp-gcc* -g:ale_fortran_gcc_options *g:ale_fortran_gcc_options* +g:ale_cpp_gcc_options *g:ale_cpp_gcc_options* Type: |String| Default: `'-Wall'` @@ -393,41 +407,40 @@ g:ale_fortran_gcc_options *g:ale_fortran_gcc_options* ------------------------------------------------------------------------------- -4.7. html-tidy *ale-linter-options-html-tidy* +4.7. fortran-gcc *ale-linter-options-fortran-gcc* -g:ale_html_tidy_executable *g:ale_html_tidy_executable* +g:ale_fortran_gcc_options *g:ale_fortran_gcc_options* Type: |String| - Default: `'tidy'` - - This variable can be changed to change the path to tidy. + Default: `'-Wall'` + This variable can be changed to modify flags given to gcc. -g:ale_html_tidy_args *g:ale_html_tidy_args* - Type: |String| - Default: `'-q -e -language en'` +------------------------------------------------------------------------------- +4.8. shell *ale-linter-options-shell* - This variable can be changed to change the arguments provided to the - executable. +g:ale_linters_sh_shell_default_shell *g:ale_linters_sh_shell_default_shell* - ALE will attempt to automatically detect the appropriate file encoding to - provide to html-tidy, and fall back to UTF-8 when encoding detection fails. + Type: |String| + Default: The current shell (`$SHELL`) or `'bash'` if that cannot be read. - The recognized file encodings are as follows: ascii, big5, cp1252 (win1252), - cp850 (ibm858), cp932 (shiftjis), iso-2022-jp (iso-2022), latin1, macroman - (mac), sjis (shiftjis), utf-16le, utf-16, utf-8 + When ALE runs the linter for shells with the `-n` flag, it will attempt to + read the shell from the shebang (`#!`) line from the shell script to + determine the shell program to run. When this detection fails, this variable + will be used instead. ------------------------------------------------------------------------------- -4.8. jshint *ale-linter-options-jshint* +4.9. shellchek *ale-linter-options-shellcheck* -g:ale_javascript_jshint_executable *g:ale_javascript_jshint_executable* +g:ale_linters_sh_shellckeck_exclusions *g:ale_linters_sh_shellckeck_exclusions* Type: |String| - Default: `'jshint'` + Default: `''` + + Set this variable to exclude test(s) for shellcheck (-e/--exclude option). - This variable can be changed to change the path to jshint. =============================================================================== 5. API *ale-api* |