VimPlug/ale
1
0
Fork 0
mirror of https://github.com/dense-analysis/ale.git synced 2026-09-19 02:03:12 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Implement Lua ALE setup & overhaul documentation

Browse Source 
1. Add ale.setup and ale.setup.buffer for pure Lua configuration.
2. Update many global settings to use Booleans instead of numbers to
   make types easiert to work with in Lua.
3. Radically reformat documentation and fix errors to make
   documentation more usable for Neovim users.
This commit is contained in:
w0rp
2025-03-27 12:40:11 +00:00
parent 2280d41b30
commit 400857d758
146 changed files with 5469 additions and 2642 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/ale-kotlin.txt
+62 -18
View File
@@ -15,47 +15,75 @@ Integration Information
===============================================================================
kotlinc *ale-kotlin-kotlinc*
g:ale_kotlin_kotlinc_options *g:ale_kotlin_kotlinc_options*
*ale-options.kotlin_kotlinc_options*
*g:ale_kotlin_kotlinc_options*
*b:ale_kotlin_kotlinc_options*
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*
*ale-options.kotlin_kotlinc_enable_config*
*g:ale_kotlin_kotlinc_enable_config*
*b:ale_kotlin_kotlinc_enable_config*
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*
*ale-options.kotlin_kotlinc_config_file*
*g:ale_kotlin_kotlinc_config_file*
*b:ale_kotlin_kotlinc_config_file*
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*
*ale-options.kotlin_kotlinc_classpath*
*g:ale_kotlin_kotlinc_classpath*
*b:ale_kotlin_kotlinc_classpath*
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*
*ale-options.kotlin_kotlinc_sourcepath*
*g:ale_kotlin_kotlinc_sourcepath*
*b:ale_kotlin_kotlinc_sourcepath*
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*
*ale-options.kotlin_kotlinc_use_module_file*
*g:ale_kotlin_kotlinc_use_module_file*
*b:ale_kotlin_kotlinc_use_module_file*
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*
*ale-options.kotlin_kotlinc_module_filename*
*g:ale_kotlin_kotlinc_module_filename*
*b:ale_kotlin_kotlinc_module_filename*
kotlin_kotlinc_module_filename
g:ale_kotlin_kotlinc_module_filename
Type: |String|
Default: `'module.xml'`
@@ -66,7 +94,11 @@ g:ale_kotlin_kotlinc_module_filename *g:ale_kotlin_kotlinc_module_filename*
===============================================================================
ktlint *ale-kotlin-ktlint*
g:ale_kotlin_ktlint_executable *g:ale_kotlin_ktlint_executable*
*ale-options.kotlin_ktlint_executable*
*g:ale_kotlin_ktlint_executable*
*b:ale_kotlin_ktlint_executable*
kotlin_ktlint_executable
g:ale_kotlin_ktlint_executable
Type: |String|
Default: `''`
@@ -77,29 +109,41 @@ g:ale_kotlin_ktlint_executable *g:ale_kotlin_ktlint_executable*
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
*ale-options.kotlin_ktlint_rulesets*
*g:ale_kotlin_ktlint_rulesets*
*b:ale_kotlin_ktlint_rulesets*
kotlin_ktlint_rulesets
g:ale_kotlin_ktlint_rulesets
Type: |List|
Default: `[]`
This list should contain paths to ruleset jars and/or strings of maven
artifact triples. Example:
>
artifact triples. Example: >
let g:ale_kotlin_ktlint_rulesets = ['/path/to/custom-ruleset.jar',
'com.ktlint.rulesets:mycustomrule:1.0.0']
g:ale_kotlin_ktlint_options *g:ale_kotlin_ktlint_options*
<
*ale-options.kotlin_ktlint_options*
*g:ale_kotlin_ktlint_options*
*b:ale_kotlin_ktlint_options*
kotlin_ktlint_options
g:ale_kotlin_ktlint_options
Type: |String|
Default: `''`
Additional options to pass to ktlint for both linting and fixing. Example:
>
let g:ale_kotlin_ktlint_options = '--android'
Options to pass to ktlint for both linting and fixing. For example: >
let g:ale_kotlin_ktlint_options = '--android'
<
===============================================================================
languageserver *ale-kotlin-languageserver*
g:ale_kotlin_languageserver_executable *g:ale_kotlin_languageserver_executable*
*ale-options.kotlin_languageserver_executable*
*g:ale_kotlin_languageserver_executable*
*b:ale_kotlin_languageserver_executable*
kotlin_languageserver_executable
g:ale_kotlin_languageserver_executable
Type: |String|
Default: `''`