jshaver
/
ale
forked from github-mirrors/ale
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

add shellcheck option to the doc and sort options by theme (#85) 

* add shellcheck options to the doc

* sort option by theme

* correct text for shellcheck option
This commit is contained in:
Marc Delage 2016-10-11 00:48:41 +02:00 committed by w0rp
parent c37e053944
commit 9a519684f2
1 changed files with 73 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

133
doc/ale.txt
View File

@ -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,54 +358,7 @@ g:ale_php_phpcs_standard *g:ale_php_phpcs_standard*
-------------------------------------------------------------------------------
4.3. c-gcc *ale-linter-options-c-gcc*
g:ale_c_gcc_options *g:ale_c_gcc_options*
Type: |String|
Default: `'-Wall'`
This variable can be change to modify flags given to gcc.
-------------------------------------------------------------------------------
4.4. cpp-gcc *ale-linter-options-cpp-gcc*
g:ale_cpp_gcc_options *g:ale_cpp_gcc_options*
Type: |String|
Default: `'-Wall'`
This variable can be changed to modify flags given to gcc.
-------------------------------------------------------------------------------
4.5. shell *ale-linter-options-shell*
g:ale_linters_sh_shell_default_shell *g:ale_linters_sh_shell_default_shell*
Type: |String|
Default: The current shell (`$SHELL`) or `'bash'` if that cannot be read.
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.6. fortran-gcc *ale-linter-options-fortran-gcc*
g:ale_fortran_gcc_options *g:ale_fortran_gcc_options*
Type: |String|
Default: `'-Wall'`
This variable can be changed to modify flags given to gcc.
-------------------------------------------------------------------------------
4.7. html-tidy *ale-linter-options-html-tidy*
4.4. html-tidy *ale-linter-options-html-tidy*
g:ale_html_tidy_executable *g:ale_html_tidy_executable*
@ -420,14 +385,62 @@ g:ale_html_tidy_args *g:ale_html_tidy_args*
-------------------------------------------------------------------------------
4.8. jshint *ale-linter-options-jshint*
4.5. c-gcc *ale-linter-options-c-gcc*
g:ale_javascript_jshint_executable *g:ale_javascript_jshint_executable*
g:ale_c_gcc_options *g:ale_c_gcc_options*
Type: |String|
Default: `'jshint'`
Default: `'-Wall'`
This variable can be change to modify flags given to gcc.
-------------------------------------------------------------------------------
4.6. cpp-gcc *ale-linter-options-cpp-gcc*
g:ale_cpp_gcc_options *g:ale_cpp_gcc_options*
Type: |String|
Default: `'-Wall'`
This variable can be changed to modify flags given to gcc.
-------------------------------------------------------------------------------
4.7. fortran-gcc *ale-linter-options-fortran-gcc*
g:ale_fortran_gcc_options *g:ale_fortran_gcc_options*
Type: |String|
Default: `'-Wall'`
This variable can be changed to modify flags given to gcc.
-------------------------------------------------------------------------------
4.8. shell *ale-linter-options-shell*
g:ale_linters_sh_shell_default_shell *g:ale_linters_sh_shell_default_shell*
Type: |String|
Default: The current shell (`$SHELL`) or `'bash'` if that cannot be read.
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.9. shellchek *ale-linter-options-shellcheck*
g:ale_linters_sh_shellckeck_exclusions *g:ale_linters_sh_shellckeck_exclusions*
Type: |String|
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*