eslint-config-isaacscript 4.6.0 → 4.8.0

package/base.js

@@ -30,14 +30,14 @@ const config = {
      * Rule modifications are split out into different files for better organization (based on the
      * originating plugin) .
      */
-    "./base-eslint",
-    "./base-no-autofix",
-    "./base-typescript-eslint",
-    "./base-eslint-comments",
-    "./base-import",
-    "./base-jsdoc",
-    "./base-n", // "n" stands for Node.
-    "./base-unicorn",
+    "./configs/base-eslint",
+    "./configs/base-no-autofix",
+    "./configs/base-typescript-eslint",
+    "./configs/base-eslint-comments",
+    "./configs/base-import",
+    "./configs/base-jsdoc",
+    "./configs/base-n", // "n" stands for Node.
+    "./configs/base-unicorn",
   ],
 
   plugins: [

package/{base-eslint.js → configs/base-eslint.js}

@@ -209,11 +209,7 @@ const SUGGESTIONS = {
 
   "max-nested-callbacks": "error",
 
-  /**
-   * Disabled because enforcing an arbitrary parameter number threshold for every function in a
-   * project does not provide much value. (Additionally, using TypeScript reduces the value of such
-   * a check.)
-   */
+  /** Superseded by the `@typescript-eslint/max-params` rule. */
   "max-params": "off",
 
   /**
@@ -561,28 +557,8 @@ const SUGGESTIONS = {
   /** Superseded by the `no-autofix/prefer-const` rule (since the autofix is usually unwanted). */
   "prefer-const": "off",
 
-  /**
-   * Object destructuring is enforced but array destructuring is not. This matches usage in the
-   * general TypeScript ecosystem.
-   */
-  "prefer-destructuring": [
-    "error",
-    {
-      VariableDeclarator: {
-        array: false,
-        object: true,
-      },
-      AssignmentExpression: {
-        array: false,
-        object: true,
-      },
-    },
-    {
-      // We disable this for renamed properties, this this is a valid use-case.
-      // e.g. `const collectibleUsedToShowFlight = CollectibleType.FATE;`
-      enforceForRenamedProperties: false,
-    },
-  ],
+  /** Superseded by the `@typescript-eslint/prefer-destructuring` rule. */
+  "prefer-destructuring": "off",
 
   "prefer-exponentiation-operator": "error",
 

package/{base-import.js → configs/base-import.js}

@@ -22,6 +22,8 @@ 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".
    */
   "import/no-extraneous-dependencies": [
     "error",
@@ -49,6 +51,8 @@ const HELPFUL_WARNINGS = {
         "**/protractor.conf.*.js", // protractor config
         "**/karma.conf.js", // karma config
         "**/.eslintrc.js", // eslint config
+
+        "**/scripts/*.{ts,cts,mts}", // TypeScript files inside of a "scripts" directory.
       ],
       optionalDependencies: false,
     },
@@ -217,7 +221,14 @@ const config = {
 
     // Disable some specific rules in config files.
     {
-      files: [".remarkrc.mjs", "prettier.config.mjs"],
+      files: [
+        ".remarkrc.mjs",
+        ".remarkrc.js",
+        "prettier.config.mjs",
+        "prettier.config.js",
+        "typedoc.config.mjs",
+        "typedoc.config.js",
+      ],
       rules: {
         "import/no-default-export": "off",
       },

package/{base-n.js → configs/base-n.js}

@@ -61,15 +61,11 @@ const POSSIBLE_ERRORS = {
 
   "n/process-exit-as-throw": "error",
 
-  /** This rule is configured to work with TypeScript file extensions. */
-  "n/shebang": [
-    "error",
-    {
-      convertPath: {
-        "src/**/*.ts": ["^src/(.+?)\\.ts$", "dist/$1.js"],
-      },
-    },
-  ],
+  /**
+   * Disabled since it does not work very well with TypeScript. (It needs project-specific
+   * configuration depending on where the output directory is located.)
+   */
+  "n/shebang": "off",
 };
 
 /** @type {import("eslint").Linter.RulesRecord} */

package/{base-typescript-eslint.js → configs/base-typescript-eslint.js}

@@ -46,6 +46,14 @@ const SUPPORTED_RULES = {
   "@typescript-eslint/explicit-member-accessibility": "off",
 
   "@typescript-eslint/explicit-module-boundary-types": "error",
+
+  /**
+   * Disabled because enforcing an arbitrary parameter number threshold for every function in a
+   * project does not provide much value. (Additionally, using TypeScript reduces the value of such
+   * a check.)
+   */
+  "@typescript-eslint/max-params": "off",
+
   "@typescript-eslint/member-delimiter-style": "off", // eslint-config-prettier
 
   /** Disabled since prescribed class ordering is too project-specific. */
@@ -100,7 +108,13 @@ const SUPPORTED_RULES = {
   "@typescript-eslint/no-explicit-any": "error",
   "@typescript-eslint/no-extra-non-null-assertion": "error",
   "@typescript-eslint/no-extraneous-class": "error",
+
+  /**
+   * The rule is disabled in "*.test.ts" files, since the built-in Node test runner returns a
+   * promise that is not meant to be awaited.
+   */
   "@typescript-eslint/no-floating-promises": "error",
+
   "@typescript-eslint/no-for-in-array": "error",
   "@typescript-eslint/no-import-type-side-effects": "error",
   "@typescript-eslint/no-inferrable-types": "error",
@@ -138,6 +152,30 @@ const SUPPORTED_RULES = {
   "@typescript-eslint/non-nullable-type-assertion-style": "error",
   "@typescript-eslint/parameter-properties": "error",
   "@typescript-eslint/prefer-as-const": "error",
+
+  /**
+   * Object destructuring is enforced but array destructuring is not. This matches usage in the
+   * general TypeScript ecosystem.
+   */
+  "@typescript-eslint/prefer-destructuring": [
+    "error",
+    {
+      VariableDeclarator: {
+        array: false,
+        object: true,
+      },
+      AssignmentExpression: {
+        array: false,
+        object: true,
+      },
+    },
+    {
+      // We disable this for renamed properties, this this is a valid use-case.
+      // e.g. `const collectibleUsedToShowFlight = CollectibleType.FATE;`
+      enforceForRenamedProperties: false,
+    },
+  ],
+
   "@typescript-eslint/prefer-enum-initializers": "error",
   "@typescript-eslint/prefer-for-of": "error",
   "@typescript-eslint/prefer-function-type": "error",
@@ -298,7 +336,17 @@ const EXTENSION_RULES = {
 
   "@typescript-eslint/no-shadow": "error",
   "@typescript-eslint/no-throw-literal": "error",
-  "@typescript-eslint/no-unused-expressions": "error",
+
+  /**
+   * The `allowTaggedTemplates` option is enabled to allow the rule to work with libraries like
+   * `execa`.
+   */
+  "@typescript-eslint/no-unused-expressions": [
+    "error",
+    {
+      allowTaggedTemplates: true,
+    },
+  ],
 
   /**
    * The `args` option is set to `all` make the rule stricter. Additionally, we ignore things that
@@ -357,7 +405,7 @@ const EXTENSION_RULES = {
 const config = {
   // We need to provide some special configuration to ESLint in order for it to parse TypeScript
   // files. From:
-  // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/base.ts
+  // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/base.ts
   parser: "@typescript-eslint/parser",
   parserOptions: {
     sourceType: "module",
@@ -395,6 +443,14 @@ const config = {
         "@typescript-eslint/strict-boolean-expressions": "off",
       },
     },
+
+    // The built-in Node.js test-runner returns a promise which is not meant to be awaited.
+    {
+      files: ["*.test.ts"],
+      rules: {
+        "@typescript-eslint/no-floating-promises": "off",
+      },
+    },
   ],
 };
 

package/mod.js

@@ -7,7 +7,7 @@ const config = {
   extends: [
     /**
      * The IsaacScript mod config extends the base configuration:
-     * https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-config-isaacscript/configs/base.js
+     * https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-config-isaacscript/base.js
      * (Normal TypeScript projects would just use the base configuration directly.)
      */
     "./base",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-isaacscript",
-  "version": "4.6.0",
+  "version": "4.8.0",
   "description": "A sharable ESLint config for TypeScript and IsaacScript projects.",
   "keywords": [
     "eslint",
@@ -22,6 +22,17 @@
   "license": "MIT",
   "author": "Zamiell",
   "type": "commonjs",
+  "files": [
+    "configs",
+    "base.js",
+    "LICENSE",
+    "mod.js",
+    "package.json",
+    "README.md"
+  ],
+  "scripts": {
+    "lint": "tsx ./scripts/lint.mts"
+  },
   "dependencies": {
     "confusing-browser-globals": "^1.0.11"
   }

package/monorepo.js

@@ -1,31 +0,0 @@
-const path = require("node:path");
-
-const REPO_ROOT = path.join(__dirname, "..", "..", "..");
-
-/**
- * This config is meant to be used in the IsaacScript monorepo.
- *
- * @type {import("eslint").Linter.Config}
- */
-const config = {
-  // We need to add the `tsconfigRootDir` property, but we must also repeat the options from
-  // "base-typescript-eslint.js" or they will be deleted.
-  parserOptions: {
-    sourceType: "module",
-    ecmaVersion: "latest",
-    tsconfigRootDir: REPO_ROOT,
-    project: true,
-  },
-
-  rules: {
-    // This rule has to be told which "package.json" file that the dependencies are located in.
-    "import/no-extraneous-dependencies": [
-      "error",
-      {
-        packageDir: REPO_ROOT,
-      },
-    ],
-  },
-};
-
-module.exports = config;