Skip to content
This repository was archived by the owner on Sep 28, 2020. It is now read-only.

Commit ddab805

Browse files
NickHeinerMoOx
authored andcommitted
Add clarifying note to README (#127)
This would have saved me some trouble 😄
1 parent c58747d commit ddab805

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -100,14 +100,16 @@ module.exports = {
100100
}
101101
```
102102

103+
Note that the config option you provide will be passed to the `CLIEngine`. This is a different set of options than what you'd specify in `package.json` or `.eslintrc`. See the [eslint docs](http://eslint.org/docs/developer-guide/nodejs-api#cliengine) for more detail.
104+
103105
**Note that you can use both methods in order to benefit from global & specific options**
104106

105107
#### `fix` (default: false)
106108

107109
This option will enable
108110
[ESLint autofix feature](http://eslint.org/docs/user-guide/command-line-interface#fix).
109111

110-
**Be careful, this option might cause webpack to enter an infinite build loop if
112+
**Be careful: this option might cause webpack to enter an infinite build loop if
111113
some issues cannot be fixed properly.**
112114

113115
#### `cache` (default: false)

0 commit comments

Comments
 (0)