ld/amix-vimrc-mirror
1
0
Fork 0
mirror of https://github.com/amix/vimrc synced 2025-07-09 18:55:01 +08:00
Code Issues Packages Projects Releases Wiki Activity

Use sources_non_forked folder for pathogen path, with sources_non_forked_fallback folder as fallback.

Browse Source
This commit is contained in:
Wu Tingfeng
2022-11-21 22:56:20 +08:00
parent dddd2e4152
commit d9555d618c
1756 changed files with 4 additions and 250 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
sources_non_forked/ale/doc/ale-ada.txt
View File

@ -1,71 +0,0 @@
===============================================================================
ALE Ada Integration *ale-ada-options*
===============================================================================
cspell *ale-ada-cspell*
See |ale-cspell-options|
===============================================================================
gcc *ale-ada-gcc*
g:ale_ada_gcc_executable *g:ale_ada_gcc_executable*
*b:ale_ada_gcc_executable*
Type: |String|
Default: `'gcc'`
This variable can be changed to use a different executable for gcc.
g:ale_ada_gcc_options *g:ale_ada_gcc_options*
*b:ale_ada_gcc_options*
Type: |String|
Default: `'-gnatwa -gnatq'`
This variable can be set to pass additional options to gcc.
===============================================================================
gnatpp *ale-ada-gnatpp*
g:ale_ada_gnatpp_options *g:ale_ada_gnatpp_options*
*b:ale_ada_gnatpp_options*
Type: |String|
Default: `''`
This variable can be set to pass extra options to the gnatpp fixer.
===============================================================================
ada-language-server *ale-ada-language-server*
g:ale_ada_adals_executable *g:ale_ada_adals_executable*
*b:ale_ada_adals_executable*
Type: |String|
Default: `'ada_language_server'`
This variable can be changed to use a different executable for Ada Language
Server.
g:ale_ada_adals_project *g:ale_ada_adals_project*
*b:ale_ada_adals_project*
Type: |String|
Default: `'default.gpr'`
This variable can be changed to use a different GPR file for
Ada Language Server.
g:ale_ada_adals_encoding *g:ale_ada_adals_encoding*
*b:ale_ada_adals_encoding*
Type: |String|
Default: `'utf-8'`
This variable can be changed to use a different file encoding for
Ada Language Server.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

16
sources_non_forked/ale/doc/ale-ansible.txt
View File

@ -1,16 +0,0 @@
===============================================================================
ALE Ansible Integration *ale-ansible-options*
===============================================================================
ansible-lint *ale-ansible-ansible-lint*
g:ale_ansible_ansible_lint_executable *g:ale_ansible_ansible_lint_executable*
*b:ale_ansible_ansible_lint_executable*
Type: |String|
Default: `'ansible-lint'`
This variable can be changed to modify the executable used for ansible-lint.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

30
sources_non_forked/ale/doc/ale-apkbuild.txt
View File

@ -1,30 +0,0 @@
===============================================================================
ALE APKBUILD Integration *ale-apkbuild-options*
===============================================================================
apkbuild-lint *ale-apkbuild-apkbuild-lint*
g:ale_apkbuild_apkbuild_lint_executable
*g:ale_apkbuild_apkbuild_lint_executable*
*b:ale_apkbuild_apkbuild_lint_executable*
Type: |String|
Default: `'apkbuild-lint'`
This variable can be set to change the path to apkbuild-lint
===============================================================================
secfixes-check *ale-apkbuild-secfixes-check*
g:ale_apkbuild_secfixes_check_executable
*g:ale_apkbuild_secfixes_check_executable*
*b:ale_apkbuild_secfixes_check_executable*
Type: |String|
Default: `'secfixes-check'`
This variable can be set to change the path to secfixes-check
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

24
sources_non_forked/ale/doc/ale-asciidoc.txt
View File

@ -1,24 +0,0 @@
===============================================================================
ALE AsciiDoc Integration *ale-asciidoc-options*
===============================================================================
cspell *ale-asciidoc-cspell*
See |ale-cspell-options|
===============================================================================
write-good *ale-asciidoc-write-good*
See |ale-write-good-options|
===============================================================================
textlint *ale-asciidoc-textlint*
See |ale-text-textlint|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

25
sources_non_forked/ale/doc/ale-asm.txt
View File

@ -1,25 +0,0 @@
===============================================================================
ALE ASM Integration *ale-asm-options*
===============================================================================
gcc *ale-asm-gcc*
g:ale_asm_gcc_executable *g:ale_asm_gcc_executable*
*b:ale_asm_gcc_executable*
Type: |String|
Default: `'gcc'`
This variable can be changed to use a different executable for gcc.
g:ale_asm_gcc_options *g:ale_asm_gcc_options*
*b:ale_asm_gcc_options*
Type: |String|
Default: `'-Wall'`
This variable can be set to pass additional options to gcc.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

26
sources_non_forked/ale/doc/ale-avra.txt
View File

@ -1,26 +0,0 @@
===============================================================================
ALE AVRA Integration *ale-avra-options*
===============================================================================
avra *ale-avra-avra*
g:ale_avra_avra_executable *g:ale_avra_avra_executable*
*b:ale_avra_avra_executable*
Type: |String|
Default `'avra'`
This variable can be changed to use different executable for AVRA.
g:ale_avra_avra_options *g:ale_avra_avra_options*
*b:ale_avra_avra_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to AVRA.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

25
sources_non_forked/ale/doc/ale-awk.txt
View File

@ -1,25 +0,0 @@
===============================================================================
ALE Awk Integration *ale-awk-options*
===============================================================================
gawk *ale-awk-gawk*
g:ale_awk_gawk_executable *g:ale_awk_gawk_executable*
*b:ale_awk_gawk_executable*
Type: |String|
Default: `'gawk'`
This variable sets executable used for gawk.
g:ale_awk_gawk_options *g:ale_awk_gawk_options*
*b:ale_awk_gawk_options*
Type: |String|
Default: `''`
With this variable we are able to pass extra arguments for gawk
for invocation.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

13
sources_non_forked/ale/doc/ale-bats.txt
View File

@ -1,13 +0,0 @@
===============================================================================
ALE Bats Integration *ale-bats-options*
===============================================================================
shellcheck *ale-bats-shellcheck*
The `shellcheck` linter for Bats uses the sh options for `shellcheck`; see:
|ale-sh-shellcheck|.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

28
sources_non_forked/ale/doc/ale-bazel.txt
View File

@ -1,28 +0,0 @@
===============================================================================
ALE Bazel Integration *ale-bazel-options*
===============================================================================
buildifier *ale-bazel-buildifier*
g:ale_bazel_buildifier_executable *g:ale_bazel_buildifier_executable*
*b:ale_bazel_buildifier_executable*
Type: |String|
Default: `'buildifier'`
See |ale-integrations-local-executables|
g:ale_bazel_buildifier_options *g:ale_bazel_buildifier_options*
*b:ale_bazel_buildifier_options*
Type: |String|
Default: `''`
This variable can be set to pass extra options to buildifier.
g:ale_bazel_buildifier_use_global *g:ale_bazel_buildifier_use_global*
*b:ale_bazel_buildifier_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|

19
sources_non_forked/ale/doc/ale-bib.txt
View File

@ -1,19 +0,0 @@
===============================================================================
ALE BibTeX Integration *ale-bib-options*
===============================================================================
bibclean *ale-bib-bibclean*
g:ale_bib_bibclean_executable *g:ale_bib_bibclean_executable*
Type: |String|
Default: `'bibclean'`
g:ale_bib_bibclean_options *g:ale_bib_bibclean_options*
Type: |String|
Default: `'-align-equals'`
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

24
sources_non_forked/ale/doc/ale-bicep.txt
View File

@ -1,24 +0,0 @@
===============================================================================
ALE Bicep Integration *ale-bicep-options*
===============================================================================
bicep *ale-bicep-bicep*
g:ale_bicep_bicep_executable *g:ale_bicep_bicep_executable*
*b:ale_bicep_bicep_executable*
Type: |String|
Default: `'bicep'`
This variable can be set to change the path to bicep.
g:ale_bicep_bicep_options *g:ale_bicep_bicep_options*
*b:ale_bicep_bicep_options*
Type: |String|
Default: `'build --outfile /dev/null'`
This variable can be set to pass additional options to bicep.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

31
sources_non_forked/ale/doc/ale-bitbake.txt
View File

@ -1,31 +0,0 @@
===============================================================================
ALE BitBake Integration *ale-bitbake-options*
===============================================================================
oelint-adv *ale-bitbake-oelint_adv*
g:ale_bitbake_oelint_adv_executable *g:ale_bitbake_oelint_adv_executable*
Type: |String|
Default: `'oelint-adv'`
This variable can be changed to use a different executable for oelint-adv.
g:ale_bitbake_oelint_adv_options *g:ale_bitbake_oelint_adv_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to oelint-adv.
g:ale_bitbake_oelint_adv_config *g:ale_bitbake_oelint_adv_config*
Type: |String|
Default: `'.oelint.cfg'`
This variable can be set to use a different config file.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

451
sources_non_forked/ale/doc/ale-c.txt
View File

@ -1,451 +0,0 @@
===============================================================================
ALE C Integration *ale-c-options*
For basic checking of problems with C files, ALE offers the `cc` linter, which
runs either `clang`, or `gcc`. See |ale-c-cc|.
===============================================================================
Global Options
g:ale_c_always_make *g:ale_c_always_make*
*b:ale_c_always_make*
Type: |Number|
Default: `has('unix') && !has('macunix')`
If set to `1`, use `--always-make` for `make`, which means that output will
always be parsed from `make` dry runs with GNU make. BSD `make` does not
support this option, so you probably want to turn this option off when using
a BSD variant.
g:ale_c_build_dir_names *g:ale_c_build_dir_names*
*b:ale_c_build_dir_names*
Type: |List|
Default: `['build', 'bin']`
A list of directory names to be used when searching upwards from cpp files
to discover compilation databases with. For directory named `'foo'`, ALE
will search for `'foo/compile_commands.json'` in all directories on and
above the directory containing the cpp file to find path to compilation
database. This feature is useful for the clang tools wrapped around
LibTooling (namely here, clang-tidy)
g:ale_c_build_dir *g:ale_c_build_dir*
*b:ale_c_build_dir*
Type: |String|
Default: `''`
For programs that can read `compile_commands.json` files, this option can be
set to the directory containing the file for the project. ALE will try to
determine the location of `compile_commands.json` automatically, but if your
file exists in some other directory, you can set this option so ALE will
know where it is.
This directory will be searched instead of |g:ale_c_build_dir_names|.
g:ale_c_parse_compile_commands *g:ale_c_parse_compile_commands*
*b:ale_c_parse_compile_commands*
Type: |Number|
Default: `1`
If set to `1`, ALE will parse `compile_commands.json` files to automatically
determine flags for C or C++ compilers. ALE will first search for the
nearest `compile_commands.json` file, and then look for
`compile_commands.json` files in the directories for
|g:ale_c_build_dir_names|.
g:ale_c_parse_makefile *g:ale_c_parse_makefile*
*b:ale_c_parse_makefile*
Type: |Number|
Default: `0`
If set to `1`, ALE will run `make -n` to automatically determine flags to
set for C or C++ compilers. This can make it easier to determine the correct
build flags to use for different files.
NOTE: When using this option on BSD, you may need to set
|g:ale_c_always_make| to `0`, and `make -n` will not provide consistent
results if binaries have already been built, so use `make clean` when
editing your files.
WARNING: Running `make -n` automatically can execute arbitrary code, even
though it's supposed to be a dry run, so enable this option with care. You
might prefer to use the buffer-local version of the option instead with
|g:ale_pattern_options|, or you own code for checking which project you're
in.
You might want to disable this option if `make -n` takes too long to run for
projects you work on.
If |g:ale_c_parse_compile_commands| or |b:ale_c_parse_compile_commands| is
set to `1`, flags taken from `compile_commands.json` will be preferred over
`make -n` output.
===============================================================================
astyle *ale-c-astyle*
g:ale_c_astyle_executable *g:ale_c_astyle_executable*
*b:ale_c_astyle_executable*
Type: |String|
Default: `'astyle'`
This variable can be changed to use a different executable for astyle.
g:ale_c_astyle_project_options *g:ale_c_astyle_project_options*
*b:ale_c_astyle_project_options*
Type: |String|
Default: `''`
This variable can be changed to use an option file for project level
configurations. Provide only the filename of the option file that should be
present at the project's root directory.
For example, if .astylrc is specified, the file is searched in the parent
directories of the source file's directory.
===============================================================================
cc *ale-c-cc*
*ale-c-gcc*
*ale-c-clang*
g:ale_c_cc_executable *g:ale_c_cc_executable*
*b:ale_c_cc_executable*
Type: |String|
Default: `'<auto>'`
This variable can be changed to use a different executable for a C compiler.
ALE will try to use `clang` if Clang is available, otherwise ALE will
default to checking C code with `gcc`.
g:ale_c_cc_options *g:ale_c_cc_options*
*b:ale_c_cc_options*
Type: |String|
Default: `'-std=c11 -Wall'`
This variable can be changed to modify flags given to the C compiler.
g:ale_c_cc_use_header_lang_flag *g:ale_c_cc_use_header_lang_flag*
*b:ale_c_cc_use_header_lang_flag*
Type: |Number|
Default: `-1`
By default, ALE will use `'-x c-header'` instead of `'-x c'` for header files
when using Clang.
This variable can be changed to manually activate or deactivate this flag
for header files.
- When set to `-1`, the default beviour is used, `'-x c-header'` is used with
Clang and `'-x c'` is used with other compilers.
- When set to `0`, the flag is deactivated, `'-x c'` is always used
independently of the compiler.
- When set to `1`, the flag is activated, `'-x c-header'` is always used
independently of the compiler.
Gcc does not support `'-x c-header'` when using `'-'` as input filename,
which is what ALE does. This why, by default, ALE only uses `'-x c-header'`
with Clang.
g:ale_c_cc_header_exts *g:ale_c_cc_header_exts*
*b:ale_c_cc_header_exts*
Type: |List|
Default: `['h']`
This variable can be changed to modify the list of extensions of the files
considered as header files.
This variable is only used when `'-x c-header'` is used instead of `'-x c'`,
see |ale_c_cc_use_header_lang_flag|.
===============================================================================
ccls *ale-c-ccls*
g:ale_c_ccls_executable *g:ale_c_ccls_executable*
*b:ale_c_ccls_executable*
Type: |String|
Default: `'ccls'`
This variable can be changed to use a different executable for ccls.
g:ale_c_ccls_init_options *g:ale_c_ccls_init_options*
*b:ale_c_ccls_init_options*
Type: |Dictionary|
Default: `{}`
This variable can be changed to customize ccls initialization options.
Example: >
{
\ 'cacheDirectory': '/tmp/ccls',
\ 'cacheFormat': 'binary',
\ 'diagnostics': {
\ 'onOpen': 0,
\ 'opChange': 1000,
\ },
\ }
<
Visit https://github.com/MaskRay/ccls/wiki/Initialization-options for all
available options and explanations.
===============================================================================
clangd *ale-c-clangd*
g:ale_c_clangd_executable *g:ale_c_clangd_executable*
*b:ale_c_clangd_executable*
Type: |String|
Default: `'clangd'`
This variable can be changed to use a different executable for clangd.
g:ale_c_clangd_options *g:ale_c_clangd_options*
*b:ale_c_clangd_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to clangd.
===============================================================================
clang-format *ale-c-clangformat*
g:ale_c_clangformat_executable *g:ale_c_clangformat_executable*
*b:ale_c_clangformat_executable*
Type: |String|
Default: `'clang-format'`
This variable can be changed to use a different executable for clang-format.
g:ale_c_clangformat_options *g:ale_c_clangformat_options*
*b:ale_c_clangformat_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to clang-format.
g:ale_c_clangformat_style_option *g:ale_c_clangformat_style_option*
*b:ale_c_clangformat_style_option*
Type: |String|
Default: `''`
This variable can be changed to modify only the style flag given to
clang-format. The contents of the variable are passed directly to the -style
flag of clang-format.
Example: >
{
\ BasedOnStyle: Microsoft,
\ ColumnLimit: 80,
\ AllowShortBlocksOnASingleLine: Always,
\ AllowShortFunctionsOnASingleLine: Inline,
\ }
<
If you set this variable, ensure you don't modify -style in
|g:ale_c_clangformat_options|, as this will cause clang-format to error.
g:ale_c_clangformat_use_local_file *g:ale_c_clangformat_use_local_file*
*b:ale_c_clangformat_use_local_file*
Type: |Number|
Default: `0`
This variable can be changed to modify whether to use a local .clang-format
file. If the file is found, the flag '-style=file' is passed to clang-format
and any options configured via |g:ale_c_clangformat_style_option| are not
passed.
If this option is enabled but no .clang-format file is found, default back to
|g:ale_c_clangformat_style_option|, if it set.
If you set this variable, ensure you don't modify -style in
|g:ale_c_clangformat_options|, as this will cause clang-format to error.
===============================================================================
clangtidy *ale-c-clangtidy*
`clang-tidy` will be run only when files are saved to disk, so that
`compile_commands.json` files can be used. It is recommended to use this
linter in combination with `compile_commands.json` files.
Therefore, `clang-tidy` linter reads the options |g:ale_c_build_dir| and
|g:ale_c_build_dir_names|. Also, setting |g:ale_c_build_dir| actually
overrides |g:ale_c_build_dir_names|.
g:ale_c_clangtidy_checks *g:ale_c_clangtidy_checks*
*b:ale_c_clangtidy_checks*
Type: |List|
Default: `[]`
The checks to enable for clang-tidy with the `-checks` argument.
All options will be joined with commas, and escaped appropriately for
the shell. The `-checks` flag can be removed entirely by setting this
option to an empty List.
Not all of clangtidy checks are applicable for C. You should consult the
clang documentation for an up-to-date list of compatible checks:
http://clang.llvm.org/extra/clang-tidy/checks/list.html
g:ale_c_clangtidy_executable *g:ale_c_clangtidy_executable*
*b:ale_c_clangtidy_executable*
Type: |String|
Default: `'clang-tidy'`
This variable can be changed to use a different executable for clangtidy.
g:ale_c_clangtidy_options *g:ale_c_clangtidy_options*
*b:ale_c_clangtidy_options*
Type: |String|
Default: `''`
This variable can be changed to modify compiler flags given to clang-tidy.
- Setting this variable to a non-empty string,
- and working in a buffer where no compilation database is found using
|g:ale_c_build_dir_names| or |g:ale_c_build_dir|,
will cause the `--` argument to be passed to `clang-tidy`, which will mean
that detection of `compile_commands.json` files for compile command
databases will be disabled.
Only set this option if you want to control compiler flags
entirely manually, and no `compile_commands.json` file is in one
of the |g:ale_c_build_dir_names| directories of the project tree.
g:ale_c_clangtidy_extra_options *g:ale_c_clangtidy_extra_options*
*b:ale_c_clangtidy_extra_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to clang-tidy.
g:ale_c_clangtidy_fix_errors *g:ale_c_clangtidy_fix_errors*
*b:ale_c_clangtidy_fix_errors*
Type: |Number|
Default: `1`
This variable can be changed to disable the `-fix-errors` option for the
|clangtidy| fixer.
===============================================================================
cppcheck *ale-c-cppcheck*
g:ale_c_cppcheck_executable *g:ale_c_cppcheck_executable*
*b:ale_c_cppcheck_executable*
Type: |String|
Default: `'cppcheck'`
This variable can be changed to use a different executable for cppcheck.
g:ale_c_cppcheck_options *g:ale_c_cppcheck_options*
*b:ale_c_cppcheck_options*
Type: |String|
Default: `'--enable=style'`
This variable can be changed to modify flags given to cppcheck.
===============================================================================
cquery *ale-c-cquery*
g:ale_c_cquery_executable *g:ale_c_cquery_executable*
*b:ale_c_cquery_executable*
Type: |String|
Default: `'cquery'`
This variable can be changed to use a different executable for cquery.
g:ale_cpp_cquery_cache_directory *g:ale_c_cquery_cache_directory*
*b:ale_c_cquery_cache_directory*
Type: |String|
Default: `'~/.cache/cquery'`
This variable can be changed to decide which directory cquery uses for its
cache.
===============================================================================
cspell *ale-c-cspell*
See |ale-cspell-options|
===============================================================================
flawfinder *ale-c-flawfinder*
g:ale_c_flawfinder_executable *g:ale_c_flawfinder_executable*
*b:ale_c_flawfinder_executable*
Type: |String|
Default: `'flawfinder'`
This variable can be changed to use a different executable for flawfinder.
g:ale_c_flawfinder_minlevel *g:ale_c_flawfinder_minlevel*
*b:ale_c_flawfinder_minlevel*
Type: |Number|
Default: `1`
This variable can be changed to ignore risks under the given risk threshold.
g:ale_c_flawfinder_options *g:ale-c-flawfinder*
*b:ale-c-flawfinder*
Type: |String|
Default: `''`
This variable can be used to pass extra options into the flawfinder command.
g:ale_c_flawfinder_error_severity *g:ale_c_flawfinder_error_severity*
*b:ale_c_flawfinder_error_severity*
Type: |Number|
Default: `6`
This variable can be changed to set the minimum severity to be treated as an
error. This setting also applies to flawfinder for c++.
===============================================================================
uncrustify *ale-c-uncrustify*
g:ale_c_uncrustify_executable *g:ale_c_uncrustify_executable*
*b:ale_c_uncrustify_executable*
Type: |String|
Default: `'uncrustify'`
This variable can be changed to use a different executable for uncrustify.
g:ale_c_uncrustify_options *g:ale_c_uncrustify_options*
*b:ale_c_uncrustify_options*
Type: |String|
Default: `''`
This variable can be change to modify flags given to uncrustify.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

15
sources_non_forked/ale/doc/ale-cairo.txt
View File

@ -1,15 +0,0 @@
===============================================================================
ALE Cairo Integration *ale-cairo-options*
===============================================================================
starknet *ale-cairo-starknet*
g:ale_cairo_starknet_executable *g:ale_cairo_starknet_executable*
*b:ale_cairo_starknet_executable*
Default: `'starknet-compile'`
Overrides the starknet-compile binary after installing the cairo-language.
For more information read 'https://starknet.io/docs/quickstart.html'

46
sources_non_forked/ale/doc/ale-chef.txt
View File

@ -1,46 +0,0 @@
===============================================================================
ALE Chef Integration *ale-chef-options*
===============================================================================
cookstyle *ale-chef-cookstyle*
g:ale_chef_cookstyle_options *g:ale_chef_cookstyle_options*
*b:ale_chef_cookstyle_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to cookstyle.
g:ale_chef_cookstyle_executable *g:ale_chef_cookstyle_executable*
*b:ale_chef_cookstyle_executable*
Type: |String|
Default: `'cookstyle'`
This variable can be changed to point to the cookstyle binary in case it's
not on the $PATH or a specific version/path must be used.
===============================================================================
foodcritic *ale-chef-foodcritic*
g:ale_chef_foodcritic_options *g:ale_chef_foodcritic_options*
*b:ale_chef_foodcritic_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to foodcritic.
g:ale_chef_foodcritic_executable *g:ale_chef_foodcritic_executable*
*b:ale_chef_foodcritic_executable*
Type: |String|
Default: `'foodcritic'`
This variable can be changed to point to the foodcritic binary in case it's
not on the $PATH or a specific version/path must be used.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

36
sources_non_forked/ale/doc/ale-clojure.txt
View File

@ -1,36 +0,0 @@
===============================================================================
ALE Clojure Integration *ale-clojure-options*
===============================================================================
clj-kondo *ale-clojure-clj-kondo*
A minimal and opinionated linter for code that sparks joy.
https://github.com/borkdude/clj-kondo
g:ale_clojure_clj_kondo_options *g:ale_clojure_clj_kondo_options*
*b:ale_clojure_clj_kondo_options*
Type: |String|
Default: `'--cache'`
This variable can be changed to modify options passed to clj-kondo.
===============================================================================
joker *ale-clojure-joker*
Joker is a small Clojure interpreter and linter written in Go.
https://github.com/candid82/joker
Linting options are not configurable by ale, but instead are controlled by a
`.joker` file in same directory as the file (or current working directory if
linting stdin), a parent directory relative to the file, or the users home
directory.
see https://github.com/candid82/joker#linter-mode for more information.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

46
sources_non_forked/ale/doc/ale-cloudformation.txt
View File

@ -1,46 +0,0 @@
===============================================================================
ALE CloudFormation Integration *ale-cloudformation-options*
===============================================================================
cfn-python-lint *ale-cloudformation-cfn-python-lint*
cfn-python-lint is a linter for AWS CloudFormation template file.
Website: https://github.com/awslabs/cfn-python-lint
Installation
-------------------------------------------------------------------------------
Install cfn-python-lint using either pip or brew: >
`pip install cfn-lint`. If pip is not available, run
`python setup.py clean --all` then `python setup.py install`.
Homebrew (macOS):
`brew install cfn-lint`
<
Configuration
-------------------------------------------------------------------------------
To get cloudformation linter to work on only CloudFormation files we must set
the buffer |filetype| to yaml.cloudformation.
This causes ALE to lint the file with linters configured for cloudformation and
yaml files.
Just put:
>
au BufRead,BufNewFile *.template.yaml set filetype=yaml.cloudformation
<
on `ftdetect/cloudformation.vim`
This will get both cloudformation and yaml linters to work on any file with `.template.yaml` ext.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

62
sources_non_forked/ale/doc/ale-cmake.txt
View File

