Add hint how to disable ESLint (#19171)

* Add hint how to disable ESLint #19170 * Run prettier * Apply code review suggestion for docs/docs/eslint.md Co-Authored-By: LB <[email protected]> * Run prettier * Add explanatory paragraph back * chore: format
gatsbyjs · Nov 13, 2019 · 337bbd0 · 337bbd0
1 parent 10a8f65
commit 337bbd0
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/docs/docs/eslint.md b/docs/docs/eslint.md
@@ -38,6 +38,10 @@ module.exports = {
 }
 ```
 
-Note: If you provide a custom `.eslintrc.js` file, Gatsby gives you full control about the ESLint configuration. This means that it will disable the built-in `eslint-loader` and you need to enable it yourself. One way to do so is to use the Community plugin [`gatsby-eslint-plugin`](/packages/gatsby-plugin-eslint/).
+### Disabling ESLint
+
+Create an empty .eslintrc.js file at the root of your project to disable linting.
 
-If you want to disable ESLint completely, create an empty `.eslintrc` file.
+When there is no ESLint file Gatsby implicitly adds a barebones ESLint loader. The empty file will disable this behavior as Gatsby assumes once you have an ESLint file you are in charge of linting.
+
+Note: If you provide a custom `.eslintrc.js` file, Gatsby gives you full control about the ESLint configuration. This means that it will disable the built-in `eslint-loader` and you need to enable it yourself. One way to do so is to use the Community plugin [`gatsby-eslint-plugin`](/packages/gatsby-plugin-eslint/).