diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale-cpp.txt | 27 | ||||
| -rw-r--r-- | doc/ale-kotlin.txt | 65 | ||||
| -rw-r--r-- | doc/ale.txt | 3 |
3 files changed, 93 insertions, 2 deletions
diff --git a/doc/ale-cpp.txt b/doc/ale-cpp.txt index 3baa767a..71673826 100644 --- a/doc/ale-cpp.txt +++ b/doc/ale-cpp.txt @@ -16,12 +16,35 @@ g:ale_cpp_clang_options *g:ale_cpp_clang_options* ------------------------------------------------------------------------------- clangtidy *ale-cpp-clangtidy* +`clang-tidy` will be run only when files are saved to disk, so that +`compile_commands.json` files can be used. It is recommended to use this +linter in combination with `compile_commands.json` files. + + +g:ale_cpp_clangtidy_checks *g:ale_cpp_clangtidy_checks* + *b:ale_cpp_clangtidy_checks* + Type: |List| + Default: `['*']` + + The checks to enable for clang-tidy with the `-checks` argument. + + All options will be joined with commas, and escaped appropriately for + the shell. The `-checks` flag can be removed entirely by setting this + option to an empty List. + + g:ale_cpp_clangtidy_options *g:ale_cpp_clangtidy_options* *b:ale_cpp_clangtidy_options* Type: |String| - Default: `'-std=c++14 -Wall'` + Default: `''` + + This variable can be changed to modify flags given to clang-tidy. - This variable can be changed to modify flags given to clangtidy. + Setting this variable to a non-empty string will cause the `--` argument + to be passed to `clang-tidy`, which will mean that detection of + `compile_commands.json` files for compile command databases will be + disabled. Only set this option if you want to control compiler flags + entirely manually. ------------------------------------------------------------------------------- diff --git a/doc/ale-kotlin.txt b/doc/ale-kotlin.txt new file mode 100644 index 00000000..04efaeaf --- /dev/null +++ b/doc/ale-kotlin.txt @@ -0,0 +1,65 @@ +=============================================================================== +ALE Kotlin Integration *ale-kotlin-options* + *ale-integration-kotlin* + +------------------------------------------------------------------------------- +Integration Information + + Make sure your setup has support for the kotlin file type. A filetype plugin + can be found here: https://github.com/udalov/kotlin-vim + + + Note: Make sure you have a working kotlin compiler + + +------------------------------------------------------------------------------- +kotlinc *ale-kotlin-kotlinc* + +g:ale_kotlin_kotlinc_options *g:ale_kotlin_kotlinc_options* + Type: |String| + Default: `''` + + Additional options to pass to the kotlin compiler + +g:ale_kotlin_kotlinc_enable_config *g:ale_kotlin_kotlinc_enable_config* + Type: |Number| + Default: `0` + + Setting this variable to `1` tells the linter to load a configuration file. + This should be set in your vimrc + +g:ale_kotlin_kotlinc_config_file *g:ale_kotlin_kotlinc_config_file* + Type: |String| + Default: `'.ale_kotlin_kotlinc_config'` + + Filename of the configuration file. This should be set in your vimrc + +g:ale_kotlin_kotlinc_classpath *g:ale_kotlin_kotlinc_classpath* + Type: |String| + Default: `''` + + A string containing the paths (separated by the appropriate path separator) + of the source directories. + +g:ale_kotlin_kotlinc_sourcepath *g:ale_kotlin_kotlinc_sourcepath* + Type: |String| + Default: `''` + + A string containing the paths (separated by space) of the source + directories. + +g:ale_kotlin_kotlinc_use_module_file *g:ale_kotlin_kotlinc_use_module_file* + Type: |Number| + Default: `0` + + This option indicates whether the linter should use a module file. It is off + by default. + +g:ale_kotlin_kotlinc_module_filename *g:ale_kotlin_kotlinc_module_filename* + Type: |String| + Default: `'module.xml'` + + The filename of the module file that the linter should pass to the kotlin + compiler. + + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index d8573ef1..01258cad 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -46,6 +46,8 @@ CONTENTS *ale-contents* jshint..............................|ale-javascript-jshint| standard............................|ale-javascript-standard| xo..................................|ale-javascript-xo| + kotlin................................|ale-kotlin-options| + kotlinc.............................|ale-kotlin-kotlinc| lua...................................|ale-lua-options| luacheck............................|ale-lua-luacheck| ocaml.................................|ale-ocaml-options| @@ -139,6 +141,7 @@ The following languages and tools are supported. * Java: 'javac' * JavaScript: 'eslint', 'jscs', 'jshint', 'flow', 'xo' * JSON: 'jsonlint' +* Kotlin: 'kotlinc' * LaTeX: 'chktex', 'lacheck' * Lua: 'luacheck' * Markdown: 'mdl', 'proselint', 'vale' |