fix(config): false positive in "scripts" directory

IsaacScript · Nov 3, 2023 · b6e3e11 · b6e3e11
1 parent 981ce4e
commit b6e3e11
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 2 deletions.
diff --git a/packages/eslint-config-isaacscript/configs/base-import.js b/packages/eslint-config-isaacscript/configs/base-import.js
@@ -23,7 +23,7 @@ const HELPFUL_WARNINGS = {
    * The options are [copied from
    * Airbnb](https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/import.js).
    *
-   * We also add a "scripts" directory entry for "devDependency".
+   * We also add a "scripts" directory entry for "devDependencies".
    */
   "import/no-extraneous-dependencies": [
     "error",
@@ -52,7 +52,7 @@ const HELPFUL_WARNINGS = {
         "**/karma.conf.js", // karma config
         "**/.eslintrc.js", // eslint config
 
-        "**/scripts/*.{ts,cts,mts}", // TypeScript files inside of a "scripts" directory.
+        "**/scripts/*.{js,cjs,mjs,ts,cts,mts}", // Files inside of a "scripts" directory.
       ],
       optionalDependencies: false,
     },

diff --git a/packages/eslint-config-isaacscript/configs/base-n.js b/packages/eslint-config-isaacscript/configs/base-n.js
@@ -41,7 +41,13 @@ const POSSIBLE_ERRORS = {
   "n/no-process-exit": "off",
 
   "n/no-unpublished-bin": "error",
+
+  /**
+   * An exception is made for files in a "scripts" directory, since those should be allowed to
+   * import from "devDependencies".
+   */
   "n/no-unpublished-import": "error",
+
   "n/no-unpublished-require": "error",
 
   /** Disabled because this rule is deprecated. */
@@ -137,6 +143,16 @@ const config = {
     ...POSSIBLE_ERRORS,
     ...STYLISTIC_ISSUES,
   },
+
+  overrides: [
+    // Imports in a "scripts" directory can use "devDependencies".
+    {
+      files: ["**/scripts/*.{js,cjs,mjs,ts,cts,mts}"],
+      rules: {
+        "n/no-unpublished-import": "off",
+      },
+    },
+  ],
 };
 
 module.exports = config;