@ -1,62 +0,0 @@
===============================================================================
ALE CMake Integration *ale-cmake-options*
===============================================================================
cmakelint *ale-cmake-cmakelint*
g:ale_cmake_cmakelint_executable *g:ale_cmake_cmakelint_executable*
*b:ale_cmake_cmakelint_executable*
Type: |String|
Default: `'cmakelint'`
This variable can be set to change the path the cmakelint.
g:ale_cmake_cmakelint_options *g:ale_cmake_cmakelint_options*
*b:ale_cmake_cmakelint_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to cmakelint.
===============================================================================
cmake-lint *ale-cmake-cmake-lint*
g:ale_cmake_cmake_lint_executable *g:ale_cmake_cmake_lint_executable*
*b:ale_cmake_cmake_lint_executable*
Type: |String|
Default: `'cmake-lint'`
This variable can be set to change the path the cmake-lint.
g:ale_cmake_cmake_lint_options *g:ale_cmake_cmake_lint_options*
*b:ale_cmake_cmake_lint_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to cmake-lint.
===============================================================================
cmake-format *ale-cmake-cmakeformat*
g:ale_cmake_cmakeformat_executable *g:ale_cmake_cmakeformat_executable*
*b:ale_cmake_cmakeformat_executable*
Type: |String|
Default: `'cmakeformat'`
This variable can be set to change the path the cmake-format.
g:ale_cmake_cmakeformat_options *g:ale_cmake_cmakeformat_options*
*b:ale_cmake_cmakeformat_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to cmake-format.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

401
sources_non_forked/ale/doc/ale-cpp.txt
View File

@ -1,401 +0,0 @@
===============================================================================
ALE C++ Integration *ale-cpp-options*
For basic checking of problems with C++ files, ALE offers the `cc` linter,
which runs either `clang++`, or `gcc`. See |ale-cpp-cc|.
===============================================================================
Global Options
The following C options also apply to some C++ linters too.
* |g:ale_c_always_make|
* |g:ale_c_build_dir_names|
* |g:ale_c_build_dir|
* |g:ale_c_parse_makefile|
* |g:ale_c_parse_compile_commands|
===============================================================================
astyle *ale-cpp-astyle*
g:ale_cpp_astyle_executable *g:ale_cpp_astyle_executable*
*b:ale_cpp_astyle_executable*
Type: |String|
Default: `'astyle'`
This variable can be changed to use a different executable for astyle.
g:ale_cpp_astyle_project_options *g:ale_cpp_astyle_project_options*
*b:ale_cpp_astyle_project_options*
Type: |String|
Default: `''`
This variable can be changed to use an option file for project level
configurations. Provide only the filename of the option file that should be
present at the project's root directory.
For example, if .astylrc is specified, the file is searched in the parent
directories of the source file's directory.
===============================================================================
cc *ale-cpp-cc*
*ale-cpp-gcc*
*ale-cpp-clang*
g:ale_cpp_cc_executable *g:ale_cpp_cc_executable*
*b:ale_cpp_cc_executable*
Type: |String|
Default: `'<auto>'`
This variable can be changed to use a different executable for a C++ compiler.
ALE will try to use `clang++` if Clang is available, otherwise ALE will
default to checking C++ code with `gcc`.
g:ale_cpp_cc_options *g:ale_cpp_cc_options*
*b:ale_cpp_cc_options*
Type: |String|
Default: `'-std=c++14 -Wall'`
This variable can be changed to modify flags given to the C++ compiler.
g:ale_cpp_cc_use_header_lang_flag *g:ale_cpp_cc_use_header_lang_flag*
*b:ale_cpp_cc_use_header_lang_flag*
Type: |Number|
Default: `-1`
By default, ALE will use `'-x c++-header'` instead of `'-x c++'` for header
files when using Clang.
This variable can be changed to manually activate or deactivate this flag
for header files.
- When set to `-1`, the default beviour is used, `'-x c++-header'` is used with
Clang and `'-x c++'` is used with other compilers.
- When set to `0`, the flag is deactivated, `'-x c++'` is always used
independently of the compiler.
- When set to `1`, the flag is activated, `'-x c++-header'` is always used
independently of the compiler.
Gcc does not support `'-x c++-header'` when using `'-'` as input filename,
which is what ALE does. This why, by default, ALE only uses `'-x c++-header'`
with Clang.
g:ale_cpp_cc_header_exts *g:ale_cpp_cc_header_exts*
*b:ale_cpp_cc_header_exts*
Type: |List|
Default: `['h', 'hpp']`
This variable can be changed to modify the list of extensions of the files
considered as header files.
This variable is only used when `'-x c++-header'` is used instead of `'-x c++'`,
see |ale_cpp_cc_use_header_lang_flag|.
===============================================================================
ccls *ale-cpp-ccls*
g:ale_cpp_ccls_executable *g:ale_cpp_ccls_executable*
*b:ale_cpp_ccls_executable*
Type: |String|
Default: `'ccls'`
This variable can be changed to use a different executable for ccls.
g:ale_cpp_ccls_init_options *g:ale_cpp_ccls_init_options*
*b:ale_cpp_ccls_init_options*
Type: |Dictionary|
Default: `{}`
This variable can be changed to customize ccls initialization options.
Example: >
{
\ 'cacheDirectory': '/tmp/ccls',
\ 'cacheFormat': 'binary',
\ 'diagnostics': {
\ 'onOpen': 0,
\ 'opChange': 1000,
\ },
\ }
<
Visit https://github.com/MaskRay/ccls/wiki/Initialization-options for all
available options and explanations.
===============================================================================
clangcheck *ale-cpp-clangcheck*
`clang-check` will be run only when files are saved to disk, so that
`compile_commands.json` files can be used. It is recommended to use this
linter in combination with `compile_commands.json` files.
Therefore, `clang-check` linter reads the options |g:ale_c_build_dir| and
|g:ale_c_build_dir_names|. Also, setting |g:ale_c_build_dir| actually
overrides |g:ale_c_build_dir_names|.
g:ale_cpp_clangcheck_executable *g:ale_cpp_clangcheck_executable*
*b:ale_cpp_clangcheck_executable*
Type: |String|
Default: `'clang-check'`
This variable can be changed to use a different executable for clangcheck.
g:ale_cpp_clangcheck_options *g:ale_cpp_clangcheck_options*
*b:ale_cpp_clangcheck_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to clang-check.
This variable should not be set to point to build subdirectory with
`-p path/to/build` option, as it is handled by the |g:ale_c_build_dir|
option.
===============================================================================
clangd *ale-cpp-clangd*
g:ale_cpp_clangd_executable *g:ale_cpp_clangd_executable*
*b:ale_cpp_clangd_executable*
Type: |String|
Default: `'clangd'`
This variable can be changed to use a different executable for clangd.
g:ale_cpp_clangd_options *g:ale_cpp_clangd_options*
*b:ale_cpp_clangd_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to clangd.
===============================================================================
clang-format *ale-cpp-clangformat*
See |ale-c-clangformat| for information about the available options.
Note that the C options are also used for C++.
===============================================================================
clangtidy *ale-cpp-clangtidy*
`clang-tidy` will be run only when files are saved to disk, so that
`compile_commands.json` files can be used. It is recommended to use this
linter in combination with `compile_commands.json` files.
Therefore, `clang-tidy` linter reads the options |g:ale_c_build_dir| and
|g:ale_c_build_dir_names|. Also, setting |g:ale_c_build_dir| actually
overrides |g:ale_c_build_dir_names|.
g:ale_cpp_clangtidy_checks *g:ale_cpp_clangtidy_checks*
*b:ale_cpp_clangtidy_checks*
Type: |List|
Default: `[]`
The checks to enable for clang-tidy with the `-checks` argument.
All options will be joined with commas, and escaped appropriately for
the shell. The `-checks` flag can be removed entirely by setting this
option to an empty List.
g:ale_cpp_clangtidy_executable *g:ale_cpp_clangtidy_executable*
*b:ale_cpp_clangtidy_executable*
Type: |String|
Default: `'clang-tidy'`
This variable can be changed to use a different executable for clangtidy.
g:ale_cpp_clangtidy_options *g:ale_cpp_clangtidy_options*
*b:ale_cpp_clangtidy_options*
Type: |String|
Default: `''`
This variable can be changed to modify compiler flags given to clang-tidy.
- Setting this variable to a non-empty string,
- and working in a buffer where no compilation database is found using
|g:ale_c_build_dir_names| or |g:ale_c_build_dir|,
will cause the `--` argument to be passed to `clang-tidy`, which will mean
that detection of `compile_commands.json` files for compile command
databases will be disabled.
Only set this option if you want to control compiler flags
entirely manually, and no `compile_commands.json` file is in one
of the |g:ale_c_build_dir_names| directories of the project tree.
g:ale_cpp_clangtidy_extra_options *g:ale_cpp_clangtidy_extra_options*
*b:ale_cpp_clangtidy_extra_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to clang-tidy.
g:ale_cpp_clangtidy_fix_errors *g:ale_cpp_clangtidy_fix_errors*
*b:ale_cpp_clangtidy_fix_errors*
Type: |Number|
Default: `1`
This variable can be changed to disable the `-fix-errors` option for the
|clangtidy| fixer.
===============================================================================
clazy *ale-cpp-clazy*
g:ale_cpp_clazy_executable *g:ale_cpp_clazy_executable*
*b:ale_cpp_clazy_executable*
Type: |String|
Default: `'clazy-standalone'`
This variable can be changed to use a different executable for clazy.
g:ale_cpp_clazy_checks *g:ale_cpp_clazy_checks*
*b:ale_cpp_clazy_checks*
Type: |List|
Default: `['level1']`
The checks to enable for clazy with the `-checks` argument.
All options will be joined with commas, and escaped appropriately for
the shell. The `-checks` flag can be removed entirely by setting this
option to an empty List.
g:ale_cpp_clazy_options *g:ale_cpp_clazy_options*
*b:ale_cpp_clazy_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to clazy.
===============================================================================
cppcheck *ale-cpp-cppcheck*
g:ale_cpp_cppcheck_executable *g:ale_cpp_cppcheck_executable*
*b:ale_cpp_cppcheck_executable*
Type: |String|
Default: `'cppcheck'`
This variable can be changed to use a different executable for cppcheck.
g:ale_cpp_cppcheck_options *g:ale_cpp_cppcheck_options*
*b:ale_cpp_cppcheck_options*
Type: |String|
Default: `'--enable=style'`
This variable can be changed to modify flags given to cppcheck.
===============================================================================
cpplint *ale-cpp-cpplint*
g:ale_cpp_cpplint_executable *g:ale_cpp_cpplint_executable*
*b:ale_cpp_cpplint_executable*
Type: |String|
Default: `'cpplint'`
This variable can be changed to use a different executable for cpplint.
g:ale_cpp_cpplint_options *g:ale_cpp_cpplint_options*
*b:ale_cpp_cpplint_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to cpplint.
g:ale_c_cpplint_executable *g:ale_c_cpplint_executable*
*b:ale_c_cpplint_executable*
Type: |String|
Default: `'cpplint'`
This variable can be changed to use a different executable for cpplint.
g:ale_c_cpplint_options *g:ale_c_cpplint_options*
*b:ale_c_cpplint_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to cpplint.
===============================================================================
cquery *ale-cpp-cquery*
g:ale_cpp_cquery_executable *g:ale_cpp_cquery_executable*
*b:ale_cpp_cquery_executable*
Type: |String|
Default: `'cquery'`
This variable can be changed to use a different executable for cquery.
g:ale_cpp_cquery_cache_directory *g:ale_cpp_cquery_cache_directory*
*b:ale_cpp_cquery_cache_directory*
Type: |String|
Default: `'~/.cache/cquery'`
This variable can be changed to decide which directory cquery uses for its
cache.
===============================================================================
cspell *ale-cpp-cspell*
See |ale-cspell-options|
===============================================================================
flawfinder *ale-cpp-flawfinder*
g:ale_cpp_flawfinder_executable *g:ale_cpp_flawfinder_executable*
*b:ale_cpp_flawfinder_executable*
Type: |String|
Default: `'flawfinder'`
This variable can be changed to use a different executable for flawfinder.
g:ale_cpp_flawfinder_minlevel *g:ale_cpp_flawfinder_minlevel*
*b:ale_cpp_flawfinder_minlevel*
Type: |Number|
Default: `1`
This variable can be changed to ignore risks under the given risk threshold.
g:ale_cpp_flawfinder_options *g:ale-cpp-flawfinder*
*b:ale-cpp-flawfinder*
Type: |String|
Default: `''`
This variable can be used to pass extra options into the flawfinder command.
===============================================================================
uncrustify *ale-cpp-uncrustify*
See |ale-c-uncrustify| for information about the available options.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

236
sources_non_forked/ale/doc/ale-cs.txt
View File

@ -1,236 +0,0 @@
===============================================================================
ALE C# Integration *ale-cs-options*
In addition to the linters that are provided with ALE, C# code can be checked
with the OmniSharp plugin. See here: https://github.com/OmniSharp/omnisharp-vim
===============================================================================
csc *ale-cs-csc*
The |ale-cs-csc| linter checks for semantic errors when files are opened or
saved.
See |ale-lint-file-linters| for more information on linters which do not
check for problems while you type.
The csc linter uses the mono csc compiler, providing full C# 7 and newer
support, to generate a temporary module target file (/t:module). The module
includes all '*.cs' files contained in the directory tree rooted at the path
defined by the |g:ale_cs_csc_source| or |b:ale_cs_csc_source| variable and
all sub directories.
It will in future replace the |ale-cs-mcs| and |ale-cs-mcsc| linters as both
utilize the mcsc compiler which, according to the mono project, is no longer
actively developed, and only receives maintenance updates. However, because
the csc compiler does not support the -syntax option, this linter does not
offer any as-you-type syntax checking, similar to the |ale-cs-mcsc| linter.
The paths to search for additional assembly files can be specified using the
|g:ale_cs_csc_assembly_path| or |b:ale_cs_csc_assembly_path| variables.
NOTE: ALE will not find any errors in files apart from syntax errors if any
one of the source files contains a syntax error. Syntax errors must be fixed
first before other errors will be shown.
g:ale_cs_csc_options *g:ale_cs_csc_options*
*b:ale_cs_csc_options*
Type: |String|
Default: `''`
This option can be set to pass additional arguments to the `csc` compiler.
For example, to add the dotnet package which is not added per default: >
let g:ale_cs_mcs_options = ' /warn:4 /langversion:7.2'
<
NOTE: the `/unsafe` option is always passed to `csc`.
g:ale_cs_csc_source *g:ale_cs_csc_source*
*b:ale_cs_csc_source*
Type: |String|
Default: `''`
This variable defines the root path of the directory tree searched for the
'*.cs' files to be linted. If this option is empty, the source file's
directory will be used.
NOTE: Currently it is not possible to specify sub directories and
directory sub trees which shall not be searched for *.cs files.
g:ale_cs_csc_assembly_path *g:ale_cs_csc_assembly_path*
*b:ale_cs_csc_assembly_path*
Type: |List|
Default: `[]`
This variable defines a list of path strings to be searched for external
assembly files. The list is passed to the csc compiler using the `/lib:`
flag.
g:ale_cs_csc_assemblies *g:ale_cs_csc_assemblies*
*b:ale_cs_csc_assemblies*
Type: |List|
Default: `[]`
This variable defines a list of external assembly (*.dll) files required
by the mono mcs compiler to generate a valid module target. The list is
passed the csc compiler using the `/r:` flag.
For example: >
" Compile C# programs with the Unity engine DLL file on Mac.
let g:ale_cs_mcsc_assemblies = [
\ '/Applications/Unity/Unity.app/Contents/Frameworks/Managed/UnityEngine.dll',
\ 'path-to-unityproject/obj/Debug',
\]
<
===============================================================================
cspell *ale-cs-cspell*
See |ale-cspell-options|
===============================================================================
dotnet-format *ale-cs-dotnet-format*
Installation
-------------------------------------------------------------------------------
Installing .NET SDK should probably ensure that `dotnet` is in your `$PATH`.
For .NET 6 the `dotnet format` tool is already included in the .NET SDK. For
.NET 5 or below you will have to manually install it using the instructions
from listed in this repository: https://github.com/dotnet/format
Options
-------------------------------------------------------------------------------
g:ale_cs_dotnet_format_executable *g:ale_cs_dotnet_format_executable*
*b:ale_cs_dotnet_format_executable*
Type: |String|
Default: `'dotnet'`
This variable can be set to specify an absolute path to the
`dotnet` executable (or to specify an alternate executable).
g:ale_cs_dotnet_format_options *g:ale_cs_dotnet_format_options*
*b:ale_cs_dotnet_format_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the `dotnet format`
fixer.
===============================================================================
mcs *ale-cs-mcs*
The `mcs` linter looks only for syntax errors while you type. See
|ale-cs-mcsc| for the separately configured linter for checking for semantic
errors.
g:ale_cs_mcs_options *g:ale_cs_mcs_options*
*b:ale_cs_mcs_options*
Type: String
Default: `''`
This variable can be changed to pass additional flags given to mcs.
NOTE: The -unsafe flag is selected implicitly and thus does not need to be
explicitly included in the |g:ale_cs_mcs_options| or |b:ale_cs_mcs_options|
parameter.
===============================================================================
mcsc *ale-cs-mcsc*
The mcsc linter checks for semantic errors when files are opened or saved
See |ale-lint-file-linters| for more information on linters which do not
check for problems while you type.
The mcsc linter uses the mono mcs compiler to generate a temporary module
target file (-t:module). The module includes including all '*.cs' files
contained in the directory tree rooted at the path defined by the
|g:ale_cs_mcsc_source| or |b:ale_cs_mcsc_source| variable.
variable and all sub directories.
The paths to search for additional assembly files can be specified using the
|g:ale_cs_mcsc_assembly_path| or |b:ale_cs_mcsc_assembly_path| variables.
NOTE: ALE will not find any errors in files apart from syntax errors if any
one of the source files contains a syntax error. Syntax errors must be fixed
first before other errors will be shown.
g:ale_cs_mcsc_options *g:ale_cs_mcsc_options*
*b:ale_cs_mcsc_options*
Type: |String|
Default: `''`
This option can be set to pass additional arguments to the `mcs` compiler.
For example, to add the dotnet package which is not added per default: >
let g:ale_cs_mcs_options = '-pkg:dotnet'
<
NOTE: the `-unsafe` option is always passed to `mcs`.
g:ale_cs_mcsc_source *g:ale_cs_mcsc_source*
*b:ale_cs_mcsc_source*
Type: |String|
Default: `''`
This variable defines the root path of the directory tree searched for the
'*.cs' files to be linted. If this option is empty, the source file's
directory will be used.
NOTE: Currently it is not possible to specify sub directories and
directory sub trees which shall not be searched for *.cs files.
g:ale_cs_mcsc_assembly_path *g:ale_cs_mcsc_assembly_path*
*b:ale_cs_mcsc_assembly_path*
Type: |List|
Default: `[]`
This variable defines a list of path strings to be searched for external
assembly files. The list is passed to the mcs compiler using the `-lib:`
flag.
g:ale_cs_mcsc_assemblies *g:ale_cs_mcsc_assemblies*
*b:ale_cs_mcsc_assemblies*
Type: |List|
Default: `[]`
This variable defines a list of external assembly (*.dll) files required
by the mono mcs compiler to generate a valid module target. The list is
passed the mcs compiler using the `-r:` flag.
For example: >
" Compile C# programs with the Unity engine DLL file on Mac.
let g:ale_cs_mcsc_assemblies = [
\ '/Applications/Unity/Unity.app/Contents/Frameworks/Managed/UnityEngine.dll',
\ 'path-to-unityproject/obj/Debug',
\]
<
===============================================================================
uncrustify *ale-cs-uncrustify*
See |ale-c-uncrustify| for information about the available options.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

93
sources_non_forked/ale/doc/ale-css.txt
View File

@ -1,93 +0,0 @@
===============================================================================
ALE CSS Integration *ale-css-options*
===============================================================================
cspell *ale-css-cspell*
See |ale-cspell-options|
===============================================================================
css-beautify *ale-css-css-beautify*
g:ale_css_css_beautify_executable *g:ale_css_css_beautify_executable*
*b:ale_css_css_beautify_executable*
Type: |String|
Default: `'css-beautify'`
See |ale-integrations-local-executables|
g:ale_css_css_beautify_options *g:ale_css_css_beautify_options*
*b:ale_css_css_beautify_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to css-beautify.
g:ale_css_css_beautify_use_global *g:ale_css_css_beautify_use_global*
*b:ale_css_css_beautify_use_global*
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
fecs *ale-css-fecs*
`fecs` options for CSS is the same as the options for JavaScript, and both of
them reads `./.fecsrc` as the default configuration file. See:
|ale-javascript-fecs|.
===============================================================================
prettier *ale-css-prettier*
See |ale-javascript-prettier| for information about the available options.
===============================================================================
stylelint *ale-css-stylelint*
g:ale_css_stylelint_executable *g:ale_css_stylelint_executable*
*b:ale_css_stylelint_executable*
Type: |String|
Default: `'stylelint'`
See |ale-integrations-local-executables|
g:ale_css_stylelint_options *g:ale_css_stylelint_options*
*b:ale_css_stylelint_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to stylelint.
g:ale_css_stylelint_use_global *g:ale_css_stylelint_use_global*
*b:ale_css_stylelint_use_global*
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
vscodecss *ale-css-vscode*
Website: https://github.com/hrsh7th/vscode-langservers-extracted
Installation
-------------------------------------------------------------------------------
Install VSCode css language server either globally or locally: >
npm install -g vscode-langservers-extracted
<
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

50
sources_non_forked/ale/doc/ale-cuda.txt
View File

@ -1,50 +0,0 @@
===============================================================================
ALE CUDA Integration *ale-cuda-options*
===============================================================================
nvcc *ale-cuda-nvcc*
g:ale_cuda_nvcc_executable *g:ale_cuda_nvcc_executable*
*b:ale_cuda_nvcc_executable*
Type: |String|
Default: `'nvcc'`
This variable can be changed to use a different executable for nvcc.
Currently only nvcc 8.0 is supported.
g:ale_cuda_nvcc_options *g:ale_cuda_nvcc_options*
*b:ale_cuda_nvcc_options*
Type: |String|
Default: `'-std=c++11'`
This variable can be changed to modify flags given to nvcc.
===============================================================================
clangd *ale-cuda-clangd*
g:ale_cuda_clangd_executable *g:ale_cuda_clangd_executable*
*b:ale_cuda_clangd_executable*
Type: |String|
Default: `'clangd'`
This variable can be changed to use a different executable for clangd.
g:ale_cuda_clangd_options *g:ale_cuda_clangd_options*
*b:ale_cuda_clangd_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to clangd.
===============================================================================
clang-format *ale-cuda-clangformat*
See |ale-c-clangformat| for information about the available options.
Note that the C options are also used for cuda.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

32
sources_non_forked/ale/doc/ale-d.txt
View File

@ -1,32 +0,0 @@
===============================================================================
ALE D Integration *ale-d-options*
===============================================================================
dfmt *ale-d-dfmt*
g:ale_d_dfmt_options *g:ale_d_dfmt_options*
*b:ale_d_dfmt_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the dfmt fixer.
===============================================================================
dls *ale-d-dls*
g:ale_d_dls_executable *g:ale_d_dls_executable*
*b:ale_d_dls_executable*
Type: |String|
Default: `dls`
See |ale-integrations-local-executables|
===============================================================================
uncrustify *ale-d-uncrustify*
See |ale-c-uncrustify| for information about the available options.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

16
sources_non_forked/ale/doc/ale-dafny.txt
View File

@ -1,16 +0,0 @@
===============================================================================
ALE Dafny Integration *ale-dafny-options*
===============================================================================
dafny *ale-dafny-dafny*
g:ale_dafny_dafny_timelimit *g:ale_dafny_dafny_timelimit*
*b:ale_dafny_dafny_timelimit*
Type: |Number|
Default: `10`
This variable sets the `/timeLimit` used for dafny.
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

124
sources_non_forked/ale/doc/ale-dart.txt
View File

@ -1,124 +0,0 @@
===============================================================================
ALE Dart Integration *ale-dart-options*
===============================================================================
analysis_server *ale-dart-analysis_server*
Installation
-------------------------------------------------------------------------------
Install Dart via whatever means. `analysis_server` will be included in the SDK.
In case that `dart` is not in your path, try to set the executable option to
its absolute path. : >
" Set the executable path for dart to the absolute path to it.
let g:ale_dart_analysis_server_executable = '/usr/local/bin/dart'
<
Options
-------------------------------------------------------------------------------
g:ale_dart_analysis_server_executable *g:ale_dart_analysis_server_executable*
*b:ale_dart_analysis_server_executable*
Type: |String|
Default: `'dart'`
This variable can be set to change the path of dart.
===============================================================================
dart-analyze *ale-dart-analyze*
Installation
-------------------------------------------------------------------------------
Installing Dart should probably ensure that `dart` is in your `$PATH`.
In case it is not, try to set the executable option to its absolute path. : >
" Set the executable path for dart to the absolute path to it.
let g:ale_dart_format_executable = '/usr/lib/dart/bin/dart'
>
Install Dart via whatever means. `dart analyze` will be included in the SDK.
Options
-------------------------------------------------------------------------------
g:ale_dart_analyze_executable *g:ale_dart_analyze_executable*
*b:ale_dart_analyze_executable*
Type: |String|
Default: `'dart'`
This variable can be set to specify an absolute path to the
format executable (or to specify an alternate executable).
===============================================================================
dart-format *ale-dart-format*
Installation
-------------------------------------------------------------------------------
Installing Dart should probably ensure that `dart` is in your `$PATH`.
In case it is not, try to set the executable option to its absolute path. : >
" Set the executable path for dart to the absolute path to it.
let g:ale_dart_format_executable = '/usr/lib/dart/bin/dart'
>
Options
-------------------------------------------------------------------------------
g:ale_dart_format_executable *g:ale_dart_format_executable*
*b:ale_dart_format_executable*
Type: |String|
Default: `'dart'`
This variable can be set to specify an absolute path to the
format executable (or to specify an alternate executable).
g:ale_dart_format_options *g:ale_dart_format_options*
*b:ale_dart_format_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the dart format fixer.
===============================================================================
dartfmt *ale-dart-dartfmt*
Installation
-------------------------------------------------------------------------------
Installing Dart should probably ensure that `dartfmt` is in your `$PATH`.
In case it is not, try to set the executable option to its absolute path. : >
" Set the executable path for dartfmt to the absolute path to it.
let g:ale_dart_dartfmt_executable = '/usr/lib/dart/bin/dartfmt'
>
Options
-------------------------------------------------------------------------------
g:ale_dart_dartfmt_executable *g:ale_dart_dartfmt_executable*
*b:ale_dart_dartfmt_executable*
Type: |String|
Default: `''`
This variable can be set to specify an absolute path to the
dartfmt executable (or to specify an alternate executable).
g:ale_dart_dartfmt_options *g:ale_dart_dartfmt_options*
*b:ale_dart_dartfmt_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the dartfmt fixer.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

