eslint-config-isaacscript 6.0.0 → 6.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-isaacscript",
-  "version": "6.0.0",
+  "version": "6.1.0",
   "description": "A sharable ESLint config for IsaacScript projects.",
   "keywords": [
     "eslint",
@@ -31,10 +31,10 @@
   },
   "dependencies": {
     "eslint-plugin-isaacscript": "4.0.0",
-    "typescript-eslint": "8.43.0"
+    "typescript-eslint": "8.69.0"
   },
   "devDependencies": {
-    "complete-node": "12.0.0"
+    "complete-node": "18.1.0"
   },
   "peerDependencies": {
     "eslint": ">= 9.0.0"

package/src/mod.js

@@ -1,4 +1,4 @@
-import ESLintPluginIsaacScript from "eslint-plugin-isaacscript";
+import esLintPluginIsaacScript from "eslint-plugin-isaacscript";
 import { defineConfig } from "eslint/config";
 
 /**
@@ -7,208 +7,221 @@ import { defineConfig } from "eslint/config";
  */
 export const isaacScriptModConfigBase = defineConfig(
   {
+    // Rules that require type information will throw an error on ".json" files. (This is needed
+    // when using `eslint-plugin-package-json`. Even though this config does not currently use the
+    // plugin, we include it here defensively.)
+    ignores: ["*.json", "*.jsonc"],
+
     plugins: {
       // TODO: The `defineConfig` helper function is bugged.
       // @ts-expect-error https://github.com/typescript-eslint/typescript-eslint/issues/11543
-      isaacscript: ESLintPluginIsaacScript,
+      isaacscript: esLintPluginIsaacScript,
     },
 
     rules: {
-      "isaacscript/enum-member-number-separation": "warn",
-      "isaacscript/no-invalid-default-map": "warn",
-      "isaacscript/no-throw": "warn",
-      "isaacscript/require-v-registration": "warn",
+      "isaacscript/enum-member-number-separation": "error",
+      "isaacscript/no-invalid-default-map": "error",
+      "isaacscript/no-throw": "error",
+      "isaacscript/require-v-registration": "error",
     },
+  },
 
+  {
     // Rules that require type information will throw an error on ".json" files. (This is needed
     // when using `eslint-plugin-package-json`. Even though this config does not currently use the
     // plugin, we include it here defensively.)
     ignores: ["*.json", "*.jsonc"],
-  },
 
-  {
     rules: {
       /**
-       * Defined at: base-typescript-eslint.js
-       *
        * It is conventional in IsaacScript mods to put the "v" object outside of the class, which
        * makes it likely that some methods will not use any internal class variables.
        */
       "@typescript-eslint/class-methods-use-this": "off",
 
       /**
-       * Defined at: base-typescript-eslint.js
-       *
        * We expand the original definition to ensure that all enums match the Isaac convention of
        * using UPPER_CASE.
        */
       "@typescript-eslint/naming-convention": [
-        "warn",
+        "error",
         // Allow camelCase variables (23.2), PascalCase variables (23.8), and UPPER_CASE variables
         // (23.10).
         {
-          selector: "variable",
           format: ["camelCase", "PascalCase", "UPPER_CASE"],
           leadingUnderscore: "allow",
+          selector: "variable",
         },
         // Allow camelCase functions (23.2), and PascalCase functions (23.8).
         {
-          selector: "function",
           format: ["camelCase", "PascalCase"],
           leadingUnderscore: "allow",
+          selector: "function",
         },
         // Airbnb recommends PascalCase for classes (23.3), and although Airbnb does not make
         // TypeScript recommendations, we are assuming this rule would similarly apply to anything
         // "type like", including interfaces, type aliases, and enums.
         {
-          selector: "typeLike",
           format: ["PascalCase"],
           leadingUnderscore: "allow",
+          selector: "typeLike",
         },
         // The vanilla Isaac enums all use UPPER_CASE:
         // https://wofsauge.github.io/IsaacDocs/rep/enums/CollectibleType.html
         {
-          selector: "enumMember",
           format: ["UPPER_CASE"],
+          selector: "enumMember",
         },
       ],
 
       /**
-       * Defined at: base-typescript-eslint.js
-       *
        * The `Vector` object has a `tostring` meta-method, so it can be properly printed without
        * explicitly specifying the X and Y values.
        */
       "@typescript-eslint/no-base-to-string": [
-        "warn",
-        {
-          ignoredTypeNames: ["Vector"],
-        },
+        "error",
+        { ignoredTypeNames: ["Vector"] },
       ],
 
       /**
-       * Defined at: base-typescript-eslint.js
-       *
        * TSTL has special behavior with respect to `this: void`, so we need to configure this rule
        * to allow the `this` parameter.
        */
       "@typescript-eslint/no-invalid-void-type": [
-        "warn",
-        {
-          allowAsThisParameter: true,
-        },
+        "error",
+        { allowAsThisParameter: true },
       ],
 
       /**
-       * Defined at: base-typescript-eslint.js
-       *
        * This rule throws false positives with Isaac API functions. It can be worked around by
        * supplying lists of globals to ESLint, but this is ugly. See:
        * https://github.com/typescript-eslint/typescript-eslint/issues/2780
        */
       "@typescript-eslint/no-loop-func": "off",
 
+      /** This has false positives with the `int` type. */
+      "@typescript-eslint/no-unsafe-unary-minus": "off",
+
       /**
-       * Defined at: base-typescript-eslint.js
-       *
        * Enums that are used with the API must be numbers since that is what the API expects. We
        * also prefer that unofficial enums are also number enums for consistency.
        */
       "@typescript-eslint/prefer-enum-initializers": "off",
 
-      /**
-       * Defined at: base-typescript-eslint.js
-       *
-       * It is common to initialize enums with the `Isaac.GetEntityVariantByName` method.
-       */
+      /** It is common to initialize enums with the `Isaac.GetEntityVariantByName` method. */
       "@typescript-eslint/prefer-literal-enum-member": "off",
 
       /**
-       * Defined at: base-typescript-eslint.js
-       *
        * The `Number.sort` method transpiles to use `table.sort`, which does not have the
        * coercion-based bugs of the JavaScript implementation. Thus, this lint rule is unnecessary.
        */
       "@typescript-eslint/require-array-sort-compare": "off",
 
       /**
-       * Defined in "complete/recommended".
-       *
        * Enums that are used with the API use upper case letters. We also prefer that unofficial
        * enums are also use upper case letters for consistency.
        */
       "complete/consistent-enum-values": "off",
 
       /**
-       * Defined in "complete/recommended".
-       *
        * Enums that are used with the API must be numbers since that is what the API expects. We
        * also prefer that unofficial enums are also number enums for consistency.
        */
       "complete/no-number-enums": "off",
 
       /**
-       * Defined at: base-n.js
-       *
-       * IsaacScript mods to not use ESM, so we must turn this rule off.
+       * "v" objects should be in a semantic order and it would be too cumbersome to annotate all of
+       * them.
        */
-      "n/file-extension-in-import": "off",
+      "complete/sort-objects": "off",
 
-      /**
-       * Defined at: base-unicorn.js
-       *
-       * `null` values are conventionally used with the `isaacscript-common` save data manager (even
-       * though they are transpiled to `nil`).
-       */
-      "unicorn/no-null": "off",
-
-      /**
-       * Defined at: base-unicorn.js
-       *
-       * IsaacScript mods use Lua bitwise operators, which are safe.
-       */
-      "unicorn/prefer-math-trunc": "off",
+      /** IsaacScript mods to not use ESM, so we must turn this rule off. */
+      "n/file-extension-in-import": "off",
 
       /**
-       * Defined at: base-eslint.js
-       *
        * Isaac API methods use capital letters, so we must make the options for the rule less
        * strict.
        */
       "new-cap": [
-        "warn",
+        "error",
         {
-          newIsCap: true,
           capIsNew: false,
+          newIsCap: true,
           properties: true,
         },
       ],
 
-      /**
-       * Defined at: base-eslint.js
-       *
-       * Isaac enums use bitwise operators (e.g. "EntityFlag").
-       */
+      /** Isaac enums use bitwise operators (e.g. "EntityFlag"). */
       "no-bitwise": "off",
 
-      /**
-       * Defined at: base-eslint.js
-       *
-       * The Isaac API callback functions expect you to modify the provided object.
-       */
+      /** The Isaac API callback functions expect you to modify the provided object. */
       "no-param-reassign": "off",
 
+      /** "print" is used with Lua mods. */
+      "no-restricted-globals": "off",
+
+      /** Is it common for set ordering to have semantic meaning in Isaac mods. */
+      "perfectionist/sort-arrays": "off",
+
+      /* * It is idiomatic in Isaac mods to use "SubType" instead of "Subtype". */
+      "unicorn/consistent-compound-words": "off",
+
+      /** The rule assumes that `print` is the JavaScript one instead of the Lua one. */
+      "unicorn/no-invalid-argument-count": [
+        "error",
+        {
+          print: {
+            min: 0,
+          },
+        },
+      ],
+
       /**
-       * Defined at: base-eslint.js
-       *
-       * "print" is used with Lua mods.
+       * `null` values are conventionally used with the `isaacscript-common` save data manager (even
+       * though they are transpiled to `nil`).
        */
-      "no-restricted-globals": "off",
+      "unicorn/no-null": "off",
+
+      /** `Iterator#toArray()` is not supported by TypeScriptToLua. */
+      "unicorn/prefer-iterator-to-array": "off",
+
+      /** IsaacScript mods use Lua bitwise operators, which are safe. */
+      "unicorn/prefer-math-trunc": "off",
     },
+  },
 
-    // Rules that require type information will throw an error on ".json" files. (This is needed
-    // when using `eslint-plugin-package-json`. Even though this config does not currently use the
-    // plugin, we include it here defensively.)
-    ignores: ["*.json", "*.jsonc"],
+  {
+    files: [
+      "eslint.config.js",
+      "eslint.config.cjs",
+      "eslint.config.mjs",
+      "eslint.config.ts",
+      "eslint.config.cts",
+      "eslint.config.mts",
+    ],
+    rules: {
+      // TypeScript projects that use "complete-lint" have a false positive when importing
+      // "defineConfig" from "eslint/config", because "eslint" is a transitive dependency in
+      // "complete-lint". Similarly, importing "completeConfigBase" from "eslint-config-complete"
+      // fails, because "eslint-config-complete" is a transitive dependency in "complete-lint". (We
+      // extend the logic from "eslint-config-complete" and add a new value for
+      // "eslint-config-isaacscript.")
+      "import-x/no-extraneous-dependencies": [
+        "error",
+        {
+          devDependencies: ["**/eslint.config.{js,cjs,mjs,ts,cts,mts}"],
+          optionalDependencies: false,
+          whitelist: [
+            "eslint",
+            "eslint-config-complete",
+            "eslint-config-isaacscript",
+          ],
+        },
+      ],
+
+      // ESLint configuration files in monorepos often intentionally import from the "packages"
+      // subdirectory, because the config files are JavaScript so they cannot use tsconfig-paths.
+      "import-x/no-relative-packages": "off",
+    },
   },
 );