summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBartek thindil Jasicki <thindil@laeran.pl>2021-01-22 17:52:01 +0100
committerBartek thindil Jasicki <thindil@laeran.pl>2021-01-22 17:52:01 +0100
commit1ca780a08ad28a2c8264ec9292e9fbbf96930e06 (patch)
tree0240bd1da22673dfb21c885bf2852fbffd7540c5 /doc
parent42bf5ca91110bac565d76263bd5d21ebb9b142a9 (diff)
parent1b010bbabb5b28cc2746ca967941ffdc9240960e (diff)
downloadale-1ca780a08ad28a2c8264ec9292e9fbbf96930e06.zip
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-dart.txt25
-rw-r--r--doc/ale-openapi.txt74
-rw-r--r--doc/ale-supported-languages-and-tools.txt6
-rw-r--r--doc/ale-typescript.txt27
-rw-r--r--doc/ale-vala.txt21
-rw-r--r--doc/ale.txt6
6 files changed, 159 insertions, 0 deletions
diff --git a/doc/ale-dart.txt b/doc/ale-dart.txt
index a6d88dd8..01089252 100644
--- a/doc/ale-dart.txt
+++ b/doc/ale-dart.txt
@@ -3,6 +3,31 @@ ALE Dart Integration *ale-dart-options*
===============================================================================
+analysis_server *ale-dart-analysis_server*
+
+Installation
+-------------------------------------------------------------------------------
+
+Install Dart via whatever means. `analysis_server` will be included in the SDK.
+
+In case that `dart` is not in your path, try to set the executable option to
+its absolute path. : >
+ " Set the executable path for dart to the absolute path to it.
+ let g:ale_dart_analysis_server_executable = '/usr/local/bin/dart'
+<
+
+Options
+-------------------------------------------------------------------------------
+
+g:ale_dart_analysis_server_executable *g:ale_dart_analysis_server_executable*
+ *b:ale_dart_analysis_server_executable*
+ Type: |String|
+ Default: `'dart'`
+
+ This variable can be set to change the path of dart.
+
+
+===============================================================================
dartanalyzer *ale-dart-dartanalyzer*
Installation
diff --git a/doc/ale-openapi.txt b/doc/ale-openapi.txt
new file mode 100644
index 00000000..1fc41add
--- /dev/null
+++ b/doc/ale-openapi.txt
@@ -0,0 +1,74 @@
+===============================================================================
+ALE OpenApi Integration *ale-openapi-options*
+
+===============================================================================
+ibm_validator *ale-openapi-ibm-validator*
+
+Website: https://github.com/IBM/openapi-validator
+
+
+Installation
+-------------------------------------------------------------------------------
+
+Install ibm-openapi-validator either globally or locally: >
+
+ npm install ibm-openapi-validator -g # global
+ npm install ibm-openapi-validator # local
+<
+Configuration
+-------------------------------------------------------------------------------
+
+OpenAPI files can be written in YAML or JSON so in order for ALE plugins to
+work with these files we must set the buffer |filetype| to either |openapi.yaml|
+or |openapi.json| respectively. This causes ALE to lint the file with linters
+configured for openapi and yaml files or openapi and json files respectively.
+
+For example setting filetype to |openapi.yaml| on a buffer and the following
+|g:ale_linters| configuration will enable linting of openapi files using both
+|ibm_validator| and |yamlint|:
+
+>
+ let g:ale_linters = {
+ \ 'yaml': ['yamllint'],
+ \ 'openapi': ['ibm_validator']
+ \}
+<
+
+The following plugin will detect openapi files automatically and set the
+filetype to |openapi.yaml| or |openapi.json|:
+
+ https://github.com/hsanson/vim-openapi
+
+Options
+-------------------------------------------------------------------------------
+
+g:ale_openapi_ibm_validator_executable *g:ale_openapi_ibm_validator_executable*
+ *b:ale_openapi_ibm_validator_executable*
+ Type: |String|
+ Default: `'lint-openapi'`
+
+ This variable can be set to change the path to lint-openapi.
+
+
+g:ale_openapi_ibm_validator_options *g:ale_openapi_ibm_validator_options*
+ *b:ale_openapi_ibm_validator_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to lint-openapi.
+
+
+===============================================================================
+prettier *ale-openapi-prettier*
+
+See |ale-javascript-prettier| for information about the available options.
+
+
+===============================================================================
+yamllint *ale-openapi-yamllint*
+
+See |ale-yaml-yamllint| for information about the available options.
+
+
+===============================================================================
+ 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 d06508c5..c3ab3690 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -117,6 +117,7 @@ Notes:
* Dafny
* `dafny`!!
* Dart
+ * `analysis_server`
* `dartanalyzer`!!
* `dartfmt`!!
* `language_server`
@@ -323,6 +324,10 @@ Notes:
* `ocamlformat`
* `ocp-indent`
* `ols`
+* OpenApi
+ * `ibm_validator`
+ * `prettier`
+ * `yamllint`
* Pawn
* `uncrustify`
* Perl
@@ -502,6 +507,7 @@ Notes:
* `typecheck`
* VALA
* `uncrustify`
+ * `vala_lint`!!
* Verilog
* `hdl-checker`
* `iverilog`
diff --git a/doc/ale-typescript.txt b/doc/ale-typescript.txt
index 2c50d119..026d17ce 100644
--- a/doc/ale-typescript.txt
+++ b/doc/ale-typescript.txt
@@ -139,4 +139,31 @@ g:ale_typescript_tsserver_use_global *g:ale_typescript_tsserver_use_global*
===============================================================================
+xo *ale-typescript-xo*
+
+g:ale_typescript_xo_executable *g:ale_typescript_xo_executable*
+ *b:ale_typescript_xo_executable*
+ Type: |String|
+ Default: `'xo'`
+
+ See |ale-integrations-local-executables|
+
+
+g:ale_typescript_xo_options *g:ale_typescript_xo_options*
+ *b:ale_typescript_xo_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to xo.
+
+
+g:ale_typescript_xo_use_global *g:ale_typescript_xo_use_global*
+ *b:ale_typescript_xo_use_global*
+ Type: |Number|
+ Default: `get(g:, 'ale_use_global_executables', 0)`
+
+ See |ale-integrations-local-executables|
+
+
+===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-vala.txt b/doc/ale-vala.txt
index ca24bcf4..d48f68bb 100644
--- a/doc/ale-vala.txt
+++ b/doc/ale-vala.txt
@@ -9,4 +9,25 @@ See |ale-c-uncrustify| for information about the available options.
===============================================================================
+Vala-Lint *ale-vala-vala-lint*
+
+g:vala_vala_lint_executable *g:vala_vala_lint_executable*
+ *b:vala_vala_lint_executable*
+ Type: |String|
+ Default: `'io.elementary.vala-lint'`
+
+ This variable can be set to specify a Vala-Lint executable file.
+
+
+g:vala_vala_lint_config_filename *g:vala_vala_lint_config_filename*
+ *b:vala_vala_lint_config_filename*
+ Type: |String|
+ Default: `'vala-lint.conf'`
+
+ This variable can be set to specify a Vala-Lint config filename. When a file
+ with the specified name was not found or this variable was set to empty,
+ Vala-Lint will be executed without specifying a config filename.
+
+
+===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale.txt b/doc/ale.txt
index ce01638f..d5ea82ca 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -2665,6 +2665,7 @@ documented in additional help files.
dafny...................................|ale-dafny-options|
dafny.................................|ale-dafny-dafny|
dart....................................|ale-dart-options|
+ analysis_server.......................|ale-dart-analysis_server|
dartanalyzer..........................|ale-dart-dartanalyzer|
dartfmt...............................|ale-dart-dartfmt|
dhall...................................|ale-dhall-options|
@@ -2836,6 +2837,10 @@ documented in additional help files.
ols...................................|ale-ocaml-ols|
ocamlformat...........................|ale-ocaml-ocamlformat|
ocp-indent............................|ale-ocaml-ocp-indent|
+ openapi.................................|ale-openapi-options|
+ ibm_validator.........................|ale-openapi-ibm-validator|
+ prettier..............................|ale-openapi-prettier|
+ yamllint..............................|ale-openapi-yamllint|
pawn....................................|ale-pawn-options|
uncrustify............................|ale-pawn-uncrustify|
perl....................................|ale-perl-options|
@@ -2994,6 +2999,7 @@ documented in additional help files.
standard..............................|ale-typescript-standard|
tslint................................|ale-typescript-tslint|
tsserver..............................|ale-typescript-tsserver|
+ xo....................................|ale-typescript-xo|
vala....................................|ale-vala-options|
uncrustify............................|ale-vala-uncrustify|
verilog/systemverilog...................|ale-verilog-options|