doc/ale-kotlin.txt

   1 ===============================================================================
   2 ALE Kotlin Integration                                     *ale-kotlin-options*
   3                                                        *ale-integration-kotlin*
   4
   5 ===============================================================================
   6 Integration Information
   7
   8   Make sure your setup has support for the kotlin file type. A filetype plugin
   9   can be found here: https://github.com/udalov/kotlin-vim
  10
  11
  12   Note: Make sure you have a working kotlin compiler
  13
  14
  15 ===============================================================================
  16 kotlinc                                                    *ale-kotlin-kotlinc*
  17
  18                                            *ale-options.kotlin_kotlinc_options*
  19                                                  *g:ale_kotlin_kotlinc_options*
  20                                                  *b:ale_kotlin_kotlinc_options*
  21 kotlin_kotlinc_options
  22 g:ale_kotlin_kotlinc_options
  23   Type: |String|
  24   Default: `''`
  25
  26   Additional options to pass to the kotlin compiler
  27
  28                                      *ale-options.kotlin_kotlinc_enable_config*
  29                                            *g:ale_kotlin_kotlinc_enable_config*
  30                                            *b:ale_kotlin_kotlinc_enable_config*
  31 kotlin_kotlinc_enable_config
  32 g:ale_kotlin_kotlinc_enable_config
  33   Type: |Number|
  34   Default: `0`
  35
  36   Setting this variable to `1` tells the linter to load a configuration file.
  37   This should be set in your vimrc
  38
  39                                        *ale-options.kotlin_kotlinc_config_file*
  40                                              *g:ale_kotlin_kotlinc_config_file*
  41                                              *b:ale_kotlin_kotlinc_config_file*
  42 kotlin_kotlinc_config_file
  43 g:ale_kotlin_kotlinc_config_file
  44   Type: |String|
  45   Default: `'.ale_kotlin_kotlinc_config'`
  46
  47   Filename of the configuration file. This should be set in your vimrc
  48
  49                                          *ale-options.kotlin_kotlinc_classpath*
  50                                                *g:ale_kotlin_kotlinc_classpath*
  51                                                *b:ale_kotlin_kotlinc_classpath*
  52 kotlin_kotlinc_classpath
  53 g:ale_kotlin_kotlinc_classpath
  54   Type: |String|
  55   Default: `''`
  56
  57   A string containing the paths (separated by the appropriate path separator)
  58   of the source directories.
  59
  60                                         *ale-options.kotlin_kotlinc_sourcepath*
  61                                               *g:ale_kotlin_kotlinc_sourcepath*
  62                                               *b:ale_kotlin_kotlinc_sourcepath*
  63 kotlin_kotlinc_sourcepath
  64 g:ale_kotlin_kotlinc_sourcepath
  65   Type: |String|
  66   Default: `''`
  67
  68   A string containing the paths (separated by space) of the source
  69   directories.
  70
  71                                    *ale-options.kotlin_kotlinc_use_module_file*
  72                                          *g:ale_kotlin_kotlinc_use_module_file*
  73                                          *b:ale_kotlin_kotlinc_use_module_file*
  74 kotlin_kotlinc_use_module_file
  75 g:ale_kotlin_kotlinc_use_module_file
  76   Type: |Number|
  77   Default: `0`
  78
  79   This option indicates whether the linter should use a module file. It is off
  80   by default.
  81
  82                                    *ale-options.kotlin_kotlinc_module_filename*
  83                                          *g:ale_kotlin_kotlinc_module_filename*
  84                                          *b:ale_kotlin_kotlinc_module_filename*
  85 kotlin_kotlinc_module_filename
  86 g:ale_kotlin_kotlinc_module_filename
  87   Type: |String|
  88   Default: `'module.xml'`
  89
  90   The filename of the module file that the linter should pass to the kotlin
  91   compiler.
  92
  93
  94 ===============================================================================
  95 ktlint                                                      *ale-kotlin-ktlint*
  96
  97                                          *ale-options.kotlin_ktlint_executable*
  98                                                *g:ale_kotlin_ktlint_executable*
  99                                                *b:ale_kotlin_ktlint_executable*
 100 kotlin_ktlint_executable
 101 g:ale_kotlin_ktlint_executable
 102   Type: |String|
 103   Default: `''`
 104
 105   The Ktlint executable.
 106
 107   Posix-compliant shell scripts are the only executables that can be found on
 108   Ktlint's github release page. If you are not on such a system, your best
 109   bet will be to download the ktlint jar and set this option to something
 110   similar to `'java -jar /path/to/ktlint.jar'`
 111
 112                                            *ale-options.kotlin_ktlint_rulesets*
 113                                                  *g:ale_kotlin_ktlint_rulesets*
 114                                                  *b:ale_kotlin_ktlint_rulesets*
 115 kotlin_ktlint_rulesets
 116 g:ale_kotlin_ktlint_rulesets
 117   Type: |List|
 118   Default: `[]`
 119
 120   This list should contain paths to ruleset jars and/or strings of maven
 121   artifact triples. Example: >
 122
 123   let g:ale_kotlin_ktlint_rulesets = ['/path/to/custom-ruleset.jar',
 124   'com.ktlint.rulesets:mycustomrule:1.0.0']
 125 <
 126                                             *ale-options.kotlin_ktlint_options*
 127                                                   *g:ale_kotlin_ktlint_options*
 128                                                   *b:ale_kotlin_ktlint_options*
 129 kotlin_ktlint_options
 130 g:ale_kotlin_ktlint_options
 131   Type: |String|
 132   Default: `''`
 133
 134   Options to pass to ktlint for both linting and fixing. For example: >
 135
 136   let g:ale_kotlin_ktlint_options = '--android'
 137 <
 138
 139 ===============================================================================
 140 languageserver                                      *ale-kotlin-languageserver*
 141
 142                                  *ale-options.kotlin_languageserver_executable*
 143                                        *g:ale_kotlin_languageserver_executable*
 144                                        *b:ale_kotlin_languageserver_executable*
 145 kotlin_languageserver_executable
 146 g:ale_kotlin_languageserver_executable
 147   Type: |String|
 148   Default: `''`
 149
 150   The kotlin-language-server executable.
 151
 152   Executables are located inside the bin/ folder of the language server
 153   release.
 154
 155
 156 ===============================================================================
 157   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: