feat: add reportUnusedDisableDirectives to base config

square · Jan 12, 2023 · 9ec0fd8 · 9ec0fd8
1 parent a0111a3
commit 9ec0fd8
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -18,16 +18,15 @@ Install alongside ESLint via yarn (or npm):
 yarn add --dev eslint eslint-plugin-square npm-run-all
 ```
 
-Edit your `.eslintrc.js` configuration file to extend one of the available configurations from this plugin and [detect unused disable directives](https://eslint.org/docs/latest/user-guide/configuring/rules#report-unused-eslint-disable-comments):
+Edit your `.eslintrc.js` configuration file to extend one of the available configurations from this plugin:
 
 ```js
 module.exports = {
-  reportUnusedDisableDirectives: true,
   extends: ['plugin:square/base'], // Or other configuration.
 };
 ```
 
-Add the relevant lint scripts in `package.json` with [npm-run-all](https://github.com/mysticatea/npm-run-all):
+Add the relevant lint scripts in `package.json` with [npm-run-all](https://github.com/mysticatea/npm-run-all) and include detection for [unused disable directives](https://eslint.org/docs/latest/user-guide/configuring/rules#report-unused-eslint-disable-comments):
 
 ```json
 {

diff --git a/lib/config/base.js b/lib/config/base.js
@@ -3,6 +3,7 @@
 // This configuration is intended for use with JavaScript applications.
 
 module.exports = {
+  reportUnusedDisableDirectives: true, // Warn on unused disable directives: https://eslint.org/docs/latest/user-guide/command-line-interface#--report-unused-disable-directives
   extends: [
     'eslint:recommended',
     'plugin:eslint-comments/recommended',