Skip to content

Commit eca01ed

Browse files
jrpoolnot-an-aardvark
authored andcommittedOct 18, 2017
Docs: Add missing info about special status of home-dir config files. (#9472)
This seems to be the last step in liquidating issue #7729.
1 parent eb8cfb1 commit eca01ed

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed
 

‎docs/user-guide/configuring.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
ESLint is designed to be completely configurable, meaning you can turn off every rule and run only with basic syntax validation, or mix and match the bundled rules and your custom rules to make ESLint perfect for your project. There are two primary ways to configure ESLint:
44

55
1. **Configuration Comments** - use JavaScript comments to embed configuration information directly into a file.
6-
1. **Configuration Files** - use a JavaScript, JSON or YAML file to specify configuration information for an entire directory and all of its subdirectories. This can be in the form of an [.eslintrc.*](#configuration-file-formats) file or an `eslintConfig` field in a [`package.json`](https://docs.npmjs.com/files/package.json) file, both of which ESLint will look for and read automatically, or you can specify a configuration file on the [command line](command-line-interface).
6+
1. **Configuration Files** - use a JavaScript, JSON or YAML file to specify configuration information for an entire directory (other than your home directory) and all of its subdirectories. This can be in the form of an [.eslintrc.*](#configuration-file-formats) file or an `eslintConfig` field in a [`package.json`](https://docs.npmjs.com/files/package.json) file, both of which ESLint will look for and read automatically, or you can specify a configuration file on the [command line](command-line-interface).
7+
8+
If you have a configuration file in your home directory (generally `~/`), ESLint uses it **only** if ESLint cannot find any other configuration file.
79

810
There are several pieces of information that can be configured:
911

0 commit comments

Comments
 (0)
Please sign in to comment.