diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale-asciidoc.txt | 12 | ||||
| -rw-r--r-- | doc/ale-elixir.txt | 17 | ||||
| -rw-r--r-- | doc/ale-haskell.txt | 10 | ||||
| -rw-r--r-- | doc/ale-html.txt | 6 | ||||
| -rw-r--r-- | doc/ale-latex.txt | 12 | ||||
| -rw-r--r-- | doc/ale-less.txt | 12 | ||||
| -rw-r--r-- | doc/ale-markdown.txt | 12 | ||||
| -rw-r--r-- | doc/ale-nroff.txt | 12 | ||||
| -rw-r--r-- | doc/ale-php.txt | 15 | ||||
| -rw-r--r-- | doc/ale-pod.txt | 12 | ||||
| -rw-r--r-- | doc/ale-python.txt | 2 | ||||
| -rw-r--r-- | doc/ale-restructuredtext.txt | 12 | ||||
| -rw-r--r-- | doc/ale-rust.txt | 13 | ||||
| -rw-r--r-- | doc/ale-texinfo.txt | 12 | ||||
| -rw-r--r-- | doc/ale-text.txt | 12 | ||||
| -rw-r--r-- | doc/ale-vim-help.txt | 12 | ||||
| -rw-r--r-- | doc/ale-xhtml.txt | 12 | ||||
| -rw-r--r-- | doc/ale.txt | 94 |
18 files changed, 274 insertions, 15 deletions
diff --git a/doc/ale-asciidoc.txt b/doc/ale-asciidoc.txt new file mode 100644 index 00000000..b6b64fd3 --- /dev/null +++ b/doc/ale-asciidoc.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE AsciiDoc Integration *ale-asciidoc-options* + + +=============================================================================== +write-good *ale-asciidoc-write-good* + +See |ale-write-good-options| + + +=============================================================================== +vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-elixir.txt b/doc/ale-elixir.txt new file mode 100644 index 00000000..a5318c0f --- /dev/null +++ b/doc/ale-elixir.txt @@ -0,0 +1,17 @@ +=============================================================================== +ALE Elixir Integration *ale-elixir-options* + + +=============================================================================== +mix *ale-elixir-mix* + +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. + +=============================================================================== + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-haskell.txt b/doc/ale-haskell.txt index bbf99fcf..4a490efc 100644 --- a/doc/ale-haskell.txt +++ b/doc/ale-haskell.txt @@ -21,6 +21,16 @@ g:ale_haskell_hdevtools_options *g:ale_haskell_hdevtools_options* This variable can be changed to modify flags given to hdevtools. =============================================================================== +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. + +=============================================================================== stack-build *ale-haskell-stack-build* g:ale_haskell_stack_build_options *g:ale_haskell_stack_build_options* diff --git a/doc/ale-html.txt b/doc/ale-html.txt index e6f3398f..14e705e0 100644 --- a/doc/ale-html.txt +++ b/doc/ale-html.txt @@ -57,4 +57,10 @@ g:ale_html_tidy_options *g:ale_html_tidy_options* =============================================================================== +write-good *ale-html-write-good* + +See |ale-write-good-options| + + +=============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-latex.txt b/doc/ale-latex.txt new file mode 100644 index 00000000..87fbd4e8 --- /dev/null +++ b/doc/ale-latex.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE LaTeX Integration *ale-latex-options* + + +=============================================================================== +write-good *ale-latex-write-good* + +See |ale-write-good-options| + + +=============================================================================== +vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-less.txt b/doc/ale-less.txt new file mode 100644 index 00000000..a6b5998e --- /dev/null +++ b/doc/ale-less.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE Less Integration *ale-less-options* + + +=============================================================================== +prettier *ale-less-prettier* + +See |ale-javascript-prettier| for information about the available options. + + +=============================================================================== + diff --git a/doc/ale-markdown.txt b/doc/ale-markdown.txt new file mode 100644 index 00000000..3ce9619c --- /dev/null +++ b/doc/ale-markdown.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE Markdown Integration *ale-markdown-options* + + +=============================================================================== +write-good *ale-markdown-write-good* + +See |ale-write-good-options| + + +=============================================================================== +vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-nroff.txt b/doc/ale-nroff.txt new file mode 100644 index 00000000..62ec7896 --- /dev/null +++ b/doc/ale-nroff.txt @@ -0,0 +1,12 @@ +=============================================================================== +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: diff --git a/doc/ale-php.txt b/doc/ale-php.txt index bae6d7d0..8756d60e 100644 --- a/doc/ale-php.txt +++ b/doc/ale-php.txt @@ -35,6 +35,21 @@ g:ale_php_langserver_use_global *g:ale_php_langserver_use_global* =============================================================================== +phan *ale-php-phan* + +WARNING: please do not use this 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 + + +=============================================================================== phpcbf *ale-php-phpcbf* g:ale_php_phpcbf_executable *g:ale_php_phpcbf_executable* diff --git a/doc/ale-pod.txt b/doc/ale-pod.txt new file mode 100644 index 00000000..c7cc0bbc --- /dev/null +++ b/doc/ale-pod.txt @@ -0,0 +1,12 @@ +=============================================================================== +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: diff --git a/doc/ale-python.txt b/doc/ale-python.txt index a8d033e2..755094a3 100644 --- a/doc/ale-python.txt +++ b/doc/ale-python.txt @@ -174,7 +174,7 @@ g:ale_python_pylint_options *g:ale_python_pylint_options* Python 3, you may want to set > let g:ale_python_pylint_executable = 'python3' " or 'python' for Python 2 - let g:ale_python_pylint_options = '-rcfile /path/to/pylint.rc' + let g:ale_python_pylint_options = '--rcfile /path/to/pylint.rc' " The virtualenv detection needs to be disabled. let g:ale_python_pylint_use_global = 0 diff --git a/doc/ale-restructuredtext.txt b/doc/ale-restructuredtext.txt new file mode 100644 index 00000000..02fbc4ad --- /dev/null +++ b/doc/ale-restructuredtext.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE reStructuredText Integration *ale-restructuredtext-options* + + +=============================================================================== +write-good *ale-restructuredtext-write-good* + +See |ale-write-good-options| + + +=============================================================================== +vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-rust.txt b/doc/ale-rust.txt index 52dc3d61..e20aea2c 100644 --- a/doc/ale-rust.txt +++ b/doc/ale-rust.txt @@ -22,6 +22,8 @@ Integration Information 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 contained in Cargo projects. + 4. rustfmt -- If you have `rustfmt` installed, you can use it as a fixer to + consistently reformat your Rust code. Only cargo is enabled by default. To switch to using rustc instead of cargo, configure |g:ale_linters| appropriately: > @@ -71,4 +73,15 @@ g:ale_rust_ignore_error_codes *g:ale_rust_ignore_error_codes* =============================================================================== +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: diff --git a/doc/ale-texinfo.txt b/doc/ale-texinfo.txt new file mode 100644 index 00000000..f8ed342d --- /dev/null +++ b/doc/ale-texinfo.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE Texinfo Integration *ale-texinfo-options* + + +=============================================================================== +write-good *ale-texinfo-write-good* + +See |ale-write-good-options| + + +=============================================================================== +vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-text.txt b/doc/ale-text.txt new file mode 100644 index 00000000..a4dfa5e2 --- /dev/null +++ b/doc/ale-text.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE Text Integration *ale-text-options* + + +=============================================================================== +write-good *ale-text-write-good* + +See |ale-write-good-options| + + +=============================================================================== +vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-vim-help.txt b/doc/ale-vim-help.txt new file mode 100644 index 00000000..3cbe20d5 --- /dev/null +++ b/doc/ale-vim-help.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE Vim help Integration *ale-vim-help-options* + + +=============================================================================== +write-good *ale-vim-help-write-good* + +See |ale-write-good-options| + + +=============================================================================== +vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-xhtml.txt b/doc/ale-xhtml.txt new file mode 100644 index 00000000..3cc639ef --- /dev/null +++ b/doc/ale-xhtml.txt @@ -0,0 +1,12 @@ +=============================================================================== +ALE XHTML Integration *ale-xhtml-options* + + +=============================================================================== +write-good *ale-xhtml-write-good* + +See |ale-write-good-options| + + +=============================================================================== +vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index eaae2842..1bc639b8 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -13,7 +13,10 @@ CONTENTS *ale-contents* 5. Completion...........................|ale-completion| 6. Global Options.......................|ale-options| 6.1 Highlights........................|ale-highlights| + 6.2 Options for write-good Linter.....|ale-write-good-options| 7. Integration Documentation............|ale-integrations| + asciidoc..............................|ale-asciidoc-options| + write-good..........................|ale-asciidoc-write-good| asm...................................|ale-asm-options| gcc.................................|ale-asm-gcc| awk...................................|ale-awk-options| @@ -48,6 +51,8 @@ CONTENTS *ale-contents* dartanalyzer........................|ale-dart-dartanalyzer| dockerfile............................|ale-dockerfile-options| hadolint............................|ale-dockerfile-hadolint| + elixir................................|ale-elixir-options| + mix.................................|ale-elixir-mix| elm...................................|ale-elm-options| elm-format..........................|ale-elm-elm-format| elm-make............................|ale-elm-elm-make| @@ -70,10 +75,12 @@ CONTENTS *ale-contents* ember-template-lint.................|ale-handlebars-embertemplatelint| haskell...............................|ale-haskell-options| hdevtools...........................|ale-haskell-hdevtools| + hfmt................................|ale-haskell-hfmt| stack-build.........................|ale-haskell-stack-build| html..................................|ale-html-options| htmlhint............................|ale-html-htmlhint| tidy................................|ale-html-tidy| + write-good..........................|ale-html-write-good| idris.................................|ale-idris-options| idris...............................|ale-idris-idris| java..................................|ale-java-options| @@ -95,10 +102,18 @@ CONTENTS *ale-contents* kotlin................................|ale-kotlin-options| kotlinc.............................|ale-kotlin-kotlinc| ktlint..............................|ale-kotlin-ktlint| + latex.................................|ale-latex-options| + write-good..........................|ale-latex-write-good| + less..................................|ale-less-options| + prettier............................|ale-less-prettier| llvm..................................|ale-llvm-options| llc.................................|ale-llvm-llc| lua...................................|ale-lua-options| luacheck............................|ale-lua-luacheck| + markdown..............................|ale-markdown-options| + write-good..........................|ale-markdown-write-good| + nroff.................................|ale-nroff-options| + write-good..........................|ale-nroff-write-good| objc..................................|ale-objc-options| clang...............................|ale-objc-clang| objcpp................................|ale-objcpp-options| @@ -111,10 +126,13 @@ CONTENTS *ale-contents* php...................................|ale-php-options| hack................................|ale-php-hack| langserver..........................|ale-php-langserver| + phan................................|ale-php-phan| phpcbf..............................|ale-php-phpcbf| phpcs...............................|ale-php-phpcs| phpmd...............................|ale-php-phpmd| phpstan.............................|ale-php-phpstan| + pod...................................|ale-pod-options| + write-good..........................|ale-pod-write-good| pug...................................|ale-pug-options| puglint.............................|ale-pug-puglint| puppet................................|ale-puppet-options| @@ -131,6 +149,8 @@ CONTENTS *ale-contents* lintr...............................|ale-r-lintr| reasonml..............................|ale-reasonml-options| merlin..............................|ale-reasonml-merlin| + restructuredtext......................|ale-restructuredtext-options| + write-good..........................|ale-restructuredtext-write-good| ruby..................................|ale-ruby-options| brakeman............................|ale-ruby-brakeman| rails_best_practices................|ale-ruby-rails_best_practices| @@ -140,6 +160,7 @@ CONTENTS *ale-contents* cargo...............................|ale-rust-cargo| rls.................................|ale-rust-rls| rustc...............................|ale-rust-rustc| + rustfmt.............................|ale-rust-rustfmt| sass..................................|ale-sass-options| stylelint...........................|ale-sass-stylelint| scala.................................|ale-scala-options| @@ -163,6 +184,10 @@ CONTENTS *ale-contents* tex...................................|ale-tex-options| chktex..............................|ale-tex-chktex| lacheck.............................|ale-tex-lacheck| + texinfo...............................|ale-texinfo-options| + write-good..........................|ale-texinfo-write-good| + text..................................|ale-text-options| + write-good..........................|ale-text-write-good| thrift................................|ale-thrift-options| thrift..............................|ale-thrift-thrift| typescript............................|ale-typescript-options| @@ -175,6 +200,10 @@ CONTENTS *ale-contents* verilator...........................|ale-verilog-verilator| vim...................................|ale-vim-options| vint................................|ale-vim-vint| + vim help..............................|ale-vim-help-options| + write-good..........................|ale-vim-help-write-good| + xhtml.................................|ale-xhtml-options| + write-good..........................|ale-xhtml-write-good| xml...................................|ale-xml-options| xmllint.............................|ale-xml-xmllint| yaml..................................|ale-yaml-options| @@ -221,7 +250,7 @@ Notes: * ASM: `gcc` * Ansible: `ansible-lint` -* AsciiDoc: `proselint` +* AsciiDoc: `proselint`, `write-good` * Awk: `gawk` * Bash: `shell` (-n flag), `shellcheck` * Bourne Shell: `shell` (-n flag), `shellcheck` @@ -249,36 +278,38 @@ Notes: * GraphQL: `gqlint` * Haml: `haml-lint` * Handlebars: `ember-template-lint` -* Haskell: `ghc`, `stack-ghc`, `stack-build`!!, `ghc-mod`, `stack-ghc-mod`, `hlint`, `hdevtools` -* HTML: `HTMLHint`, `proselint`, `tidy` +* Haskell: `ghc`, `stack-ghc`, `stack-build`!!, `ghc-mod`, `stack-ghc-mod`, `hlint`, `hdevtools`, `hfmt` +* HTML: `HTMLHint`, `proselint`, `tidy`, `write-good` * Idris: `idris` * Java: `checkstyle`, `javac` * JavaScript: `eslint`, `jscs`, `jshint`, `flow`, `prettier`, `prettier-eslint` >= 4.2.0, `prettier-standard`, `standard`, `xo` * JSON: `jsonlint`, `prettier` * Kotlin: `kotlinc`, `ktlint` -* LaTeX (tex): `chktex`, `lacheck`, `proselint` +* LaTeX (tex): `chktex`, `lacheck`, `proselint`, `write-good` * LLVM: `llc` * Lua: `luacheck` -* Markdown: `mdl`, `proselint`, `vale` +* Mail: `proselint`, `vale` +* Make: `checkmake` +* Markdown: `mdl`, `proselint`, `vale`, `remark-lint`, `write-good` * MATLAB: `mlint` * Nim: `nim check`!! * nix: `nix-instantiate` -* nroff: `proselint` +* nroff: `proselint`, `write-good` * Objective-C: `clang` * Objective-C++: `clang` * OCaml: `merlin` (see |ale-ocaml-merlin|) * Perl: `perl -c`, `perl-critic` -* PHP: `hack`, `langserver`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf` -* Pod: `proselint` +* PHP: `hack`, `langserver`, `phan`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf` +* Pod: `proselint`, `write-good` * Pug: `pug-lint` * Puppet: `puppet`, `puppet-lint` * Python: `autopep8`, `flake8`, `isort`, `mypy`, `pycodestyle`, `pylint`!!, `yapf` * R: `lintr` * ReasonML: `merlin` -* reStructuredText: `proselint` +* reStructuredText: `proselint`, `write-good` * RPM spec: `rpmlint` * Ruby: `brakeman`, `rails_best_practices`!!, `reek`, `rubocop`, `ruby` -* Rust: `cargo`!!, `rls`, `rustc` (see |ale-integration-rust|) +* Rust: `cargo`!!, `rls`, `rustc` (see |ale-integration-rust|), `rustfmt` * SASS: `sass-lint`, `stylelint` * SCSS: `sass-lint`, `scss-lint`, `stylelint`, `prettier` * Scala: `scalac`, `scalastyle` @@ -289,14 +320,14 @@ Notes: * SQL: `sqlint` * Swift: `swiftlint`, `swiftformat` * Tcl: `nagelfar`!! -* Texinfo: `proselint` -* Text^: `proselint`, `vale` +* Texinfo: `proselint`, `write-good` +* Text^: `proselint`, `vale`, `write-good` * Thrift: `thrift` * TypeScript: `eslint`, `tslint`, `tsserver`, `typecheck`, `prettier` * Verilog: `iverilog`, `verilator` * Vim: `vint` -* Vim help^: `proselint` -* XHTML: `proselint` +* Vim help^: `proselint`, `write-good` +* XHTML: `proselint`, `write-good` * XML: `xmllint` * YAML: `swaglint`, `yamllint` @@ -593,6 +624,11 @@ g:ale_emit_conflict_warnings *g:ale_emit_conflict_warnings* When set to `0`, ALE will not emit any warnings on startup about conflicting plugins. ALE will probably not work if other linting plugins are installed. + When this option is set to `1`, ALE will add its `after` directory to + |runtimepath| automatically, so the checks can be applied. Setting this + option to `0` before ALE is loaded will prevent ALE from modifying + |runtimepath|. + g:ale_enabled *g:ale_enabled* *b:ale_enabled* @@ -1274,6 +1310,36 @@ ALEWarningSign *ALEWarningSign* The highlight used for warning signs. See |g:ale_set_signs|. +------------------------------------------------------------------------------- +6.2. Options for write-good *ale-write-good-options* + +The options for the write-good linter are global because it does not make +sense to have them specified on a per-language basis. + +g:ale_writegood_executable *g:ale_writegood_executable* + *b:ale_writegood_executable* + Type: |String| + Default: `'writegood'` + + See |ale-integrations-local-executables| + + +g:ale_writegood_options *g:ale_writegood_options* + *b:ale_writegood_options* + Type: |String| + Default: `''` + + This variable can be set to pass additional options to writegood. + + +g:ale_writegood_use_global *g:ale_writegood_use_global* + *b:ale_writegood_use_global* + Type: |Number| + Default: `0` + + See |ale-integrations-local-executables| + + =============================================================================== 7. Integration Documentation *ale-integrations* |