eslint-config-isaacscript 3.4.1 → 3.5.1

package/base-eslint.js

@@ -1,18 +1,23 @@
 // This is a shared configuration file for ESLint:
 // https://eslint.org/docs/latest/user-guide/configuring
 // This config only contains modifications to the built-in rules from the ESLint tool.
+// https://eslint.org/docs/latest/rules/
 module.exports = {
   rules: {
-    /**
-     * Documentation:
-     * https://eslint.org/docs/latest/rules/array-callback-return
-     *
-     * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/best-practices.js
-     *
-     * Airbnb changes the default options for some reason, which makes the rule less strict.
-     */
-    "array-callback-return": ["warn", {}],
+    // -----------------
+    // Possible Problems
+    // -----------------
+
+    // https://eslint.org/docs/latest/rules/array-callback-return
+    // - Using "checkForEach" makes the rule stricter.
+    "array-callback-return": [
+      "warn",
+      {
+        checkForEach: true,
+      },
+    ],
+
+    // asdf
 
     /**
      * Documentation:
@@ -280,5 +285,13 @@ module.exports = {
 
     // "valid-typeof" is disabled due to conflicting with the TypeScript compiler:
     // https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+
+    /**
+     * Documentation: https://eslint.org/docs/latest/rules/class-methods-use-this
+     *
+     * Defined at:
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/best-practices.js
+     */
+    // class-methods-use-this
   },
 };

package/base-jsdoc.js

@@ -244,4 +244,14 @@ module.exports = {
 
     // - jsdoc/valid-types - Not needed in TypeScript.
   },
+
+  overrides: [
+    // Disable some TypeScript-specific rules in JavaScript files.
+    {
+      files: ["*.js", "*.cjs", "*.mjs", "*.jsx"],
+      rules: {
+        "jsdoc/no-types": "off",
+      },
+    },
+  ],
 };

package/base-typescript-eslint.js

@@ -82,6 +82,16 @@ module.exports = {
       },
     ],
 
+    /**
+     * Documentation:
+     * https://typescript-eslint.io/rules/no-confusing-void-expression
+     *
+     * Not defined in the parent configs.
+     *
+     * This prevents assigning void to variables, which is almost certainly a bug.
+     */
+    "@typescript-eslint/no-confusing-void-expression": "warn",
+
     /**
      * Documentation:
      * https://typescript-eslint.io/rules/no-unnecessary-boolean-literal-compare
@@ -214,7 +224,6 @@ module.exports = {
         "@typescript-eslint/no-unsafe-return": "off",
         "@typescript-eslint/no-var-requires": "off",
         "@typescript-eslint/strict-boolean-expressions": "off",
-        "isaacscript/no-object-any": "off",
       },
     },
   ],

package/base.js

@@ -201,6 +201,16 @@ module.exports = {
      */
     "import/prefer-default-export": "off",
 
+    /**
+     * Documentation:
+     * https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/file-extension-in-import.md
+     *
+     * Not defined in parent configs.
+     *
+     * We use this to automatically fix import statements to ESM.
+     */
+    "n/file-extension-in-import": ["error", "always"],
+
     /**
      * Documentation:
      * https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-extraneous-import.md
@@ -329,5 +339,37 @@ module.exports = {
      * Enforce the new "node:" prefix as an extra safety measure.
      */
     "unicorn/prefer-node-protocol": "warn",
+
+    // TEST
+    // https://github.com/typescript-eslint/typescript-eslint/issues/6446
+    "no-restricted-syntax": [
+      "error",
+      {
+        selector:
+          'VariableDeclarator[id.typeAnnotation] > :matches(TSTypeAssertion, TSAsExpression) > TSTypeReference.typeAnnotation > Identifier[name="const"]',
+        message:
+          "Don't use `as const` with a type annotated variable, since it widens the type.",
+      },
+    ],
   },
+
+  overrides: [
+    // Disable some TypeScript-specific rules in JavaScript files.
+    {
+      files: ["*.js", "*.cjs", "*.mjs", "*.jsx"],
+      rules: {
+        "isaacscript/no-object-any": "off",
+        "isaacscript/require-capital-const-assertions": "off",
+        "isaacscript/require-capital-read-only": "off",
+      },
+    },
+
+    // Remark configs require a default export.
+    {
+      files: [".remarkrc.mjs"],
+      rules: {
+        "import/no-default-export": "off",
+      },
+    },
+  ],
 };

package/mod.js

@@ -142,6 +142,28 @@ module.exports = {
      */
     "isaacscript/no-throw": "warn",
 
+    /**
+     * Documentation:
+     * https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/file-extension-in-import.md
+     *
+     * Defined in "base.js".
+     *
+     * IsaacScript mods to not use ESM, so we must turn this rule off.
+     */
+    "n/file-extension-in-import": "off",
+
+    /**
+     * Documentation:
+     * https://eslint.org/docs/latest/rules/class-methods-use-this
+     *
+     * Defined at:
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/best-practices.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.
+     */
+    "class-methods-use-this": "off",
+
     /**
      * Documentation:
      * https://eslint.org/docs/latest/rules/no-bitwise

package/monorepo.js

@@ -1,6 +1,6 @@
 const path = require("node:path");
 
-const REPO_ROOT = path.join(__dirname, "..", "..");
+const REPO_ROOT = path.join(__dirname, "..", "..", "..");
 
 // This is a shared configuration file for ESLint:
 // https://eslint.org/docs/latest/user-guide/configuring

package/package.json

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