X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/0ee596c5c5e11fc79598407eaf22f83d279f7e9e..5a4872f466ebd76ddd532bdf2798554421c53df4:/.vim/bundle/ale/doc/ale-erlang.txt?ds=sidebyside diff --git a/.vim/bundle/ale/doc/ale-erlang.txt b/.vim/bundle/ale/doc/ale-erlang.txt new file mode 100644 index 00000000..388f80ad --- /dev/null +++ b/.vim/bundle/ale/doc/ale-erlang.txt @@ -0,0 +1,232 @@ +=============================================================================== +ALE Erlang Integration *ale-erlang-options* + + +=============================================================================== +dialyzer *ale-erlang-dialyzer* + + *ale-options.erlang_dialyzer_executable* + *g:ale_erlang_dialyzer_executable* + *b:ale_erlang_dialyzer_executable* +erlang_dialyzer_executable +g:ale_erlang_dialyzer_executable + Type: |String| + Default: `'dialyzer'` + + This variable can be changed to specify the dialyzer executable. + + *ale-options.erlang_dialyzer_options* + *g:ale_erlang_dialyzer_options* + *b:ale_erlang_dialyzer_options* +erlang_dialyzer_options +g: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. + *ale-options.erlang_dialyzer_plt_file* + *g:ale_erlang_dialyzer_plt_file* + *b:ale_erlang_dialyzer_plt_file* +erlang_dialyzer_plt_file +g:ale_erlang_dialyzer_plt_file + Type: |String| + Default: `''` + + 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`. + + *ale-options.erlang_dialyzer_rebar3_profile* + *g:ale_erlang_dialyzer_rebar3_profile* + *b:ale_erlang_dialyzer_rebar3_profile* +erlang_dialyzer_rebar3_profile +g: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* + + *ale-options.erlang_elvis_executable* + *g:ale_erlang_elvis_executable* + *b:ale_erlang_elvis_executable* +erlang_elvis_executable +g:ale_erlang_elvis_executable + Type: |String| + Default: `'elvis'` + + This variable can be changed to specify the elvis executable. + + +=============================================================================== +erlang-mode *ale-erlang-erlang-mode* + + *ale-options.erlang_erlang_mode_emacs_executable* + *g:ale_erlang_erlang_mode_emacs_executable* + *b:ale_erlang_erlang_mode_emacs_executable* +erlang_erlang_mode_emacs_executable +g:ale_erlang_erlang_mode_emacs_executable + Type: |String| + Default: `'emacs'` + + This variable can be changed to specify the Emacs executable. + + *ale-options.erlang_erlang_mode_indent_level* + *g:ale_erlang_erlang_mode_indent_level* + *b:ale_erlang_erlang_mode_indent_level* +erlang_erlang_mode_indent_level +g:ale_erlang_erlang_mode_indent_level + Type: |Number| + Default: `4` + + Indentation of Erlang calls/clauses within blocks. + + *ale-options.erlang_erlang_mode_icr_indent* + *g:ale_erlang_erlang_mode_icr_indent* + *b:ale_erlang_erlang_mode_icr_indent* +erlang_erlang_mode_icr_indent +g:ale_erlang_erlang_mode_icr_indent + Type: `'nil'` or |Number| + Default: `'nil'` + + Indentation of Erlang if/case/receive patterns. `'nil'` means keeping default + behavior. When non-`'nil'`, indent to the column of if/case/receive. + + *ale-options.erlang_erlang_mode_indent_guard* + *g:ale_erlang_erlang_mode_indent_guard* + *b:ale_erlang_erlang_mode_indent_guard* +erlang_erlang_mode_indent_guard +g:ale_erlang_erlang_mode_indent_guard + Type: |Number| + Default: `2` + + Indentation of Erlang guards. + + *ale-options.erlang_erlang_mode_argument_indent* + *g:ale_erlang_erlang_mode_argument_indent* + *b:ale_erlang_erlang_mode_argument_indent* +erlang_erlang_mode_argument_indent +g:ale_erlang_erlang_mode_argument_indent + Type: `'nil'` or |Number| + Default: `2` + + Indentation of the first argument in a function call. When `'nil'`, indent + to the column after the `'('` of the function. + + *ale-options.erlang_erlang_mode_indent_tabs_mode* + *g:ale_erlang_erlang_mode_indent_tabs_mode* + *b:ale_erlang_erlang_mode_indent_tabs_mode* +erlang_erlang_mode_indent_tabs_mode +g:ale_erlang_erlang_mode_indent_tabs_mode + Type: `'nil'` or `'t'` + Default: `'nil'` + + Indentation can insert tabs if this is non-`'nil'`. + + +=============================================================================== +erlang_ls *ale-erlang-erlang_ls* + + *ale-options.erlang_erlang_ls_executable* + *g:ale_erlang_erlang_ls_executable* + *b:ale_erlang_erlang_ls_executable* +erlang_erlang_ls_executable +g:ale_erlang_erlang_ls_executable + Type: |String| + Default: `'erlang_ls'` + + This variable can be changed to specify the erlang_ls executable. + + *ale-options.erlang_erlang_ls_log_dir* + *g:ale_erlang_erlang_ls_log_dir* + *b:ale_erlang_erlang_ls_log_dir* +erlang_erlang_ls_log_dir +g:ale_erlang_erlang_ls_log_dir + Type: |String| + Default: `''` + + If set this variable overrides default directory where logs will be written. + + *ale-options.erlang_erlang_ls_log_level* + *g:ale_erlang_erlang_ls_log_level* + *b:ale_erlang_erlang_ls_log_level* +erlang_erlang_ls_log_level +g:ale_erlang_erlang_ls_log_level + Type: |String| + Default: `'info'` + + This variable can be changed to specify log level. + + +=============================================================================== +erlc *ale-erlang-erlc* + + *ale-options.erlang_erlc_executable* + *g:ale_erlang_erlc_executable* + *b:ale_erlang_erlc_executable* +erlang_erlc_executable +g:ale_erlang_erlc_executable + Type: |String| + Default: `'erlc'` + + This variable can be changed to specify the erlc executable. + + *ale-options.erlang_erlc_options* + *g:ale_erlang_erlc_options* + *b:ale_erlang_erlc_options* +erlang_erlc_options +g:ale_erlang_erlc_options + Type: |String| + Default: `''` + + This variable controls additional parameters passed to `erlc`, such as `-I` + or `-pa`. + + +=============================================================================== +erlfmt *ale-erlang-erlfmt* + + *ale-options.erlang_erlfmt_executable* + *g:ale_erlang_erlfmt_executable* + *b:ale_erlang_erlfmt_executable* +erlang_erlfmt_executable +g:ale_erlang_erlfmt_executable + Type: |String| + Default: `'erlfmt'` + + This variable can be changed to specify the erlfmt executable. + + *ale-options.erlang_erlfmt_options* + *g:ale_erlang_erlfmt_options* + *b:ale_erlang_erlfmt_options* +erlang_erlfmt_options +g: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* + + *ale-options.erlang_syntaxerl_executable* + *g:ale_erlang_syntaxerl_executable* + *b:ale_erlang_syntaxerl_executable* +erlang_syntaxerl_executable +g: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: