diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale.txt | 97 |
1 files changed, 62 insertions, 35 deletions
diff --git a/doc/ale.txt b/doc/ale.txt index 8025f776..a0784e4e 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -11,19 +11,21 @@ CONTENTS *ale-contents* 3. Global Options.............................|ale-options| 4. Linter Specific Options....................|ale-linter-options| 4.1. eslint................................|ale-linter-options-eslint| - 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| - 4.10. vint..................................|ale-linter-options-vint| - 4.11. luacheck..............................|ale-linter-options-luacheck| - 4.12. c-cppcheck............................|ale-linter-options-c-cppcheck| - 4.13. cpp-cppcheck..........................|ale-linter-options-cpp-cppcheck| - 4.14. htmlhint..............................|ale-linter-options-htmlhint| + 4.2. flow..................................|ale-linter-options-flow| + 4.3. jshint................................|ale-linter-options-jshint| + 4.4. phpcs.................................|ale-linter-options-phpcs| + 4.5. html-tidy.............................|ale-linter-options-html-tidy| + 4.6. c-gcc.................................|ale-linter-options-c-gcc| + 4.7. cpp-gcc...............................|ale-linter-options-cpp-gcc| + 4.8. fortran-gcc...........................|ale-linter-options-fortran-gcc| + 4.9. shell.................................|ale-linter-options-shell| + 4.10. shellcheck............................|ale-linter-options-shellcheck| + 4.11. vint..................................|ale-linter-options-vint| + 4.12. luacheck..............................|ale-linter-options-luacheck| + 4.13. c-cppcheck............................|ale-linter-options-c-cppcheck| + 4.14. cpp-cppcheck..........................|ale-linter-options-cpp-cppcheck| + 4.15. htmlhint..............................|ale-linter-options-htmlhint| + 4.16. c-clang...............................|ale-linter-options-c-clang| 5. Commands/Keybinds..........................|ale-commands| 6. API........................................|ale-api| 7. Special Thanks.............................|ale-special-thanks| @@ -57,6 +59,7 @@ The following languages and tools are supported. * Bourne Shell: 'shell' (-n flag), 'shellcheck' * C: 'cppcheck', 'gcc', 'clang' * C++ (filetype cpp): 'cppcheck', 'gcc' +* Chef: 'foodcritic' * CoffeeScript: 'coffee', 'coffelint' * CSS: 'csslint' * Cython (pyrex filetype): 'cython' @@ -66,7 +69,7 @@ The following languages and tools are supported. * Go: 'gofmt -e', 'go vet', 'golint' * Haskell: 'ghc', 'hlint' * HTML: 'HTMLHint', 'tidy' -* JavaScript: 'eslint', 'jscs', 'jshint' +* JavaScript: 'eslint', 'jscs', 'jshint', 'flow' * JSON: 'jsonlint' * Lua: 'luacheck' * Markdown: 'mdl' @@ -276,7 +279,7 @@ g:ale_echo_cursor *g:ale_echo_cursor* The format of the message can be customizable in |g:ale_echo_msg_format|. -g:ale_echo_msg_format *g:ale_echo_msg_format* +g:ale_echo_msg_format *g:ale_echo_msg_format* Type: |String| Default: `%s` @@ -288,7 +291,7 @@ g:ale_echo_msg_format *g:ale_echo_msg_format* Note |`g:ale_echo_cursor`| should be setted to 1 -g:ale_echo_msg_error_str *g:ale_echo_msg_error_str* +g:ale_echo_msg_error_str *g:ale_echo_msg_error_str* Type: |String| Default: `Error` @@ -298,7 +301,7 @@ g:ale_echo_msg_error_str *g:ale_echo_msg_error_str* Note |`g:ale_echo_msg_format`| should contain the `%severity%` handler -g:ale_echo_msg_warning_str *g:ale_echo_msg_warning_str* +g:ale_echo_msg_warning_str *g:ale_echo_msg_warning_str* Type: |String| Default: `Warning` @@ -377,9 +380,33 @@ g:ale_javascript_eslint_use_global *g:ale_javascript_eslint_use_global* global version of eslint, in preference to locally installed versions of eslint in node_modules. +------------------------------------------------------------------------------- +4.2. flow *ale-linter-options-flow* + +g:ale_javascript_flow_executable *g:ale_javascript_flow_executable* + + Type: |String| + Default: `'flow'` + + ALE will first discover the flow path in an ancestor node_modules + directory. If no such path exists, this variable will be used instead. + + If you wish to use only a globally installed version of flow, set + |g:ale_javascript_flow_use_global| to `1`. + + +g:ale_javascript_flow_use_global *g:ale_javascript_flow_use_global* + + Type: |String| + Default: `0` + + This variable controls whether or not ALE will search for a local path for + flow first. If this variable is set to `1`, then ALE will always use the + global version of flow, in preference to locally installed versions of + flow in node_modules. ------------------------------------------------------------------------------- -4.2. jshint *ale-linter-options-jshint* +4.3. jshint *ale-linter-options-jshint* g:ale_javascript_jshint_executable *g:ale_javascript_jshint_executable* @@ -407,7 +434,7 @@ g:ale_javascript_jshint_use_global *g:ale_javascript_jshint_use_global* ------------------------------------------------------------------------------- -4.3. phpcs *ale-linter-options-phpcs* +4.4. phpcs *ale-linter-options-phpcs* g:ale_php_phpcs_standard *g:ale_php_phpcs_standard* @@ -420,7 +447,7 @@ g:ale_php_phpcs_standard *g:ale_php_phpcs_standard* ------------------------------------------------------------------------------- -4.4. html-tidy *ale-linter-options-html-tidy* +4.5. html-tidy *ale-linter-options-html-tidy* g:ale_html_tidy_executable *g:ale_html_tidy_executable* @@ -447,7 +474,7 @@ g:ale_html_tidy_args *g:ale_html_tidy_args* ------------------------------------------------------------------------------- -4.5. c-gcc *ale-linter-options-c-gcc* +4.6. c-gcc *ale-linter-options-c-gcc* g:ale_c_gcc_options *g:ale_c_gcc_options* @@ -458,7 +485,7 @@ g:ale_c_gcc_options *g:ale_c_gcc_options* ------------------------------------------------------------------------------- -4.6. cpp-gcc *ale-linter-options-cpp-gcc* +4.7. cpp-gcc *ale-linter-options-cpp-gcc* g:ale_cpp_gcc_options *g:ale_cpp_gcc_options* @@ -469,7 +496,7 @@ g:ale_cpp_gcc_options *g:ale_cpp_gcc_options* ------------------------------------------------------------------------------- -4.7. fortran-gcc *ale-linter-options-fortran-gcc* +4.8. fortran-gcc *ale-linter-options-fortran-gcc* g:ale_fortran_gcc_options *g:ale_fortran_gcc_options* @@ -480,7 +507,7 @@ g:ale_fortran_gcc_options *g:ale_fortran_gcc_options* ------------------------------------------------------------------------------- -4.8. shell *ale-linter-options-shell* +4.9. shell *ale-linter-options-shell* g:ale_linters_sh_shell_default_shell *g:ale_linters_sh_shell_default_shell* @@ -494,7 +521,7 @@ g:ale_linters_sh_shell_default_shell *g:ale_linters_sh_shell_default_shell* ------------------------------------------------------------------------------- -4.9. shellcheck *ale-linter-options-shellcheck* +4.10. shellcheck *ale-linter-options-shellcheck* g:ale_linters_sh_shellckeck_exclusions *g:ale_linters_sh_shellckeck_exclusions* @@ -505,7 +532,7 @@ g:ale_linters_sh_shellckeck_exclusions *g:ale_linters_sh_shellckeck_exclusions* ------------------------------------------------------------------------------- -4.10. vint *ale-linter-options-vint* +4.11. vint *ale-linter-options-vint* g:ale_vim_vint_show_style_issues *g:ale_vim_vint_show_style_issues* @@ -518,7 +545,7 @@ g:ale_vim_vint_show_style_issues *g:ale_vim_vint_show_style_issues* ------------------------------------------------------------------------------- -4.11. luacheck *ale-linter-options-luacheck* +4.12. luacheck *ale-linter-options-luacheck* g:ale_lua_luacheck_executable *g:ale_lua_luacheck_executable* @@ -529,9 +556,9 @@ g:ale_lua_luacheck_executable *g:ale_lua_luacheck_executable* ------------------------------------------------------------------------------- -4.12. c-cppcheck *ale-linter-options-c-cppcheck* +4.13. c-cppcheck *ale-linter-options-c-cppcheck* -g:ale_c_cppcheck_options *g:ale_c_cppcheck_options* +g:ale_c_cppcheck_options *g:ale_c_cppcheck_options* Type: |String| Default: `'--enable=style'` @@ -540,9 +567,9 @@ g:ale_c_cppcheck_options *g:ale_c_cppcheck_options ------------------------------------------------------------------------------- -4.13. cpp-cppcheck *ale-linter-options-cpp-cppcheck* +4.14. cpp-cppcheck *ale-linter-options-cpp-cppcheck* -g:ale_cpp_cppcheck_options *g:ale_cpp_cppcheck_options* +g:ale_cpp_cppcheck_options *g:ale_cpp_cppcheck_options* Type: |String| Default: `'--enable=style'` @@ -551,9 +578,9 @@ g:ale_cpp_cppcheck_options *g:ale_cpp_cppcheck_options ------------------------------------------------------------------------------- -4.14. htmlhint *ale-linter-options-htmlhint* +4.15. htmlhint *ale-linter-options-htmlhint* -g:ale_html_htmlhint_options *g:ale_html_htmlhint_options* +g:ale_html_htmlhint_options *g:ale_html_htmlhint_options* Type: |String| Default: `'--format=unix'` @@ -562,7 +589,7 @@ g:ale_html_htmlhint_options *g:ale_html_htmlhint_options ------------------------------------------------------------------------------- -4.5. c-gcc *ale-linter-options-c-clang* +4.16. c-clang *ale-linter-options-c-clang* g:ale_c_clang_options *g:ale_c_clang_options* @@ -727,7 +754,7 @@ ALELint *ALELint* =============================================================================== -7. Special Thanks *ale-special-thanks* +7. Special Thanks *ale-special-thanks* Special thanks to Mark Grealish (https://www.bhalash.com/) for providing ALE's snazzy looking ale glass logo. Cheers, Mark! |