summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2018-04-09 19:11:20 +0100
committerw0rp <devw0rp@gmail.com>2018-04-09 19:11:20 +0100
commit719b790574b6aeb4fc3c956dfbcffa3c3987a668 (patch)
treed0d773308e97a3002075f9de2348874606b70ed4 /doc
parent3a47413286ff4701898b571aa4b066bd6d17bf3e (diff)
downloadale-719b790574b6aeb4fc3c956dfbcffa3c3987a668.zip
Close #542 - Add an option for disabling running locally installed executables by default
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-css.txt2
-rw-r--r--doc/ale-elm.txt4
-rw-r--r--doc/ale-gitcommit.txt2
-rw-r--r--doc/ale-handlebars.txt2
-rw-r--r--doc/ale-html.txt2
-rw-r--r--doc/ale-javascript.txt18
-rw-r--r--doc/ale-json.txt2
-rw-r--r--doc/ale-less.txt4
-rw-r--r--doc/ale-ocaml.txt2
-rw-r--r--doc/ale-php.txt8
-rw-r--r--doc/ale-pug.txt2
-rw-r--r--doc/ale-python.txt20
-rw-r--r--doc/ale-reasonml.txt2
-rw-r--r--doc/ale-sass.txt2
-rw-r--r--doc/ale-scss.txt2
-rw-r--r--doc/ale-stylus.txt2
-rw-r--r--doc/ale-text.txt2
-rw-r--r--doc/ale-typescript.txt4
-rw-r--r--doc/ale-yaml.txt2
-rw-r--r--doc/ale.txt17
20 files changed, 58 insertions, 43 deletions
diff --git a/doc/ale-css.txt b/doc/ale-css.txt
index 474445b8..f3cae385 100644
--- a/doc/ale-css.txt
+++ b/doc/ale-css.txt
@@ -30,7 +30,7 @@ g:ale_css_stylelint_options *g:ale_css_stylelint_options*
g:ale_css_stylelint_use_global *g:ale_css_stylelint_use_global*
*b:ale_css_stylelint_use_global*
Type: |String|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
diff --git a/doc/ale-elm.txt b/doc/ale-elm.txt
index e96205df..32beab7b 100644
--- a/doc/ale-elm.txt
+++ b/doc/ale-elm.txt
@@ -16,7 +16,7 @@ g:ale_elm_format_executable *g:ale_elm_format_executable*
g:ale_elm_format_use_global *g:ale_elm_format_use_global*
*b:ale_elm_format_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -42,7 +42,7 @@ g:ale_elm_make_executable *g:ale_elm_make_executable*
g:ale_elm_make_use_global *g:ale_elm_make_use_global*
*b:ale_elm_make_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
diff --git a/doc/ale-gitcommit.txt b/doc/ale-gitcommit.txt
index 71813dd0..19ba8e94 100644
--- a/doc/ale-gitcommit.txt
+++ b/doc/ale-gitcommit.txt
@@ -30,7 +30,7 @@ g:ale_gitcommit_gitlint_options *g:ale_gitcommit_gitlint_options*
g:ale_gitcommit_gitlint_use_global *g:ale_gitcommit_gitlint_use_global*
*b:ale_gitcommit_gitlint_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
This variable controls whether or not ALE will search for gitlint in a
virtualenv directory first. If this variable is set to `1`, then ALE will
diff --git a/doc/ale-handlebars.txt b/doc/ale-handlebars.txt
index 6908aac6..061c5d3c 100644
--- a/doc/ale-handlebars.txt
+++ b/doc/ale-handlebars.txt
@@ -16,7 +16,7 @@ g:ale_handlebars_embertemplatelint_executable
g:ale_handlebars_embertemplatelint_use_global
*g:ale_handlebars_embertemplatelint_use_global*
Type: |Number| *b:ale_handlebars_embertemplatelint_use_global*
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
diff --git a/doc/ale-html.txt b/doc/ale-html.txt
index 416e932e..2d8873ef 100644
--- a/doc/ale-html.txt
+++ b/doc/ale-html.txt
@@ -24,7 +24,7 @@ g:ale_html_htmlhint_options *g:ale_html_htmlhint_options*
g:ale_html_htmlhint_use_global *g:ale_html_htmlhint_use_global*
*b:ale_html_htmlhint_use_global*
Type: |String|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
diff --git a/doc/ale-javascript.txt b/doc/ale-javascript.txt
index f625fd7f..80f41016 100644
--- a/doc/ale-javascript.txt
+++ b/doc/ale-javascript.txt
@@ -45,7 +45,7 @@ g:ale_javascript_eslint_options *g:ale_javascript_eslint_options*
g:ale_javascript_eslint_use_global *g:ale_javascript_eslint_use_global*
*b:ale_javascript_eslint_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -98,7 +98,7 @@ g:ale_javascript_flow_use_home_config *g:ale_javascript_flow_use_home_config*
g:ale_javascript_flow_use_global *g:ale_javascript_flow_use_global*
*b:ale_javascript_flow_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -126,7 +126,7 @@ g:ale_javascript_jscs_executable *g:ale_javascript_jscs_executable*
g:ale_javascript_jscs_use_global *g:ale_javascript_jscs_use_global*
*b:ale_javascript_jscs_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -145,7 +145,7 @@ g:ale_javascript_jshint_executable *g:ale_javascript_jshint_executable*
g:ale_javascript_jshint_use_global *g:ale_javascript_jshint_use_global*
*b:ale_javascript_jshint_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -172,7 +172,7 @@ g:ale_javascript_prettier_options *g:ale_javascript_prettier_options*
g:ale_javascript_prettier_use_global *g:ale_javascript_prettier_use_global*
*b:ale_javascript_prettier_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -202,7 +202,7 @@ g:ale_javascript_prettier_eslint_use_global
*g:ale_javascript_prettier_eslint_use_global*
*b:ale_javascript_prettier_eslint_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -233,7 +233,7 @@ g:ale_javascript_prettier_standard_use_global
*g:ale_javascript_prettier_standard_use_global*
*b:ale_javascript_prettier_standard_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -262,7 +262,7 @@ g:ale_javascript_standard_options *g:ale_javascript_standard_options*
g:ale_javascript_standard_use_global *g:ale_javascript_standard_use_global*
*b:ale_javascript_standard_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -289,7 +289,7 @@ g:ale_javascript_xo_options *g:ale_javascript_xo_options*
g:ale_javascript_xo_use_global *g:ale_javascript_xo_use_global*
*b:ale_javascript_xo_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
diff --git a/doc/ale-json.txt b/doc/ale-json.txt
index 1e97abce..0ec7932d 100644
--- a/doc/ale-json.txt
+++ b/doc/ale-json.txt
@@ -44,7 +44,7 @@ g:ale_json_fixjson_use_global *g:ale_json_fixjson_use_global*
*b:ale_json_fixjson_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
diff --git a/doc/ale-less.txt b/doc/ale-less.txt
index 05f56e2b..040e511e 100644
--- a/doc/ale-less.txt
+++ b/doc/ale-less.txt
@@ -24,7 +24,7 @@ g:ale_less_lessc_options *g:ale_less_lessc_options*
g:ale_less_lessc_use_global *g:ale_less_lessc_use_global*
*b:ale_less_lessc_use_global*
Type: |String|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -57,7 +57,7 @@ g:ale_less_stylelint_options *g:ale_less_stylelint_options*
g:ale_less_stylelint_use_global *g:ale_less_stylelint_use_global*
*b:ale_less_stylelint_use_global*
Type: |String|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
diff --git a/doc/ale-ocaml.txt b/doc/ale-ocaml.txt
index cfa365af..a7ef8d29 100644
--- a/doc/ale-ocaml.txt
+++ b/doc/ale-ocaml.txt
@@ -28,7 +28,7 @@ g:ale_ocaml_ols_executable *g:ale_ocaml_ols_executable*
g:ale_ocaml_ols_use_global *g:ale_ocaml_ols_use_global*
*b:ale_ocaml_ols_use_global*
Type: |String|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
This variable can be set to `1` to always use the globally installed
executable. See also |ale-integrations-local-executables|.
diff --git a/doc/ale-php.txt b/doc/ale-php.txt
index 52b37ea3..1ba34388 100644
--- a/doc/ale-php.txt
+++ b/doc/ale-php.txt
@@ -37,7 +37,7 @@ g:ale_php_langserver_executable *g:ale_php_langserver_executable*
g:ale_php_langserver_use_global *g:ale_php_langserver_use_global*
*b:ale_php_langserver_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
This variable can be set to `1` to force the language server to be run with
the executable set for |g:ale_php_langserver_executable|.
@@ -84,7 +84,7 @@ g:ale_php_phpcbf_standard *g:ale_php_phpcbf_standard*
g:ale_php_phpcbf_use_global *g:ale_php_phpcbf_use_global*
*b:ale_php_phpcbf_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -113,7 +113,7 @@ g:ale_php_phpcs_standard *g:ale_php_phpcs_standard*
g:ale_php_phpcs_use_global *g:ale_php_phpcs_use_global*
*b:ale_php_phpcs_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -179,7 +179,7 @@ g:ale_php_cs_fixer_executable *g:ale_php_cs_fixer_executable*
g:ale_php_cs_fixer_use_global *g:ale_php_cs_fixer_use_global*
*b:ale_php_cs_fixer_use_global*
Type: |Boolean|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
This variable force globally installed fixer.
diff --git a/doc/ale-pug.txt b/doc/ale-pug.txt
index 01071485..e2836f85 100644
--- a/doc/ale-pug.txt
+++ b/doc/ale-pug.txt
@@ -35,7 +35,7 @@ g:ale_pug_puglint_options *g:ale_pug_puglint_options*
g:ale_pug_puglint_use_global *g:ale_pug_puglint_use_global*
*b:ale_pug_puglint_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
diff --git a/doc/ale-python.txt b/doc/ale-python.txt
index dc7c8bba..396603e9 100644
--- a/doc/ale-python.txt
+++ b/doc/ale-python.txt
@@ -24,7 +24,7 @@ g:ale_python_autopep8_options *g:ale_python_autopep8_options*
g:ale_python_autopep8_use_global *g:ale_python_autopep8_use_global*
*b:ale_python_autopep8_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -51,7 +51,7 @@ g:ale_python_black_options *g:ale_python_black_options*
g:ale_python_black_use_global *g:ale_python_black_use_global*
*b:ale_python_black_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -88,7 +88,7 @@ g:ale_python_flake8_options *g:ale_python_flake8_options*
g:ale_python_flake8_use_global *g:ale_python_flake8_use_global*
*b:ale_python_flake8_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
This variable controls whether or not ALE will search for flake8 in a
virtualenv directory first. If this variable is set to `1`, then ALE will
@@ -111,7 +111,7 @@ g:ale_python_isort_executable *g:ale_python_isort_executable*
g:ale_python_isort_use_global *g:ale_python_isort_use_global*
*b:ale_python_isort_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -154,7 +154,7 @@ g:ale_python_mypy_options *g:ale_python_mypy_options*
g:ale_python_mypy_use_global *g:ale_python_mypy_use_global*
*b:ale_python_mypy_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -194,7 +194,7 @@ g:ale_python_prospector_options *g:ale_python_prospector_options*
g:ale_python_prospector_use_global *g:ale_python_prospector_use_global*
*b:ale_python_prospector_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -223,7 +223,7 @@ g:ale_python_pycodestyle_options *g:ale_python_pycodestyle_options*
g:ale_python_pycodestyle_use_global *g:ale_python_pycodestyle_use_global*
*b:ale_python_pycodestyle_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -262,7 +262,7 @@ g:ale_python_pylint_options *g:ale_python_pylint_options*
g:ale_python_pylint_use_global *g:ale_python_pylint_use_global*
*b:ale_python_pylint_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -281,7 +281,7 @@ g:ale_python_pyls_executable *g:ale_python_pyls_executable*
g:ale_python_pyls_use_global *g:ale_python_pyls_use_global*
*b:ale_python_pyls_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -300,7 +300,7 @@ g:ale_python_yapf_executable *g:ale_python_yapf_executable*
g:ale_python_yapf_use_global *g:ale_python_yapf_use_global*
*b:ale_python_yapf_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
diff --git a/doc/ale-reasonml.txt b/doc/ale-reasonml.txt
index 36ddd75d..426d4c46 100644
--- a/doc/ale-reasonml.txt
+++ b/doc/ale-reasonml.txt
@@ -28,7 +28,7 @@ g:ale_reason_ols_executable *g:ale_reason_ols_executable*
g:ale_reason_ols_use_global *g:ale_reason_ols_use_global*
*b:ale_reason_ols_use_global*
Type: |String|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
This variable can be set to `1` to always use the globally installed
executable. See also |ale-integrations-local-executables|.
diff --git a/doc/ale-sass.txt b/doc/ale-sass.txt
index 5465957a..08e9a381 100644
--- a/doc/ale-sass.txt
+++ b/doc/ale-sass.txt
@@ -16,7 +16,7 @@ g:ale_sass_stylelint_executable *g:ale_sass_stylelint_executable*
g:ale_sass_stylelint_use_global *g:ale_sass_stylelint_use_global*
*b:ale_sass_stylelint_use_global*
Type: |String|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
diff --git a/doc/ale-scss.txt b/doc/ale-scss.txt
index 19695a76..14e6feb7 100644
--- a/doc/ale-scss.txt
+++ b/doc/ale-scss.txt
@@ -22,7 +22,7 @@ g:ale_scss_stylelint_executable *g:ale_scss_stylelint_executable*
g:ale_scss_stylelint_use_global *g:ale_scss_stylelint_use_global*
*b:ale_scss_stylelint_use_global*
Type: |String|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
diff --git a/doc/ale-stylus.txt b/doc/ale-stylus.txt
index 59d90551..3e6ba906 100644
--- a/doc/ale-stylus.txt
+++ b/doc/ale-stylus.txt
@@ -24,7 +24,7 @@ g:ale_stylus_stylelint_options *g:ale_stylus_stylelint_options*
g:ale_stylus_stylelint_use_global *g:ale_stylus_stylelint_use_global*
*b:ale_stylus_stylelint_use_global*
Type: |String|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
diff --git a/doc/ale-text.txt b/doc/ale-text.txt
index 844f2ff4..913d7e61 100644
--- a/doc/ale-text.txt
+++ b/doc/ale-text.txt
@@ -27,7 +27,7 @@ g:ale_textlint_options *g:ale_textlint_options*
g:ale_textlint_use_global *g:ale_textlint_use_global*
*b:ale_textlint_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
diff --git a/doc/ale-typescript.txt b/doc/ale-typescript.txt
index d83a2dfe..1bccf5a3 100644
--- a/doc/ale-typescript.txt
+++ b/doc/ale-typescript.txt
@@ -59,7 +59,7 @@ g:ale_typescript_tslint_rules_dir *g:ale_typescript_tslint_rules_dir*
g:ale_typescript_tslint_use_global *g:ale_typescript_tslint_use_global*
*b:ale_typescript_tslint_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -91,7 +91,7 @@ g:ale_typescript_tsserver_config_path *g:ale_typescript_tsserver_config_path*
g:ale_typescript_tsserver_use_global *g:ale_typescript_tsserver_use_global*
*b:ale_typescript_tsserver_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
This variable controls whether or not ALE will search for a local path for
tsserver first. If this variable is set to `1`, then ALE will always use the
diff --git a/doc/ale-yaml.txt b/doc/ale-yaml.txt
index a902f25d..044d0b3d 100644
--- a/doc/ale-yaml.txt
+++ b/doc/ale-yaml.txt
@@ -31,7 +31,7 @@ g:ale_yaml_swaglint_executable *g:ale_yaml_swaglint_executable*
g:ale_yaml_swaglint_use_global *g:ale_yaml_swaglint_use_global*
*b:ale_yaml_swaglint_use_global*
Type: |String|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
diff --git a/doc/ale.txt b/doc/ale.txt
index 0d3053e2..c051a86f 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -1498,6 +1498,18 @@ g:ale_type_map *g:ale_type_map*
Type maps can be set per-buffer with `b:ale_type_map`.
+g:ale_use_global_executables *g:ale_use_global_executables*
+
+ Type: |Number|
+ Default: not set
+
+ This option can be set to change the default for all `_use_global` options.
+ This option must be set before ALE is loaded, preferably in a vimrc file.
+
+ See |ale-integrations-local-executables| for more information on those
+ options.
+
+
g:ale_virtualenv_dir_names *g:ale_virtualenv_dir_names*
b:ale_virtualenv_dir_names *b:ale_virtualenv_dir_names*
@@ -1685,7 +1697,7 @@ g:ale_writegood_options *g:ale_writegood_options*
g:ale_writegood_use_global *g:ale_writegood_use_global*
*b:ale_writegood_use_global*
Type: |Number|
- Default: `0`
+ Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@@ -1719,6 +1731,9 @@ If you prefer to use global executables for those tools, set the relevant
let g:ale_python_flake8_use_global = 1
<
+|g:ale_use_global_executables| can be set to `1` in your vimrc file to make
+ALE use global executables for all linters by default.
+
The option |g:ale_virtualenv_dir_names| controls the local virtualenv paths
ALE will use to search for Python executables.