Skip to content
This repository has been archived by the owner on Feb 18, 2024. It is now read-only.

Add warning to eslint docs about differing config from eslintrc #505

Merged
merged 1 commit into from
Dec 1, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/packages/eslint/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,10 @@ module.exports = Neutrino()
```

If you are able, only use a `.eslintrc.js` file for editor hints, and use the Neutrino `lint` command for one-off linting
or fixes.
or fixes. **Loading ESLint configuration from `.eslintrc.js` that is not `.neutrinorc.js` or uses configuration that
differs from `.neutrinorc.js` could lead to unintended consequences such as linting not failing or passing when expected,
or working differently when running different commands. Closely evaluate whether you _actually_ need to make these rule
changes in `.eslintrc.js` over `.neutrinorc.js`.**

Projects may face a problem when their editor or IDE lints all files and highlights errors that were normally excluded
from source, i.e. Neutrino's `include` and `exclude` options. This is because the ESLint CLI does not have a way to
Expand Down
5 changes: 4 additions & 1 deletion packages/eslint/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,10 @@ module.exports = Neutrino()
```

If you are able, only use a `.eslintrc.js` file for editor hints, and use the Neutrino `lint` command for one-off linting
or fixes.
or fixes. **Loading ESLint configuration from `.eslintrc.js` that is not `.neutrinorc.js` or uses configuration that
differs from `.neutrinorc.js` could lead to unintended consequences such as linting not failing or passing when expected,
or working differently when running different commands. Closely evaluate whether you _actually_ need to make these rule
changes in `.eslintrc.js` over `.neutrinorc.js`.**

Projects may face a problem when their editor or IDE lints all files and highlights errors that were normally excluded
from source, i.e. Neutrino's `include` and `exclude` options. This is because the ESLint CLI does not have a way to
Expand Down