eslint-config-isaacscript 4.8.0 → 4.9.0

package/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,
     },

package/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;

package/configs/base-typescript-eslint.js

@@ -329,10 +329,58 @@ const EXTENSION_RULES = {
   "@typescript-eslint/no-redeclare": "off",
 
   /**
-   * Disabled since it would only be needed in specific environments (such as forbidding Node.js
-   * imports in a browser environment).
+   * Configured to prevent importing with some common patterns that are almost always a mistake:
+   *
+   * - "src" directories (but allowed in test files that are in a separate "tests" directory)
+   * - "dist" directories
+   * - "index" files
    */
-  "@typescript-eslint/no-restricted-imports": "off",
+  "@typescript-eslint/no-restricted-imports": [
+    "error",
+    {
+      patterns: [
+        // Some "src" directories have an "index.ts" file, which means that importing from the
+        // directory is valid. Thus, we check for the "src" directory with no suffix.
+        {
+          group: ["*/src"],
+          message:
+            'You cannot import from a "src" directory. If this is a monorepo, import using the package name like you would in a non-monorepo project.',
+        },
+
+        {
+          group: ["*/src/*"],
+          message:
+            'You cannot import from a "src" directory. If this is a monorepo, import using the package name like you would in a non-monorepo project.',
+        },
+
+        // Some "dist" directories have an "index.ts" file, which means that importing from the
+        // directory is valid. Thus, we check for the "dist" directory with no suffix.
+        {
+          group: ["*/dist"],
+          message:
+            'You cannot import from a "dist" directory. If this is a monorepo, import using the package name like you would in a non-monorepo project.',
+        },
+
+        {
+          group: ["*/dist/*"],
+          message:
+            'You cannot import from a "dist" directory. If this is a monorepo, import using the package name like you would in a non-monorepo project.',
+        },
+
+        {
+          group: ["*/index"],
+          message:
+            "You cannot import from a package index. Instead, import directly from the file where the code is located.",
+        },
+
+        {
+          group: ["*/index.{js,cjs,mjs,ts,cts,mts}"],
+          message:
+            "You cannot import from a package index. Instead, import directly from the file where the code is located.",
+        },
+      ],
+    },
+  ],
 
   "@typescript-eslint/no-shadow": "error",
   "@typescript-eslint/no-throw-literal": "error",
@@ -446,11 +494,20 @@ const config = {
 
     // The built-in Node.js test-runner returns a promise which is not meant to be awaited.
     {
-      files: ["*.test.ts"],
+      files: ["*.test.{js,cjs,mjs,ts,cts,mts}"],
       rules: {
         "@typescript-eslint/no-floating-promises": "off",
       },
     },
+
+    // We want to be allowed to import from the "src" directory in test files that are located in a
+    // separate "tests" directory.
+    {
+      files: ["**/tests/**"],
+      rules: {
+        "@typescript-eslint/no-restricted-imports": "off",
+      },
+    },
   ],
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-isaacscript",
-  "version": "4.8.0",
+  "version": "4.9.0",
   "description": "A sharable ESLint config for TypeScript and IsaacScript projects.",
   "keywords": [
     "eslint",