.vim/bundle/ale/doc/ale-elixir.txt

   1 ===============================================================================
   2 ALE Elixir Integration                                     *ale-elixir-options*
   3
   4
   5 ===============================================================================
   6 mix                                                            *ale-elixir-mix*
   7
   8 The `mix` linter is disabled by default, as it can be too expensive to run.
   9 See `:help g:ale_linters`
  10
  11                                                *ale-options.elixir_mix_options*
  12                                                      *g:ale_elixir_mix_options*
  13                                                      *b:ale_elixir_mix_options*
  14 elixir_mix_options
  15 g:ale_elixir_mix_options
  16   Type: |String|
  17   Default: `'mix'`
  18
  19
  20   This variable can be changed to specify the mix executable.
  21
  22
  23 ===============================================================================
  24 mix_format                                              *ale-elixir-mix-format*
  25
  26                                         *ale-options.elixir_mix_format_options*
  27                                               *g:ale_elixir_mix_format_options*
  28                                               *b:ale_elixir_mix_format_options*
  29 elixir_mix_format_options
  30 g:ale_elixir_mix_format_options
  31   Type: |String|
  32   Default: `''`
  33
  34
  35   This variable can be changed to specify the mix options passed to the
  36   mix_format fixer
  37
  38
  39 ===============================================================================
  40 dialyxir                                                  *ale-elixir-dialyxir*
  41
  42 Dialyzer, a DIscrepancy AnaLYZer for ERlang programs.
  43 http://erlang.org/doc/man/dialyzer.html
  44
  45 It can be used with elixir through dialyxir
  46 https://github.com/jeremyjh/dialyxir
  47
  48 Options for dialyzer are not configurable by ale, but they are instead
  49 configured on your project's `mix.exs`.
  50
  51 See https://github.com/jeremyjh/dialyxir#with-explaining-stuff for more
  52 information.
  53
  54
  55 ===============================================================================
  56 elixir-ls                                                *ale-elixir-elixir-ls*
  57
  58 Elixir Language Server (https://github.com/JakeBecker/elixir-ls)
  59
  60                                          *ale-options.elixir_elixir_ls_release*
  61                                                *g:ale_elixir_elixir_ls_release*
  62                                                *b:ale_elixir_elixir_ls_release*
  63 elixir_elixir_ls_release
  64 g:ale_elixir_elixir_ls_release
  65   Type: |String|
  66   Default: `'elixir-ls'`
  67
  68   Location of the elixir-ls release directory. This directory must contain
  69   the language server scripts (language_server.sh and language_server.bat).
  70
  71                                           *ale-options.elixir_elixir_ls_config*
  72                                                 *g:ale_elixir_elixir_ls_config*
  73                                                 *b:ale_elixir_elixir_ls_config*
  74 elixir_elixir_ls_config
  75 g:ale_elixir_elixir_ls_config
  76   Type: |Dictionary|
  77   Default: `{}`
  78
  79   Dictionary containing configuration settings that will be passed to the
  80   language server. For example, to disable Dialyzer: >
  81
  82   let g:ale_elixir_elixir_ls_config = {
  83   \   'elixirLS': {
  84   \       'dialyzerEnabled': v:false,
  85   \   },
  86   \}
  87 <
  88   Consult the ElixirLS documentation for more information about settings.
  89
  90
  91 ===============================================================================
  92 credo                                                        *ale-elixir-credo*
  93
  94 Credo (https://github.com/rrrene/credo)
  95
  96                                               *ale-options.elixir_credo_strict*
  97                                                     *g:ale_elixir_credo_strict*
  98                                                     *b:ale_elixir_credo_strict*
  99 elixir_credo_strict
 100 g:ale_elixir_credo_strict
 101   Type: |Integer|
 102   Default: `0`
 103
 104   Tells credo to run in strict mode or suggest mode.  Set variable to 1 to
 105   enable --strict mode.
 106
 107                                          *ale-options.elixir_credo_config_file*
 108                                                *g:ale_elixir_credo_config_file*
 109                                                *b:ale_elixir_credo_config_file*
 110 elixir_credo_config_file
 111 g:ale_elixir_credo_config_file
 112   Type: |String|
 113   Default: `''`
 114
 115   Tells credo to use a custom configuration file.
 116
 117
 118 ===============================================================================
 119 cspell                                                      *ale-elixir-cspell*
 120
 121 See |ale-cspell-options|
 122
 123
 124 ===============================================================================
 125 lexical                                                    *ale-elixir-lexical*
 126
 127 Lexical (https://github.com/lexical-lsp/lexical)
 128
 129                                            *ale-options.elixir_lexical_release*
 130                                                  *g:ale_elixir_lexical_release*
 131                                                  *b:ale_elixir_lexical_release*
 132 elixir_lexical_release
 133 g:ale_elixir_lexical_release
 134   Type: |String|
 135   Default: `'lexical'`
 136
 137   Location of the lexical release directory. This directory must contain
 138   the language server scripts (start_lexical.sh and start_lexical.bat).
 139
 140   For example, set release to: `/home/projects/lexical/_build/dev/rel/lexical`
 141
 142   There are currnetly no configuration options for lexical.
 143
 144
 145 ===============================================================================
 146   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: