summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <w0rp@users.noreply.github.com>2018-09-09 11:30:30 +0100
committerGitHub <noreply@github.com>2018-09-09 11:30:30 +0100
commit395aba19c37a4bc4ead34f115381227d7b71bc0a (patch)
tree54d00658f7d339bba7cb85511f160efffbbb3f89 /doc
parent0ae4ea23c8573f9c693fcd5cd5ff9a3acc795b58 (diff)
parent6e4dccc0e0888ea44f6914d6a8b16744492f2215 (diff)
downloadale-395aba19c37a4bc4ead34f115381227d7b71bc0a.zip
Merge pull request #1885 from dsifford/dsifford-fixer-uncrustify
add uncrustify fixer for several languages
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-c.txt19
-rw-r--r--doc/ale-cpp.txt6
-rw-r--r--doc/ale-cs.txt6
-rw-r--r--doc/ale-d.txt12
-rw-r--r--doc/ale-java.txt6
-rw-r--r--doc/ale-objc.txt6
-rw-r--r--doc/ale-objcpp.txt6
-rw-r--r--doc/ale-pawn.txt12
-rw-r--r--doc/ale-vala.txt12
-rw-r--r--doc/ale.txt28
10 files changed, 106 insertions, 7 deletions
diff --git a/doc/ale-c.txt b/doc/ale-c.txt
index 282dcf94..c3820ba0 100644
--- a/doc/ale-c.txt
+++ b/doc/ale-c.txt
@@ -263,4 +263,23 @@ g:ale_c_gcc_options *g:ale_c_gcc_options*
===============================================================================
+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:
diff --git a/doc/ale-cpp.txt b/doc/ale-cpp.txt
index e582ae6e..6c05c96d 100644
--- a/doc/ale-cpp.txt
+++ b/doc/ale-cpp.txt
@@ -274,4 +274,10 @@ g:ale_cpp_gcc_options *g:ale_cpp_gcc_options*
===============================================================================
+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:
diff --git a/doc/ale-cs.txt b/doc/ale-cs.txt
index f65b9f39..b4cd295c 100644
--- a/doc/ale-cs.txt
+++ b/doc/ale-cs.txt
@@ -99,4 +99,10 @@ g:ale_cs_mcsc_assemblies *g:ale_cs_mcsc_assemblies*
<
===============================================================================
+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:
diff --git a/doc/ale-d.txt b/doc/ale-d.txt
new file mode 100644
index 00000000..8db04774
--- /dev/null
+++ b/doc/ale-d.txt
@@ -0,0 +1,12 @@
+===============================================================================
+ALE D Integration *ale-d-options*
+
+
+===============================================================================
+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:
diff --git a/doc/ale-java.txt b/doc/ale-java.txt
index 827a268c..7bba12a3 100644
--- a/doc/ale-java.txt
+++ b/doc/ale-java.txt
@@ -99,4 +99,10 @@ g:ale_java_javalsp_jar *g:ale_java_javalsp_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:
diff --git a/doc/ale-objc.txt b/doc/ale-objc.txt
index 9e7db367..2d560267 100644
--- a/doc/ale-objc.txt
+++ b/doc/ale-objc.txt
@@ -33,4 +33,10 @@ g:ale_objc_clangd_options *g:ale_objc_clangd_options*
===============================================================================
+uncrustify *ale-objc-uncrustify*
+
+See |ale-c-uncrustify| for information about the available options.
+
+
+===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-objcpp.txt b/doc/ale-objcpp.txt
index 1f76aecb..cd65ab73 100644
--- a/doc/ale-objcpp.txt
+++ b/doc/ale-objcpp.txt
@@ -33,4 +33,10 @@ g:ale_objcpp_clangd_options *g:ale_objcpp_clangd_options*
===============================================================================
+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:
diff --git a/doc/ale-pawn.txt b/doc/ale-pawn.txt
new file mode 100644
index 00000000..f836df97
--- /dev/null
+++ b/doc/ale-pawn.txt
@@ -0,0 +1,12 @@
+===============================================================================
+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:
diff --git a/doc/ale-vala.txt b/doc/ale-vala.txt
new file mode 100644
index 00000000..ca24bcf4
--- /dev/null
+++ b/doc/ale-vala.txt
@@ -0,0 +1,12 @@
+===============================================================================
+ALE VALA Integration *ale-vala-options*
+
+
+===============================================================================
+uncrustify *ale-vala-uncrustify*
+
+See |ale-c-uncrustify| for information about the available options.
+
+
+===============================================================================
+vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale.txt b/doc/ale.txt
index e08946e5..983fa462 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -33,6 +33,7 @@ CONTENTS *ale-contents*
cquery..............................|ale-c-cquery|
flawfinder..........................|ale-c-flawfinder|
gcc.................................|ale-c-gcc|
+ uncrustify..........................|ale-c-uncrustify|
chef..................................|ale-chef-options|
foodcritic..........................|ale-chef-foodcritic|
clojure...............................|ale-clojure-options|
@@ -53,14 +54,18 @@ CONTENTS *ale-contents*
cquery..............................|ale-cpp-cquery|
flawfinder..........................|ale-cpp-flawfinder|
gcc.................................|ale-cpp-gcc|
+ uncrustify..........................|ale-cpp-uncrustify|
c#....................................|ale-cs-options|
mcs.................................|ale-cs-mcs|
mcsc................................|ale-cs-mcsc|
+ uncrustify..........................|ale-cs-uncrustify|
css...................................|ale-css-options|
prettier............................|ale-css-prettier|
stylelint...........................|ale-css-stylelint|
cuda..................................|ale-cuda-options|
nvcc................................|ale-cuda-nvcc|
+ d.....................................|ale-d-options|
+ uncrustify..........................|ale-d-uncrustify|
dart..................................|ale-dart-options|
dartanalyzer........................|ale-dart-dartanalyzer|
dartfmt.............................|ale-dart-dartfmt|
@@ -130,6 +135,7 @@ CONTENTS *ale-contents*
google-java-format..................|ale-java-google-java-format|
pmd.................................|ale-java-pmd|
javalsp.............................|ale-java-javalsp|
+ uncrustify..........................|ale-java-uncrustify|
javascript............................|ale-javascript-options|
eslint..............................|ale-javascript-eslint|
flow................................|ale-javascript-flow|
@@ -176,13 +182,17 @@ CONTENTS *ale-contents*
objc..................................|ale-objc-options|
clang...............................|ale-objc-clang|
clangd..............................|ale-objc-clangd|
+ uncrustify..........................|ale-objc-uncrustify|
objcpp................................|ale-objcpp-options|
clang...............................|ale-objcpp-clang|
clangd..............................|ale-objcpp-clangd|
+ uncrustify..........................|ale-objcpp-uncrustify|
ocaml.................................|ale-ocaml-options|
merlin..............................|ale-ocaml-merlin|
ols.................................|ale-ocaml-ols|
ocamlformat.........................|ale-ocaml-ocamlformat|
+ pawn..................................|ale-pawn-options|
+ uncrustify..........................|ale-pawn-uncrustify|
perl..................................|ale-perl-options|
perl................................|ale-perl-perl|
perlcritic..........................|ale-perl-perlcritic|
@@ -290,6 +300,8 @@ CONTENTS *ale-contents*
prettier............................|ale-typescript-prettier|
tslint..............................|ale-typescript-tslint|
tsserver............................|ale-typescript-tsserver|
+ vala..................................|ale-vala-options|
+ uncrustify..........................|ale-vala-uncrustify|
verilog/systemverilog.................|ale-verilog-options|
iverilog............................|ale-verilog-iverilog|
verilator...........................|ale-verilog-verilator|
@@ -359,10 +371,10 @@ Notes:
* Awk: `gawk`
* Bash: `language-server`, `shell` (-n flag), `shellcheck`, `shfmt`
* Bourne Shell: `shell` (-n flag), `shellcheck`, `shfmt`
-* C: `cppcheck`, `cpplint`!!, `clang`, `clangd`, `clangtidy`!!, `clang-format`, `cquery`, `flawfinder`, `gcc`
-* C++ (filetype cpp): `clang`, `clangd`, `clangcheck`!!, `clangtidy`!!, `clang-format`, `clazy`!!, `cppcheck`, `cpplint`!!, `cquery`, `flawfinder`, `gcc`
+* C: `cppcheck`, `cpplint`!!, `clang`, `clangd`, `clangtidy`!!, `clang-format`, `cquery`, `flawfinder`, `gcc`, `uncrustify`
+* C++ (filetype cpp): `clang`, `clangd`, `clangcheck`!!, `clangtidy`!!, `clang-format`, `clazy`!!, `cppcheck`, `cpplint`!!, `cquery`, `flawfinder`, `gcc`, `uncrustify`
* CUDA: `nvcc`!!
-* C#: `mcs`, `mcsc`!!
+* C#: `mcs`, `mcsc`!!, `uncrustify`
* Chef: `foodcritic`
* Clojure: `joker`
* CloudFormation: `cfn-python-lint`
@@ -372,7 +384,7 @@ Notes:
* CSS: `csslint`, `prettier`, `stylelint`
* Cucumber: `cucumber`
* Cython (pyrex filetype): `cython`
-* D: `dmd`
+* D: `dmd`, `uncrustify`
* Dafny: `dafny`!!
* Dart: `dartanalyzer`!!, `language_server`, dartfmt!!
* Dockerfile: `hadolint`
@@ -394,7 +406,7 @@ Notes:
* Haskell: `brittany`, `ghc`, `cabal-ghc`, `stylish-haskell`, `stack-ghc`, `stack-build`!!, `ghc-mod`, `stack-ghc-mod`, `hlint`, `hdevtools`, `hfmt`, `hie`
* HTML: `alex`!!, `HTMLHint`, `proselint`, `tidy`, `write-good`
* Idris: `idris`
-* Java: `checkstyle`, `javac`, `google-java-format`, `PMD`, `javalsp`
+* Java: `checkstyle`, `javac`, `google-java-format`, `PMD`, `javalsp`, `uncrustify`
* JavaScript: `eslint`, `flow`, `jscs`, `jshint`, `prettier`, `prettier-eslint`, `prettier-standard`, `standard`, `xo`
* JSON: `fixjson`, `jsonlint`, `jq`, `prettier`
* Kotlin: `kotlinc`!!, `ktlint`!!, `languageserver`
@@ -411,9 +423,10 @@ Notes:
* Nim: `nim check`!!
* nix: `nix-instantiate`
* nroff: `alex`!!, `proselint`, `write-good`
-* Objective-C: `clang`, `clangd`
-* Objective-C++: `clang`, `clangd`
+* Objective-C: `clang`, `clangd`, `uncrustify`
+* Objective-C++: `clang`, `clangd`, `uncrustify`
* OCaml: `merlin` (see |ale-ocaml-merlin|), `ols`, `ocamlformat`
+* Pawn: `uncrustify`
* Perl: `perl -c`, `perl-critic`, `perltidy`
* PHP: `langserver`, `phan`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf`, `php-cs-fixer`
* PO: `alex`!!, `msgfmt`, `proselint`, `write-good`
@@ -446,6 +459,7 @@ Notes:
* Text^: `alex`!!, `proselint`, `redpen`, `textlint`, `vale`, `write-good`
* Thrift: `thrift`
* TypeScript: `eslint`, `prettier`, `tslint`, `tsserver`, `typecheck`
+* VALA: `uncrustify`
* Verilog: `iverilog`, `verilator`
* Vim: `vint`
* Vim help^: `alex`!!, `proselint`, `write-good`