mirror of
https://github.com/dense-analysis/ale.git
synced 2025-12-06 12:44:23 +08:00
400857d758
1. Add ale.setup and ale.setup.buffer for pure Lua configuration. 2. Update many global settings to use Booleans instead of numbers to make types easiert to work with in Lua. 3. Radically reformat documentation and fix errors to make documentation more usable for Neovim users.
481 lines
19 KiB
Plaintext
481 lines
19 KiB
Plaintext
===============================================================================
|
|
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*
|
|
|
|
*ale-options.cpp_astyle_executable*
|
|
*g:ale_cpp_astyle_executable*
|
|
*b:ale_cpp_astyle_executable*
|
|
cpp_astyle_executable
|
|
g:ale_cpp_astyle_executable
|
|
Type: |String|
|
|
Default: `'astyle'`
|
|
|
|
This variable can be changed to use a different executable for astyle.
|
|
|
|
*ale-options.cpp_astyle_project_options*
|
|
*g:ale_cpp_astyle_project_options*
|
|
*b:ale_cpp_astyle_project_options*
|
|
cpp_astyle_project_options
|
|
g: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*
|
|
|
|
*ale-options.cpp_cc_executable*
|
|
*g:ale_cpp_cc_executable*
|
|
*b:ale_cpp_cc_executable*
|
|
cpp_cc_executable
|
|
g: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`.
|
|
|
|
*ale-options.cpp_cc_options*
|
|
*g:ale_cpp_cc_options*
|
|
*b:ale_cpp_cc_options*
|
|
cpp_cc_options
|
|
g:ale_cpp_cc_options
|
|
Type: |String|
|
|
Default: `'-std=c++14 -Wall'`
|
|
|
|
This variable can be changed to modify flags given to the C++ compiler.
|
|
|
|
*ale-options.cpp_cc_use_header_lang_flag*
|
|
*g:ale_cpp_cc_use_header_lang_flag*
|
|
*b:ale_cpp_cc_use_header_lang_flag*
|
|
cpp_cc_use_header_lang_flag
|
|
g: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 behavior 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.
|
|
|
|
*ale-options.cpp_cc_header_exts*
|
|
*g:ale_cpp_cc_header_exts*
|
|
*b:ale_cpp_cc_header_exts*
|
|
cpp_cc_header_exts
|
|
g: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 |g:ale_cpp_cc_use_header_lang_flag|.
|
|
|
|
|
|
===============================================================================
|
|
ccls *ale-cpp-ccls*
|
|
|
|
*ale-options.cpp_ccls_executable*
|
|
*g:ale_cpp_ccls_executable*
|
|
*b:ale_cpp_ccls_executable*
|
|
cpp_ccls_executable
|
|
g:ale_cpp_ccls_executable
|
|
Type: |String|
|
|
Default: `'ccls'`
|
|
|
|
This variable can be changed to use a different executable for ccls.
|
|
|
|
*ale-options.cpp_ccls_init_options*
|
|
*g:ale_cpp_ccls_init_options*
|
|
*b:ale_cpp_ccls_init_options*
|
|
cpp_ccls_init_options
|
|
g:ale_cpp_ccls_init_options
|
|
Type: |Dictionary|
|
|
Default: `{}`
|
|
|
|
This variable can be changed to customize ccls initialization options.
|
|
Example: >
|
|
|
|
let g:ale_cpp_ccls_init_options = {
|
|
\ '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|.
|
|
|
|
|
|
-------------------------------------------------------------------------------
|
|
Options
|
|
*ale-options.cpp_clangcheck_executable*
|
|
*g:ale_cpp_clangcheck_executable*
|
|
*b:ale_cpp_clangcheck_executable*
|
|
cpp_clangcheck_executable
|
|
g:ale_cpp_clangcheck_executable
|
|
Type: |String|
|
|
Default: `'clang-check'`
|
|
|
|
This variable can be changed to use a different executable for clangcheck.
|
|
|
|
*ale-options.cpp_clangcheck_options*
|
|
*g:ale_cpp_clangcheck_options*
|
|
*b:ale_cpp_clangcheck_options*
|
|
cpp_clangcheck_options
|
|
g: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*
|
|
|
|
*ale-options.cpp_clangd_executable*
|
|
*g:ale_cpp_clangd_executable*
|
|
*b:ale_cpp_clangd_executable*
|
|
cpp_clangd_executable
|
|
g:ale_cpp_clangd_executable
|
|
Type: |String|
|
|
Default: `'clangd'`
|
|
|
|
This variable can be changed to use a different executable for clangd.
|
|
|
|
*ale-options.cpp_clangd_options*
|
|
*g:ale_cpp_clangd_options*
|
|
*b:ale_cpp_clangd_options*
|
|
cpp_clangd_options
|
|
g: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|.
|
|
|
|
|
|
-------------------------------------------------------------------------------
|
|
Options
|
|
*ale-options.cpp_clangtidy_checks*
|
|
*g:ale_cpp_clangtidy_checks*
|
|
*b:ale_cpp_clangtidy_checks*
|
|
cpp_clangtidy_checks
|
|
g: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.
|
|
|
|
*ale-options.cpp_clangtidy_executable*
|
|
*g:ale_cpp_clangtidy_executable*
|
|
*b:ale_cpp_clangtidy_executable*
|
|
cpp_clangtidy_executable
|
|
g:ale_cpp_clangtidy_executable
|
|
Type: |String|
|
|
Default: `'clang-tidy'`
|
|
|
|
This variable can be changed to use a different executable for clangtidy.
|
|
|
|
*ale-options.cpp_clangtidy_options*
|
|
*g:ale_cpp_clangtidy_options*
|
|
*b:ale_cpp_clangtidy_options*
|
|
cpp_clangtidy_options
|
|
g: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.
|
|
|
|
*ale-options.cpp_clangtidy_extra_options*
|
|
*g:ale_cpp_clangtidy_extra_options*
|
|
*b:ale_cpp_clangtidy_extra_options*
|
|
cpp_clangtidy_extra_options
|
|
g:ale_cpp_clangtidy_extra_options
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be changed to modify flags given to clang-tidy.
|
|
|
|
*ale-options.cpp_clangtidy_fix_errors*
|
|
*g:ale_cpp_clangtidy_fix_errors*
|
|
*b:ale_cpp_clangtidy_fix_errors*
|
|
cpp_clangtidy_fix_errors
|
|
g: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*
|
|
|
|
*ale-options.cpp_clazy_executable*
|
|
*g:ale_cpp_clazy_executable*
|
|
*b:ale_cpp_clazy_executable*
|
|
cpp_clazy_executable
|
|
g:ale_cpp_clazy_executable
|
|
Type: |String|
|
|
Default: `'clazy-standalone'`
|
|
|
|
This variable can be changed to use a different executable for clazy.
|
|
|
|
*ale-options.cpp_clazy_checks*
|
|
*g:ale_cpp_clazy_checks*
|
|
*b:ale_cpp_clazy_checks*
|
|
cpp_clazy_checks
|
|
g: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.
|
|
|
|
*ale-options.cpp_clazy_options*
|
|
*g:ale_cpp_clazy_options*
|
|
*b:ale_cpp_clazy_options*
|
|
cpp_clazy_options
|
|
g:ale_cpp_clazy_options
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be changed to modify flags given to clazy.
|
|
|
|
|
|
===============================================================================
|
|
cppcheck *ale-cpp-cppcheck*
|
|
|
|
*ale-options.cpp_cppcheck_executable*
|
|
*g:ale_cpp_cppcheck_executable*
|
|
*b:ale_cpp_cppcheck_executable*
|
|
cpp_cppcheck_executable
|
|
g:ale_cpp_cppcheck_executable
|
|
Type: |String|
|
|
Default: `'cppcheck'`
|
|
|
|
This variable can be changed to use a different executable for cppcheck.
|
|
|
|
*ale-options.cpp_cppcheck_options*
|
|
*g:ale_cpp_cppcheck_options*
|
|
*b:ale_cpp_cppcheck_options*
|
|
cpp_cppcheck_options
|
|
g:ale_cpp_cppcheck_options
|
|
Type: |String|
|
|
Default: `'--enable=style'`
|
|
|
|
This variable can be changed to modify flags given to cppcheck.
|
|
|
|
|
|
===============================================================================
|
|
cpplint *ale-cpp-cpplint*
|
|
|
|
*ale-options.cpp_cpplint_executable*
|
|
*g:ale_cpp_cpplint_executable*
|
|
*b:ale_cpp_cpplint_executable*
|
|
cpp_cpplint_executable
|
|
g:ale_cpp_cpplint_executable
|
|
Type: |String|
|
|
Default: `'cpplint'`
|
|
|
|
This variable can be changed to use a different executable for cpplint.
|
|
|
|
*ale-options.cpp_cpplint_options*
|
|
*g:ale_cpp_cpplint_options*
|
|
*b:ale_cpp_cpplint_options*
|
|
cpp_cpplint_options
|
|
g:ale_cpp_cpplint_options
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be changed to modify flags given to cpplint.
|
|
|
|
*ale-options.c_cpplint_executable*
|
|
*g:ale_c_cpplint_executable*
|
|
*b:ale_c_cpplint_executable*
|
|
c_cpplint_executable
|
|
g:ale_c_cpplint_executable
|
|
Type: |String|
|
|
Default: `'cpplint'`
|
|
|
|
This variable can be changed to use a different executable for cpplint.
|
|
|
|
*ale-options.c_cpplint_options*
|
|
*g:ale_c_cpplint_options*
|
|
*b:ale_c_cpplint_options*
|
|
c_cpplint_options
|
|
g:ale_c_cpplint_options
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be changed to modify flags given to cpplint.
|
|
|
|
|
|
===============================================================================
|
|
cquery *ale-cpp-cquery*
|
|
|
|
*ale-options.cpp_cquery_executable*
|
|
*g:ale_cpp_cquery_executable*
|
|
*b:ale_cpp_cquery_executable*
|
|
cpp_cquery_executable
|
|
g:ale_cpp_cquery_executable
|
|
Type: |String|
|
|
Default: `'cquery'`
|
|
|
|
This variable can be changed to use a different executable for cquery.
|
|
|
|
*ale-options.cpp_cquery_cache_directory*
|
|
*g:ale_cpp_cquery_cache_directory*
|
|
*b:ale_cpp_cquery_cache_directory*
|
|
cpp_cquery_cache_directory
|
|
g: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*
|
|
|
|
*ale-options.cpp_flawfinder_executable*
|
|
*g:ale_cpp_flawfinder_executable*
|
|
*b:ale_cpp_flawfinder_executable*
|
|
cpp_flawfinder_executable
|
|
g:ale_cpp_flawfinder_executable
|
|
Type: |String|
|
|
Default: `'flawfinder'`
|
|
|
|
This variable can be changed to use a different executable for flawfinder.
|
|
|
|
*ale-options.cpp_flawfinder_minlevel*
|
|
*g:ale_cpp_flawfinder_minlevel*
|
|
*b:ale_cpp_flawfinder_minlevel*
|
|
cpp_flawfinder_minlevel
|
|
g:ale_cpp_flawfinder_minlevel
|
|
Type: |Number|
|
|
Default: `1`
|
|
|
|
This variable can be changed to ignore risks under the given risk threshold.
|
|
|
|
*ale-options.cpp_flawfinder_options*
|
|
*g:ale_cpp_flawfinder_options*
|
|
*b:ale-cpp-flawfinder*
|
|
cpp_flawfinder_options
|
|
g:ale_cpp_flawfinder_options
|
|
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:
|