Add description how to ignore files in an IDE lint #205
Conversation
Codecov Report
@@ Coverage Diff @@
## master #205 +/- ##
=======================================
Coverage 94.14% 94.14%
=======================================
Files 36 36
Lines 512 512
=======================================
Hits 482 482
Misses 30 30Continue to review full report at Codecov.
|
| @@ -127,6 +127,19 @@ pkg.neutrino.use | |||
| module.exports = api.eslintrc(); | |||
There was a problem hiding this comment.
The docs here need to also be replicated in docs/, but with relative paths.
| @@ -127,6 +127,19 @@ pkg.neutrino.use | |||
| module.exports = api.eslintrc(); | |||
| ``` | |||
|
|
|||
| Projects authors may also face the problem when their code editor lints all files in the project and highlights errors in all of them. It ignores Neutrino `include` and `exclude` options. This is because editors use CLI to call ESLint instead of Neutrino infrastructure. | |||
There was a problem hiding this comment.
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
includeandexcludeoptions. This is because the ESLint CLI does not have a way to specify included and excluded files from configuration. If you still wish to use ESLint's CLI for linting, consider setting CLI flags or using an eslintignore to choose which files to include or exclude from linting.
| @@ -251,6 +251,19 @@ pkg.neutrino.use | |||
| module.exports = api.eslintrc(); | |||
| ``` | |||
|
|
|||
| Projects authors may also face the problem when their code editor lints all files in the project and highlights errors in all of them. It ignores Neutrino `include` and `exclude` options. This is because editors use CLI to call ESLint instead of Neutrino infrastructure. | |||
There was a problem hiding this comment.
Use same copy as I commented elsewhere.
|
Just wanted to update here that these documentation files still need to be duplicated into the |
| @@ -251,6 +251,19 @@ pkg.neutrino.use | |||
| module.exports = api.eslintrc(); | |||
| ``` | |||
|
|
|||
| 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 specify included and excluded files from configuration. If you still wish to use ESLint's CLI for linting, consider setting [CLI flags](http://eslint.org/docs/user-guide/command-line-interface#options) or using an [eslintignore](http://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories) to choose which files to include or exclude from linting. | |||
|
|
|||
| Unfortunately ESlint doesn't provide possibility to configure ignored paths from `.neutrino.js` to exclude them from linting. Projects authors should define this manually in their project root directory in `.eslintignore` file. | |||
There was a problem hiding this comment.
Replace all .neutrino.js with "Neutrino configuration".
Please check if everything is described clearly.