diff options
| author | Francis Agyapong <francisagyapong2@gmail.com> | 2017-06-02 12:41:46 -0600 |
|---|---|---|
| committer | w0rp <w0rp@users.noreply.github.com> | 2017-06-02 19:41:46 +0100 |
| commit | 2c89a4c98a5a3435ed2b5b479a20f0e715553596 (patch) | |
| tree | 9b60e63be3ae594dddf4f929a6c8f23c6c18c6c7 /doc/ale-kotlin.txt | |
| parent | 7c68889bbcf04091ea19bd4d3d18d5f800d24c30 (diff) | |
| download | ale-2c89a4c98a5a3435ed2b5b479a20f0e715553596.zip | |
Add ktlint support (without formatting) for kotlin filetype (#610)
* Add ktlint support (without formatting) for kotlin filetype
* Fix code style and refactor to use ALE utility functions (GetMatches)
* Remove options for configuration file
* Refactor: Rename exec variable and use ale#Set for variable configuration
Diffstat (limited to 'doc/ale-kotlin.txt')
| -rw-r--r-- | doc/ale-kotlin.txt | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/ale-kotlin.txt b/doc/ale-kotlin.txt index 04efaeaf..07e26393 100644 --- a/doc/ale-kotlin.txt +++ b/doc/ale-kotlin.txt @@ -62,4 +62,29 @@ g:ale_kotlin_kotlinc_module_filename *g:ale_kotlin_kotlinc_module_filename* The filename of the module file that the linter should pass to the kotlin compiler. + +------------------------------------------------------------------------------- +ktlint *ale-kotlin-ktlint* + +g:ale_kotlin_ktlint_executable *g:ale_kotlin_ktlint_executable* + Type: |String| + Default: `''` + + The Ktlint executable. + + Posix-compliant shell scripts are the only executables that can be found on + Ktlint's github release page. If you are not on such a system, your best + bet will be to download the ktlint jar and set this option to something + similar to `'java -jar /path/to/ktlint.jar'` + +g:ale_kotlin_ktlint_rulesets *g:ale_kotlin_ktlint_rulesets* + Type: |List| of |String|s + Default: [] + + This list should contain paths to ruleset jars and/or strings of maven + artifact triples. Example: + > + let g:ale_kotlin_ktlint_rulesets = ['/path/to/custom-rulset.jar', + 'com.ktlint.rulesets:mycustomrule:1.0.0'] + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: |