aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/doc/ale-elixir.txt
blob: 224a100f438796af95e4bd14dcf65b9880b1e789 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
===============================================================================
ALE Elixir Integration                                     *ale-elixir-options*


===============================================================================
mix                                                            *ale-elixir-mix*

The `mix` linter is disabled by default, as it can be too expensive to run.
See `:help g:ale_linters`

                                               *ale-options.elixir_mix_options*
                                                     *g:ale_elixir_mix_options*
                                                     *b:ale_elixir_mix_options*
elixir_mix_options
g:ale_elixir_mix_options
  Type: |String|
  Default: `'mix'`


  This variable can be changed to specify the mix executable.


===============================================================================
mix_format                                              *ale-elixir-mix-format*

                                        *ale-options.elixir_mix_format_options*
                                              *g:ale_elixir_mix_format_options*
                                              *b:ale_elixir_mix_format_options*
elixir_mix_format_options
g:ale_elixir_mix_format_options
  Type: |String|
  Default: `''`


  This variable can be changed to specify the mix options passed to the
  mix_format fixer


===============================================================================
dialyxir                                                  *ale-elixir-dialyxir*

Dialyzer, a DIscrepancy AnaLYZer for ERlang programs.
http://erlang.org/doc/man/dialyzer.html

It can be used with elixir through dialyxir
https://github.com/jeremyjh/dialyxir

Options for dialyzer are not configurable by ale, but they are instead
configured on your project's `mix.exs`.

See https://github.com/jeremyjh/dialyxir#with-explaining-stuff for more
information.


===============================================================================
elixir-ls                                                *ale-elixir-elixir-ls*

Elixir Language Server (https://github.com/JakeBecker/elixir-ls)

                                         *ale-options.elixir_elixir_ls_release*
                                               *g:ale_elixir_elixir_ls_release*
                                               *b:ale_elixir_elixir_ls_release*
elixir_elixir_ls_release
g:ale_elixir_elixir_ls_release
  Type: |String|
  Default: `'elixir-ls'`

  Location of the elixir-ls release directory. This directory must contain
  the language server scripts (language_server.sh and language_server.bat).

                                          *ale-options.elixir_elixir_ls_config*
                                                *g:ale_elixir_elixir_ls_config*
                                                *b:ale_elixir_elixir_ls_config*
elixir_elixir_ls_config
g:ale_elixir_elixir_ls_config
  Type: |Dictionary|
  Default: `{}`

  Dictionary containing configuration settings that will be passed to the
  language server. For example, to disable Dialyzer: >

  let g:ale_elixir_elixir_ls_config = {
  \   'elixirLS': {
  \       'dialyzerEnabled': v:false,
  \   },
  \}
<
  Consult the ElixirLS documentation for more information about settings.


===============================================================================
credo                                                        *ale-elixir-credo*

Credo (https://github.com/rrrene/credo)

                                              *ale-options.elixir_credo_strict*
                                                    *g:ale_elixir_credo_strict*
                                                    *b:ale_elixir_credo_strict*
elixir_credo_strict
g:ale_elixir_credo_strict
  Type: |Integer|
  Default: `0`

  Tells credo to run in strict mode or suggest mode.  Set variable to 1 to
  enable --strict mode.

                                         *ale-options.elixir_credo_config_file*
                                               *g:ale_elixir_credo_config_file*
                                               *b:ale_elixir_credo_config_file*
elixir_credo_config_file
g:ale_elixir_credo_config_file
  Type: |String|
  Default: `''`

  Tells credo to use a custom configuration file.


===============================================================================
cspell                                                      *ale-elixir-cspell*

See |ale-cspell-options|


===============================================================================
lexical                                                    *ale-elixir-lexical*

Lexical (https://github.com/lexical-lsp/lexical)

                                           *ale-options.elixir_lexical_release*
                                                 *g:ale_elixir_lexical_release*
                                                 *b:ale_elixir_lexical_release*
elixir_lexical_release
g:ale_elixir_lexical_release
  Type: |String|
  Default: `'lexical'`

  Location of the lexical release directory. This directory must contain
  the language server scripts (start_lexical.sh and start_lexical.bat).

  For example, set release to: `/home/projects/lexical/_build/dev/rel/lexical`

  There are currently no configuration options for lexical.


===============================================================================
expert                                                      *ale-elixir-expert*

Expert (https://github.com/elixir-lang/expert)

                                         *ale-options.elixir_expert_executable*
                                               *g:ale_elixir_expert_executable*
                                               *b:ale_elixir_expert_executable*
elixir_expert_executable
g:ale_elixir_expert_executable
  Type: |String|
  Default: `/usr/bin/elixir-expert`

  Location of the expert executable.

  For example, set release to:
  `/home/projects/expert/apps/expert/burrito_out/expert_linux_amd64`

  There are currently no configuration options for expert.

===============================================================================
  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: