summaryrefslogtreecommitdiff
path: root/doc/ale-javascript.txt
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-06-24 17:32:43 +0100
committerw0rp <devw0rp@gmail.com>2017-06-24 17:32:43 +0100
commitd1e23f7295cabf3c62bb218687613f82125bc118 (patch)
tree8c1767d5637e0be4d51f2557f56d4e1ddff1dd49 /doc/ale-javascript.txt
parentdc647fcc7fc716c3f5488fc7af115e64243e2021 (diff)
downloadale-d1e23f7295cabf3c62bb218687613f82125bc118.zip
Fix #683 Recommend prettier and eslint over prettier-eslint
Diffstat (limited to 'doc/ale-javascript.txt')
-rw-r--r--doc/ale-javascript.txt11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/ale-javascript.txt b/doc/ale-javascript.txt
index f7b01fa2..296cb901 100644
--- a/doc/ale-javascript.txt
+++ b/doc/ale-javascript.txt
@@ -80,6 +80,17 @@ g:ale_javascript_prettier_use_global *g:ale_javascript_prettier_use_global*
-------------------------------------------------------------------------------
prettier-eslint *ale-javascript-prettier-eslint*
+ALE supports `prettier-eslint` for easy integration with projects, but it is
+not recommended for new projects. ALE instead recommends configuring
+|g:ale_fixers| to run `'prettier'` and `'eslint'` in a sequence like so: >
+
+ let g:ale_fixers = {'javascript': ['prettier', 'eslint']}
+<
+
+This is because `prettier-eslint` cannot be configured to use the ESLint
+configuration file for input given via stdin, which is how ALE integrates with
+the tool.
+
g:ale_javascript_prettier_eslint_executable
*g:ale_javascript_prettier_eslint_executable*
*b:ale_javascript_prettier_eslint_executable*