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

   1 ===============================================================================
   2 ALE Erlang Integration                                     *ale-erlang-options*
   3
   4
   5 ===============================================================================
   6 dialyzer                                                  *ale-erlang-dialyzer*
   7
   8                                        *ale-options.erlang_dialyzer_executable*
   9                                              *g:ale_erlang_dialyzer_executable*
  10                                              *b:ale_erlang_dialyzer_executable*
  11 erlang_dialyzer_executable
  12 g:ale_erlang_dialyzer_executable
  13   Type: |String|
  14   Default: `'dialyzer'`
  15
  16   This variable can be changed to specify the dialyzer executable.
  17
  18                                           *ale-options.erlang_dialyzer_options*
  19                                                 *g:ale_erlang_dialyzer_options*
  20                                                 *b:ale_erlang_dialyzer_options*
  21 erlang_dialyzer_options
  22 g:ale_erlang_dialyzer_options
  23   Type: |String|
  24   Default: `'-Wunmatched_returns -Werror_handling -Wrace_conditions -Wunderspec'`
  25
  26   This variable can be changed to specify the options to pass to the dialyzer
  27   executable.
  28                                          *ale-options.erlang_dialyzer_plt_file*
  29                                                *g:ale_erlang_dialyzer_plt_file*
  30                                                *b:ale_erlang_dialyzer_plt_file*
  31 erlang_dialyzer_plt_file
  32 g:ale_erlang_dialyzer_plt_file
  33   Type: |String|
  34   Default: `''`
  35
  36   This variable can be changed to specify the path to the PLT file. By
  37   default, it will search for the PLT file inside the `_build` directory. If
  38   there isn't one, it will fallback to the path `$REBAR_PLT_DIR/dialyzer/plt`.
  39   Otherwise, it will default to `$HOME/.dialyzer_plt`.
  40
  41                                    *ale-options.erlang_dialyzer_rebar3_profile*
  42                                          *g:ale_erlang_dialyzer_rebar3_profile*
  43                                          *b:ale_erlang_dialyzer_rebar3_profile*
  44 erlang_dialyzer_rebar3_profile
  45 g:ale_erlang_dialyzer_rebar3_profile
  46   Type: |String|
  47   Default: `'default'`
  48
  49   This variable can be changed to specify the profile that is used to
  50   run dialyzer with rebar3.
  51
  52
  53 ===============================================================================
  54 elvis                                                        *ale-erlang-elvis*
  55
  56                                           *ale-options.erlang_elvis_executable*
  57                                                 *g:ale_erlang_elvis_executable*
  58                                                 *b:ale_erlang_elvis_executable*
  59 erlang_elvis_executable
  60 g:ale_erlang_elvis_executable
  61   Type: |String|
  62   Default: `'elvis'`
  63
  64   This variable can be changed to specify the elvis executable.
  65
  66
  67 ===============================================================================
  68 erlang-mode                                            *ale-erlang-erlang-mode*
  69
  70                               *ale-options.erlang_erlang_mode_emacs_executable*
  71                                     *g:ale_erlang_erlang_mode_emacs_executable*
  72                                     *b:ale_erlang_erlang_mode_emacs_executable*
  73 erlang_erlang_mode_emacs_executable
  74 g:ale_erlang_erlang_mode_emacs_executable
  75   Type: |String|
  76   Default: `'emacs'`
  77
  78   This variable can be changed to specify the Emacs executable.
  79
  80                                   *ale-options.erlang_erlang_mode_indent_level*
  81                                         *g:ale_erlang_erlang_mode_indent_level*
  82                                         *b:ale_erlang_erlang_mode_indent_level*
  83 erlang_erlang_mode_indent_level
  84 g:ale_erlang_erlang_mode_indent_level
  85   Type: |Number|
  86   Default: `4`
  87
  88   Indentation of Erlang calls/clauses within blocks.
  89
  90                                     *ale-options.erlang_erlang_mode_icr_indent*
  91                                           *g:ale_erlang_erlang_mode_icr_indent*
  92                                           *b:ale_erlang_erlang_mode_icr_indent*
  93 erlang_erlang_mode_icr_indent
  94 g:ale_erlang_erlang_mode_icr_indent
  95   Type: `'nil'` or |Number|
  96   Default: `'nil'`
  97
  98   Indentation of Erlang if/case/receive patterns. `'nil'` means keeping default
  99   behavior. When non-`'nil'`, indent to the column of if/case/receive.
 100
 101                                   *ale-options.erlang_erlang_mode_indent_guard*
 102                                         *g:ale_erlang_erlang_mode_indent_guard*
 103                                         *b:ale_erlang_erlang_mode_indent_guard*
 104 erlang_erlang_mode_indent_guard
 105 g:ale_erlang_erlang_mode_indent_guard
 106   Type: |Number|
 107   Default: `2`
 108
 109   Indentation of Erlang guards.
 110
 111                                *ale-options.erlang_erlang_mode_argument_indent*
 112                                      *g:ale_erlang_erlang_mode_argument_indent*
 113                                      *b:ale_erlang_erlang_mode_argument_indent*
 114 erlang_erlang_mode_argument_indent
 115 g:ale_erlang_erlang_mode_argument_indent
 116   Type: `'nil'` or |Number|
 117   Default: `2`
 118
 119   Indentation of the first argument in a function call. When `'nil'`, indent
 120   to the column after the `'('` of the function.
 121
 122                               *ale-options.erlang_erlang_mode_indent_tabs_mode*
 123                                     *g:ale_erlang_erlang_mode_indent_tabs_mode*
 124                                     *b:ale_erlang_erlang_mode_indent_tabs_mode*
 125 erlang_erlang_mode_indent_tabs_mode
 126 g:ale_erlang_erlang_mode_indent_tabs_mode
 127   Type: `'nil'` or `'t'`
 128   Default: `'nil'`
 129
 130   Indentation can insert tabs if this is non-`'nil'`.
 131
 132
 133 ===============================================================================
 134 erlang_ls                                                *ale-erlang-erlang_ls*
 135
 136                                       *ale-options.erlang_erlang_ls_executable*
 137                                             *g:ale_erlang_erlang_ls_executable*
 138                                             *b:ale_erlang_erlang_ls_executable*
 139 erlang_erlang_ls_executable
 140 g:ale_erlang_erlang_ls_executable
 141   Type: |String|
 142   Default: `'erlang_ls'`
 143
 144   This variable can be changed to specify the erlang_ls executable.
 145
 146                                          *ale-options.erlang_erlang_ls_log_dir*
 147                                                *g:ale_erlang_erlang_ls_log_dir*
 148                                                *b:ale_erlang_erlang_ls_log_dir*
 149 erlang_erlang_ls_log_dir
 150 g:ale_erlang_erlang_ls_log_dir
 151   Type: |String|
 152   Default: `''`
 153
 154   If set this variable overrides default directory where logs will be written.
 155
 156                                        *ale-options.erlang_erlang_ls_log_level*
 157                                              *g:ale_erlang_erlang_ls_log_level*
 158                                              *b:ale_erlang_erlang_ls_log_level*
 159 erlang_erlang_ls_log_level
 160 g:ale_erlang_erlang_ls_log_level
 161   Type: |String|
 162   Default: `'info'`
 163
 164   This variable can be changed to specify log level.
 165
 166
 167 ===============================================================================
 168 erlc                                                          *ale-erlang-erlc*
 169
 170                                            *ale-options.erlang_erlc_executable*
 171                                                  *g:ale_erlang_erlc_executable*
 172                                                  *b:ale_erlang_erlc_executable*
 173 erlang_erlc_executable
 174 g:ale_erlang_erlc_executable
 175   Type: |String|
 176   Default: `'erlc'`
 177
 178   This variable can be changed to specify the erlc executable.
 179
 180                                               *ale-options.erlang_erlc_options*
 181                                                     *g:ale_erlang_erlc_options*
 182                                                     *b:ale_erlang_erlc_options*
 183 erlang_erlc_options
 184 g:ale_erlang_erlc_options
 185   Type: |String|
 186   Default: `''`
 187
 188   This variable controls additional parameters passed to `erlc`, such as `-I`
 189   or `-pa`.
 190
 191
 192 ===============================================================================
 193 erlfmt                                                      *ale-erlang-erlfmt*
 194
 195                                          *ale-options.erlang_erlfmt_executable*
 196                                                *g:ale_erlang_erlfmt_executable*
 197                                                *b:ale_erlang_erlfmt_executable*
 198 erlang_erlfmt_executable
 199 g:ale_erlang_erlfmt_executable
 200   Type: |String|
 201   Default: `'erlfmt'`
 202
 203   This variable can be changed to specify the erlfmt executable.
 204
 205                                             *ale-options.erlang_erlfmt_options*
 206                                                   *g:ale_erlang_erlfmt_options*
 207                                                   *b:ale_erlang_erlfmt_options*
 208 erlang_erlfmt_options
 209 g:ale_erlang_erlfmt_options
 210   Type: |String|
 211   Default: `''`
 212
 213   This variable controls additional parameters passed to `erlfmt`, such as
 214   `--insert-pragma` or `--print-width`.
 215
 216
 217 ===============================================================================
 218 syntaxerl                                                *ale-erlang-syntaxerl*
 219
 220                                       *ale-options.erlang_syntaxerl_executable*
 221                                             *g:ale_erlang_syntaxerl_executable*
 222                                             *b:ale_erlang_syntaxerl_executable*
 223 erlang_syntaxerl_executable
 224 g:ale_erlang_syntaxerl_executable
 225   Type: |String|
 226   Default: `'syntaxerl'`
 227
 228   This variable can be changed to specify the syntaxerl executable.
 229
 230
 231 ===============================================================================
 232   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: