diff options
author | Matheus <46067952+Spixmaster@users.noreply.github.com> | 2022-11-25 14:16:16 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-11-25 13:16:16 +0000 |
commit | 5ce2bf84ca00cee8f375f108952789302980ae57 (patch) | |
tree | 2412926618e08f343c0af92cf719bdf1872db7c3 /doc | |
parent | b8de4ac96dcb84ff7ec704a65cdffad97d9bbeb1 (diff) | |
download | ale-5ce2bf84ca00cee8f375f108952789302980ae57.zip |
Added support for more file types for clang-format. (#4367)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ale-cs.txt | 7 | ||||
-rw-r--r-- | doc/ale-cuda.txt | 38 | ||||
-rw-r--r-- | doc/ale-java.txt | 7 | ||||
-rw-r--r-- | doc/ale-javascript.txt | 9 | ||||
-rw-r--r-- | doc/ale-json.txt | 7 | ||||
-rw-r--r-- | doc/ale-objc.txt | 69 | ||||
-rw-r--r-- | doc/ale-proto.txt | 14 | ||||
-rw-r--r-- | doc/ale-supported-languages-and-tools.txt | 7 | ||||
-rw-r--r-- | doc/ale.txt | 12 |
9 files changed, 118 insertions, 52 deletions
diff --git a/doc/ale-cs.txt b/doc/ale-cs.txt index 26e2b023..d9a9dc00 100644 --- a/doc/ale-cs.txt +++ b/doc/ale-cs.txt @@ -7,6 +7,13 @@ with the OmniSharp plugin. See here: https://github.com/OmniSharp/omnisharp-vim =============================================================================== +clang-format *ale-cs-clangformat* + +See |ale-c-clangformat| for information about the available options. +Note that the C options are also used for C#. + + +=============================================================================== csc *ale-cs-csc* The |ale-cs-csc| linter checks for semantic errors when files are opened or diff --git a/doc/ale-cuda.txt b/doc/ale-cuda.txt index 06aa48ce..729d86b5 100644 --- a/doc/ale-cuda.txt +++ b/doc/ale-cuda.txt @@ -3,23 +3,11 @@ 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. - +clang-format *ale-cuda-clangformat* -g:ale_cuda_nvcc_options *g:ale_cuda_nvcc_options* - *b:ale_cuda_nvcc_options* - Type: |String| - Default: `'-std=c++11'` +See |ale-c-clangformat| for information about the available options. +Note that the C options are also used for CUDA. - This variable can be changed to modify flags given to nvcc. =============================================================================== clangd *ale-cuda-clangd* @@ -39,11 +27,25 @@ g:ale_cuda_clangd_options *g:ale_cuda_clangd_options* This variable can be changed to modify flags given to clangd. + =============================================================================== -clang-format *ale-cuda-clangformat* +nvcc *ale-cuda-nvcc* -See |ale-c-clangformat| for information about the available options. -Note that the C options are also used for cuda. +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. =============================================================================== diff --git a/doc/ale-java.txt b/doc/ale-java.txt index 8767c791..69611866 100644 --- a/doc/ale-java.txt +++ b/doc/ale-java.txt @@ -42,6 +42,13 @@ g:ale_java_checkstyle_options *g:ale_java_checkstyle_options* =============================================================================== +clang-format *ale-java-clangformat* + +See |ale-c-clangformat| for information about the available options. +Note that the C options are also used for Java. + + +=============================================================================== cspell *ale-java-cspell* See |ale-cspell-options| diff --git a/doc/ale-javascript.txt b/doc/ale-javascript.txt index 7d626efe..a55cd643 100644 --- a/doc/ale-javascript.txt +++ b/doc/ale-javascript.txt @@ -17,12 +17,21 @@ 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"] < + +=============================================================================== +clang-format *ale-javascript-clangformat* + +See |ale-c-clangformat| for information about the available options. +Note that the C options are also used for JavaScript. + + =============================================================================== cspell *ale-javascript-cspell* diff --git a/doc/ale-json.txt b/doc/ale-json.txt index 154aee62..7b240373 100644 --- a/doc/ale-json.txt +++ b/doc/ale-json.txt @@ -3,6 +3,13 @@ ALE JSON Integration *ale-json-options* =============================================================================== +clang-format *ale-json-clangformat* + +See |ale-c-clangformat| for information about the available options. +Note that the C options are also used for JSON. + + +=============================================================================== cspell *ale-json-cspell* See |ale-cspell-options| diff --git a/doc/ale-objc.txt b/doc/ale-objc.txt index 0163175a..e1a0c2a2 100644 --- a/doc/ale-objc.txt +++ b/doc/ale-objc.txt @@ -3,6 +3,37 @@ ALE Objective-C Integration *ale-objc-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. + + +=============================================================================== clang *ale-objc-clang* g:ale_objc_clang_options *g:ale_objc_clang_options* @@ -14,6 +45,13 @@ g:ale_objc_clang_options *g:ale_objc_clang_options* =============================================================================== +clang-format *ale-objc-clangformat* + +See |ale-c-clangformat| for information about the available options. +Note that the C options are also used for Objective-C. + + +=============================================================================== clangd *ale-objc-clangd* g:ale_objc_clangd_executable *g:ale_objc_clangd_executable* @@ -39,35 +77,4 @@ 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: diff --git a/doc/ale-proto.txt b/doc/ale-proto.txt index 198ae3b6..e7015dcc 100644 --- a/doc/ale-proto.txt +++ b/doc/ale-proto.txt @@ -9,12 +9,15 @@ 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* @@ -29,6 +32,7 @@ g:ale_proto_buf_format_executable *g:ale_proto_buf_format_executable* This variable can be changed to modify the executable used for buf. + =============================================================================== buf-lint *ale-proto-buf-lint* @@ -53,6 +57,14 @@ g:ale_proto_buf_lint_config *g:ale_proto_buf_lint_config* 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. + +=============================================================================== +clang-format *ale-proto-clangformat* + +See |ale-c-clangformat| for information about the available options. +Note that the C options are also used for Proto. + + =============================================================================== protoc-gen-lint *ale-proto-protoc-gen-lint* @@ -68,6 +80,7 @@ g:ale_proto_protoc_gen_lint_options *g:ale_proto_protoc_gen_lint_options* directory of the linted file is always passed as an include path with '-I' before any user-supplied options. + =============================================================================== protolint *ale-proto-protolint* @@ -94,5 +107,6 @@ g:ale_proto_protolint_config *g:ale_proto_protolint_config* 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: diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt index 298c0024..2477fe5a 100644 --- a/doc/ale-supported-languages-and-tools.txt +++ b/doc/ale-supported-languages-and-tools.txt @@ -76,6 +76,7 @@ Notes: * `gcc` (`cc`) * `uncrustify` * C# + * `clang-format` * `csc`!! * `cspell` * `dotnet-format` @@ -129,6 +130,7 @@ Notes: * Cucumber * `cucumber` * CUDA + * `clang-format` * `clangd` * `nvcc`!! * Cypher @@ -271,6 +273,7 @@ Notes: * Java * `PMD` * `checkstyle`!! + * `clang-format` * `cspell` * `eclipselsp` * `google-java-format` @@ -278,6 +281,7 @@ Notes: * `javalsp` * `uncrustify` * JavaScript + * `clang-format` * `cspell` * `deno` * `dprint` @@ -294,6 +298,7 @@ Notes: * `xo` * JSON * `VSCode JSON language server` + * `clang-format` * `cspell` * `dprint` * `eslint` @@ -384,6 +389,7 @@ Notes: * Objective-C * `ccls` * `clang` + * `clang-format` * `clangd` * `uncrustify` * Objective-C++ @@ -450,6 +456,7 @@ Notes: * proto * `buf-format`!! * `buf-lint`!! + * `clang-format` * `protoc-gen-lint`!! * `protolint`!! * Pug diff --git a/doc/ale.txt b/doc/ale.txt index a9232c4e..9752ce6f 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -2834,6 +2834,7 @@ documented in additional help files. flawfinder............................|ale-cpp-flawfinder| uncrustify............................|ale-cpp-uncrustify| c#......................................|ale-cs-options| + clang-format..........................|ale-cs-clangformat| csc...................................|ale-cs-csc| cspell................................|ale-cs-cspell| dotnet-format.........................|ale-cs-dotnet-format| @@ -2848,9 +2849,9 @@ documented in additional help files. stylelint.............................|ale-css-stylelint| vscodecss.............................|ale-css-vscode| cuda....................................|ale-cuda-options| - nvcc..................................|ale-cuda-nvcc| - clangd................................|ale-cuda-clangd| clang-format..........................|ale-cuda-clangformat| + clangd................................|ale-cuda-clangd| + nvcc..................................|ale-cuda-nvcc| d.......................................|ale-d-options| dfmt..................................|ale-d-dfmt| dls...................................|ale-d-dls| @@ -2975,6 +2976,7 @@ documented in additional help files. ispc..................................|ale-ispc-ispc| java....................................|ale-java-options| checkstyle............................|ale-java-checkstyle| + clang-format..........................|ale-java-clangformat| cspell................................|ale-java-cspell| javac.................................|ale-java-javac| google-java-format....................|ale-java-google-java-format| @@ -2983,6 +2985,7 @@ documented in additional help files. eclipselsp............................|ale-java-eclipselsp| uncrustify............................|ale-java-uncrustify| javascript..............................|ale-javascript-options| + clang-format..........................|ale-javascript-clangformat| cspell................................|ale-javascript-cspell| deno..................................|ale-javascript-deno| dprint................................|ale-javascript-dprint| @@ -2998,6 +3001,7 @@ documented in additional help files. standard..............................|ale-javascript-standard| xo....................................|ale-javascript-xo| json....................................|ale-json-options| + clang-format..........................|ale-json-clangformat| cspell................................|ale-json-cspell| dprint................................|ale-json-dprint| eslint................................|ale-json-eslint| @@ -3065,10 +3069,11 @@ documented in additional help files. nroff...................................|ale-nroff-options| write-good............................|ale-nroff-write-good| objc....................................|ale-objc-options| + ccls..................................|ale-objc-ccls| clang.................................|ale-objc-clang| + clang-format..........................|ale-objc-clangformat| clangd................................|ale-objc-clangd| uncrustify............................|ale-objc-uncrustify| - ccls..................................|ale-objc-ccls| objcpp..................................|ale-objcpp-options| clang.................................|ale-objcpp-clang| clangd................................|ale-objcpp-clangd| @@ -3127,6 +3132,7 @@ documented in additional help files. proto...................................|ale-proto-options| buf-format............................|ale-proto-buf-format| buf-lint..............................|ale-proto-buf-lint| + clang-format..........................|ale-proto-clangformat| protoc-gen-lint.......................|ale-proto-protoc-gen-lint| protolint.............................|ale-proto-protolint| pug.....................................|ale-pug-options| |