summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-06-08 09:37:51 +0100
committerw0rp <devw0rp@gmail.com>2017-06-08 09:37:51 +0100
commitd8d96fb0eb193c504680d3e21489c761fce46172 (patch)
treefe925696ee12c6160875ce01ccaa28b45bd2e32c
parente93dba351cd4f78dd58a4e04fc6c06806029a77c (diff)
downloadale-d8d96fb0eb193c504680d3e21489c761fce46172.zip
Fix #634 - Document eslint --fix behaviour with nested configuration files
-rw-r--r--doc/ale-javascript.txt21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/ale-javascript.txt b/doc/ale-javascript.txt
index 2eab1177..e104656b 100644
--- a/doc/ale-javascript.txt
+++ b/doc/ale-javascript.txt
@@ -1,6 +1,27 @@
===============================================================================
ALE JavaScript Integration *ale-javascript-options*
+ *ale-eslint-nested-configuration-files*
+
+For fixing files with ESLint, nested configuration files with `root: false`
+are not supported. This is because ALE fixes files by writing the contents of
+buffers to temporary files, and then explicitly sets the configuration file.
+Configuration files which are set explicitly must be root configuration files.
+If you are using nested configuration files, you should restructure your
+project so your configuration files use `extends` instead.
+
+See the ESLint documentation here:
+http://eslint.org/docs/user-guide/configuring#extending-configuration-files
+
+You should change the structure of your project from this: >
+ /path/foo/.eslintrc.js # root: true
+ /path/foo/bar/.eslintrc.js # root: false
+<
+To this: >
+ /path/foo/.base-eslintrc.js # Base configuration here
+ /path/foo/.eslintrc.js # extends: ["/path/foo/.base-eslintrc.js"]
+ /path/foo/bar/.eslintrc.js # extends: ["/path/foo/.base-eslintrc.js"]
+<
-------------------------------------------------------------------------------
eslint *ale-javascript-eslint*