summaryrefslogtreecommitdiff
path: root/doc/ale-erlang.txt
blob: 2c6ff22a2f0237724a8a580359a2a02d1c5abd49 (plain)
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
===============================================================================
ALE Erlang Integration                                     *ale-erlang-options*


===============================================================================
dialyzer                                                  *ale-erlang-dialyzer*

g:ale_erlang_dialyzer_executable             *g:ale_erlang_dialyzer_executable*
                                             *b:ale_erlang_dialyzer_executable*
  Type: |String|
  Default: `'dialyzer'`

  This variable can be changed to specify the dialyzer executable.


g:ale_erlang_dialyzer_options                   *g:ale_erlang_dialyzer_options*
                                                *b:ale_erlang_dialyzer_options*
  Type: |String|
  Default: `'-Wunmatched_returns -Werror_handling -Wrace_conditions -Wunderspec'`

  This variable can be changed to specify the options to pass to the dialyzer
  executable.

g:ale_erlang_dialyzer_plt_file                 *g:ale_erlang_dialyzer_plt_file*
                                               *b:ale_erlang_dialyzer_plt_file*
  Type: |String|

  This variable can be changed to specify the path to the PLT file. By
  default, it will search for the PLT file inside the `_build` directory. If
  there isn't one, it will fallback to the path `$REBAR_PLT_DIR/dialyzer/plt`.
  Otherwise, it will default to `$HOME/.dialyzer_plt`.


g:ale_erlang_dialyzer_rebar3_profile     *g:ale_erlang_dialyzer_rebar3_profile*
                                         *b:ale_erlang_dialyzer_rebar3_profile*
  Type: |String|
  Default: `'default'`

  This variable can be changed to specify the profile that is used to
  run dialyzer with rebar3.


-------------------------------------------------------------------------------
elvis                                                        *ale-erlang-elvis*

g:ale_erlang_elvis_executable                   *g:ale_erlang_elvis_executable*
                                                *b:ale_erlang_elvis_executable*
  Type: |String|
  Default: `'elvis'`

  This variable can be changed to specify the elvis executable.


-------------------------------------------------------------------------------
erlang_ls                                                *ale-erlang-erlang_ls*

g:ale_erlang_erlang_ls_executable           *g:ale_erlang_erlang_ls_executable*
                                            *b:ale_erlang_erlang_ls_executable*
  Type: |String|
  Default: `'erlang_ls'`

  This variable can be changed to specify the erlang_ls executable.

g:ale_erlang_erlang_ls_log_dir                 *g:ale_erlang_erlang_ls_log_dir*
                                               *b:ale_erlang_erlang_ls_log_dir*
  Type: |String|
  Default: `''`

  If set this variable overrides default directory where logs will be written.

g:ale_erlang_erlang_ls_log_level             *g:ale_erlang_erlang_ls_log_level*
                                             *b:ale_erlang_erlang_ls_log_level*
  Type: |String|
  Default: `'info'`

  This variable can be changed to specify log level.


-------------------------------------------------------------------------------
erlc                                                          *ale-erlang-erlc*

g:ale_erlang_erlc_executable                     *g:ale_erlang_erlc_executable*
                                                 *b:ale_erlang_erlc_executable*
  Type: |String|
  Default: `'erlc'`

  This variable can be changed to specify the erlc executable.


g:ale_erlang_erlc_options                           *g:ale_erlang_erlc_options*
                                                    *b:ale_erlang_erlc_options*
  Type: |String|
  Default: `''`

  This variable controls additional parameters passed to `erlc`, such as `-I`
  or `-pa`.


-------------------------------------------------------------------------------
erlfmt                                                      *ale-erlang-erlfmt*

g:ale_erlang_erlfmt_executable                 *g:ale_erlang_erlfmt_executable*
                                               *b:ale_erlang_erlfmt_executable*
  Type: |String|
  Default: `'erlfmt'`

  This variable can be changed to specify the erlfmt executable.


g:ale_erlang_erlfmt_options                       *g:ale_erlang_erlfmt_options*
                                                  *b:ale_erlang_erlfmt_options*
  Type: |String|
  Default: `''`

  This variable controls additional parameters passed to `erlfmt`, such as
  `--insert-pragma` or `--print-width`.


-------------------------------------------------------------------------------
syntaxerl                                                *ale-erlang-syntaxerl*

g:ale_erlang_syntaxerl_executable           *g:ale_erlang_syntaxerl_executable*
                                            *b:ale_erlang_syntaxerl_executable*
  Type: |String|
  Default: `'syntaxerl'`

  This variable can be changed to specify the syntaxerl executable.


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