diff options
Diffstat (limited to 'doc/ale.txt')
| -rw-r--r-- | doc/ale.txt | 39 |
1 files changed, 33 insertions, 6 deletions
diff --git a/doc/ale.txt b/doc/ale.txt index 1f6ef977..402780b2 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -10,7 +10,9 @@ CONTENTS *ale-contents* 2. Supported Languages & Tools....................|ale-support| 3. Global Options.................................|ale-options| 4. Linter Specific Options........................|ale-linter-options| - 4.1. eslint................................ ....|ale-linter-options-eslint| + 4.1. eslint.....................................|ale-linter-options-eslint| + 4.2. phpcs......................................|ale-linter-options-phpcs| + 4.3. c-gcc......................................|ale-linter-options-c-gcc| 5. API............................................|ale-api| 6. Contact........................................|ale-contact| @@ -53,6 +55,7 @@ The following languages and tools are supported. * Ruby: 'rubocop' * SASS: 'sasslint' * SCSS: 'sasslint', 'scsslint' +* Scala: 'scalac' * TypeScript: 'tslint' * Vim: 'vint' * YAML: 'yamllint' @@ -236,7 +239,7 @@ Some linters have specific options which can be configured for each of them, for customising their behaviour. ------------------------------------------------------------------------------- -4.1. eslint +4.1. eslint *ale-linter-options-eslint* g:ale_javascript_eslint_executable *g:ale_javascript_eslint_executable* @@ -246,6 +249,28 @@ Default: `'eslint'` This variable can be changed to change the path to eslint. If you have eslint_d installed, you can set this option to use eslint_d instead. +------------------------------------------------------------------------------- +4.2. phpcs *ale-linter-options-phpcs* + +g:ale_php_phpcs_standard *g:ale_php_phpcs_standard* + +Type: |String| +Default: `''` + +This variable can be set to specify the coding standard used by phpcs. If +no coding standard is specified, phpcs will default to checking against the +PEAR coding standard, or the standard you have set as the default. + +------------------------------------------------------------------------------- +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. + =============================================================================== 5. API *ale-api* @@ -309,10 +334,12 @@ ALEAddLinter(filetype, linter) *ALEAddLinter()* `output_stream` A |String| for the output stream the lines of output should be read from for the command which is run. The - accepted values are `'stdout'` and `'stderr'`. This - argument defaults to `'stdout'`. This argument can be - set for linter programs which output their errors and - warnings to the stderr stream instead of stdout. + accepted values are `'stdout'`, `'stderr'`, and + `'both'`. This argument defaults to `'stdout'`. This + argument can be set for linter programs which output + their errors and warnings to the stderr stream + instead of stdout. The option `'both'` will read + from both stder and stdout at the same time. Some programs for checking for errors are not capable of receiving input from stdin, as is required by ALE. To remedy this, a wrapper script is |