21
sources_non_forked/ale/doc/ale-desktop.txt
View File

@ -1,21 +0,0 @@
===============================================================================
ALE desktop Integration *ale-desktop-options*
===============================================================================
desktop-file-validate *ale-desktop-desktop-file-validate*
ALE supports checking .desktop files with `desktop-file-validate.`
g:ale_desktop_desktop_file_validate_options
*g:ale_desktop_desktop_file_validate_options*
*b:ale_desktop_desktop_file_validate_options*
Type: |String|
Default: `''`
This variable can be changed to set options for `desktop-file-validate`,
such as `'--warn-kde'`.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

466
sources_non_forked/ale/doc/ale-development.txt
View File

@ -1,466 +0,0 @@
*ale-development.txt* For Vim version 8.0.
*ale-dev*
*ale-development*
ALE Development Documentation
===============================================================================
CONTENTS *ale-development-contents*
1. Introduction.........................|ale-development-introduction|
2. Design Goals.........................|ale-design-goals|
3. Coding Standards.....................|ale-coding-standards|
4. Testing ALE..........................|ale-development-tests|
4.1. Writing Linter Tests.............|ale-development-linter-tests|
4.2. Writing Fixer Tests..............|ale-development-fixer-tests|
4.3. Running Tests in a Windows VM....|ale-development-windows-tests|
5. Contributing.........................|ale-development-contributing|
===============================================================================
1. Introduction *ale-development-introduction*
This document contains helpful information for ALE developers, including
design goals, information on how to run the tests, coding standards, and so
on. You should read this document if you want to get involved with ALE
development.
===============================================================================
2. Design Goals *ale-design-goals*
This section lists design goals for ALE, in no particular order. They are as
follows.
ALE code should be almost 100% VimL. This makes the plugin as portable as
possible.
ALE should run without needing any other plugins to be installed, to make
installation simple. ALE can integrate with other plugins for more advanced
functionality, non-essential functionality, or improving on basic first party
functionality.
ALE should check files with as many tools as possible by default, except where
they cause security issues or make excessive use of resources on modern
machines.
ALE should be free of breaking changes to the public API, which is comprised of
documented functions and options, until a major version is planned. Breaking
changes should be preceded by a deprecation phase complete with warnings.
Changes required for security may be an exception.
ALE supports Vim 8 and above, and NeoVim 0.2.0 or newer. These are the
earliest versions of Vim and NeoVim which support |job|, |timer|, |closure|,
and |lambda| features. All ALE code should be written so it is compatible with
these versions of Vim, or with version checks so particular features can
degrade or fail gracefully.
Just about everything should be documented and covered with tests.
By and large, people shouldn't pay for the functionality they don't use. Care
should be taken when adding new features, so supporting new features doesn't
degrade the general performance of anything ALE does.
LSP support will become more important as time goes on. ALE should provide
better support for LSP features as time goes on.
When merging pull requests, you should respond with `Cheers! :beers:`, purely
for comedy value.
===============================================================================
3. Coding Standards *ale-coding-standards*
The following general coding standards should be adhered to for Vim code.
* Check your Vim code with `Vint` and do everything it says. ALE will check
your Vim code with Vint automatically. See: https://github.com/Kuniwak/vint
Read ALE's `Dockerfile` to see which version of `Vint` it uses.
* Try to write descriptive and concise names for variables and functions.
Names shouldn't be too short or too long. Think about others reading your
code later on.
* Use `snake_case` names for variables and arguments, and `PascalCase` names
for functions. Prefix every variable name with its scope. (`l:`, `g:`, etc.)
* Try to keep lines no longer than 80 characters, but this isn't an absolute
requirement.
* Use 4 spaces for every level of indentation in Vim code.
* Add a blank line before every `function`, `if`, `for`, `while`, or `return`,
which doesn't start a new level of indentation. This makes the logic in
your code easier to follow.
* End every file with a trailing newline character, but not with extra blank
lines. Remove trailing whitespace from the ends of lines.
* Write the full names of commands instead of abbreviations. For example, write
`function` instead of `func`, and `endif` instead of `end`.
* Write functions with `!`, so files can be reloaded. Use the |abort| keyword
for all functions, so functions exit on the first error.
* Make sure to credit yourself in files you have authored with `Author:`
and `Description:` comments.
In addition to the above general guidelines for the style of your code, you
should also follow some additional rules designed to prevent mistakes. Some of
these are reported with ALE's `custom-linting-rules` script. See
|ale-development-tests|.
* Don't leave stray `:echo` lines in code. Write `" no-custom-checks` above
the line if you must echo something.
* For strings use |is#| instead of |==#|, `is?` instead of `==?`, `isnot#`
instead of `!=#`, and `isnot?` instead of `!=?`. This is because `'x' ==# 0`
returns 1, while `'x' is# 0` returns 0, so you will experience fewer issues
when numbers are compared with strings. `is` and `isnot` also do not throw
errors when other objects like List or Dictionaries are compared with
strings.
* Don't use the `getcwd()` function in the ALE codebase. Most of ALE's code
runs from asynchronous callback functions, and these functions can execute
from essentially random buffers. Therefore, the `getcwd()` output is
useless. Use `expand('#' . a:buffer . ':p:h')` instead. Don't use
`expand('%...')` for the same reason.
* Don't use the `simplify()` function. It doesn't simplify paths enough. Use
`ale#path#Simplify()` instead.
* Don't use the `shellescape()` function. It doesn't escape arguments properly
on Windows. Use `ale#Escape()` instead, which will avoid escaping where it
isn't needed, and generally escape arguments better on Windows.
* Don't use the `tempname()` function. It doesn't work when `$TMPDIR` isn't
set. Use `ale#util#Tempname()` instead, which temporarily sets `$TMPDIR`
appropriately where needed.
* Use `snake_case` names for linter names, so they can be used as part of
variable names. You can define `aliases` for linters, for other names people
might try to configure linters with.
* Use |v:t_TYPE| variables instead of `type()`, which are more readable.
Apply the following guidelines when writing Vader test files.
* Use 2 spaces for Vader test files, instead of the 4 spaces for Vim files.
* If you write `Before` and `After` blocks, you should typically write them at
the top of the file, so they run for all tests. There may be some tests
where it make sense to modify the `Before` and `After` code part of the way
through the file.
* If you modify any settings or global variables, reset them in `After`
blocks. The Vader `Save` and `Restore` commands can be useful for this
purpose.
* If you load or define linters in tests, write `call ale#linter#Reset()` in
an `After` block.
* Just write `Execute` blocks for Vader tests, and don't bother writing `Then`
blocks. `Then` blocks execute after `After` blocks in older versions, and
that can be confusing.
Apply the following rules when writing Bash scripts.
* Run `shellcheck`, and do everything it says.
See: https://github.com/koalaman/shellcheck
* Try to write scripts so they will run on Linux, BSD, or Mac OSX.
===============================================================================
4. Testing ALE *ale-development-tests* *ale-dev-tests* *ale-tests*
ALE is tested with a suite of tests executed via GitHub Actions and AppVeyor.
ALE runs tests with the following versions of Vim in the following
environments.
1. Vim 8.0.0027 on Linux via GitHub Actions.
2. Vim 8.2.4693 on Linux via GitHub Actions.
3. NeoVim 0.2.0 on Linux via GitHub Actions.
4. NeoVim 0.7.0 on Linux via GitHub Actions.
6. Vim 8 (stable builds) on Windows via AppVeyor.
If you are developing ALE code on Linux, Mac OSX, or BSD, you can run ALEs
tests by installing Docker and running the `run-tests` script. Follow the
instructions on the Docker site for installing Docker.
See: https://docs.docker.com/install/
NOTE: Don't forget to add your user to the `docker` group on Linux, or Docker
just won't work. See: https://docs.docker.com/install/linux/linux-postinstall/
If you run simply `./run-tests` from the ALE repository root directory, the
latest Docker image for tests will be downloaded if needed, and the script
will run all of the tests in Vader, Vint checks, and several Bash scripts for
finding extra issues. Run `./run-tests --help` to see all of the options the
script supports. Note that the script supports selecting particular test files.
Once you get used to dealing with Vim and NeoVim compatibility issues, you
probably want to use `./run-tests --fast -q` for running tests with only the
fastest available Vim version, and with success messages from tests
suppressed.
Generally write tests for any changes you make. The following types of tests
are recommended for the following types of code.
* New/edited error handler callbacks -> Write tests in `test/handler`
* New/edited linter definition -> Write tests in `test/linter`
* New/edited fixer functions -> Write tests in `test/fixers`
Look at existing tests in the codebase for examples of how to write tests.
Refer to the Vader documentation for general information on how to write Vader
tests: https://github.com/junegunn/vader.vim
If you need to add any supporting files for tests, such as empty files present
to test searching upwards through paths for configuration files, they can be
added to the `test/test-files` directory.
See |ale-development-linter-tests| for more information on how to write linter
tests.
When you add new linters or fixers, make sure to add them into the tables in
supported-tools.md and |ale-supported-languages-and-tools.txt|. If you forget to
keep them both in sync, you should see an error like the following in the
builds run for GitHub Actions.
>
========================================
diff supported-tools.md and doc/ale-supported-languages-and-tools.txt tables
========================================
Differences follow:
--- /tmp/readme.qLjNhJdB 2018-07-01 16:29:55.590331972 +0100
+++ /tmp/doc.dAi8zfVE 2018-07-01 16:29:55.582331877 +0100
@@ -1 +1 @@
- ASM: gcc, foobar
+ ASM: gcc
<
Make sure to list documentation entries for linters and fixers in individual
help files in the table of contents, and to align help tags to the right
margin. For example, if you add a heading for an `aardvark` tool to
`ale-python.txt` with a badly aligned doc tag, you will see errors like so. >
========================================
Look for badly aligned doc tags
========================================
Badly aligned tags follow:
doc/ale-python.txt:aardvark ...
========================================
Look for table of contents issues
========================================
Check for bad ToC sorting:
Check for mismatched ToC and headings:
--- /tmp/table-of-contents.mwCFOgSI 2018-07-01 16:33:25.068811878 +0100
+++ /tmp/headings.L4WU0hsO 2018-07-01 16:33:25.076811973 +0100
@@ -168,6 +168,7 @@
pyrex (cython), ale-pyrex-options
cython, ale-pyrex-cython
python, ale-python-options
+ aardvark, ale-python-aardvark
autopep8, ale-python-autopep8
black, ale-python-black
flake8, ale-python-flake8
<
Make sure to make the table of contents match the headings, and to keep the
doc tags on the right margin.
===============================================================================
4.1 Writing Linter Tests *ale-development-linter-tests*
Tests for ALE linters take two forms.
1. Tests for handling the output of commands.
2. Tests for checking which commands are run, or connections are made.
Tests of the first form should go in the `test/handler` directory, and should
be written like so. >
Before:
" Load the file which defines the linter.
runtime ale_linters/filetype/linter_name_here.vim
After:
" Unload all linters again.
call ale#linter#Reset()
Execute(The output should be correct):
" Test that the right loclist items are parsed from the handler.
AssertEqual
\ [
\ {
\ 'lnum': 1,
\ 'type': 'E',
\ 'text': 'Something went wrong',
\ },
\ ],
\ ale_linters#filetype#linter_name#Handle(bufnr(''), [
\ '1:Something went wrong',
\ ]
<
Tests for what ALE runs should go in the `test/linter` directory, and should
be written like so. >
Before:
" Load the linter and set up a series of commands, reset linter variables,
" clear caches, etc.
"
" Vader's 'Save' command will be called here for linter variables.
call ale#assert#SetUpLinterTest('filetype', 'linter_name')
After:
" Reset linters, variables, etc.
"
" Vader's 'Restore' command will be called here.
call ale#assert#TearDownLinterTest()
Execute(The default command should be correct):
" AssertLinter checks the executable and command.
" Pass expected_executable, expected_command
AssertLinter 'some-command', ale#Escape('some-command') . ' --foo'
Execute(Check chained commands):
" GivenCommandOutput can be called with 1 or more list for passing output
" to chained commands. The output for each callback defaults to an empty
" list.
GivenCommandOutput ['v2.1.2']
" Given a List of commands, check all of them.
" Given a String, only the last command in the chain will be checked.
AssertLinter 'some-command', [
\ ale#Escape('some-command') . ' --version',
\ ale#Escape('some-command') . ' --foo',
\]
<
The full list of commands that will be temporarily defined for linter tests
given the above setup are as follows.
`GivenCommandOutput [...]` - Define output for ale#command#Run.
`AssertLinterCwd cwd` - Check the `cwd` for the linter.
`AssertLinter executable, command` - Check the executable and command.
`AssertLinterNotExecuted` - Check that linters will not be executed.
`AssertLSPLanguage language` - Check the language given to an LSP server.
`AssertLSPOptions options_dict` - Check the options given to an LSP server.
`AssertLSPConfig config_dict` - Check the config given to an LSP server.
`AssertLSPProject project_root` - Check the root given to an LSP server.
`AssertLSPAddress address` - Check the address to an LSP server.
===============================================================================
4.2 Writing Fixer Tests *ale-development-fixer-tests*
Tests for ALE fixers should go in the `test/fixers` directory, and should
be written like so. >
Before:
" Load the fixer and set up a series of commands, reset fixer variables,
" clear caches, etc.
"
" Vader's 'Save' command will be called here for fixer variables.
call ale#assert#SetUpFixerTest('filetype', 'fixer_name')
After:
" Reset fixers, variables, etc.
"
" Vader's 'Restore' command will be called here.
call ale#assert#TearDownFixerTest()
Execute(The default command should be correct):
" AssertFixer checks the result of the loaded fixer function.
AssertFixer {'command': ale#Escape('some-command') . ' --foo'}
Execute(Check chained commands):
" Same as above for linter tests.
GivenCommandOutput ['v2.1.2']
" Given a List of commands, check all of them.
" Given anything else, only the last result will be checked.
AssertFixer [
\ ale#Escape('some-command') . ' --version',
\ {'command': ale#Escape('some-command') . ' --foo'}
\]
<
The full list of commands that will be temporarily defined for fixer tests
given the above setup are as follows.
`GivenCommandOutput [...]` - Define output for ale#command#Run.
`AssertFixerCwd cwd` - Check the `cwd` for the fixer.
`AssertFixer results` - Check the fixer results
`AssertFixerNotExecuted` - Check that fixers will not be executed.
===============================================================================
4.3 Running Tests in a Windows VM *ale-development-windows-tests*
Tests are run for ALE in a build of Vim 8 for Windows via AppVeyor. These
tests can frequently break due to minor differences in paths and how escaping
is done for commands on Windows. If you are a Linux or Mac user, running these
tests locally can be difficult. Here is a process that will make that easier.
First, you want to install a Windows image with VirtualBox. Install VirtualBox
and grab a VirtualBox image for Windows such as from here:
https://developer.microsoft.com/en-us/microsoft-edge/tools/vms/
NOTE: If you need to enter a password for the virtual machine at any point,
the password is "Passw0rd!" without the double quotes.
NOTE: If your trial period for Windows runs out, run the commands like the
wallpaper tells you to.
Your virtual machine will need to have PowerShell installed. Before you go any
further, confirm that PowerShell is installed in your Windows virtual machine.
Consult the VirtualBox documentation on how to install "Guest Additions."
You probably want to install "Guest Additions" for most things to work
properly.
After you've loaded your virtual machine image, go into "Settings" for your
virtual machine, and "Shared Folders." Add a shared folder with the name
"ale", and set the "Folder Path" to the path to your ALE repository, for
example: "/home/w0rp/ale"
Find out which drive letter "ale" has been mounted as in Windows. We'll use
"E:" as the drive letter, for example. Open the command prompt as an
administrator by typing in `cmd` in the start menu, right clicking on the
command prompt application, and clicking "Run as administrator." Click "Yes"
when prompted to ask if you're sure you want to run the command prompt. You
should type in the following command to mount the "ale" directory for testing,
where "E:" is replaced with your drive letter. >
mklink /D C:\testplugin E:
<
Close the administrator Command Prompt, and try running the command
`type C:\testplugin\LICENSE` in a new Command Prompt which you are NOT running
as administrator. You should see the license for ALE in your terminal. After
you have confirmed that you have mounted ALE on your machine, search in the
Start Menu for "power shell," run PowerShell as an administrator, and issue
the following commands to install the correct Vim and Vader versions for
running tests. >
Add-Type -A System.IO.Compression.FileSystem
Invoke-WebRequest ftp://ftp.vim.org/pub/vim/pc/vim80-586w32.zip -OutFile C:\vim.zip
[IO.Compression.ZipFile]::ExtractToDirectory('C:\vim.zip', 'C:\vim')
rm C:\vim.zip
Invoke-WebRequest ftp://ftp.vim.org/pub/vim/pc/vim80-586rt.zip -OutFile C:\rt.zip
[IO.Compression.ZipFile]::ExtractToDirectory('C:\rt.zip', 'C:\vim')
rm C:\rt.zip
Invoke-WebRequest https://github.com/junegunn/vader.vim/archive/c6243dd81c98350df4dec608fa972df98fa2a3af.zip -OutFile C:\vader.zip
[IO.Compression.ZipFile]::ExtractToDirectory('C:\vader.zip', 'C:\')
mv C:\vader.vim-c6243dd81c98350df4dec608fa972df98fa2a3af C:\vader
rm C:\vader.zip
<
After you have finished installing everything, you can run all of the tests
in Windows by opening a Command Prompt NOT as an administrator by navigating
to the directory where you've mounted the ALE code, which must be named
`C:\testplugin`, and by running the `run-tests.bat` batch file. >
cd C:\testplugin
run-tests
<
It will probably take several minutes for all of the tests to run. Be patient.
You can run a specific test by passing the filename as an argument to the
batch file, for example: `run-tests test/test_c_flag_parsing.vader` . This will
give you results much more quickly.
===============================================================================
5. Contributing *ale-development-contributing*
All integration of new code into ALE is done through GitHub pull requests.
Using that tool streamlines the process and minimizes the time and effort
required to e.g. ensure test suites are run for every change.
As for any project hosted by GitHub, the choice of platform demands every
contributor to take care to setup an account and configure it accordingly.
Due to details of our process, a difference to many other GitHub hosted
projects is that contributors who wish to keep the author fields for their
commits unaltered need to configure a public email address in their account
and profile settings. See: https://docs.github.com/en/account-and-profile/
Unless configuring GitHub to expose contact details, commits will be rewritten
to appear by `USERNAME <RANDOM_NUMBER+USERNAME@users.noreply.github.com>` .
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

52
sources_non_forked/ale/doc/ale-dhall.txt
View File

@ -1,52 +0,0 @@
===============================================================================
ALE Dhall Integration *ale-dhall-options*
g:ale_dhall_executable *g:ale_dhall_executable*
*b:ale_dhall_executable*
Type: |String|
Default: `'dhall'`
g:ale_dhall_options *g:ale_dhall_options*
*b:ale_dhall_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the 'dhall` executable.
This is shared with `dhall-freeze` and `dhall-lint`.
>
let g:ale_dhall_options = '--ascii'
<
===============================================================================
dhall-format *ale-dhall-format*
Dhall
(https://dhall-lang.org/)
===============================================================================
dhall-freeze *ale-dhall-freeze*
Dhall
(https://dhall-lang.org/)
g:ale_dhall_freeze_options *g:ale_dhall_freeze_options*
*b:ale_dhall_freeze_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the 'dhall freeze`
executable.
>
let g:ale_dhall_freeze_options = '--all'
<
===============================================================================
dhall-lint *ale-dhall-lint*
Dhall
(https://dhall-lang.org/)
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

76
sources_non_forked/ale/doc/ale-dockerfile.txt
View File

@ -1,76 +0,0 @@
===============================================================================
ALE Dockerfile Integration *ale-dockerfile-options*
===============================================================================
dockerfile_lint *ale-dockerfile-dockerfile_lint*
g:ale_dockerfile_dockerfile_lint_executable
*g:ale_dockerfile_dockerfile_lint_executable*
*b:ale_dockerfile_dockerfile_lint_executable*
Type: |String|
Default: `'dockerfile_lint'`
This variable can be changed to specify the executable used to run
dockerfile_lint.
g:ale_dockerfile_dockerfile_lint_options
*g:ale_dockerfile_dockerfile_lint_options*
*b:ale_dockerfile_dockerfile_lint_options*
Type: |String|
Default: `''`
This variable can be changed to add additional command-line arguments to
the dockerfile lint invocation - like custom rule file definitions.
===============================================================================
dprint *ale-dockerfile-dprint*
See |ale-dprint-options| and https://dprint.dev/plugins/dockerfile
===============================================================================
hadolint *ale-dockerfile-hadolint*
hadolint can be found at: https://github.com/hadolint/hadolint
g:ale_dockerfile_hadolint_options *g:ale_dockerfile_hadolint_options*
*b:ale_dockerfile_hadolint_options*
Type: |String|
Default: `''`
This variable can be changed to add command-line arguments to the hadolint
invocation. These arguments will be used whether docker is being used or not
(see below).
g:ale_dockerfile_hadolint_use_docker *g:ale_dockerfile_hadolint_use_docker*
*b:ale_dockerfile_hadolint_use_docker*
Type: |String|
Default: `'never'`
This variable controls if docker and the hadolint image are used to run this
linter: if 'never', docker will never be used; 'always' means docker will
always be used; 'yes' and docker will be used if the hadolint executable
cannot be found.
For now, the default is 'never'. This may change as ale's support for using
docker to lint evolves.
g:ale_dockerfile_hadolint_image *g:ale_dockerfile_hadolint_image*
*b:ale_dockerfile_hadolint_image*
Type: |String|
Default: `'hadolint/hadolint'`
This variable controls the docker image used to run hadolint. The default
is hadolint's author's build, and can be found at:
https://hub.docker.com/r/hadolint/hadolint/
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

108
sources_non_forked/ale/doc/ale-elixir.txt
View File

@ -1,108 +0,0 @@
===============================================================================
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`
g:ale_elixir_mix_options *g:ale_elixir_mix_options*
*b:ale_elixir_mix_options*
Type: |String|
Default: `'mix'`
This variable can be changed to specify the mix executable.
===============================================================================
mix_format *ale-elixir-mix-format*
g:ale_elixir_mix_format_options *g:ale_elixir_mix_format_options*
*b: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)
g:ale_elixir_elixir_ls_release *g:ale_elixir_elixir_ls_release*
*b: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).
g:ale_elixir_elixir_ls_config *g:ale_elixir_elixir_ls_config*
*b: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: >
{
\ 'elixirLS': {
\ 'dialyzerEnabled': v:false,
\ },
\ }
<
Consult the ElixirLS documentation for more information about settings.
===============================================================================
credo *ale-elixir-credo*
Credo (https://github.com/rrrene/credo)
g:ale_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.
g:ale_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|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

100
sources_non_forked/ale/doc/ale-elm.txt
View File

@ -1,100 +0,0 @@
===============================================================================
ALE Elm Integration *ale-elm-options*
===============================================================================
elm-format *ale-elm-elm-format*
g:ale_elm_format_executable *g:ale_elm_format_executable*
*b:ale_elm_format_executable*
Type: |String|
Default: `'elm-format'`
See |ale-integrations-local-executables|
g:ale_elm_format_use_global *g:ale_elm_format_use_global*
*b:ale_elm_format_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
g:ale_elm_format_options *g:ale_elm_format_options*
*b:ale_elm_format_options*
Type: |String|
Default: `'--yes'`
This variable can be set to pass additional options to elm-format.
===============================================================================
elm-ls *ale-elm-elm-ls*
g:ale_elm_ls_executable *g:ale_elm_ls_executable*
*b:ale_elm_ls_executable*
Type: |String|
Default: `'elm-language-server'`
See |ale-integrations-local-executables|
g:ale_elm_ls_use_global *g:ale_elm_ls_use_global*
*b:ale_elm_ls_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 1)`
See |ale-integrations-local-executables|
g:ale_elm_ls_elm_path *g:ale_elm_ls_elm_path*
*b:ale_elm_ls_elm_path*
Type: |String|
Default: `''`
See |ale-integrations-local-executables|
g:ale_elm_ls_elm_format_path *g:ale_elm_ls_elm_format_path*
*b:ale_elm_ls_elm_format_path*
Type: |String|
Default: `''`
See |ale-integrations-local-executables|
g:ale_elm_ls_elm_test_path *g:ale_elm_ls_elm_test_path*
*b:ale_elm_ls_elm_test_path*
Type: |String|
Default: `''`
See |ale-integrations-local-executables|
g:ale_elm_ls_elm_analyse_trigger *g:ale_elm_ls_elm_analyse_trigger*
*b:ale_elm_ls_elm_analyse_trigger*
Type: |String|
Default: `'change'`
One of 'change', 'save' or 'never'
===============================================================================
elm-make *ale-elm-elm-make*
g:ale_elm_make_executable *g:ale_elm_make_executable*
*b:ale_elm_make_executable*
Type: |String|
Default: `'elm'`
See |ale-integrations-local-executables|
g:ale_elm_make_use_global *g:ale_elm_make_use_global*
*b:ale_elm_make_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

131
sources_non_forked/ale/doc/ale-erlang.txt
View File

@ -1,131 +0,0 @@
===============================================================================
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:

58
sources_non_forked/ale/doc/ale-eruby.txt
View File

@ -1,58 +0,0 @@
===============================================================================
ALE Eruby Integration *ale-eruby-options*
There are four linters for `eruby` files:
- `erb`
- `erblint`
- `erubis`
- `erubi`
- `ruumba`
`erb` is in the Ruby standard library and is mostly universal. `erubis` is the
default parser in Rails between 3.0 and 5.1. `erubi` is the default in Rails
5.1 and later. `ruumba` can extract Ruby from eruby files and run rubocop on
the result. To selectively enable a subset, see |g:ale_linters|.
===============================================================================
erblint *ale-eruby-erblint*
g:ale_eruby_erblint_executable *g:ale_eruby_erblint_executable*
*b:ale_eruby_erblint_executable*
Type: |String|
Default: `'erblint'`
Override the invoked erblint binary. This is useful for running erblint
from binstubs or a bundle.
g:ale_eruby_erblint_options *g:ale_ruby_erblint_options*
*b:ale_ruby_erblint_options*
Type: |String|
Default: `''`
This variable can be change to modify flags given to erblint.
===============================================================================
ruumba *ale-eruby-ruumba*
g:ale_eruby_ruumba_executable *g:ale_eruby_ruumba_executable*
*b:ale_eruby_ruumba_executable*
Type: |String|
Default: `'ruumba`
Override the invoked ruumba binary. This is useful for running ruumba
from binstubs or a bundle.
g:ale_eruby_ruumba_options *g:ale_ruby_ruumba_options*
*b:ale_ruby_ruumba_options*
Type: |String|
Default: `''`
This variable can be change to modify flags given to ruumba.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

31
sources_non_forked/ale/doc/ale-fish.txt
View File

@ -1,31 +0,0 @@
===============================================================================
ALE Fish Integration *ale-fish-options*
Lints fish files using `fish -n`.
Note that `fish -n` is not foolproof: it sometimes gives false positives or
errors that are difficult to parse without more context. This integration skips
displaying errors if an error message is not found.
If ALE is not showing any errors but your file does not run as expected, run
`fish -n <file.fish>` from the command line.
===============================================================================
fish_indent *ale-fish-fish_indent*
g:ale_fish_fish_indent_executable *g:ale_fish_fish_indent_executable*
*b:ale_fish_fish_indent_executable*
Type: |String|
Default: `'fish_indent'`
This variable can be changed to use a different executable for fish_indent.
g:ale_fish_fish_indent_options *g:ale_fish_fish_indent_options*
*b:ale_fish_fish_indent_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to fish_indent.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

55
sources_non_forked/ale/doc/ale-fortran.txt
View File

@ -1,55 +0,0 @@
===============================================================================
ALE Fortran Integration *ale-fortran-options*
===============================================================================
gcc *ale-fortran-gcc*
g:ale_fortran_gcc_executable *g:ale_fortran_gcc_executable*
*b:ale_fortran_gcc_executable*
Type: |String|
Default: `'gcc'`
This variable can be changed to modify the executable used for checking
Fortran code with GCC.
g:ale_fortran_gcc_options *g:ale_fortran_gcc_options*
*b:ale_fortran_gcc_options*
Type: |String|
Default: `'-Wall'`
This variable can be changed to modify flags given to gcc.
g:ale_fortran_gcc_use_free_form *g:ale_fortran_gcc_use_free_form*
*b:ale_fortran_gcc_use_free_form*
Type: |Number|
Default: `1`
When set to `1`, the `-ffree-form` flag will be used for GCC, to check files
with the free form layout. When set to `0`, `-ffixed-form` will be used
instead, for checking files with fixed form layouts.
===============================================================================
language_server *ale-fortran-language-server*
g:ale_fortran_language_server_executable *g:ale_fortran_language_server_executable*
*b:ale_fortran_language_server_executable*
Type: |String|
Default: `'fortls'`
This variable can be changed to modify the executable used for the Fortran
Language Server.
g:ale_fortran_language_server_use_global *g:ale_fortran_language_server_use_global*
*b:ale_fortran_language_server_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

6
sources_non_forked/ale/doc/ale-fountain.txt
View File

@ -1,6 +0,0 @@
===============================================================================
ALE Fountain Integration *ale-fountain-options*
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

25
sources_non_forked/ale/doc/ale-fuse.txt
View File

@ -1,25 +0,0 @@
===============================================================================
ALE FusionScript Integration *ale-fuse-options*
===============================================================================
fusion-lint *ale-fuse-fusionlint*
g:ale_fusion_fusionlint_executable *g:ale_fuse_fusionlint_executable*
*b:ale_fuse_fusionlint_executable*
Type: |String|
Default: `'fusion-lint'`
This variable can be changed to change the path to fusion-lint.
g:ale_fuse_fusionlint_options *g:ale_fuse_fusionlint_options*
*b:ale_fuse_fusionlint_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to fusion-lint.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

44
sources_non_forked/ale/doc/ale-gitcommit.txt
View File

@ -1,44 +0,0 @@
===============================================================================
ALE Git Commit Integration *ale-gitcommit-options*
===============================================================================
gitlint *ale-gitcommit-gitlint*
g:ale_gitcommit_gitlint_executable *g:ale_gitcommit_gitlint_executable*
*b:ale_gitcommit_gitlint_executable*
Type: |String|
Default: `'gitlint'`
This variable can be changed to modify the executable used for gitlint.
g:ale_gitcommit_gitlint_options *g:ale_gitcommit_gitlint_options*
*b:ale_gitcommit_gitlint_options*
Type: |String|
Default: `''`
This variable can be changed to add command-line arguments to the gitlint
invocation. For example, you can specify the path to a configuration file. >
let g:ale_gitcommit_gitlint_options = '-C /home/user/.config/gitlint.ini'
<
You can also disable particular error codes using this option. For example,
you can ignore errors for git commits with a missing body. >
let g:ale_gitcommit_gitlint_options = '--ignore B6'
<
g:ale_gitcommit_gitlint_use_global *g:ale_gitcommit_gitlint_use_global*
*b:ale_gitcommit_gitlint_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
This variable controls whether or not ALE will search for gitlint in a
virtualenv directory first. If this variable is set to `1`, then ALE will
always use |g:ale_gitcommit_gitlint_executable| for the executable path.
Both variables can be set with `b:` buffer variables instead.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

56
sources_non_forked/ale/doc/ale-glsl.txt
View File

@ -1,56 +0,0 @@
===============================================================================
ALE GLSL Integration *ale-glsl-options*
*ale-integration-glsl*
===============================================================================
Integration Information
Since Vim does not detect the glsl file types out-of-the-box, you need the
runtime files for glsl from here: https://github.com/tikhomirov/vim-glsl
Note that the current glslang-based linter expects glslangValidator in
standard paths. If it's not installed system-wide you can set
|g:ale_glsl_glslang_executable| to a specific path.
===============================================================================
glslang *ale-glsl-glslang*
g:ale_glsl_glslang_executable *g:ale_glsl_glslang_executable*
*b:ale_glsl_glslang_executable*
Type: |String|
Default: `'glslangValidator'`
This variable can be changed to change the path to glslangValidator.
g:ale_glsl_glslang_options *g:ale_glsl_glslang_options*
*b:ale_glsl_glslang_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to glslangValidator.
===============================================================================
glslls *ale-glsl-glslls*
g:ale_glsl_glslls_executable *g:ale_glsl_glslls_executable*
*b:ale_glsl_glslls_executable*
Type: |String|
Default: `'glslls'`
This variable can be changed to change the path to glslls.
See |ale-integrations-local-executables|
g:ale_glsl_glslls_logfile *g:ale_glsl_glslls_logfile*
*b:ale_glsl_glslls_logfile*
Type: |String|
Default: `''`
Setting this variable to a writeable file path will enable logging to that
file.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

372
sources_non_forked/ale/doc/ale-go.txt
View File

@ -1,372 +0,0 @@
===============================================================================
ALE Go Integration *ale-go-options*
===============================================================================
Integration Information
The `gometalinter` linter is disabled by default. ALE enables `gofmt`,
`golint` and `go vet` by default. It also supports `staticcheck`, `go
build`, `gosimple`, `golangserver`.
To enable `gometalinter`, update |g:ale_linters| as appropriate:
>
" Enable all of the linters you want for Go.
let g:ale_linters = {'go': ['gometalinter', 'gofmt']}
<
A possible configuration is to enable `gometalinter` and `gofmt` but paired
with the `--fast` option, set by |g:ale_go_gometalinter_options|. This gets you
the benefit of running a number of linters, more than ALE would by default,
while ensuring it doesn't run any linters known to be slow or resource
intensive.
g:ale_go_go_executable *g:ale_go_go_executable*
*b:ale_go_go_executable*
Type: |String|
Default: `'go'`
The executable that will be run for the `gobuild` and `govet` linters, and
the `gomod` fixer.
g:ale_go_go111module *g:ale_go_go111module*
*b:ale_go_go111module*
Type: |String|
Default: `''`
Override the value of the `$GO111MODULE` environment variable for
golang tools.
===============================================================================
bingo *ale-go-bingo*
g:ale_go_bingo_executable *g:ale_go_bingo_executable*
*b:ale_go_bingo_executable*
Type: |String|
Default: `'bingo'`
Location of the bingo binary file.
g:ale_go_bingo_options *g:ale_go_bingo_options*
*b:ale_go_bingo_options*
Type: |String|
Default: `''`
===============================================================================
cspell *ale-go-cspell*
See |ale-cspell-options|
===============================================================================
gobuild *ale-go-gobuild*
g:ale_go_gobuild_options *g:ale_go_gobuild_options*
*b:ale_go_gobuild_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the gobuild linter.
They are injected directly after "go test".
===============================================================================
gofmt *ale-go-gofmt*
g:ale_go_gofmt_options *g:ale_go_gofmt_options*
*b:ale_go_gofmt_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the gofmt fixer.
===============================================================================
gofumpt *ale-go-gofumpt*
g:ale_go_gofumpt_executable *g:ale_go_gofumpt_executable*
*b:ale_go_gofumpt_executable*
Type: |String|
Default: `'gofumpt'`
Executable to run to use as the gofumpt fixer.
g:ale_go_gofumpt_options *g:ale_go_gofumpt_options*
*b:ale_go_gofumpt_options*
Type: |String|
Default: `''`
Options to pass to the gofumpt fixer.
===============================================================================
golangci-lint *ale-go-golangci-lint*
`golangci-lint` is a `lint_file` linter, which only lints files that are
written to disk. This differs from the default behavior of linting the buffer.
See: |ale-lint-file|
g:ale_go_golangci_lint_executable *g:ale_go_golangci_lint_executable*
*b:ale_go_golangci_lint_executable*
Type: |String|
Default: `'golangci-lint'`
The executable that will be run for golangci-lint.
g:ale_go_golangci_lint_options *g:ale_go_golangci_lint_options*
*b:ale_go_golangci_lint_options*
Type: |String|
Default: `'--enable-all'`
This variable can be changed to alter the command-line arguments to the
golangci-lint invocation.
g:ale_go_golangci_lint_package *g:ale_go_golangci_lint_package*
*b:ale_go_golangci_lint_package*
Type: |Number|
Default: `0`
When set to `1`, the whole Go package will be checked instead of only the
current file.
===============================================================================
golangserver *ale-go-golangserver*
g:ale_go_langserver_executable *g:ale_go_langserver_executable*
*b:ale_go_langserver_executable*
Type: |String|
Default: `'go-langserver'`
Location of the go-langserver binary file.
g:ale_go_langserver_options *g:ale_go_langserver_options*
*b:ale_go_langserver_options*
Type: |String|
Default: `''`
Additional options passed to the go-langserver command. Note that the
`-gocodecompletion` option is ignored because it is handled automatically
by the |g:ale_completion_enabled| variable.
===============================================================================
golines *ale-go-golines*
g:ale_go_golines_executable *g:ale_go_lines_executable*
*b:ale_go_lines_executable*
Type: |String|
Default: `'golines'`
Location of the golines binary file
g:ale_go_golines_options *g:ale_go_golines_options*
*b:ale_go_golines_options*
Type: |String|
Default: `''`
Additional options passed to the golines command. By default golines has
--max-length=100 (lines above 100 characters will be wrapped)
===============================================================================
golint *ale-go-golint*
g:ale_go_golint_executable *g:ale_go_golint_executable*
*b:ale_go_golint_executable*
Type: |String|
Default: `'golint'`
This variable can be set to change the golint executable path.
g:ale_go_golint_options *g:ale_go_golint_options*
*b:ale_go_golint_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the golint linter.
===============================================================================
gometalinter *ale-go-gometalinter*
`gometalinter` is a `lint_file` linter, which only lints files that are
written to disk. This differs from the default behavior of linting the buffer.
See: |ale-lint-file|
g:ale_go_gometalinter_executable *g:ale_go_gometalinter_executable*
*b:ale_go_gometalinter_executable*
Type: |String|
Default: `'gometalinter'`
The executable that will be run for gometalinter.
g:ale_go_gometalinter_options *g:ale_go_gometalinter_options*
*b:ale_go_gometalinter_options*
Type: |String|
Default: `''`
This variable can be changed to alter the command-line arguments to the
gometalinter invocation.
Since `gometalinter` runs a number of linters that can consume a lot of
resources it's recommended to set this option to a value of `--fast` if you
use `gometalinter` as one of the linters in |g:ale_linters|. This disables a
number of linters known to be slow or consume a lot of resources.
g:ale_go_gometalinter_lint_package *g:ale_go_gometalinter_lint_package*
*b:ale_go_gometalinter_lint_package*
Type: |Number|
Default: `0`
When set to `1`, the whole Go package will be checked instead of only the
current file.
===============================================================================
gopls *ale-go-gopls*
gopls is the official Go language server, and is enabled for use with ALE by
default.
To install the latest stable version of `gopls` to your `$GOPATH`, try the
following command: >
GO111MODULE=on go get golang.org/x/tools/gopls@latest
<
If `$GOPATH` is readable by ALE, it should probably work without you having to
do anything else. See the `gopls` README file for more information:
https://github.com/golang/tools/blob/master/gopls/README.md
g:ale_go_gopls_executable *g:ale_go_gopls_executable*
*b:ale_go_gopls_executable*
Type: |String|
Default: `'gopls'`
See |ale-integrations-local-executables|
ALE will search for `gopls` in locally installed directories first by
default, and fall back on a globally installed `gopls` if it can't be found
otherwise.
g:ale_go_gopls_options *g:ale_go_gopls_options*
*b:ale_go_gopls_options*
Type: |String|
Default: `''`
Command-line options passed to the gopls executable. See `gopls -h`.
g:ale_go_gopls_init_options *g:ale_go_gopls_init_options*
*b:ale_go_gopls_init_options*
Type: |Dictionary|
Default: `{}`
LSP initialization options passed to gopls. This can be used to configure
the behaviour of gopls.
Example: >
let g:ale_go_gopls_init_options = {'ui.diagnostic.analyses': {
\ 'composites': v:false,
\ 'unusedparams': v:true,
\ 'unusedresult': v:true,
\ }}
<
For a full list of supported analyzers, see:
https://github.com/golang/tools/blob/master/gopls/doc/analyzers.md
g:ale_go_gopls_use_global *g:ale_go_gopls_use_global*
*b:ale_go_gopls_use_global*
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
govet *ale-go-govet*
g:ale_go_govet_options *g:ale_go_govet_options*
*b:ale_go_govet_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the go vet linter.
===============================================================================
revive *ale-go-revive*
g:ale_go_revive_executable *g:ale_go_revive_executable*
*b:ale_go_revive_executable*
Type: |String|
Default: `'revive'`
This variable can be set to change the revive executable path.
g:ale_go_revive_options *g:ale_go_revive_options*
*b:ale_go_revive_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the revive
===============================================================================
staticcheck *ale-go-staticcheck*
g:ale_go_staticcheck_executable *g:ale_go_staticcheck_executable*
*b:ale_go_staticcheck_executable*
Type: |String|
Default: `'staticcheck'`
See |ale-integrations-local-executables|
ALE will search for `staticcheck` in locally installed directories first by
default, and fall back on a globally installed `staticcheck` if it can't be
found otherwise.
g:ale_go_staticcheck_options *g:ale_go_staticcheck_options*
*b:ale_go_staticcheck_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the staticcheck
linter.
g:ale_go_staticcheck_lint_package *g:ale_go_staticcheck_lint_package*
*b:ale_go_staticcheck_lint_package*
Type: |Number|
Default: `1`
When set to `1`, the whole Go package will be checked instead of only the
current file.
g:ale_go_staticcheck_use_global *g:ale_go_staticcheck_use_global*
*b:ale_go_staticcheck_use_global*
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

22
sources_non_forked/ale/doc/ale-graphql.txt
View File

@ -1,22 +0,0 @@
===============================================================================
ALE GraphQL Integration *ale-graphql-options*
===============================================================================
eslint *ale-graphql-eslint*
The `eslint` linter for GraphQL uses the JavaScript options for `eslint`; see:
|ale-javascript-eslint|.
You will need the GraphQL ESLint plugin installed for this to work.
===============================================================================
gqlint *ale-graphql-gqlint*
===============================================================================
prettier *ale-graphql-prettier*
See |ale-javascript-prettier| for information about the available options.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

51
sources_non_forked/ale/doc/ale-hack.txt
View File

@ -1,51 +0,0 @@
===============================================================================
ALE Hack Integration *ale-hack-options*
*ale-integration-hack*
HHAST is disabled by default, as it executes code in the project root.
Currently linters must be enabled globally. HHAST can be enabled with:
>
let g:ale_linters = {'hack': ['hack', 'hhast']}
<
===============================================================================
hack *ale-hack-hack*
g:ale_hack_hack_executable *g:ale_hack_hack_executable*
*b:ale_hack_hack_executable*
Type: |String|
Default: `'hh_client'`
This variable can be set to use a specific executable to interact with the
Hack typechecker.
===============================================================================
hackfmt *ale-hack-hackfmt*
g:ale_hack_hackfmt_options *g:ale_hack_hackfmt_options*
*b:ale_hack_hackfmt_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the hackfmt fixer.
===============================================================================
hhast *ale-hack-hhast*
g:ale_hack_hhast_executable *g:ale_hack_hhast_executable*
*b:ale_hack_hhast_executable*
Type: |String|
Default: `'vendor/bin/hhast-lint'`
This variable can be set to use a specific executable to interact with the
Hack typechecker.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

34
sources_non_forked/ale/doc/ale-handlebars.txt
View File

@ -1,34 +0,0 @@
===============================================================================
ALE Handlebars Integration *ale-handlebars-options*
===============================================================================
prettier *ale-handlebars-prettier*
See |ale-javascript-prettier| for information about the available options.
Uses glimmer parser by default.
===============================================================================
ember-template-lint *ale-handlebars-embertemplatelint*
g:ale_handlebars_embertemplatelint_executable
*g:ale_handlebars_embertemplatelint_executable*
*b:ale_handlebars_embertemplatelint_executable*
Type: |String|
Default: `'ember-template-lint'`
See |ale-integrations-local-executables|
g:ale_handlebars_embertemplatelint_use_global
*g:ale_handlebars_embertemplatelint_use_global*
*b:ale_handlebars_embertemplatelint_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

228
sources_non_forked/ale/doc/ale-haskell.txt
View File

@ -1,228 +0,0 @@
===============================================================================
ALE Haskell Integration *ale-haskell-options*
===============================================================================
brittany *ale-haskell-brittany*
g:ale_haskell_brittany_executable *g:ale_haskell_brittany_executable*
*b:ale_haskell_brittany_executable*
Type: |String|
Default: `'brittany'`
This variable can be changed to use a different executable for brittany.
===============================================================================
cspell *ale-haskell-cspell*
See |ale-cspell-options|
===============================================================================
floskell *ale-haskell-floskell*
g:ale_haskell_floskell_executable *g:ale_haskell_floskell_executable*
*b:ale_haskell_floskell_executable*
Type: |String|
Default: `'floskell'`
This variable can be changed to use a different executable for floskell.
===============================================================================
ghc *ale-haskell-ghc*
g:ale_haskell_ghc_options *g:ale_haskell_ghc_options*
*b:ale_haskell_ghc_options*
Type: |String|
Default: `'-fno-code -v0'`
This variable can be changed to modify flags given to ghc.
===============================================================================
ghc-mod *ale-haskell-ghc-mod*
g:ale_haskell_ghc_mod_executable *g:ale_haskell_ghc_mod_executable*
*b:ale_haskell_ghc_mod_executable*
Type: |String|
Default: `'ghc-mod'`
This variable can be changed to use a different executable for ghc-mod.
===============================================================================
cabal-ghc *ale-haskell-cabal-ghc*
g:ale_haskell_cabal_ghc_options *g:ale_haskell_cabal_ghc_options*
*b:ale_haskell_cabal_ghc_options*
Type: |String|
Default: `'-fno-code -v0'`
This variable can be changed to modify flags given to ghc through cabal
exec.
===============================================================================
hdevtools *ale-haskell-hdevtools*
g:ale_haskell_hdevtools_executable *g:ale_haskell_hdevtools_executable*
*b:ale_haskell_hdevtools_executable*
Type: |String|
Default: `'hdevtools'`
This variable can be changed to use a different executable for hdevtools.
g:ale_haskell_hdevtools_options *g:ale_haskell_hdevtools_options*
*b:ale_haskell_hdevtools_options*
Type: |String|
Default: `get(g:, 'hdevtools_options', '-g -Wall')`
This variable can be changed to modify flags given to hdevtools.
The hdevtools documentation recommends setting GHC options for `hdevtools`
with `g:hdevtools_options`. ALE will use the value of `g:hdevtools_options`
for the value of `g:ale_haskell_hdevtools_options` by default, so this
option can be respected and overridden specifically for ALE.
===============================================================================
hfmt *ale-haskell-hfmt*
g:ale_haskell_hfmt_executable *g:ale_haskell_hfmt_executable*
*b:ale_haskell_hfmt_executable*
Type: |String|
Default: `'hfmt'`
This variable can be changed to use a different executable for hfmt.
===============================================================================
hindent *ale-haskell-hindent*
g:ale_haskell_hindent_executable *g:ale_haskell_hindent_executable*
*b:ale_haskell_hindent_executable*
Type: |String|
Default: `'hindent'`
This variable can be changed to use a different executable for hindent.
===============================================================================
hlint *ale-haskell-hlint*
g:ale_haskell_hlint_executable *g:ale_haskell_hlint_executable*
*b:ale_haskell_hlint_executable*
Type: |String|
Default: `'hlint'`
This variable can be changed to use a different executable for hlint.
g:ale_haskell_hlint_options g:ale_haskell_hlint_options
b:ale_haskell_hlint_options
Type: |String|
Default: `''`
This variable can be used to pass extra options to the underlying hlint
executable.
===============================================================================
hls *ale-haskell-hls*
g:ale_haskell_hls_executable *g:ale_haskell_hls_executable*
*b:ale_haskell_hls_executable*
Type: |String|
Default: `'haskell-language-server-wrapper'`
This variable can be changed to use a different executable for the haskell
language server.
g:ale_haskell_hls_config *g:ale_haskell_hls_config*
*b:ale_haskell_hls_config*
Type: |Dictionary|
Default: `{}`
Dictionary with configuration settings for HLS. For example, to see more
completions:
>
let g:ale_haskell_hls_config = {'haskell': {'maxCompletions': 250}}
<
Refer to HLS documentation for possible settings:
https://haskell-language-server.readthedocs.io/en/latest/configuration.html#language-specific-server-options
===============================================================================
stack-build *ale-haskell-stack-build*
g:ale_haskell_stack_build_options *g:ale_haskell_stack_build_options*
*b:ale_haskell_stack_build_options*
Type: |String|
Default: `'--fast'`
We default to using `'--fast'`. Since Stack generates binaries, your
programs will be slower unless you separately rebuild them outside of ALE.
===============================================================================
stack-ghc *ale-haskell-stack-ghc*
g:ale_haskell_stack_ghc_options *g:ale_haskell_stack_ghc_options*
*b:ale_haskell_stack_ghc_options*
Type: |String|
Default: `'-fno-code -v0'`
This variable can be changed to modify flags given to ghc through `stack
ghc`
===============================================================================
stylish-haskell *ale-haskell-stylish-haskell*
g:ale_haskell_stylish_haskell_executable
*g:ale_haskell_stylish_haskell_executable*
*b:ale_haskell_stylish_haskell_executable*
Type: |String|
Default: `'stylish-haskell'`
This variable can be changed to use a different executable for stylish-haskell.
===============================================================================
hie *ale-haskell-hie*
g:ale_haskell_hie_executable *g:ale_haskell_hie_executable*
*b:ale_haskell_hie_executable*
Type: |String|
Default: `'hie'`
This variable can be changed to use a different executable for the haskell
ide engine. i.e. `'hie-wrapper'`
===============================================================================
ormolu *ale-haskell-ormolu*
g:ale_haskell_ormolu_executable *g:ale_haskell_ormolu_executable*
*b:ale_haskell_ormolu_executable*
Type: |String|
Default: `'ormolu'`
This variable can be changed to use a different executable for ormolu.
g:ale_haskell_ormolu_options *g:ale_haskell_ormolu_options*
*b:ale_haskell_ormolu_options*
Type: |String|
Default: `''`
This variable can be used to pass extra options to the underlying ormolu
executable.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

16
sources_non_forked/ale/doc/ale-hcl.txt
View File

@ -1,16 +0,0 @@
===============================================================================
ALE HCL Integration *ale-hcl-options*
===============================================================================
packer-fmt *ale-hcl-packer-fmt*
See |ale-packer-fmt-fixer| for information about the available options.
===============================================================================
terraform-fmt *ale-hcl-terraform-fmt*
See |ale-terraform-fmt-fixer| for information about the available options.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

12
sources_non_forked/ale/doc/ale-help.txt
View File

@ -1,12 +0,0 @@
===============================================================================
ALE Help Integration *ale-help-options*
===============================================================================
cspell *ale-help-cspell*
See |ale-cspell-options|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

202
sources_non_forked/ale/doc/ale-html.txt
View File

@ -1,202 +0,0 @@
===============================================================================
ALE HTML Integration *ale-html-options*
===============================================================================
angular *ale-html-angular*
ALE supports language server features for Angular. You can install it via `npm`: >
$ npm install --save-dev @angular/language-server
<
Angular 11 and up are supported.
g:ale_html_angular_executable *g:ale_html_angular_executable*
*b:ale_html_angular_executable*
Type: |String|
Default: `'ngserver'`
See |ale-integrations-local-executables|
g:ale_html_angular_use_global *g:ale_html_angular_use_global*
*b:ale_html_angular_use_global*
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
cspell *ale-html-cspell*
See |ale-cspell-options|
===============================================================================
fecs *ale-html-fecs*
`fecs` options for HTML are the same as the options for JavaScript, and both
of them read `./.fecsrc` as the default configuration file.
See: |ale-javascript-fecs|.
===============================================================================
html-beautify *ale-html-beautify*
g:ale_html_beautify_executable *g:ale_html_beautify_executable*
*b:ale_html_beautify_executable*
Type: |String|
Default: `'html-beautify'`
See |ale-integrations-local-executables|
g:ale_html_beautify_options *g:ale_html_beautify_options*
*b:ale_html_beautify_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to html-beautify.
g:ale_html_beautify_use_global *g:ale_html_beautify_use_global*
*b:ale_html_beautify_use_global*
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
htmlhint *ale-html-htmlhint*
g:ale_html_htmlhint_executable *g:ale_html_htmlhint_executable*
*b:ale_html_htmlhint_executable*
Type: |String|
Default: `'htmlhint'`
See |ale-integrations-local-executables|
g:ale_html_htmlhint_options *g:ale_html_htmlhint_options*
*b:ale_html_htmlhint_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to HTMLHint.
g:ale_html_htmlhint_use_global *g:ale_html_htmlhint_use_global*
*b:ale_html_htmlhint_use_global*
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
prettier *ale-html-prettier*
See |ale-javascript-prettier| for information about the available options.
===============================================================================
stylelint *ale-html-stylelint*
g:ale_html_stylelint_executable *g:ale_html_stylelint_executable*
*b:ale_html_stylelint_executable*
Type: |String|
Default: `'stylelint'`
See |ale-integrations-local-executables|
g:ale_html_stylelint_options *g:ale_html_stylelint_options*
*b:ale_html_stylelint_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to stylelint.
g:ale_html_stylelint_use_global *g:ale_html_stylelint_use_global*
*b:ale_html_stylelint_use_global*
Type: |String|
Default: `0`
See |ale-integrations-local-executables|
===============================================================================
tidy *ale-html-tidy*
`tidy` is a console application which corrects and cleans up HTML and XML
documents by fixing markup errors and upgrading legacy code to modern
standards.
Note:
`/usr/bin/tidy` on macOS (installed by default) is too old. It was released
on 31 Oct 2006. It does not consider modern HTML specs (HTML5) and shows
outdated warnings. So |ale| ignores `/usr/bin/tidy` on macOS.
To use `tidy` on macOS, please install the latest version with Homebrew:
>
$ brew install tidy-html5
<
`/usr/local/bin/tidy` is installed.
g:ale_html_tidy_executable *g:ale_html_tidy_executable*
*b:ale_html_tidy_executable*
Type: |String|
Default: `'tidy'`
This variable can be changed to change the path to tidy.
g:ale_html_tidy_options *g:ale_html_tidy_options*
*b:ale_html_tidy_options*
Type: |String|
Default: `'-q -e -language en'`
This variable can be changed to change the arguments provided to the
executable.
ALE will attempt to automatically detect the appropriate file encoding to
provide to html-tidy, and fall back to UTF-8 when encoding detection fails.
The recognized file encodings are as follows: ascii, big5, cp1252 (win1252),
cp850 (ibm858), cp932 (shiftjis), iso-2022-jp (iso-2022), latin1, macroman
(mac), sjis (shiftjis), utf-16le, utf-16, utf-8
g:ale_html_tidy_use_global *g:html_tidy_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
vscodehtml *ale-html-vscode*
Website: https://github.com/hrsh7th/vscode-langservers-extracted
Installation
-------------------------------------------------------------------------------
Install VSCode html language server either globally or locally: >
npm install -g vscode-langservers-extracted
<
===============================================================================
write-good *ale-html-write-good*
See |ale-write-good-options|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

23
sources_non_forked/ale/doc/ale-idris.txt
View File

@ -1,23 +0,0 @@
===============================================================================
ALE Idris Integration *ale-idris-options*
===============================================================================
idris *ale-idris-idris*
g:ale_idris_idris_executable *g:ale_idris_idris_executable*
*b:ale_idris_idris_executable*
Type: |String|
Default: `'idris'`
This variable can be changed to change the path to idris.
g:ale_idris_idris_options *g:ale_idris_idris_options*
*b:ale_idris_idris_options*
Type: |String|
Default: `'--total --warnpartial --warnreach --warnipkg'`
This variable can be changed to modify flags given to idris.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

40
sources_non_forked/ale/doc/ale-ink.txt
View File

@ -1,40 +0,0 @@
===============================================================================
ALE Ink Integration *ale-ink-options*
===============================================================================
ink-language-server *ale-ink-language-server*
Ink Language Server
(https://github.com/ephraim/ink-language-server)
g:ale_ink_ls_executable g:ale_ink_ls_executable
b:ale_ink_ls_executable
Type: |String|
Default: `'ink-language-server'`
Ink language server executable.
g:ale_ink_ls_initialization_options
g:ale_ink_ls_initialization_options
b:ale_ink_ls_initialization_options
Type: |Dictionary|
Default: `{}`
Dictionary containing configuration settings that will be passed to the
language server at startup. For certain platforms and certain story
structures, the defaults will suffice. However, many projects will need to
change these settings - see the ink-language-server website for more
information.
An example of setting non-default options:
{
\ 'ink': {
\ 'mainStoryPath': 'init.ink',
\ 'inklecateExecutablePath': '/usr/local/bin/inklecate',
\ 'runThroughMono': v:false
\ }
\}
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

22
sources_non_forked/ale/doc/ale-inko.txt
View File

@ -1,22 +0,0 @@
===============================================================================
ALE Inko Integration *ale-inko-options*
*ale-integration-inko*
===============================================================================
Integration Information
Currently, the only supported linter for Inko is the Inko compiler itself.
===============================================================================
inko *ale-inko-inko*
g:ale_inko_inko_executable *g:ale_inko_inko_executable*
*b:ale_inko_inko_executable*
Type: |String|
Default: `'inko'`
This variable can be modified to change the executable path for `inko`.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

24
sources_non_forked/ale/doc/ale-ispc.txt
View File

@ -1,24 +0,0 @@
===============================================================================
ALE ISPC Integration *ale-ispc-options*
===============================================================================
ispc *ale-ispc-ispc*
g:ale_ispc_ispc_executable *g:ale_ispc_ispc_executable*
*b:ale_ispc_ispc_executable*
Type: |String|
Default: `'ispc'`
This variable can be changed to use a different executable for ispc.
g:ale_ispc_ispc_options *g:ale_ispc_ispc_options*
*b:ale_ispc_ispc_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to ispc.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

284
sources_non_forked/ale/doc/ale-java.txt
View File

@ -1,284 +0,0 @@
===============================================================================
ALE Java Integration *ale-java-options*
===============================================================================
checkstyle *ale-java-checkstyle*
g:ale_java_checkstyle_config *g:ale_java_checkstyle_config*
*b:ale_java_checkstyle_config*
Type: |String|
Default: `'/google_checks.xml'`
A path to a checkstyle configuration file.
If a configuration file is specified with |g:ale_java_checkstyle_options|,
it will be preferred over this setting.
The path to the configuration file can be an absolute path or a relative
path. ALE will search for the relative path in parent directories.
g:ale_java_checkstyle_executable *g:ale_java_checkstyle_executable*
*b:ale_java_checkstyle_executable*
Type: |String|
Default: `'checkstyle'`
This variable can be changed to modify the executable used for checkstyle.
g:ale_java_checkstyle_options *g:ale_java_checkstyle_options*
*b:ale_java_checkstyle_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to checkstyle.
If a configuration file is specified with `-c`, it will be used instead of
configuration files set with |g:ale_java_checkstyle_config|.
===============================================================================
cspell *ale-java-cspell*
See |ale-cspell-options|
===============================================================================
javac *ale-java-javac*
g:ale_java_javac_classpath *g:ale_java_javac_classpath*
*b:ale_java_javac_classpath*
Type: |String| or |List|
Default: `''`
This variable can be set to change the global classpath for Java.
g:ale_java_javac_executable *g:ale_java_javac_executable*
*b:ale_java_javac_executable*
Type: |String|
Default: `'javac'`
This variable can be set to change the executable path used for javac.
g:ale_java_javac_options *g:ale_java_javac_options*
*b:ale_java_javac_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to javac.
g:ale_java_javac_sourcepath *g:ale_java_javac_sourcepath*
*b:ale_java_javac_sourcepath*
Type: |String| or |List|
Default: `''`
This variable can set multiple source code paths, the source code path is a
relative path (relative to the project root directory).
Example:
String type:
Note that the unix system separator is a colon(`:`) window system
is a semicolon(`;`).
>
let g:ale_java_javac_sourcepath = 'build/gen/source/xx/main:build/gen/source'
<
List type:
>
let g:ale_java_javac_sourcepath = [
\ 'build/generated/source/querydsl/main',
\ 'target/generated-sources/source/querydsl/main'
\ ]
<
===============================================================================
google-java-format *ale-java-google-java-format*
g:ale_java_google_java_format_executable
*g:ale_java_google_java_format_executable*
*b:ale_java_google_java_format_executable*
Type: |String|
Default: `'google-java-format'`
See |ale-integrations-local-executables|
g:ale_java_google_java_format_options *g:ale_java_google_java_format_options*
*b:ale_java_google_java_format_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options
===============================================================================
pmd *ale-java-pmd*
g:ale_java_pmd_options *g:ale_java_pmd_options*
*b:ale_java_pmd_options*
Type: |String|
Default: `'-R category/java/bestpractices'`
This variable can be changed to modify flags given to PMD. Do not specify -f
and -d. They are added automatically.
===============================================================================
javalsp *ale-java-javalsp*
To enable Java LSP linter you need to download and build the vscode-javac
language server from https://github.com/georgewfraser/java-language-server.
Before building the language server you need to install pre-requisites: npm,
maven, and protobuf. You also need to have Java 13 and JAVA_HOME properly
set.
After downloading the source code and installing all pre-requisites you can
build the language server with the included build.sh script:
scripts/build.sh
This will create launch scripts for Linux, Mac, and Windows in the dist folder
within the repo:
- lang_server_linux.sh
- lang_server_mac.sh
- lang_server_windows.sh
To let ALE use this language server you need to set the
g:ale_java_javalsp_executable variable to the absolute path of the launcher
executable for your platform.
g:ale_java_javalsp_executable *g:ale_java_javalsp_executable*
*b:ale_java_javalsp_executable*
Type: |String|
Default: `''`
This variable must be set to the absolute path of the language server launcher
executable. For example:
>
let g:ale_java_javalsp_executable=/java-language-server/dist/lang_server_linux.sh
<
g:ale_java_javalsp_config *g:ale_java_javalsp_config*
*b:ale_java_javalsp_config*
Type: |Dictionary|
Default: `{}`
The javalsp linter automatically detects external dependencies for Maven and
Gradle projects. In case the javalsp fails to detect some of them, you can
specify them setting a dictionary to |g:ale_java_javalsp_config| variable.
>
let g:ale_java_javalsp_config =
\ {
\ 'java': {
\ 'externalDependencies': [
\ 'junit:junit:jar:4.12:test', " Maven format
\ 'junit:junit:4.1' " Gradle format
\ ],
\ 'classPath': [
\ 'lib/some-dependency.jar',
\ '/android-sdk/platforms/android-28.jar'
\ ]
\ }
\ }
The Java language server will look for the dependencies you specify in
`externalDependencies` array in your Maven and Gradle caches ~/.m2 and
~/.gradle.
===============================================================================
eclipselsp *ale-java-eclipselsp*
To enable Eclipse JDT LSP linter you need to clone and build the eclipse.jdt.ls
language server from https://github.com/eclipse/eclipse.jdt.ls. Simply
clone the source code repo and then build the plugin:
./mvnw clean verify
Note: currently, the build can only run when launched with JDK 11. More
recent versions can be used to run the server though.
After build completes the files required to run the language server will be
located inside the repository folder `eclipse.jdt.ls`. Please ensure to set
|g:ale_java_eclipselsp_path| to the absolute path of that folder.
You could customize compiler options and code assists of the server.
Under your project folder, modify the file `.settings/org.eclipse.jdt.core.prefs`
with options presented at
https://help.eclipse.org/neon/topic/org.eclipse.jdt.doc.isv/reference/api/org/eclipse/jdt/core/JavaCore.html.
g:ale_java_eclipselsp_path *g:ale_java_eclipselsp_path*
*b:ale_java_eclipselsp_path*
Type: |String|
Default: `'$HOME/eclipse.jdt.ls'`
Absolute path to the location of the eclipse.jdt.ls repository folder. Or if
you have VSCode extension installed the absolute path to the VSCode
extensions folder (e.g. $HOME/.vscode/extensions/redhat.java-0.4x.0 in
Linux).
g:ale_java_eclipselsp_executable *g:ale_java_eclipse_executable*
*b:ale_java_eclipse_executable*
Type: |String|
Default: `'java'`
This variable can be set to change the executable path used for java.
g:ale_java_eclipselsp_config_path *g:ale_java_eclipse_config_path*
*b:ale_java_eclipse_config_path*
Type: |String|
Default: `''`
Set this variable to change the configuration directory path used by
eclipselsp (e.g. `$HOME/.jdtls` in Linux).
By default ALE will attempt to use the configuration within the installation
directory.
This setting is particularly useful when eclipselsp is installed in a
non-writable directory like `/usr/share/java/jdtls`, as is the case when
installed via system package.
g:ale_java_eclipselsp_workspace_path *g:ale_java_eclipselsp_workspace_path*
*b:ale_java_eclipselsp_workspace_path*
Type: |String|
Default: `''`
If you have Eclipse installed is good idea to set this variable to the
absolute path of the Eclipse workspace. If not set this value will be set to
the parent folder of the project root.
g:ale_java_eclipselsp_javaagent *g:ale_java_eclipselsp_javaagent*
*b:ale_java_eclipselsp_javaagent*
Type: |String|
Default: `''`
A variable to add java agent for annotation processing such as Lombok.
If you have multiple java agent files, use space to separate them.
For example:
>
let g:ale_java_eclipselsp_javaagent='/eclipse/lombok.jar /eclipse/jacoco.jar'
<
===============================================================================
uncrustify *ale-java-uncrustify*
See |ale-c-uncrustify| for information about the available options.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

354
sources_non_forked/ale/doc/ale-javascript.txt
View File

@ -1,354 +0,0 @@
===============================================================================
ALE JavaScript Integration *ale-javascript-options*
*ale-eslint-nested-configuration-files*
For fixing files with ESLint, nested configuration files with `root: false`
are not supported. This is because ALE fixes files by writing the contents of
buffers to temporary files, and then explicitly sets the configuration file.
Configuration files which are set explicitly must be root configuration files.
If you are using nested configuration files, you should restructure your
project so your configuration files use `extends` instead.
See the ESLint documentation here:
http://eslint.org/docs/user-guide/configuring#extending-configuration-files
You should change the structure of your project from this: >
/path/foo/.eslintrc.js # root: true
/path/foo/bar/.eslintrc.js # root: false
<
To this: >
/path/foo/.base-eslintrc.js # Base configuration here
/path/foo/.eslintrc.js # extends: ["/path/foo/.base-eslintrc.js"]
/path/foo/bar/.eslintrc.js # extends: ["/path/foo/.base-eslintrc.js"]
<
===============================================================================
cspell *ale-javascript-cspell*
See |ale-cspell-options|
===============================================================================
deno *ale-javascript-deno*
Check the docs over at |ale-typescript-deno|.
===============================================================================
dprint *ale-javascript-dprint*
See |ale-dprint-options| and https://dprint.dev/plugins/typescript
===============================================================================
eslint *ale-javascript-eslint*
g:ale_javascript_eslint_executable *g:ale_javascript_eslint_executable*
*b:ale_javascript_eslint_executable*
Type: |String|
Default: `'eslint'`
See |ale-integrations-local-executables|
g:ale_javascript_eslint_options *g:ale_javascript_eslint_options*
*b:ale_javascript_eslint_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to eslint.
g:ale_javascript_eslint_use_global *g:ale_javascript_eslint_use_global*
*b:ale_javascript_eslint_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
g:ale_javascript_eslint_suppress_eslintignore
*g:ale_javascript_eslint_suppress_eslintignore*
*b:ale_javascript_eslint_suppress_eslintignore*
Type: |Number|
Default: `0`
This variable can be set to `1` to disable warnings for files being ignored
by eslint.
g:ale_javascript_eslint_suppress_missing_config
*g:ale_javascript_eslint_suppress_missing_config*
*b:ale_javascript_eslint_suppress_missing_config*
Type: |Number|
Default: `0`
This variable can be set to `1` to disable errors for missing eslint
configuration files.
When turning this option on, eslint will not report any problems when no
configuration files are found.
===============================================================================
fecs *ale-javascript-fecs*
`fecs` is a lint tool for HTML/CSS/JavaScript, can be installed via:
`$ npm install --save-dev fecs`
And the configuration file is located at `./fecsrc`, see http://fecs.baidu.com
for more options.
g:ale_javascript_fecs_executable *g:ale_javascript_fecs_executable*
*b:ale_javascript_fecs_executable*
Type: |String|
Default: `'fecs'`
See |ale-integrations-local-executables|
g:ale_javascript_fecs_use_global *g:ale_javascript_fecs_use_global*
*b:ale_javascript_fecs_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
flow *ale-javascript-flow*
g:ale_javascript_flow_executable *g:ale_javascript_flow_executable*
*b:ale_javascript_flow_executable*
Type: |String|
Default: `'flow'`
See |ale-integrations-local-executables|
g:ale_javascript_flow_use_home_config *g:ale_javascript_flow_use_home_config*
*b:ale_javascript_flow_use_home_config*
Type: |Number|
Default: `0`
When set to `1`, ALE will allow Flow to be executed with configuration files
from your home directory. ALE will not run Flow with home directory
configuration files by default, as doing so can lead to Vim consuming all of
your RAM and CPU power.
g:ale_javascript_flow_use_global *g:ale_javascript_flow_use_global*
*b:ale_javascript_flow_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
g:ale_javascript_flow_use_respect_pragma
*g:ale_javascript_flow_use_respect_pragma*
*b:ale_javascript_flow_use_respect_pragma*
Type: |Number|
Default: `1`
By default, ALE will use the `--respect-pragma` option for `flow`, so only
files with the `@flow` pragma are checked by ALE. This option can be set to
`0` to disable that behavior, so all files can be checked by `flow`.
===============================================================================
importjs *ale-javascript-importjs*
g:ale_javascript_importjs_executable *g:ale_javascript_importjs_executable*
*b:ale_javascript_importjs_executable*
Type: |String|
Default: `'importjs'`
===============================================================================
jscs *ale-javascript-jscs*
g:ale_javascript_jscs_executable *g:ale_javascript_jscs_executable*
*b:ale_javascript_jscs_executable*
Type: |String|
Default: `'jscs'`
See |ale-integrations-local-executables|
g:ale_javascript_jscs_use_global *g:ale_javascript_jscs_use_global*
*b:ale_javascript_jscs_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
jshint *ale-javascript-jshint*
g:ale_javascript_jshint_executable *g:ale_javascript_jshint_executable*
*b:ale_javascript_jshint_executable*
Type: |String|
Default: `'jshint'`
See |ale-integrations-local-executables|
g:ale_javascript_jshint_use_global *g:ale_javascript_jshint_use_global*
*b:ale_javascript_jshint_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
prettier *ale-javascript-prettier*
g:ale_javascript_prettier_executable *g:ale_javascript_prettier_executable*
*b:ale_javascript_prettier_executable*
Type: |String|
Default: `'prettier'`
See |ale-integrations-local-executables|
g:ale_javascript_prettier_options *g:ale_javascript_prettier_options*
*b:ale_javascript_prettier_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to prettier.
g:ale_javascript_prettier_use_global *g:ale_javascript_prettier_use_global*
*b:ale_javascript_prettier_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
prettier-eslint *ale-javascript-prettier-eslint*
g:ale_javascript_prettier_eslint_executable
*g:ale_javascript_prettier_eslint_executable*
*b:ale_javascript_prettier_eslint_executable*
Type: |String|
Default: `'prettier-eslint'`
See |ale-integrations-local-executables|
g:ale_javascript_prettier_eslint_options
*g:ale_javascript_prettier_eslint_options*
*b:ale_javascript_prettier_eslint_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to prettier-eslint.
g:ale_javascript_prettier_eslint_use_global
*g:ale_javascript_prettier_eslint_use_global*
*b:ale_javascript_prettier_eslint_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
prettier-standard *ale-javascript-prettier-standard*
g:ale_javascript_prettier_standard_executable
*g:ale_javascript_prettier_standard_executable*
*b:ale_javascript_prettier_standard_executable*
Type: |String|
Default: `'prettier-standard'`
See |ale-integrations-local-executables|
g:ale_javascript_prettier_standard_options
*g:ale_javascript_prettier_standard_options*
*b:ale_javascript_prettier_standard_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to prettier-standard.
g:ale_javascript_prettier_standard_use_global
*g:ale_javascript_prettier_standard_use_global*
*b:ale_javascript_prettier_standard_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
standard *ale-javascript-standard*
g:ale_javascript_standard_executable *g:ale_javascript_standard_executable*
*b:ale_javascript_standard_executable*
Type: |String|
Default: `'standard'`
See |ale-integrations-local-executables|
g:ale_javascript_standard_options *g:ale_javascript_standard_options*
*b:ale_javascript_standard_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to standard.
g:ale_javascript_standard_use_global *g:ale_javascript_standard_use_global*
*b:ale_javascript_standard_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
xo *ale-javascript-xo*
g:ale_javascript_xo_executable *g:ale_javascript_xo_executable*
*b:ale_javascript_xo_executable*
Type: |String|
Default: `'xo'`
See |ale-integrations-local-executables|
g:ale_javascript_xo_options *g:ale_javascript_xo_options*
*b:ale_javascript_xo_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to xo.
g:ale_javascript_xo_use_global *g:ale_javascript_xo_use_global*
*b:ale_javascript_xo_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

170
sources_non_forked/ale/doc/ale-json.txt
View File

@ -1,170 +0,0 @@
===============================================================================
ALE JSON Integration *ale-json-options*
===============================================================================
cspell *ale-json-cspell*
See |ale-cspell-options|
===============================================================================
dprint *ale-json-dprint*
See |ale-dprint-options| and https://dprint.dev/plugins/json
===============================================================================
eslint *ale-json-eslint*
The `eslint` linter for JSON uses the JavaScript options for `eslint`; see:
|ale-javascript-eslint|.
You will need a JSON ESLint plugin installed for this to work.
===============================================================================
fixjson *ale-json-fixjson*
fixjson is a JSON file fixer/formatter for humans using (relaxed) JSON5.
It provides:
- Pretty-prints JSON input
- Fixes various failures while humans writing JSON
- Fixes trailing commas objects or arrays
- Fixes missing commas for elements of objects or arrays
- Adds quotes to keys in objects
- Newlines in strings
- Hex numbers
- Fixes single quotes to double quotes
You can install it using npm:
>
$ npm install -g fixjson
<
ALE provides fixjson integration as a fixer. See |ale-fix|.
g:ale_json_fixjson_executable *g:ale_json_fixjson_executable*
*b:ale_json_fixjson_executable*
Type: |String|
Default: `'fixjson'`
The executable that will be run for fixjson.
g:ale_json_fixjson_options *g:ale_json_fixjson_options*
*b:ale_json_fixjson_options*
Type: |String|
Default: `''`
This variable can add extra options to the command executed for running
fixjson.
g:ale_json_fixjson_use_global *g:ale_json_fixjson_use_global*
*b:ale_json_fixjson_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
jsonlint *ale-json-jsonlint*
g:ale_json_jsonlint_executable *g:ale_json_jsonlint_executable*
*b:ale_json_jsonlint_executable*
Type: |String|
Default: `'jsonlint'`
The executable that will be run for jsonlint.
g:ale_json_jsonlint_use_global *g:ale_json_jsonlint_use_global*
*b:ale_json_jsonlint_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
jq *ale-json-jq*
g:ale_json_jq_executable *g:ale_json_jq_executable*
*b:ale_json_jq_executable*
Type: |String|
Default: `'jq'`
This option can be changed to change the path for `jq`.
g:ale_json_jq_options *g:ale_json_jq_options*
*b:ale_json_jq_options*
Type: |String|
Default: `''`
This option can be changed to pass extra options to `jq`.
g:ale_json_jq_filters *g:ale_json_jq_filters*
*b:ale_json_jq_filters*
Type: |String|
Default: `'.'`
This option can be changed to pass custom filters to `jq`.
===============================================================================
prettier *ale-json-prettier*
See |ale-javascript-prettier| for information about the available options.
===============================================================================
spectral *ale-json-spectral*
Website: https://github.com/stoplightio/spectral
Installation
-------------------------------------------------------------------------------
Install spectral either globally or locally: >
npm install @stoplight/spectral -g # global
npm install @stoplight/spectral # local
<
Options
-------------------------------------------------------------------------------
g:ale_json_spectral_executable *g:ale_json_spectral_executable*
*b:ale_json_spectral_executable*
Type: |String|
Default: `'spectral'`
This variable can be set to change the path to spectral.
g:ale_json_spectral_use_global *g:ale_json_spectral_use_global*
*b:ale_json_spectral_use_global*
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
vscodejson *ale-json-vscode*
Website: https://github.com/hrsh7th/vscode-langservers-extracted
Installation
-------------------------------------------------------------------------------
Install VSCode json language server either globally or locally: >
npm install -g vscode-langservers-extracted
<
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

15
sources_non_forked/ale/doc/ale-json5.txt
View File

@ -1,15 +0,0 @@
===============================================================================
ALE JSON5 Integration *ale-json5-options*
===============================================================================
eslint *ale-json5-eslint*
The `eslint` linter for JSON uses the JavaScript options for `eslint`; see:
|ale-javascript-eslint|.
You will need a JSON5 ESLint plugin installed for this to work.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

15
sources_non_forked/ale/doc/ale-jsonc.txt
View File

@ -1,15 +0,0 @@
===============================================================================
ALE JSONC Integration *ale-jsonc-options*
===============================================================================
eslint *ale-jsonc-eslint*
The `eslint` linter for JSON uses the JavaScript options for `eslint`; see:
|ale-javascript-eslint|.
You will need a JSONC ESLint plugin installed for this to work.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

43
sources_non_forked/ale/doc/ale-jsonnet.txt
View File

@ -1,43 +0,0 @@
===============================================================================
ALE Jsonnet Integration *ale-jsonnet-options*
===============================================================================
jsonnetfmt *ale-jsonnet-jsonnetfmt*
g:ale_jsonnet_jsonnetfmt_executable *g:ale_jsonnet_jsonnetfmt_executable*
*b:ale_jsonnet_jsonnetfmt_executable*
Type: |String|
Default: `'jsonnetfmt'`
This option can be changed to change the path for `jsonnetfmt`.
g:ale_jsonnet_jsonnetfmt_options *g:ale_jsonnet_jsonnetfmt_options*
*b:ale_jsonnet_jsonnetfmt_options*
Type: |String|
Default: `''`
This option can be changed to pass extra options to `jsonnetfmt`.
===============================================================================
jsonnet-lint *ale-jsonnet-jsonnet-lint*
g:ale_jsonnet_jsonnet_lint_executable *g:ale_jsonnet_jsonnet_lint_executable*
*b:ale_jsonnet_jsonnet_lint_executable*
Type: |String|
Default: `'jsonnet-lint'`
This option can be changed to change the path for `jsonnet-lint`.
g:ale_jsonnet_jsonnet_lint_options *g:ale_jsonnet_jsonnet_lint_options*
*b:ale_jsonnet_jsonnet_lint_options*
Type: |String|
Default: `''`
This option can be changed to pass extra options to `jsonnet-lint`.
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

20
sources_non_forked/ale/doc/ale-julia.txt
View File

@ -1,20 +0,0 @@
===============================================================================
ALE Julia Integration *ale-julia-options*
===============================================================================
languageserver *ale-julia-languageserver*
To enable Julia LSP linter you need to install the LanguageServer.jl package
within julia.
g:ale_julia_executable *g:ale_julia_executable*
*b:ale_julia_executable*
Type: |String|
Default: `'julia'`
Path to the julia exetuable.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

113
sources_non_forked/ale/doc/ale-kotlin.txt
View File

@ -1,113 +0,0 @@
===============================================================================
ALE Kotlin Integration *ale-kotlin-options*
*ale-integration-kotlin*
===============================================================================
Integration Information
Make sure your setup has support for the kotlin file type. A filetype plugin
can be found here: https://github.com/udalov/kotlin-vim
Note: Make sure you have a working kotlin compiler
===============================================================================
kotlinc *ale-kotlin-kotlinc*
g:ale_kotlin_kotlinc_options *g:ale_kotlin_kotlinc_options*
Type: |String|
Default: `''`
Additional options to pass to the kotlin compiler
g:ale_kotlin_kotlinc_enable_config *g:ale_kotlin_kotlinc_enable_config*
Type: |Number|
Default: `0`
Setting this variable to `1` tells the linter to load a configuration file.
This should be set in your vimrc
g:ale_kotlin_kotlinc_config_file *g:ale_kotlin_kotlinc_config_file*
Type: |String|
Default: `'.ale_kotlin_kotlinc_config'`
Filename of the configuration file. This should be set in your vimrc
g:ale_kotlin_kotlinc_classpath *g:ale_kotlin_kotlinc_classpath*
Type: |String|
Default: `''`
A string containing the paths (separated by the appropriate path separator)
of the source directories.
g:ale_kotlin_kotlinc_sourcepath *g:ale_kotlin_kotlinc_sourcepath*
Type: |String|
Default: `''`
A string containing the paths (separated by space) of the source
directories.
g:ale_kotlin_kotlinc_use_module_file *g:ale_kotlin_kotlinc_use_module_file*
Type: |Number|
Default: `0`
This option indicates whether the linter should use a module file. It is off
by default.
g:ale_kotlin_kotlinc_module_filename *g:ale_kotlin_kotlinc_module_filename*
Type: |String|
Default: `'module.xml'`
The filename of the module file that the linter should pass to the kotlin
compiler.
===============================================================================
ktlint *ale-kotlin-ktlint*
g:ale_kotlin_ktlint_executable *g:ale_kotlin_ktlint_executable*
Type: |String|
Default: `''`
The Ktlint executable.
Posix-compliant shell scripts are the only executables that can be found on
Ktlint's github release page. If you are not on such a system, your best
bet will be to download the ktlint jar and set this option to something
similar to `'java -jar /path/to/ktlint.jar'`
g:ale_kotlin_ktlint_rulesets *g:ale_kotlin_ktlint_rulesets*
Type: |List| of |String|s
Default: `[]`
This list should contain paths to ruleset jars and/or strings of maven
artifact triples. Example:
>
let g:ale_kotlin_ktlint_rulesets = ['/path/to/custom-ruleset.jar',
'com.ktlint.rulesets:mycustomrule:1.0.0']
g:ale_kotlin_ktlint_options *g:ale_kotlin_ktlint_options*
Type: |String|
Default: `''`
Additional options to pass to ktlint for both linting and fixing. Example:
>
let g:ale_kotlin_ktlint_options = '--android'
===============================================================================
languageserver *ale-kotlin-languageserver*
g:ale_kotlin_languageserver_executable *g:ale_kotlin_languageserver_executable*
Type: |String|
Default: `''`
The kotlin-language-server executable.
Executables are located inside the bin/ folder of the language server
release.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

21
sources_non_forked/ale/doc/ale-latex.txt
View File

@ -1,21 +0,0 @@
===============================================================================
ALE LaTeX Integration *ale-latex-options*
===============================================================================
cspell *ale-latex-cspell*
===============================================================================
write-good *ale-latex-write-good*
See |ale-write-good-options|
===============================================================================
textlint *ale-latex-textlint*
See |ale-text-textlint|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

66
sources_non_forked/ale/doc/ale-less.txt
View File

@ -1,66 +0,0 @@
===============================================================================
ALE Less Integration *ale-less-options*
===============================================================================
lessc *ale-less-lessc*
g:ale_less_lessc_executable *g:ale_less_lessc_executable*
*b:ale_less_lessc_executable*
Type: |String|
Default: `'lessc'`
See |ale-integrations-local-executables|
g:ale_less_lessc_options *g:ale_less_lessc_options*
*b:ale_less_lessc_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to lessc.
g:ale_less_lessc_use_global *g:ale_less_lessc_use_global*
*b:ale_less_lessc_use_global*
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
prettier *ale-less-prettier*
See |ale-javascript-prettier| for information about the available options.
===============================================================================
stylelint *ale-less-stylelint*
g:ale_less_stylelint_executable *g:ale_less_stylelint_executable*
*b:ale_less_stylelint_executable*
Type: |String|
Default: `'stylelint'`
See |ale-integrations-local-executables|
g:ale_less_stylelint_options *g:ale_less_stylelint_options*
*b:ale_less_stylelint_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to stylelint.
g:ale_less_stylelint_use_global *g:ale_less_stylelint_use_global*
*b:ale_less_stylelint_use_global*
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

19
sources_non_forked/ale/doc/ale-llvm.txt
View File

@ -1,19 +0,0 @@
===============================================================================
ALE LLVM Integration *ale-llvm-options*
===============================================================================
llc *ale-llvm-llc*
g:ale_llvm_llc_executable *g:ale_llvm_llc_executable*
*b:ale_llvm_llc_executable*
Type: |String|
Default: `"llc"`
The command to use for checking. This variable is useful when llc command
has suffix like "llc-5.0".
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

118
sources_non_forked/ale/doc/ale-lua.txt
View File

@ -1,118 +0,0 @@
===============================================================================
ALE Lua Integration *ale-lua-options*
===============================================================================
cspell *ale-lua-cspell*
See |ale-cspell-options|
===============================================================================
lua-format *ale-lua-lua-format*
g:ale_lua_lua_format_executable *g:ale_lua_lua_format_executable*
*b:ale_lua_lua_format_executable*
Type: |String|
Default: `'lua-format'`
This variable can be changed to change the path to lua-format.
g:ale_lua_lua_format_options *g:ale_lua_lua_format_options*
*b:ale_lua_lua_format_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to lua-format.
===============================================================================
luac *ale-lua-luac*
g:ale_lua_luac_executable *g:ale_lua_luac_executable*
*b:ale_lua_luac_executable*
Type: |String|
Default: `'luac'`
This variable can be changed to change the path to luac.
===============================================================================
luacheck *ale-lua-luacheck*
g:ale_lua_luacheck_executable *g:ale_lua_luacheck_executable*
*b:ale_lua_luacheck_executable*
Type: |String|
Default: `'luacheck'`
This variable can be changed to change the path to luacheck.
g:ale_lua_luacheck_options *g:ale_lua_luacheck_options*
*b:ale_lua_luacheck_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to luacheck.
===============================================================================
luafmt *ale-lua-luafmt*
g:ale_lua_luafmt_executable *g:ale_lua_luafmt_executable*
*b:ale_lua_luafmt_executable*
Type: |String|
Default: `'luafmt'`
This variable can be set to use a different executable for luafmt.
g:ale_lua_luafmt_options *g:ale_lua_luafmt_options*
*b:ale_lua_luafmt_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the luafmt fixer.
===============================================================================
selene *ale-lua-selene*
g:ale_lua_selene_executable *g:ale_lua_selene_executable*
*b:ale_lua_selene_executable*
Type: |String|
Default: `'selene'`
This variable can be set to use a different executable for selene.
g:ale_lua_selene_options *g:ale_lua_selene_options*
*b:ale_lua_selene_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to selene.
===============================================================================
stylua *ale-lua-stylua*
g:ale_lua_stylua_executable *g:ale_lua_stylua_executable*
*b:ale_lua_stylua_executable*
Type: |String|
Default: `'stylua'`
This variable can be set to use a different executable for stylua.
g:ale_lua_stylua_options *g:ale_lua_stylua_options*
*b:ale_lua_stylua_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the stylua fixer.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

18
sources_non_forked/ale/doc/ale-make.txt
View File

@ -1,18 +0,0 @@
===============================================================================
ALE Make Integration *ale-make-options*
===============================================================================
checkmake *ale-make-checkmake*
g:ale_make_checkmake_config *g:ale_make_checkmake_config*
*b:ale_make_checkmake_config*
Type: |String|
Default: `''`
This variable can be used to set the `--config` option of checkmake command.
if the value is empty, the checkmake command will not be invoked with the
option.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

113
sources_non_forked/ale/doc/ale-markdown.txt
View File

@ -1,113 +0,0 @@
===============================================================================
ALE Markdown Integration *ale-markdown-options*
===============================================================================
cspell *ale-markdown-cspell*
See |ale-cspell-options|
===============================================================================
dprint *ale-markdown-dprint*
See |ale-dprint-options| and https://dprint.dev/plugins/markdown
===============================================================================
markdownlint *ale-markdown-markdownlint*
g:ale_markdown_markdownlint_options *g:ale_markdown_markdownlint_options*
*b:ale_markdown_markdownlint_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to markdownlint.
===============================================================================
mdl *ale-markdown-mdl*
g:ale_markdown_mdl_executable *g:ale_markdown_mdl_executable*
*b:ale_markdown_mdl_executable*
Type: |String|
Default: `'mdl'`
Override the invoked mdl binary. This is useful for running mdl from
binstubs or a bundle.
g:ale_markdown_mdl_options *g:ale_markdown_mdl_options*
*b:ale_markdown_mdl_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to mdl.
===============================================================================
pandoc *ale-markdown-pandoc*
g:ale_markdown_pandoc_executable *g:ale_markdown_pandoc_executable*
*b:ale_markdown_pandoc_executable*
Type: |String|
Default: `'pandoc'`
This variable can be set to specify where to find the pandoc executable
g:ale_markdown_pandoc_options *g:ale_markdown_pandoc_options*
*b:ale_markdown_pandoc_options*
Type: |String|
Default: `'-f gfm -t gfm -s -'`
This variable can be set to change the default options passed to pandoc
===============================================================================
prettier *ale-markdown-prettier*
See |ale-javascript-prettier| for information about the available options.
===============================================================================
remark-lint *ale-markdown-remark-lint*
g:ale_markdown_remark_lint_executable *g:ale_markdown_remark_lint_executable*
*b:ale_markdown_remark_lint_executable*
Type: |String|
Default: `'remark'`
See |ale-integrations-local-executables|
g:ale_markdown_remark_lint_options *g:ale_markdown_remark_lint_options*
*b:ale_markdown_remark_lint_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to remark-lint.
g:ale_markdown_remark_lint_use_global *g:ale_markdown_remark_lint_use_global*
*b:ale_markdown_remark_lint_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
textlint *ale-markdown-textlint*
See |ale-text-textlint|
===============================================================================
write-good *ale-markdown-write-good*
See |ale-write-good-options|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

26
sources_non_forked/ale/doc/ale-mercury.txt
View File

@ -1,26 +0,0 @@
===============================================================================
ALE Mercury Integration *ale-mercury-options*
===============================================================================
mmc *ale-mercury-mmc*
g:ale_mercury_mmc_executable *g:ale_mercury_mmc_executable*
*b:ale_mercury_mmc_executable*
Type: |String|
Default: `'mmc'`
This variable can be changed to use a different executable for mmc.
g:ale_mercury_mmc_options *g:ale_mercury_mmc_options*
*b:ale_mercury_mmc_options*
Type: |String|
Default: `'--make --output-compile-error-lines 100'`
This variable can be set to pass additional options to mmc.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

26
sources_non_forked/ale/doc/ale-nasm.txt
View File

@ -1,26 +0,0 @@
===============================================================================
ALE NASM Integration *ale-nasm-options*
===============================================================================
nasm *ale-nasm-nasm*
g:ale_nasm_nasm_executable *g:ale_nasm_nasm_executable*
*b:ale_nasm_nasm_executable*
Type: |String|
Default `'nasm'`
This variable can be changed to use different executable for NASM.
g:ale_nasm_nasm_options *g:ale_nasm_nasm_options*
*b:ale_nasm_nasm_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to NASM.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

45
sources_non_forked/ale/doc/ale-nim.txt
View File

@ -1,45 +0,0 @@
===============================================================================
ALE Nim Integration *ale-nim-options*
===============================================================================
nimcheck *ale-nim-nimcheck*
ALE does not provide additional configuration options for `nimcheck` at this
point.
===============================================================================
nimlsp *ale-nim-nimlsp*
g:nim_nimlsp_nim_sources *g:nim_nimlsp_nim_sources*
Type: |String|
Default: `''`
Sets the path to Nim source repository as the first argument to `nimlsp`
command.
===============================================================================
nimpretty *ale-nim-nimpretty*
g:ale_nim_nimpretty_executable *g:ale_nim_nimpretty_executable*
*b:ale_nim_nimpretty_executable*
Type: |String|
Default: `'nimpretty'`
This variable can be changed to use a different executable for nimpretty.
g:ale_nim_nimpretty_options *g:ale_nim_nimpretty_options*
*b:ale_nim_nimpretty_options*
Type: |String|
Default: `'--maxLineLen:80'`
This variable can be changed to modify flags given to nimpretty.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

79
sources_non_forked/ale/doc/ale-nix.txt
View File

@ -1,79 +0,0 @@
===============================================================================
ALE Nix Integration *ale-nix-options*
===============================================================================
nixfmt *ale-nix-nixfmt*
g:ale_nix_nixfmt_executable *g:ale_nix_nixfmt_executable*
*b:ale_nix_nixfmt_executable*
Type: |String|
Default: `'nixfmt'`
This variable sets the executable used for nixfmt.
g:ale_nix_nixfmt_options *g:ale_nix_nixfmt_options*
*b:ale_nix_nixfmt_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the nixfmt fixer.
===============================================================================
nixpkgs-fmt *ale-nix-nixpkgs-fmt*
g:ale_nix_nixpkgsfmt_executable *g:ale_nix_nixpkgsfmt_executable*
*b:ale_nix_nixpkgsfmt_executable*
Type: |String|
Default: `'nixpkgs-fmt'`
This variable sets executable used for nixpkgs-fmt.
g:ale_nix_nixpkgsfmt_options *g:ale_nix_nixpkgsfmt_options*
*b:ale_nix_nixpkgsfmt_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the nixpkgs-fmt
fixer.
===============================================================================
statix *ale-nix-statix*
g:ale_nix_statix_check_executable *g:ale_nix_statix_check_executable*
*b:ale_nix_statix_check_executable*
Type: |String|
Default: `'statix'`
This variable sets the executable used for statix when running it as a
linter.
g:ale_nix_statix_check_options *g:ale_nix_statix_check_options*
*b:ale_nix_statix_check_options*
Type: |String|
Default: `''`
This variable can be used to pass additional options to statix when running
it as a linter.
g:ale_nix_statix_fix_executable *g:ale_nix_fix_check_executable*
*b:ale_nix_fix_check_executable*
Type: |String|
Default: `'statix'`
This variable sets the executable used for statix when running it as a
fixer.
g:ale_nix_statix_fix_options *g:ale_nix_statix_fix_options*
*b:ale_nix_statix_fix_options*
Type: |String|
Default: `''`
This variable can be used to pass additional options to statix when running
it as a fixer.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

12
sources_non_forked/ale/doc/ale-nroff.txt
View File

@ -1,12 +0,0 @@
===============================================================================
ALE nroff Integration *ale-nroff-options*
===============================================================================
write-good *ale-nroff-write-good*
See |ale-write-good-options|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

73
sources_non_forked/ale/doc/ale-objc.txt
View File

@ -1,73 +0,0 @@
===============================================================================
ALE Objective-C Integration *ale-objc-options*
===============================================================================
clang *ale-objc-clang*
g:ale_objc_clang_options *g:ale_objc_clang_options*
*b:ale_objc_clang_options*
Type: |String|
Default: `'-std=c11 -Wall'`
This variable can be changed to modify flags given to clang.
===============================================================================
clangd *ale-objc-clangd*
g:ale_objc_clangd_executable *g:ale_objc_clangd_executable*
*b:ale_objc_clangd_executable*
Type: |String|
Default: `'clangd'`
This variable can be changed to use a different executable for clangd.
g:ale_objc_clangd_options *g:ale_objc_clangd_options*
*b:ale_objc_clangd_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to clangd.
===============================================================================
uncrustify *ale-objc-uncrustify*
See |ale-c-uncrustify| for information about the available options.
===============================================================================
ccls *ale-objc-ccls*
g:ale_objc_ccls_executable *g:ale_objc_ccls_executable*
*b:ale_objc_ccls_executable*
Type: |String|
Default: `'ccls'`
This variable can be changed to use a different executable for ccls.
g:ale_objc_ccls_init_options *g:ale_objc_ccls_init_options*
*b:ale_objc_ccls_init_options*
Type: |Dictionary|
Default: `{}`
This variable can be changed to customize ccls initialization options.
Example: >
{
\ 'cacheDirectory': '/tmp/ccls',
\ 'cacheFormat': 'binary',
\ 'diagnostics': {
\ 'onOpen': 0,
\ 'opChange': 1000,
\ },
\ }
<
Visit https://github.com/MaskRay/ccls/wiki/Initialization-options for all
available options and explanations.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

42
sources_non_forked/ale/doc/ale-objcpp.txt
View File

@ -1,42 +0,0 @@
===============================================================================
ALE Objective-C++ Integration *ale-objcpp-options*
===============================================================================
clang *ale-objcpp-clang*
g:ale_objcpp_clang_options *g:ale_objcpp_clang_options*
*b:ale_objcpp_clang_options*
Type: |String|
Default: `'-std=c++14 -Wall'`
This variable can be changed to modify flags given to clang.
===============================================================================
clangd *ale-objcpp-clangd*
g:ale_objcpp_clangd_executable *g:ale_objcpp_clangd_executable*
*b:ale_objcpp_clangd_executable*
Type: |String|
Default: `'clangd'`
This variable can be changed to use a different executable for clangd.
g:ale_objcpp_clangd_options *g:ale_objcpp_clangd_options*
*b:ale_objcpp_clangd_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to clangd.
===============================================================================
uncrustify *ale-objcpp-uncrustify*
See |ale-c-uncrustify| for information about the available options.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

117
sources_non_forked/ale/doc/ale-ocaml.txt
View File

@ -1,117 +0,0 @@
===============================================================================
ALE OCaml Integration *ale-ocaml-options*
===============================================================================
dune *ale-ocaml-dune*
Dune is a build system for OCaml projects. The `dune format` command is
supported for automatically formatting `dune` and `dune-project` files.
g:ale_ocaml_dune_executable *g:ale_ocaml_dune_executable*
*b:ale_ocaml_dune_executable*
Type: |String|
Default: `'dune'`
This variable can be set to pass the path to dune.
g:ale_ocaml_dune_options *g:ale_ocaml_dune_options*
*b:ale_ocaml_dune_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the dune fixer.
===============================================================================
merlin *ale-ocaml-merlin*
To use merlin linter for OCaml source code you need to make sure Merlin for
Vim is correctly configured. See the corresponding Merlin wiki page for
detailed instructions
(https://github.com/the-lambda-church/merlin/wiki/vim-from-scratch).
===============================================================================
ocamllsp *ale-ocaml-ocamllsp*
The `ocaml-lsp-server` is the official OCaml implementation of the Language
Server Protocol. See the installation instructions:
https://github.com/ocaml/ocaml-lsp#installation
g:ale_ocaml_ocamllsp_use_opam *g:ale_ocaml_ocamllsp_use_opam*
*b:ale_ocaml_ocamllsp_use_opam*
Type: |Number|
Default: `get(g:, 'ale_ocaml_ocamllsp_use_opam', 1)`
This variable can be set to change whether or not opam is used to execute
the language server.
===============================================================================
ols *ale-ocaml-ols*
The `ocaml-language-server` is the engine that powers OCaml and ReasonML
editor support using the Language Server Protocol. See the installation
instructions:
https://github.com/freebroccolo/ocaml-language-server#installation
g:ale_ocaml_ols_executable *g:ale_ocaml_ols_executable*
*b:ale_ocaml_ols_executable*
Type: |String|
Default: `'ocaml-language-server'`
This variable can be set to change the executable path for `ols`.
g:ale_ocaml_ols_use_global *g:ale_ocaml_ols_use_global*
*b:ale_ocaml_ols_use_global*
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`
This variable can be set to `1` to always use the globally installed
executable. See also |ale-integrations-local-executables|.
===============================================================================
ocamlformat *ale-ocaml-ocamlformat*
g:ale_ocaml_ocamlformat_executable *g:ale_ocaml_ocamlformat_executable*
*b:ale_ocaml_ocamlformat_executable*
Type: |String|
Default: `'ocamlformat'`
This variable can be set to pass the path of the ocamlformat fixer.
g:ale_ocaml_ocamlformat_options *g:ale_ocaml_ocamlformat_options*
*b:ale_ocaml_ocamlformat_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the ocamlformat fixer.
===============================================================================
ocp-indent *ale-ocaml-ocp-indent*
g:ale_ocaml_ocp_indent_executable *g:ale_ocaml_ocp_indent_executable*
*b:ale_ocaml_ocp_indent_executable*
Type: |String|
Default: `ocp-indent`
This variable can be set to pass the path of the ocp-indent.
g:ale_ocaml_ocp_indent_options *g:ale_ocaml_ocp_indent_options*
*b:ale_ocaml_ocp_indent_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the ocp-indent.
g:ale_ocaml_ocp_indent_config *g:ale_ocaml_ocp_indent_config*
*b:ale_ocaml_ocp_indent_config*
Type: |String|
Default: `''`
This variable can be set to pass additional config to the ocp-indent.
Expand after "--config=".
"ocp-indent" can also be enabled from ocamlformat config.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

74
sources_non_forked/ale/doc/ale-openapi.txt
View File

@ -1,74 +0,0 @@
===============================================================================
ALE OpenApi Integration *ale-openapi-options*
===============================================================================
ibm_validator *ale-openapi-ibm-validator*
Website: https://github.com/IBM/openapi-validator
Installation
-------------------------------------------------------------------------------
Install ibm-openapi-validator either globally or locally: >
npm install ibm-openapi-validator -g # global
npm install ibm-openapi-validator # local
<
Configuration
-------------------------------------------------------------------------------
OpenAPI files can be written in YAML or JSON so in order for ALE plugins to
work with these files we must set the buffer |filetype| to either |openapi.yaml|
or |openapi.json| respectively. This causes ALE to lint the file with linters
configured for openapi and yaml files or openapi and json files respectively.
For example setting filetype to |openapi.yaml| on a buffer and the following
|g:ale_linters| configuration will enable linting of openapi files using both
|ibm_validator| and |yamlint|:
>
let g:ale_linters = {
\ 'yaml': ['yamllint'],
\ 'openapi': ['ibm_validator']
\}
<
The following plugin will detect openapi files automatically and set the
filetype to |openapi.yaml| or |openapi.json|:
https://github.com/hsanson/vim-openapi
Options
-------------------------------------------------------------------------------
g:ale_openapi_ibm_validator_executable *g:ale_openapi_ibm_validator_executable*
*b:ale_openapi_ibm_validator_executable*
Type: |String|
Default: `'lint-openapi'`
This variable can be set to change the path to lint-openapi.
g:ale_openapi_ibm_validator_options *g:ale_openapi_ibm_validator_options*
*b:ale_openapi_ibm_validator_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to lint-openapi.
===============================================================================
prettier *ale-openapi-prettier*
See |ale-javascript-prettier| for information about the available options.
===============================================================================
yamllint *ale-openapi-yamllint*
See |ale-yaml-yamllint| for information about the available options.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

25
sources_non_forked/ale/doc/ale-openscad.txt
View File

@ -1,25 +0,0 @@
===============================================================================
ALE OpenSCAD Integration *ale-openscad-options*
===============================================================================
sca2d *ale-openscad-sca2d*
g:ale_openscad_sca2d_executable *g:ale_openscad_sca2d_executable*
*b:ale_openscad_sca2d_executable*
Type: |String|
Default: `'sca2d'`
See |ale-integrations-local-executables|
g:ale_openscad_sca2d_options *g:ale_openscad_sca2d_options*
*b:ale_openscad_sca2d_options*
Type: |String|
Default: `''`
This variable can be set to pass options to sca2d.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

24
sources_non_forked/ale/doc/ale-packer.txt
View File

@ -1,24 +0,0 @@
===============================================================================
ALE Packer Integration *ale-packer-options*
===============================================================================
packer-fmt-fixer *ale-packer-fmt-fixer*
g:ale_packer_fmt_executable *g:ale_packer_fmt_executable*
*b:ale_packer_fmt_executable*
Type: |String|
Default: `'packer'`
This variable can be changed to use a different executable for packer.
g:ale_packer_fmt_options *g:ale_packer_fmt_options*
*b:ale_packer_fmt_options*
Type: |String|
Default: `''`
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

24
sources_non_forked/ale/doc/ale-pascal.txt
View File

@ -1,24 +0,0 @@
===============================================================================
ALE Pascal Integration *ale-pascal-options*
===============================================================================
ptop *ale-pascal-ptop*
g:ale_pascal_ptop_executable *g:ale_pascal_ptop_executable*
*b:ale_pascal_ptop_executable*
Type: |String|
Default: `'ptop'`
This variable can be changed to specify the ptop executable.
g:ale_pascal_ptop_options *g:ale_pascal_ptop_options*
*b:ale_pascal_ptop_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the ptop fixer.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

12
sources_non_forked/ale/doc/ale-pawn.txt
View File

@ -1,12 +0,0 @@
===============================================================================
ALE Pawn Integration *ale-pawn-options*
===============================================================================
uncrustify *ale-pawn-uncrustify*
See |ale-c-uncrustify| for information about the available options.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

91
sources_non_forked/ale/doc/ale-perl.txt
View File

@ -1,91 +0,0 @@
===============================================================================
ALE Perl Integration *ale-perl-options*
ALE offers a few ways to check Perl code. Checking code with `perl` is
disabled by default, as `perl` code cannot be checked without executing it.
Specifically, we use the `-c` flag to see if `perl` code compiles. This does
not execute all of the code in a file, but it does run `BEGIN` and `CHECK`
blocks. See `perl --help` and https://stackoverflow.com/a/12908487/406224
See |g:ale_linters|.
===============================================================================
perl *ale-perl-perl*
g:ale_perl_perl_executable *g:ale_perl_perl_executable*
*b:ale_perl_perl_executable*
Type: |String|
Default: `'perl'`
This variable can be changed to modify the executable used for linting perl.
g:ale_perl_perl_options *g:ale_perl_perl_options*
*b:ale_perl_perl_options*
Type: |String|
Default: `'-c -Mwarnings -Ilib'`
This variable can be changed to alter the command-line arguments to the perl
invocation.
===============================================================================
perlcritic *ale-perl-perlcritic*
g:ale_perl_perlcritic_executable *g:ale_perl_perlcritic_executable*
*b:ale_perl_perlcritic_executable*
Type: |String|
Default: `'perlcritic'`
This variable can be changed to modify the perlcritic executable used for
linting perl.
g:ale_perl_perlcritic_profile *g:ale_perl_perlcritic_profile*
*b:ale_perl_perlcritic_profile*
Type: |String|
Default: `'.perlcriticrc'`
This variable can be changed to modify the perlcritic profile used for
linting perl. The current directory is checked for the file, then the
parent directory, etc, until it finds one. If no matching file is found, no
profile is passed to perlcritic.
Set to an empty string to disable passing a specific profile to perlcritic
with the `'--profile'` option.
To prevent perlcritic from using any profile, set this variable to an empty
string and pass `'--no-profile'`to perlcritic via the
|g:ale_perl_perlcritic_options| variable.
g:ale_perl_perlcritic_options *g:ale_perl_perlcritic_options*
*b:ale_perl_perlcritic_options*
Type: |String|
Default: `''`
This variable can be changed to supply additional command-line arguments to
the perlcritic invocation.
g:ale_perl_perlcritic_showrules *g:ale_perl_perlcritic_showrules*
Type: |Number|
Default: `0`
Controls whether perlcritic rule names are shown after the error message.
Defaults to off to reduce length of message.
===============================================================================
perltidy *ale-perl-perltidy*
g:ale_perl_perltidy_options *g:ale_perl_perltidy_options*
*b:ale_perl_perltidy_options*
Type: |String|
Default: `''`
This variable can be changed to alter the command-line arguments to
the perltidy invocation.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

43
sources_non_forked/ale/doc/ale-perl6.txt
View File

@ -1,43 +0,0 @@
===============================================================================
ALE Perl6 Integration *ale-perl6-options*
Checking code with `perl6` is disabled by default, as `perl6` code cannot be
checked without executing it. Specifically, we use the `-c` flag to see if
`perl6` code compiles. This does not execute all of the code in a file, but it
does run `BEGIN` and `CHECK` blocks. See `perl6 --help`
Full support requires a perl6 implementation that supports the
PERL6_EXCEPTIONS_HANDLER environment variable and JSON error output,
which was specified in 6.d. Rakudo version 2018.08 is the first rakudo release
that supports this. See `perl6 --version` and
https://docs.perl6.org/programs/03-environment-variables.
Without this variable, errors and warnings will appear at line 1, and can be
viewed with ALEDetail. This also serves as a fallback for errors and warnings
that do not trigger JSON output.
See |g:ale_linters|.
===============================================================================
perl6 *ale-perl6-perl6*
g:ale_perl6_perl6_executable *g:ale_perl6_perl6_executable*
*b:ale_perl6_perl6_executable*
Type: |String|
Default: `'perl6'`
This variable can be changed to modify the executable used for linting
perl6.
g:ale_perl6_perl6_options *g:ale_perl6_perl6_options*
*b:ale_perl6_perl6_options*
Type: |String|
Default: `'-c -Ilib'`
This variable can be changed to alter the command-line arguments to the
perl6 invocation.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

367
sources_non_forked/ale/doc/ale-php.txt
View File

@ -1,367 +0,0 @@
===============================================================================
ALE PHP Integration *ale-php-options*
===============================================================================
cspell *ale-php-cspell*
See |ale-cspell-options|
===============================================================================
langserver *ale-php-langserver*
g:ale_php_langserver_executable *g:ale_php_langserver_executable*
*b:ale_php_langserver_executable*
Type: |String|
Default: `'php-language-server.php'`
The variable can be set to configure the executable that will be used for
running the PHP language server. `vendor` directory executables will be
preferred instead of this setting if |g:ale_php_langserver_use_global| is `0`.
See: |ale-integrations-local-executables|
g:ale_php_langserver_use_global *g:ale_php_langserver_use_global*
*b:ale_php_langserver_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
This variable can be set to `1` to force the language server to be run with
the executable set for |g:ale_php_langserver_executable|.
See: |ale-integrations-local-executables|
===============================================================================
phan *ale-php-phan*
WARNING: please use the phan_client linter if you have an configuration file
for your project because the phan will look into your entirely project and
ale will display in the current buffer warnings that may belong to other file.
g:ale_php_phan_minimum_severity *g:ale_php_phan_minimum_severity*
*b:ale_php_phan_minimum_severity*
Type: |Number|
Default: `0`
This variable defines the minimum severity level.
g:ale_php_phan_executable *g:ale_php_phan_executable*
*b:ale_php_phan_executable*
Type: |String|
Default: `'phan'`
This variable sets executable used for phan or phan_client.
g:ale_php_phan_use_client *g:ale_php_phan_use_client*
*b:ale_php_phan_use_client*
Type: |Number|
Default: `get(g:, 'ale_php_phan_use_client', 0)`
This variable can be set to 1 to use the phan_client with phan daemon mode
instead of the phan standalone.
===============================================================================
phpcbf *ale-php-phpcbf*
g:ale_php_phpcbf_executable *g:ale_php_phpcbf_executable*
*b:ale_php_phpcbf_executable*
Type: |String|
Default: `'phpcbf'`
See |ale-integrations-local-executables|
g:ale_php_phpcbf_standard *g:ale_php_phpcbf_standard*
*b:ale_php_phpcbf_standard*
Type: |String|
Default: `''`
This variable can be set to specify the coding standard used by phpcbf. If no
coding standard is specified, phpcbf will default to fixing against the
PEAR coding standard, or the standard you have set as the default.
g:ale_php_phpcbf_use_global *g:ale_php_phpcbf_use_global*
*b:ale_php_phpcbf_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
g:ale_php_phpcbf_options *g:ale_php_phpcbf_options*
*b:ale_php_phpcbf_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to php-cbf
===============================================================================
phpcs *ale-php-phpcs*
g:ale_php_phpcs_executable *g:ale_php_phpcs_executable*
*b:ale_php_phpcs_executable*
Type: |String|
Default: `'phpcs'`
See |ale-integrations-local-executables|
g:ale_php_phpcs_standard *g:ale_php_phpcs_standard*
*b:ale_php_phpcs_standard*
Type: |String|
Default: `''`
This variable can be set to specify the coding standard used by phpcs. If no
coding standard is specified, phpcs will default to checking against the
PEAR coding standard, or the standard you have set as the default.
g:ale_php_phpcs_use_global *g:ale_php_phpcs_use_global*
*b:ale_php_phpcs_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
g:ale_php_phpcs_options *g:ale_php_phpcs_options*
*b:ale_php_phpcs_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to php-cs
===============================================================================
phpmd *ale-php-phpmd*
g:ale_php_phpmd_executable *g:ale_php_phpmd_executable*
*b:ale_php_phpmd_executable*
Type: |String|
Default: `'phpmd'`
This variable sets executable used for phpmd.
g:ale_php_phpmd_ruleset *g:ale_php_phpmd_ruleset*
*b:ale_php_phpmd_ruleset*
Type: |String|
Default: `'cleancode,codesize,controversial,design,naming,unusedcode'`
This variable controls the ruleset used by phpmd. Default is to use all of
the available phpmd rulesets
===============================================================================
phpstan *ale-php-phpstan*
g:ale_php_phpstan_executable *g:ale_php_phpstan_executable*
*b:ale_php_phpstan_executable*
Type: |String|
Default: `'phpstan'`
This variable sets executable used for phpstan.
g:ale_php_phpstan_level *g:ale_php_phpstan_level*
*b:ale_php_phpstan_level*
Type: |String|
Default: `''`
This variable controls the rule levels. 0 is the loosest and 7 is the
strictest. If this option isn't set, the rule level will be controlled by
the configuration file. If no configuration file can be detected, `'7'` will
be used instead.
g:ale_php_phpstan_configuration *g:ale_php_phpstan_configuration*
*b:ale_php_phpstan_configuration*
Type: |String|
Default: `''`
This variable sets path to phpstan configuration file.
g:ale_php_phpstan_autoload *g:ale_php_phpstan_autoload*
*b:ale_php_phpstan_autoload*
Type: |String|
Default: `''`
This variable sets path to phpstan autoload file.
g:ale_php_phpstan_memory_limit *g:ale_php_phpstan_memory-limit*
*b:ale_php_phpstan_memory-limit*
Type: |String|
Default: `''`
This variable sets the memory limit for phpstan analysis. This is a string
in the same format as `php.ini` accepts, e.g. `128M`, `1G`.
===============================================================================
psalm *ale-php-psalm*
g:ale_php_psalm_executable *g:ale_php_psalm_executable*
*b:ale_php_psalm_executable*
Type: |String|
Default: `'psalm'`
This variable sets the executable used for psalm.
g:ale_php_psalm_options *g:ale_php_psalm_options*
*b:ale_php_psalm_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to psalm.
g:ale_php_psalm_use_global *g:ale_php_psalm_use_global*
*b:ale_php_psalm_use_global*
Type: |Boolean|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
php-cs-fixer *ale-php-php-cs-fixer*
g:ale_php_cs_fixer_executable *g:ale_php_cs_fixer_executable*
*b:ale_php_cs_fixer_executable*
Type: |String|
Default: `'php-cs-fixer'`
This variable sets executable used for php-cs-fixer.
g:ale_php_cs_fixer_options *g:ale_php_cs_fixer_options*
*b:ale_php_cs_fixer_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to php-cs-fixer.
g:ale_php_cs_fixer_use_global *g:ale_php_cs_fixer_use_global*
*b:ale_php_cs_fixer_use_global*
Type: |Boolean|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
php *ale-php-php*
g:ale_php_php_executable *g:ale_php_php_executable*
*b:ale_php_php_executable*
Type: |String|
Default: `'php'`
This variable sets the executable used for php.
===============================================================================
pint *ale-php-pint*
g:ale_php_pint_executable *g:ale_php_pint_executable*
*b:ale_php_pint_executable*
Type: |String|
Default: `'pint'`
This variable sets the executable used for pint.
g:ale_php_pint_options *g:ale_php_pint_options*
*b:ale_php_pint_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to pint.
g:ale_php_pint_use_global *g:ale_php_pint_use_global*
*b:ale_php_pint_use_global*
Type: |Boolean|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
tlint *ale-php-tlint*
g:ale_php_tlint_executable *g:ale_php_tlint_executable*
*b:ale_php_tlint_executable*
Type: |String|
Default: `'tlint'`
See |ale-integrations-local-executables|
g:ale_php_tlint_use_global *g:ale_php_tlint_use_global*
*b:ale_php_tlint_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
g:ale_php_tlint_options *g:ale_php_tlint_options*
*b:ale_php_tlint_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to tlint
===============================================================================
intelephense *ale-php-intelephense*
g:ale_php_intelephense_executable *g:ale_php_intelephense_executable*
*b:ale_php_intelephense_executable*
Type: |String|
Default: `'intelephense'`
The variable can be set to configure the executable that will be used for
running the intelephense language server. `node_modules` directory
executable will be preferred instead of this setting if
|g:ale_php_intelephense_use_global| is `0`.
See: |ale-integrations-local-executables|
g:ale_php_intelephense_use_global *g:ale_php_intelephense_use_global*
*b:ale_php_intelephense_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
This variable can be set to `1` to force the language server to be run with
the executable set for |g:ale_php_intelephense_executable|.
See: |ale-integrations-local-executables|
g:ale_php_intelephense_config *g:ale_php_intelephense_config*
*b:ale_php_intelephense_config*
Type: |Dictionary|
Default: `{}`
The initialization options config specified by Intelephense. Refer to the
installation docs provided by intelephense (github.com/bmewburn/intelephense
-docs).
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

12
sources_non_forked/ale/doc/ale-po.txt
View File

@ -1,12 +0,0 @@
===============================================================================
ALE PO Integration *ale-po-options*
===============================================================================
write-good *ale-po-write-good*
See |ale-write-good-options|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

12
sources_non_forked/ale/doc/ale-pod.txt
View File

@ -1,12 +0,0 @@
===============================================================================
ALE Pod Integration *ale-pod-options*
===============================================================================
write-good *ale-pod-write-good*
See |ale-write-good-options|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

25
sources_non_forked/ale/doc/ale-pony.txt
View File

@ -1,25 +0,0 @@
===============================================================================
ALE Pony Integration *ale-pony-options*
===============================================================================
ponyc *ale-pony-ponyc*
g:ale_pony_ponyc_executable *g:ale_pony_ponyc_executable*
*b:ale_pony_ponyc_executable*
Type: |String|
Default: `'ponyc'`
See |ale-integrations-local-executables|
g:ale_pony_ponyc_options *g:ale_pony_ponyc_options*
*b:ale_pony_ponyc_options*
Type: |String|
Default: `'--pass paint'`
This variable can be set to pass options to ponyc.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

75
sources_non_forked/ale/doc/ale-powershell.txt
View File

@ -1,75 +0,0 @@
===============================================================================
ALE PowerShell Integration *ale-powershell-options*
===============================================================================
cspell *ale-powershell-cspell*
See |ale-cspell-options|
===============================================================================
powershell *ale-powershell-powershell*
g:ale_powershell_powershell_executable *g:ale_powershell_powershell_executable*
*b:ale_powershell_powershell_executable*
Type: |String|
Default: `'pwsh'`
This variable can be changed to use a different executable for powershell.
>
" Use powershell.exe rather than the default pwsh
let g:ale_powershell_powershell_executable = 'powershell.exe'
>
===============================================================================
psscriptanalyzer *ale-powershell-psscriptanalyzer*
Installation
-------------------------------------------------------------------------------
Install PSScriptAnalyzer by any means, so long as it can be automatically
imported in PowerShell.
g:ale_powershell_psscriptanalyzer_executable
*g:ale_powershell_psscriptanalyzer_executable*
*b:ale_powershell_psscriptanalyzer_executable*
Type: |String|
Default: `'pwsh'`
This variable sets executable used for powershell.
For example, on Windows you could set powershell to be Windows Powershell:
>
let g:ale_powershell_psscriptanalyzer_executable = 'powershell.exe'
<
g:ale_powershell_psscriptanalyzer_module
*g:ale_powershell_psscriptanalyzer_module*
*b:ale_powershell_psscriptanalyzer_module*
Type: |String
Default: `'psscriptanalyzer'`
This variable sets the name of the psscriptanalyzer module.
for psscriptanalyzer invocation.
g:ale_powershell_psscriptanalyzer_exclusions
*g:ale_powershell_psscriptanalyzer_exclusions*
*b:ale_powershell_psscriptanalyzer_exclusions*
Type: |String|
Default: `''`
Set this variable to exclude test(s) for psscriptanalyzer
(-ExcludeRule option). To exclude more than one option, separate them with
commas.
>
" Suppress Write-Host and Global vars warnings
let g:ale_powershell_psscriptanalyzer_exclusions =
\ 'PSAvoidUsingWriteHost,PSAvoidGlobalVars'
<
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

56
sources_non_forked/ale/doc/ale-prolog.txt
View File

@ -1,56 +0,0 @@
===============================================================================
ALE Prolog Integration *ale-prolog-options*
===============================================================================
swipl *ale-prolog-swipl*
g:ale_prolog_swipl_executable *g:ale_prolog_swipl_executable*
*b:ale_prolog_swipl_executable*
Type: |String|
Default: `'swipl'`
The executable that will be run for the `swipl` linter.
g:ale_prolog_swipl_load *g:ale_prolog_swipl_load*
*b:ale_prolog_swipl_load*
Type: |String|
Default: `'current_prolog_flag(argv, [File]), load_files(File, [sandboxed(true)]), halt.'`
The prolog goals that will be passed to |g:ale_prolog_swipl_executable| with `-g` option.
It does:
1. Takes the first command argument (current file path)
2. Checks (syntactic / semantic) problems and output to stderr
NOTE: `sandboxed(true)` prohibits executing some directives such as 'initialization main'.
g:ale_prolog_swipl_timeout *g:ale_prolog_swipl_timeout*
*b:ale_prolog_swipl_timeout*
Type: |Number|
Default: `3`
Timeout seconds to detect long-running linter.
It is done by setting SIGALRM.
See |g:ale_prolog_swipl_alarm| and |g:ale_prolog_swipl_alarm_handler|.
g:ale_prolog_swipl_alarm *g:ale_prolog_swipl_alarm*
*b:ale_prolog_swipl_alarm*
Type: |String|
Default: `'alarm(%t, (%h), _, [])'`
The prolog goals to be expected to set SIGALRM.
`%t` is replaced by |g:ale_prolog_swipl_timeout|.
`%h` is replaced by |g:ale_prolog_swipl_alarm_handler|.
g:ale_prolog_swipl_alarm_handler *g:ale_prolog_swipl_alarm_handler*
*b:ale_prolog_swipl_alarm_handler*
Type: |String|
Default: `'writeln(user_error, "ERROR: Exceeded %t seconds, Please change g:prolog_swipl_timeout to modify the limit."), halt(1)'`
The prolog goals to be expected that will be run on SIGALRM.
`%t` is replaced by |g:ale_prolog_swipl_timeout|.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

98
sources_non_forked/ale/doc/ale-proto.txt
View File

@ -1,98 +0,0 @@
===============================================================================
ALE Proto Integration *ale-proto-options*
===============================================================================
Integration Information
To enable `.proto` file linting, update |g:ale_linters| as appropriate:
>
" Enable linter for .proto files
let g:ale_linters = {'proto': ['buf-lint', 'protoc-gen-lint', 'protolint']}
To enable `.proto` file fixing, update |g:ale_fixers| as appropriate:
>
" Enable linter for .proto files
let b:ale_fixers = {'proto': ['buf-format', 'protolint']}
<
===============================================================================
buf-format *ale-proto-buf-format*
The formatter uses `buf`, a fully-featured Protobuf compiler that doesn't depend
on `protoc`. Make sure the `buf` binary is available in the system path, or
set ale_proto_buf_format_executable.
g:ale_proto_buf_format_executable *g:ale_proto_buf_format_executable*
Type: |String|
Default: `'buf'`
This variable can be changed to modify the executable used for buf.
===============================================================================
buf-lint *ale-proto-buf-lint*
The linter uses `buf`, a fully-featured Protobuf compiler that doesn't depend
on `protoc`. Make sure the `buf` binary is available in the system path, or
set ale_proto_buf_lint_executable.
g:ale_proto_buf_lint_executable *g:ale_proto_buf_lint_executable*
Type: |String|
Default: `'buf'`
This variable can be changed to modify the executable used for buf.
g:ale_proto_buf_lint_config *g:ale_proto_buf_lint_config*
Type: |String|
Default: `''`
A path to a buf configuration file.
The path to the configuration file can be an absolute path or a relative
path. ALE will search for the relative path in parent directories.
===============================================================================
protoc-gen-lint *ale-proto-protoc-gen-lint*
The linter is a plugin for the `protoc` binary. As long as the binary resides
in the system path, `protoc` will find it.
g:ale_proto_protoc_gen_lint_options *g:ale_proto_protoc_gen_lint_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to protoc. Note that the
directory of the linted file is always passed as an include path with '-I'
before any user-supplied options.
===============================================================================
protolint *ale-proto-protolint*
The linter is a pluggable tool that doesn't depend on the `protoc` binary.
This supports both linting and fixing.
Make sure the binary is available in the system path, or set
ale_proto_protolint_executable.
Note that the binary with v0.22.0 or above is supported.
g:ale_proto_protolint_executable *g:ale_proto_protolint_executable*
Type: |String|
Default: `'protolint'`
This variable can be changed to modify the executable used for protolint.
g:ale_proto_protolint_config *g:ale_proto_protolint_config*
Type: |String|
Default: `''`
A path to a protolint configuration file.
The path to the configuration file can be an absolute path or a relative
path. ALE will search for the relative path in parent directories.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

44
sources_non_forked/ale/doc/ale-pug.txt
View File

@ -1,44 +0,0 @@
===============================================================================
ALE Pug Integration *ale-pug-options*
===============================================================================
puglint *ale-pug-puglint*
The puglint linter will detect configuration files based on the path to the
filename automatically. Configuration files will be loaded in this order:
1. `.pug-lintrc`
2. `.pug-lintrc.js`
3. `.pug-lintrc.json`
4. `package.json`
You might need to create a configuration file for your project to get
meaningful results.
g:ale_pug_puglint_executable *g:ale_pug_puglint_executable*
*b:ale_pug_puglint_executable*
Type: |String|
Default: `'pug-lint'`
See |ale-integrations-local-executables|
g:ale_pug_puglint_options *g:ale_pug_puglint_options*
*b:ale_pug_puglint_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to pug-lint.
g:ale_pug_puglint_use_global *g:ale_pug_puglint_use_global*
*b:ale_pug_puglint_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

57
sources_non_forked/ale/doc/ale-puppet.txt
View File

@ -1,57 +0,0 @@
===============================================================================
ALE Puppet Integration *ale-puppet-options*
===============================================================================
puppet *ale-puppet-puppet*
g:ale_puppet_puppet_executable *g:ale_puppet_puppet_executable*
*b:ale_puppet_puppet_executable*
Type: |String|
Default: `'puppet'`
This variable can be changed to specify the executable used for puppet.
g:ale_puppet_puppet_options *g:ale_puppet_puppet_options*
*b:ale_puppet_puppet_options*
Type: |String|
Default: `''`
This variable can be changed to add command-line arguments to the
puppet parser validate invocation.
===============================================================================
puppetlint *ale-puppet-puppetlint*
g:ale_puppet_puppetlint_executable *g:ale_puppet_puppetlint_executable*
*b:ale_puppet_puppetlint_executable*
Type: |String|
Default: `'puppet-lint'`
This variable can be changed to specify the executable used for puppet-lint.
g:ale_puppet_puppetlint_options *g:ale_puppet_puppetlint_options*
*b:ale_puppet_puppetlint_options*
Type: |String|
Default: `'--no-autoloader_layout-check'`
This variable can be changed to add command-line arguments to the
puppet-lint invocation.
===============================================================================
puppet-languageserver *ale-puppet-languageserver*
g:ale_puppet_languageserver_executable *g:ale_puppet_languageserver_executable*
*b:ale_puppet_languageserver_executable*
type: |String|
Default: `'puppet-languageserver'`
This variable can be used to specify the executable used for
puppet-languageserver.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

69
sources_non_forked/ale/doc/ale-purescript.txt
View File

@ -1,69 +0,0 @@
===============================================================================
ALE PureScript Integration *ale-purescript-options*
===============================================================================
purescript-language-server *ale-purescript-language-server*
PureScript Language Server
(https://github.com/nwolverson/purescript-language-server)
g:ale_purescript_ls_executable g:ale_purescript_ls_executable
b:ale_purescript_ls_executable
Type: |String|
Default: `'purescript-language-server'`
PureScript language server executable.
g:ale_purescript_ls_config g:ale_purescript_ls_config
b:ale_purescript_ls_config
Type: |Dictionary|
Default: `{}`
Dictionary containing configuration settings that will be passed to the
language server. For example, with a spago project:
{
\ 'purescript': {
\ 'addSpagoSources': v:true,
\ 'addNpmPath': v:true,
\ 'buildCommand': 'spago --quiet build --purs-args --json-errors'
\ }
\}
===============================================================================
purs-tidy *ale-purescript-tidy*
g:ale_purescript_tidy_executable *g:ale_purescript_tidy_executable*
*b:ale_purescript_tidy_executable*
Type: |String|
Default: `'purs-tidy'`
This variable can be changed to use a different executable for purs-tidy.
g:ale_purescript_tidy_use_global *g:ale_purescript_tidy_use_global*
*b:ale_purescript_tidy_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
g:ale_purescript_tidy_options *g:ale_purescript_tidy_options*
*b:ale_purescript_tidy_options*
Type: |String|
Default: `''`
This variable can be set to pass in additional option to the 'purs-tidy'
executable.
>
let g:ale_purescript_options = '--indent 3'
<
===============================================================================
purty *ale-purescript-purty*
g:ale_purescript_purty_executable *g:ale_purescript_purty_executable*
*b:ale_purescript_purty_executable*
Type: |String|
Default: `'purty'`
This variable can be changed to use a different executable for purty.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

25
sources_non_forked/ale/doc/ale-pyrex.txt
View File

@ -1,25 +0,0 @@
===============================================================================
ALE Pyrex (Cython) Integration *ale-pyrex-options*
===============================================================================
cython *ale-pyrex-cython*
g:ale_pyrex_cython_executable *g:ale_pyrex_cython_executable*
*b:ale_pyrex_cython_executable*
Type: |String|
Default: `'cython'`
This variable can be changed to use a different executable for cython.
g:ale_pyrex_cython_options *g:ale_pyrex_cython_options*
*b:ale_pyrex_cython_options*
Type: |String|
Default: `'--warning-extra --warning-errors'`
This variable can be changed to modify flags given to cython.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

1292
sources_non_forked/ale/doc/ale-python.txt
View File

File diff suppressed because it is too large Load Diff

18
sources_non_forked/ale/doc/ale-qml.txt
View File

@ -1,18 +0,0 @@
===============================================================================
ALE QML Integration *ale-qml-options*
===============================================================================
qmlfmt *ale-qml-qmlfmt*
g:ale_qml_qmlfmt_executable *g:ale_qml_qmlfmt_executable*
*b:ale_qml_qmlfmt_executable*
Type: |String|
Default: `'qmlfmt'`
This variable can be set to change the path to qmlfmt.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

68
sources_non_forked/ale/doc/ale-r.txt
View File

@ -1,68 +0,0 @@
===============================================================================
ALE R Integration *ale-r-options*
===============================================================================
languageserver *ale-r-languageserver*
g:ale_r_languageserver_cmd *g:ale_r_languageserver_cmd*
*b:ale_r_languageserver_cmd*
Type: |String|
Default: `'languageserver::run()'`
This option can be configured to change the execution command for
languageserver.
See the languageserver documentation for more options.
g:ale_r_languageserver_config *g:ale_r_languageserver_config*
*b:ale_r_languageserver_config*
Type: |Dictionary|
Default: `{}`
This option can be configured to change settings for languageserver. See the
languageserver documentation for more information.
===============================================================================
lintr *ale-r-lintr*
g:ale_r_lintr_options *g:ale_r_lintr_options*
*b:ale_r_lintr_options*
Type: |String|
Default: `'lintr::with_defaults()'`
This option can be configured to change the options for lintr.
The value of this option will be run with `eval` for the `lintr::lint`
options. Consult the lintr documentation for more information.
g:ale_r_lintr_lint_package *g:ale_r_lintr_lint_package*
*b:ale_r_lintr_lint_package*
Type: |Number|
Default: `0`
When set to `1`, the file will be checked with `lintr::lint_package` instead
of `lintr::lint`. This prevents erroneous namespace warnings when linting
package files.
===============================================================================
styler *ale-r-styler*
g:ale_r_styler_options *g:ale_r_styler_options*
*b:ale_r_styler_options*
Type: |String|
Default: `'styler::tidyverse_style'`
This option can be configured to change the options for styler.
The value of this option will be used as the `style` argument for the
`styler::style_file` options. Consult the styler documentation
for more information.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

76
sources_non_forked/ale/doc/ale-reasonml.txt
View File

@ -1,76 +0,0 @@
===============================================================================
ALE ReasonML Integration *ale-reasonml-options*
===============================================================================
merlin *ale-reasonml-merlin*
To use merlin linter for ReasonML source code you need to make sure Merlin for
Vim is correctly configured. See the corresponding Merlin wiki page for
detailed instructions:
https://github.com/the-lambda-church/merlin/wiki/vim-from-scratch
===============================================================================
ols *ale-reasonml-ols*
The `ocaml-language-server` is the engine that powers OCaml and ReasonML
editor support using the Language Server Protocol. See the installation
instructions:
https://github.com/freebroccolo/ocaml-language-server#installation
g:ale_reason_ols_executable *g:ale_reason_ols_executable*
*b:ale_reason_ols_executable*
Type: |String|
Default: `'ocaml-language-server'`
This variable can be set to change the executable path for `ols`.
g:ale_reason_ols_use_global *g:ale_reason_ols_use_global*
*b:ale_reason_ols_use_global*
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`
This variable can be set to `1` to always use the globally installed
executable. See also |ale-integrations-local-executables|.
===============================================================================
reason-language-server *ale-reasonml-language-server*
Note: You must set an executable - there is no 'default' install location.
Go to https://github.com/jaredly/reason-language-server and download the
latest release. You can place it anywhere, but ensure you set the executable
path.
g:ale_reason_ls_executable *g:ale_reason_ls_executable*
*b:ale_reason_ls_executable*
Type: |String|
This variable defines the standard location of the language server
executable. This must be set.
===============================================================================
refmt *ale-reasonml-refmt*
g:ale_reasonml_refmt_executable *g:ale_reasonml_refmt_executable*
*b:ale_reasonml_refmt_executable*
Type: |String|
Default: `'refmt'`
This variable can be set to pass the path of the refmt fixer.
g:ale_reasonml_refmt_options *g:ale_reasonml_refmt_options*
*b:ale_reasonml_refmt_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the refmt fixer.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

50
sources_non_forked/ale/doc/ale-rego.txt
View File

@ -1,50 +0,0 @@
===============================================================================
ALE Rego Integration *ale-rego-options*
===============================================================================
cspell *ale-rego-cspell*
See |ale-cspell-options|
===============================================================================
opacheck *ale-rego-opa-check*
g:ale_rego_opacheck_executable *g:rego_opacheck_executable*
*b:rego_opacheck_executable*
Type: |String|
Default: `'opa'`
This variable can be changed to use a different executable for opa.
g:rego_opacheck_options *g:rego_opacheck_options*
*b:rego_opacheck_options*
Type: |String|
Default: `''`
This variable can be changed to pass custom CLI flags to opa check.
===============================================================================
opafmt *ale-rego-opa-fmt-fixer*
g:ale_opa_fmt_executable *g:ale_opa_fmt_executable*
*b:ale_opa_fmt_executable*
Type: |String|
Default: `'opa'`
This variable can be changed to use a different executable for opa.
g:ale_opa_fmt_options *g:ale_opa_fmt_options*
*b:ale_opa_fmt_options*
Type: |String|
Default: `''`
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

33
sources_non_forked/ale/doc/ale-restructuredtext.txt
View File

@ -1,33 +0,0 @@
===============================================================================
ALE reStructuredText Integration *ale-restructuredtext-options*
===============================================================================
cspell *ale-restructuredtext-cspell*
See |ale-cspell-options|
===============================================================================
textlint *ale-restructuredtext-textlint*
To use textlint at reStructuredText, please install `textlint-plugin-rst`.
https://github.com/jimo1001/textlint-plugin-rst
>
$ npm install textlint-plugin-rst
To install `textlint-plugin-rst`, `docutils-ast-writer` python package
must be installed.
See: https://github.com/jimo1001/docutils-ast-writer
See |ale-text-textlint|
===============================================================================
write-good *ale-restructuredtext-write-good*
See |ale-write-good-options|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

16
sources_non_forked/ale/doc/ale-robot.txt
View File

@ -1,16 +0,0 @@
===============================================================================
ALE Robot Integration *ale-robot-options*
===============================================================================
rflint *ale-robot-rflint*
g:ale_robot_rflint_executable *g:ale_robot_rflint_executable*
*b:ale_robot_rflint_executable*
Type: |String|
Default: `'rflint'`
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

243
sources_non_forked/ale/doc/ale-ruby.txt
View File

@ -1,243 +0,0 @@
===============================================================================
ALE Ruby Integration *ale-ruby-options*
===============================================================================
brakeman *ale-ruby-brakeman*
g:ale_ruby_brakeman_executable *g:ale_ruby_brakeman_executable*
*b:ale_ruby_brakeman_executable*
Type: |String|
Default: `'brakeman'`
Override the invoked brakeman binary. Set this to `'bundle'` to invoke
`'bundle` `exec` brakeman'.
g:ale_ruby_brakeman_options *g:ale_ruby_brakeman_options*
*b:ale_ruby_brakeman_options*
Type: |String|
Default: `''`
The contents of this variable will be passed through to brakeman.
===============================================================================
cspell *ale-ruby-cspell*
See |ale-cspell-options|
===============================================================================
debride *ale-ruby-debride*
g:ale_ruby_debride_executable *g:ale_ruby_debride_executable*
*b:ale_ruby_debride_executable*
Type: |String|
Default: `'debride'`
Override the invoked debride binary. Set this to `'bundle'` to invoke
`'bundle` `exec` debride'.
g:ale_ruby_debride_options *g:ale_ruby_debride_options*
*b:ale_ruby_debride_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to debride.
===============================================================================
prettier *ale-ruby-prettier*
See |ale-javascript-prettier| for information about the available options.
===============================================================================
rails_best_practices *ale-ruby-rails_best_practices*
g:ale_ruby_rails_best_practices_executable
*g:ale_ruby_rails_best_practices_executable*
*b:ale_ruby_rails_best_practices_executable*
Type: |String|
Default: `'rails_best_practices'`
Override the invoked rails_best_practices binary. Set this to `'bundle'` to
invoke `'bundle` `exec` rails_best_practices'.
g:ale_ruby_rails_best_practices_options
*g:ale_ruby_rails_best_practices_options*
*b:ale_ruby_rails_best_practices_options*
Type: |String|
Default: `''`
The contents of this variable will be passed through to rails_best_practices.
===============================================================================
reek *ale-ruby-reek*
g:ale_ruby_reek_executable *g:ale_ruby_reek_executable*
*b:ale_ruby_reek_executable*
Type: |String|
Default: `'reek'`
Override the invoked reek binary. Set this to `'bundle'` to invoke
`'bundle` `exec` reek'.
g:ale_ruby_reek_show_context *g:ale_ruby_reek_show_context*
*b:ale_ruby_reek_show_context*
Type: |Number|
Default: `0`
Controls whether context is included in the linter message. Defaults to off
because context is usually obvious while viewing a file.
g:ale_ruby_reek_show_wiki_link *g:ale_ruby_reek_show_wiki_link*
*b:ale_ruby_reek_show_wiki_link*
Type: |Number|
Default: `0`
Controls whether linter messages contain a link to an explanatory wiki page
for the type of code smell. Defaults to off to improve readability.
===============================================================================
rubocop *ale-ruby-rubocop*
g:ale_ruby_rubocop_executable *g:ale_ruby_rubocop_executable*
*b:ale_ruby_rubocop_executable*
Type: |String|
Default: `'rubocop'`
Override the invoked rubocop binary. Set this to `'bundle'` to invoke
`'bundle` `exec` rubocop'.
g:ale_ruby_rubocop_options *g:ale_ruby_rubocop_options*
*b:ale_ruby_rubocop_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to rubocop.
g:ale_ruby_rubocop_auto_correct_all *g:ale_ruby_rubocop_auto_correct_all*
*b:ale_ruby_rubocop_auto_correct_all*
Type: |Number|
Default: `0`
This variable can be changed to make rubocop to correct all offenses (unsafe).
===============================================================================
ruby *ale-ruby-ruby*
g:ale_ruby_ruby_executable *g:ale_ruby_ruby_executable*
*b:ale_ruby_ruby_executable*
Type: |String|
Default: `'ruby'`
This variable can be changed to use a different executable for ruby.
===============================================================================
rufo *ale-ruby-rufo*
g:ale_ruby_rufo_executable *g:ale_ruby_rufo_executable*
*b:ale_ruby_rufo_executable*
Type: |String|
Default: `'rufo'`
Override the invoked rufo binary. This is useful for running rufo from
binstubs or a bundle.
===============================================================================
solargraph *ale-ruby-solargraph*
g:ale_ruby_solargraph_executable *g:ale_ruby_solargraph_executable*
*b:ale_ruby_solargraph_executable*
Type: |String|
Default: `'solargraph'`
Override the invoked solargraph binary. This is useful for running solargraph
from binstubs or a bundle.
===============================================================================
sorbet *ale-ruby-sorbet*
g:ale_ruby_sorbet_executable *g:ale_ruby_sorbet_executable*
*b:ale_ruby_sorbet_executable*
Type: |String|
Default: `'srb'`
Override the invoked sorbet binary. Set this to `'bundle'` to invoke
`'bundle` `exec` srb'.
g:ale_ruby_sorbet_options *g:ale_ruby_sorbet_options*
*b:ale_ruby_sorbet_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to sorbet.
g:ale_ruby_sorbet_enable_watchman *g:ale_ruby_sorbet_enable_watchman*
*b:ale_ruby_sorbet_enable_watchman*
Type: |Number|
Default: `0`
Whether or not to use watchman to let the LSP server to know about changes
to files from outside of vim. Defaults to disable watchman because it
requires watchman to be installed separately from sorbet.
===============================================================================
standardrb *ale-ruby-standardrb*
g:ale_ruby_standardrb_executable *g:ale_ruby_standardrb_executable*
*b:ale_ruby_standardrb_executable*
Type: |String|
Default: `'standardrb'`
Override the invoked standardrb binary. Set this to `'bundle'` to invoke
`'bundle` `exec` standardrb'.
g:ale_ruby_standardrb_options *g:ale_ruby_standardrb_options*
*b:ale_ruby_standardrb_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to standardrb.
===============================================================================
syntax_tree *ale-ruby-syntax_tree*
g:ale_ruby_syntax_tree_executable *g:ale_ruby_syntax_tree_executable*
*b:ale_ruby_syntax_tree_executable*
Type: |String|
Default: `'stree'`
Override the invoked SyntaxTree binary. Set this to `'bundle'` to invoke
`'bundle` `exec` stree'.
g:ale_ruby_syntax_tree_options *g:ale_ruby_syntax_tree_options*
*b:ale_ruby_syntax_tree_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to SyntaxTree.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

292
sources_non_forked/ale/doc/ale-rust.txt
View File

@ -1,292 +0,0 @@
===============================================================================
ALE Rust Integration *ale-rust-options*
*ale-integration-rust*
===============================================================================
Integration Information
If Vim does not detect the Rust file type out-of-the-box, you need the runtime
files for Rust distributed in Vim >=8.0.0501 or upstream:
https://github.com/rust-lang/rust.vim
Note that there are several possible linters and fixers for Rust files:
1. rustc -- The Rust compiler is used to check the currently edited file.
So, if your project consists of multiple files, you will get some errors
when you use e.g. a struct which is defined in another file. You can use
|g:ale_rust_ignore_error_codes| to ignore some of these errors.
2. cargo -- If your project is managed by Cargo, the whole project is
checked. That means that all errors are properly shown, but cargo can
only operate on the files written on disk, so errors will not be reported
while you type.
3. rls -- If you have `rls` installed, you might prefer using this linter
over cargo. rls implements the Language Server Protocol for incremental
compilation of Rust code, and can check Rust files while you type. `rls`
requires Rust files to be contained in Cargo projects.
4. analyzer -- If you have rust-analyzer installed, you might prefer using
this linter over cargo and rls. rust-analyzer also implements the
Language Server Protocol for incremental compilation of Rust code, and is
the next iteration of rls. rust-analyzer either requires Rust files to be
contained in Cargo projects or requires the project to be described in
the rust-project.json format:
https://rust-analyzer.github.io/manual.html#non-cargo-based-projects
5. rustfmt -- If you have `rustfmt` installed, you can use it as a fixer to
consistently reformat your Rust code.
Only cargo and rls are enabled by default. To switch to using rustc instead
of cargo, configure |g:ale_linters| appropriately: >
" See the help text for the option for more information.
let g:ale_linters = {'rust': ['rustc', 'rls']}
<
Also note that rustc 1.18. or later is needed.
===============================================================================
analyzer *ale-rust-analyzer*
g:ale_rust_analyzer_executable *g:ale_rust_analyzer_executable*
*b:ale_rust_analyzer_executable*
Type: |String|
Default: `'rust-analyzer'`
This variable can be modified to change the executable path for
`rust-analyzer`.
g:ale_rust_analyzer_config *g:ale_rust_analyzer_config*
*b:ale_rust_analyzer_config*
Type: |Dictionary|
Default: `{}`
Dictionary with configuration settings for rust-analyzer.
===============================================================================
cargo *ale-rust-cargo*
g:ale_rust_cargo_use_check *g:ale_rust_cargo_use_check*
*b:ale_rust_cargo_use_check*
Type: |Number|
Default: `1`
When set to `1`, this option will cause ALE to use `cargo check` instead of
`cargo build` . `cargo check` is supported since version 1.16.0 of Rust.
ALE will never use `cargo check` when the version of `cargo` is less than
0.17.0.
g:ale_rust_cargo_check_all_targets *g:ale_rust_cargo_check_all_targets*
*b:ale_rust_cargo_check_all_targets*
Type: |Number|
Default: `0`
When set to `1`, ALE will set the `--all-targets` option when `cargo check`
is used. See |g:ale_rust_cargo_use_check|,
g:ale_rust_cargo_check_tests *g:ale_rust_cargo_check_tests*
*b:ale_rust_cargo_check_tests*
Type: |Number|
Default: `0`
When set to `1`, ALE will set the `--tests` option when `cargo check`
is used. This allows for linting of tests which are normally excluded.
See |g:ale_rust_cargo_use_check|,
g:ale_rust_cargo_check_examples *g:ale_rust_cargo_check_examples*
*b:ale_rust_cargo_check_examples*
Type: |Number|
Default: `0`
When set to `1`, ALE will set the `--examples` option when `cargo check`
is used. This allows for linting of examples which are normally excluded.
See |g:ale_rust_cargo_use_check|,
g:ale_rust_cargo_default_feature_behavior
*g:ale_rust_cargo_default_feature_behavior*
*b:ale_rust_cargo_default_feature_behavior*
Type: |String|
Default: `default`
When set to `none`, ALE will set the `--no-default-features` option when
invoking `cargo`. Only the features specified in
|g:ale_rust_cargo_include_features| will be included when performing the
lint check.
When set to `default`, ALE will instruct `cargo` to build all default
features specified in the project's `Cargo.toml` file, in addition to
including any additional features defined in
|g:ale_rust_cargo_include_features|.
When set to `all`, ALE will set the `--all-features` option when
invoking `cargo`, which will include all features defined in the project's
`Cargo.toml` file when performing the lint check.
g:ale_rust_cargo_include_features *g:ale_rust_cargo_include_features*
*b:ale_rust_cargo_include_features*
Type: |String|
Default: `''`
When defined, ALE will set the `--features` option when invoking `cargo` to
perform the lint check. See |g:ale_rust_cargo_default_feature_behavior|.
g:ale_rust_cargo_avoid_whole_workspace *g:ale_rust_cargo_avoid_whole_workspace*
*b:ale_rust_cargo_avoid_whole_workspace*
Type: |Number|
Default: `1`
When set to 1, and ALE is used to edit a crate that is part of a Cargo
workspace, avoid building the entire workspace by invoking `cargo` directly
in the crate's directory. Otherwise, behave as usual.
g:ale_rust_cargo_use_clippy *g:ale_rust_cargo_use_clippy*
*b:ale_rust_cargo_use_clippy*
Type: |Number|
Default: `0`
When set to 1, `cargo clippy` will be used instead of `cargo check` or
`cargo build` as linter.
For details of `cargo clippy`, please visit the following link:
https://github.com/rust-lang-nursery/rust-clippy
Since `cargo clippy` is optional toolchain, it's safer to check whether
`cargo-clippy` is executable as follows:
>
let g:ale_rust_cargo_use_clippy = executable('cargo-clippy')
<
g:ale_rust_cargo_clippy_options *g:ale_rust_cargo_clippy_options*
*b:ale_rust_cargo_clippy_options*
Type: |String|
Default: `''`
When `cargo clippy` is used, this value will be added to a command line to run
it. This variable is useful when you want to add some extra options which
only `cargo clippy` supports (e.g. `--deny`).
g:ale_rust_cargo_target_dir *g:ale_rust_cargo_target_dir*
*b:ale_rust_cargo_target_dir*
Type: |String|
Default: `''`
Use a custom target directory when running the commands for ALE. This can
help to avoid "waiting for file lock on build directory" messages when
running `cargo` commands manually while ALE is performing its checks.
===============================================================================
cspell *ale-rust-cspell*
See |ale-cspell-options|
===============================================================================
rls *ale-rust-rls*
g:ale_rust_rls_executable *g:ale_rust_rls_executable*
*b:ale_rust_rls_executable*
Type: |String|
Default: `'rls'`
This variable can be modified to change the executable path for `rls`.
g:ale_rust_rls_toolchain *g:ale_rust_rls_toolchain*
*b:ale_rust_rls_toolchain*
Type: |String|
Default: `''`
This option can be set to change the toolchain used for `rls`. Possible
values include `'nightly'`, `'beta'`, `'stable'`, and `''`. When using
option `''`, rls will automatically find the default toolchain set by
rustup. If you want to use `rls` from a specific toolchain version, you may
also use values like `'channel-yyyy-mm-dd-arch-target'` as long as
`'rls +{toolchain_name} -V'` runs correctly in your command line.
The `rls` server will only be started once per executable.
g:ale_rust_rls_config *g:ale_rust_rls_config*
*b:ale_rust_rls_config*
Type: |Dictionary|
Default: `{}`
Dictionary with configuration settings for rls. For example, to force
using clippy as linter: >
{
\ 'rust': {
\ 'clippy_preference': 'on'
\ }
\ }
===============================================================================
rustc *ale-rust-rustc*
g:ale_rust_rustc_options *g:ale_rust_rustc_options*
*b:ale_rust_rustc_options*
Type: |String|
Default: `'--emit=mir -o /dev/null'`
The variable can be used to change the options passed to `rustc`.
Users of nightly builds of Rust might want to use `-Z no-codegen` instead.
Be careful when setting the options, as running `rustc` could execute code
or generate binary files.
g:ale_rust_ignore_error_codes *g:ale_rust_ignore_error_codes*
*b:ale_rust_ignore_error_codes*
Type: |List| of |String|s
Default: `[]`
This variable can contain error codes which will be ignored. For example, to
ignore most errors regarding failed imports, put this in your .vimrc
>
let g:ale_rust_ignore_error_codes = ['E0432', 'E0433']
g:ale_rust_ignore_secondary_spans *g:ale_rust_ignore_secondary_spans*
*b:ale_rust_ignore_secondary_spans*
Type: |Number|
Default: `0`
When set to 1, instructs the Rust error reporting to ignore secondary spans.
The problem with secondary spans is that they sometimes appear in error
messages before the main cause of the error, for example: >
1 src/main.rs|98 col 5 error| this function takes 4 parameters but 5
parameters were supplied: defined here
2 src/main.rs|430 col 32 error| this function takes 4 parameters but 5
parameters were supplied: expected 4 parameters
<
This is due to the sorting by line numbers. With this option set to 1,
the 'defined here' span will not be presented.
===============================================================================
rustfmt *ale-rust-rustfmt*
g:ale_rust_rustfmt_options *g:ale_rust_rustfmt_options*
*b:ale_rust_rustfmt_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the rustfmt fixer.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

Some files were not shown because too many files have changed in this diff Show More