summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authortunnckoCore <mameto2011@gmail.com>2017-05-22 01:03:33 +0300
committerw0rp <devw0rp@gmail.com>2017-05-27 18:03:14 +0100
commit8e8113ff6f742572d02e52d33070ec374111c6d6 (patch)
tree1f4beb7920a1e7420c0c5ade4b6bf505243d6f9d /doc
parentc4f22186bd74b85c3ff22fdba2bed7a7d0009148 (diff)
downloadale-8e8113ff6f742572d02e52d33070ec374111c6d6.zip
feat(fixer): add Prettier fixer (using Prettier-ESLint CLI) + docs
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-javascript.txt39
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/ale-javascript.txt b/doc/ale-javascript.txt
index 561a84dc..4340ffee 100644
--- a/doc/ale-javascript.txt
+++ b/doc/ale-javascript.txt
@@ -40,6 +40,45 @@ g:ale_javascript_eslint_use_global *g:ale_javascript_eslint_use_global*
-------------------------------------------------------------------------------
+prettier *ale-javascript-prettier*
+
+g:ale_javascript_prettier_executable *g:ale_javascript_prettier_executable*
+ *b:ale_javascript_prettier_executable*
+ Type: |String|
+ Default: `'prettier-eslint'`
+
+ ALE will first discover the prettier-eslint path in an ancestor node_modules
+ directory. If no such path exists, this variable will be used instead.
+
+ This variable can be set to change the path to prettier-eslint or if you want
+ to use the original Prettier CLI.
+
+ If you wish to use only a globally installed version of prettier or
+ prettier-eslint, set the set
+ |g:ale_javascript_prettier_use_global| to `1`.
+
+
+g:ale_javascript_prettier_options *g:ale_javascript_prettier_options*
+ *b:ale_javascript_prettier_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to prettier.
+
+
+g:ale_javascript_prettier_use_global *g:ale_javascript_eslint_use_global*
+ *b:ale_javascript_eslint_use_global*
+ Type: |Number|
+ Default: `0`
+
+ This variable controls whether or not ALE will search for a local path for
+ prettier-eslint-cli first. If this variable is set to `1`,
+ then ALE will always use the global version of Prettier or Prettier-ESLint,
+ depending on g:ale_javascript_prettier_executable, in preference to
+ locally installed versions of Prettier / Prettier-ESLint in node_modules.
+
+
+-------------------------------------------------------------------------------
flow *ale-javascript-flow*
g:ale_javascript_flow_executable *g:ale_javascript_flow_executable*