diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale-development.txt | 1 | ||||
| -rw-r--r-- | doc/ale-java.txt | 23 | ||||
| -rw-r--r-- | doc/ale-ocaml.txt | 17 | ||||
| -rw-r--r-- | doc/ale-ruby.txt | 18 | ||||
| -rw-r--r-- | doc/ale.txt | 9 |
5 files changed, 65 insertions, 3 deletions
diff --git a/doc/ale-development.txt b/doc/ale-development.txt index d83c98f2..ac72d615 100644 --- a/doc/ale-development.txt +++ b/doc/ale-development.txt @@ -307,6 +307,7 @@ given the above setup are as follows. `AssertLSPLanguage language` - Check the language given to an LSP server. `AssertLSPOptions options_dict` - Check the options 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. =============================================================================== 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 4481e823..827a268c 100644 --- a/doc/ale-java.txt +++ b/doc/ale-java.txt @@ -76,4 +76,27 @@ g:ale_java_pmd_options *g:ale_java_pmd_options* =============================================================================== +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/vscode-javac. Simply +download the source code and then build the plugin using maven: + + mvn package + +This generates a out/fat-jar.jar file that contains the language server. To +let ALE use this language server you need to set the g:ale_java_javalsp_jar +variable to the absolute path of this jar file. + +g:ale_java_javalsp_jar *g:ale_java_javalsp_jar* + *b:ale_java_javalsp_jar* + + Type: String + Default: 'fat-jar.jar + + Path to the location of the vscode-javac language server plugin. + and -d. They are added automatically. + + +=============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-ocaml.txt b/doc/ale-ocaml.txt index a7ef8d29..adf17716 100644 --- a/doc/ale-ocaml.txt +++ b/doc/ale-ocaml.txt @@ -34,4 +34,21 @@ g:ale_ocaml_ols_use_global *g:ale_ocaml_ols_use_global* 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. + +=============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-ruby.txt b/doc/ale-ruby.txt index 85a3e137..ec7b07cf 100644 --- a/doc/ale-ruby.txt +++ b/doc/ale-ruby.txt @@ -99,4 +99,22 @@ g:ale_ruby_rufo_executable *g:ale_ruby_rufo_executable* =============================================================================== +solargraph *ale-ruby-solargraph* + +g:ale_ruby_solargraph_host *g:ale_ruby_solargraph_host* + *b:ale_ruby_solargraph_host* + Type: String + Default: `'127.0.0.1'` + + The host/ip where the solargraph language server is running. + +g:ale_ruby_solargraph_port *g:ale_ruby_solargraph_port* + *b:ale_ruby_solargraph_port* + Type: String + Default: `'7658'` + + The listening port where the solargraph language server is running. + + +=============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index 8e38f92a..29f74e1a 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -127,6 +127,7 @@ CONTENTS *ale-contents* javac...............................|ale-java-javac| google-java-format..................|ale-java-google-java-format| pmd.................................|ale-java-pmd| + javalsp.............................|ale-java-javalsp| javascript............................|ale-javascript-options| eslint..............................|ale-javascript-eslint| flow................................|ale-javascript-flow| @@ -179,6 +180,7 @@ CONTENTS *ale-contents* ocaml.................................|ale-ocaml-options| merlin..............................|ale-ocaml-merlin| ols.................................|ale-ocaml-ols| + ocamlformat.........................|ale-ocaml-ocamlformat| perl..................................|ale-perl-options| perl................................|ale-perl-perl| perlcritic..........................|ale-perl-perlcritic| @@ -237,6 +239,7 @@ CONTENTS *ale-contents* rubocop.............................|ale-ruby-rubocop| ruby................................|ale-ruby-ruby| rufo................................|ale-ruby-rufo| + solargraph..........................|ale-ruby-solargraph| rust..................................|ale-rust-options| cargo...............................|ale-rust-cargo| rls.................................|ale-rust-rls| @@ -387,7 +390,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` +* Java: `checkstyle`, `javac`, `google-java-format`, `PMD`, `javalsp` * JavaScript: `eslint`, `flow`, `jscs`, `jshint`, `prettier`, `prettier-eslint`, `prettier-standard`, `standard`, `xo` * JSON: `fixjson`, `jsonlint`, `jq`, `prettier` * Kotlin: `kotlinc`!!, `ktlint`!!, `languageserver` @@ -406,7 +409,7 @@ Notes: * nroff: `alex`!!, `proselint`, `write-good` * Objective-C: `clang`, `clangd` * Objective-C++: `clang`, `clangd` -* OCaml: `merlin` (see |ale-ocaml-merlin|), `ols` +* OCaml: `merlin` (see |ale-ocaml-merlin|), `ols`, `ocamlformat` * Perl: `perl -c`, `perl-critic`, `perltidy` * PHP: `langserver`, `phan`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf`, `php-cs-fixer` * PO: `alex`!!, `msgfmt`, `proselint`, `write-good` @@ -422,7 +425,7 @@ Notes: * reStructuredText: `alex`!!, `proselint`, `redpen`, `rstcheck`, `vale`, `write-good` * Re:VIEW: `redpen` * RPM spec: `rpmlint` -* Ruby: `brakeman`, `rails_best_practices`!!, `reek`, `rubocop`, `ruby`, `rufo` +* Ruby: `brakeman`, `rails_best_practices`!!, `reek`, `rubocop`, `ruby`, `rufo`, `solargraph` * Rust: `cargo`!!, `rls`, `rustc` (see |ale-integration-rust|), `rustfmt` * SASS: `sass-lint`, `stylelint` * SCSS: `prettier`, `sass-lint`, `scss-lint`, `stylelint` |