eslint-config-isaacscript 3.7.1 → 4.0.0

package/mod.js

@@ -1,7 +1,9 @@
-// This is a shared configuration file for ESLint:
-// https://eslint.org/docs/latest/user-guide/configuring
-// This config is meant to be used as a base for IsaacScript mods.
-module.exports = {
+/**
+ * This config is meant to be used as a base for IsaacScript mods (or TypeScriptToLua projects).
+ *
+ * @type {import("eslint").Linter.Config}
+ */
+const config = {
   extends: [
     /**
      * The IsaacScript mod config extends the base configuration:
@@ -13,25 +15,25 @@ module.exports = {
 
   rules: {
     /**
-     * Documentation:
-     * https://typescript-eslint.io/rules/naming-convention
+     * Defined at: base-typescript-eslint.js
      *
-     * Defined at:
-     * https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
-     *
-     * Modify the Airbnb config to allow for a leading underscore, which signifies that it is
-     * temporarily not being used.
-     *
-     * Additionally, ensure that all enums match the Isaac convention of using UPPER_CASE.
+     * 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",
+
+        // Polyfilling "__dirname" in ESM files is a common pattern.
+        filter: {
+          regex: "^__dirname$",
+          match: false,
+        },
       },
       // Allow camelCase functions (23.2), and PascalCase functions (23.8).
       {
@@ -45,6 +47,7 @@ module.exports = {
       {
         selector: "typeLike",
         format: ["PascalCase"],
+        leadingUnderscore: "allow",
       },
       // The vanilla Isaac enums all use UPPER_CASE:
       // https://wofsauge.github.io/IsaacDocs/rep/enums/CollectibleType.html
@@ -55,176 +58,187 @@ module.exports = {
     ],
 
     /**
-     * Documentation:
-     * https://typescript-eslint.io/rules/no-base-to-string/
-     *
-     * Defined at:
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/strict.ts
+     * 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",
+      "error",
       {
         ignoredTypeNames: ["Vector"],
       },
     ],
 
     /**
-     * Documentation:
-     * https://typescript-eslint.io/rules/no-invalid-void-type
-     *
-     * Defined at:
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/strict.ts
+     * 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.
+     * 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",
+      "error",
       {
         allowAsThisParameter: true,
       },
     ],
 
     /**
-     * Documentation:
-     * https://typescript-eslint.io/rules/no-loop-func
+     * Defined at: base-typescript-eslint.js
      *
-     * Defined at:
-     * https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
-     *
-     * This rule throws false positives with API functions. It can be worked around by supplying
-     * lists of globals to ESLint, but this is ugly. See:
+     * 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",
 
     /**
-     * Documentation:
-     * https://typescript-eslint.io/rules/prefer-literal-enum-member
+     * Defined at: base-typescript-eslint.js
      *
-     * Defined at:
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/strict.ts
+     * 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.
      */
     "@typescript-eslint/prefer-literal-enum-member": "off",
 
     /**
-     * Documentation:
-     * https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-plugin-isaacscript/docs/rules/enum-member-number-separation.md
+     * 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 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 in "isaacscript/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.
+     */
+    "isaacscript/consistent-enum-values": "off",
+
+    /**
      * Not defined in the parent configs.
      *
      * Since Isaac enums use the `SHOUTING_SNAKE_CASE` convention, this rule ensures correctness.
      */
-    "isaacscript/enum-member-number-separation": "warn",
+    "isaacscript/enum-member-number-separation": "error",
 
     /**
-     * Documentation:
-     * https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-plugin-isaacscript/docs/rules/no-invalid-default-map.md
+     * Defined in "isaacscript/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.
+     */
+    "isaacscript/no-number-enums": "off",
+
+    /**
      * Not defined in the parent configs.
      *
      * Prevents misuse of the custom `DefaultMap` class in the standard library.
      */
-    "isaacscript/no-invalid-default-map": "warn",
+    "isaacscript/no-invalid-default-map": "error",
 
     /**
-     * Documentation:
-     * https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-plugin-isaacscript/docs/rules/no-throw.md
-     *
      * Not defined in the parent configs.
      *
      * The `throw` keyword should never be used in Isaac mods.
      */
-    "isaacscript/no-throw": "warn",
+    "isaacscript/no-throw": "error",
 
     /**
-     * Documentation:
-     * https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-plugin-isaacscript/docs/rules/require-v-registration.md
-     *
      * Not defined in the parent configs.
      *
      * We must explicitly enable this rule, since it should only apply to IsaacScript mods.
      */
-    "isaacscript/require-v-registration": "warn",
+    "isaacscript/require-v-registration": "error",
 
     /**
-     * Documentation:
-     * https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/file-extension-in-import.md
-     *
-     * Defined in "base.js".
+     * Defined at: base-n.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: base-unicorn.js
      *
-     * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/best-practices.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
      *
-     * 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.
+     * TypeScriptToLua does not support the `Array.at` method.
      */
-    "class-methods-use-this": "off",
+    "unicorn/prefer-at": "off",
 
     /**
-     * Documentation:
-     * https://eslint.org/docs/latest/rules/no-bitwise
+     * Defined at: base-unicorn.js
      *
-     * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js
+     * IsaacScript mods use Lua bitwise operators, which are safe.
+     */
+    "unicorn/prefer-math-trunc": "off",
+
+    /**
+     * Defined at: base-unicorn.js
+     *
+     * TypeScriptToLua supports `parseInt`, but not `Number.parseInt`:
+     * https://github.com/TypeScriptToLua/TypeScriptToLua/issues/1471
+     */
+    "unicorn/prefer-number-properties": "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": [
+      "error",
+      {
+        newIsCap: true,
+        capIsNew: false,
+        properties: true,
+      },
+    ],
+
+    /**
+     * Defined at: base-eslint.js
      *
      * Isaac enums use bitwise operators (e.g. "EntityFlag").
      */
     "no-bitwise": "off",
 
     /**
-     * Documentation:
-     * https://eslint.org/docs/latest/rules/no-param-reassign
-     *
-     * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/best-practices.js
+     * Defined at: base-eslint.js
      *
      * The Isaac API callback functions expect you to modify the provided object.
      */
     "no-param-reassign": "off",
 
     /**
-     * Documentation:
-     * https://eslint.org/docs/latest/rules/no-restricted-globals
-     *
-     * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/variables.js
+     * Defined at: base-eslint.js
      *
      * "print" is used with Lua mods.
      */
     "no-restricted-globals": "off",
-
-    /**
-     * Documentation:
-     * https://eslint.org/docs/latest/rules/no-underscore-dangle
-     *
-     * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js
-     *
-     * We keep the Airbnb specification but allow calling functions that overload Lua operators:
-     * https://moddingofisaac.com/docs/class_vector.html
-     */
-    "no-underscore-dangle": [
-      "warn",
-      {
-        allow: ["__add", "__sub", "__mul", "__div", "__unm", "__len"],
-        allowAfterThis: false,
-        allowAfterSuper: false,
-        enforceInMethodNames: true,
-      },
-    ],
   },
 };
+
+module.exports = config;

package/monorepo.js

@@ -2,44 +2,29 @@ const path = require("node:path");
 
 const REPO_ROOT = path.join(__dirname, "..", "..", "..");
 
-// This is a shared configuration file for ESLint:
-// https://eslint.org/docs/latest/user-guide/configuring
-module.exports = {
-  plugins: ["@nrwl/nx"],
-
-  // From:
-  // https://github.com/nrwl/nx/blob/master/packages/eslint-plugin-nx/src/configs/typescript.ts
+/**
+ * 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: {
-    ecmaVersion: 2020,
+    ecmaVersion: "latest",
     sourceType: "module",
-    // This cannot be simplified to `./../..` because of relative path shenanigans.
     tsconfigRootDir: REPO_ROOT,
   },
 
-  // The ".prettierrc.cjs" file is ignored by default, so we have to un-ignore it.
-  ignorePatterns: ["!.prettierrc.cjs"],
-
   rules: {
-    "@nrwl/nx/enforce-module-boundaries": [
-      "warn",
-      {
-        enforceBuildableLibDependency: true,
-        allow: [],
-        depConstraints: [
-          {
-            sourceTag: "*",
-            onlyDependOnLibsWithTags: ["*"],
-          },
-        ],
-      },
-    ],
-
     // This rule has to be told which "package.json" file that the dependencies are located in.
     "import/no-extraneous-dependencies": [
-      "warn",
+      "error",
       {
         packageDir: REPO_ROOT,
       },
     ],
   },
 };
+
+module.exports = config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-isaacscript",
-  "version": "3.7.1",
+  "version": "4.0.0",
   "description": "A sharable ESLint config for TypeScript and IsaacScript projects.",
   "keywords": [
     "eslint",
@@ -21,5 +21,8 @@
   },
   "license": "MIT",
   "author": "Zamiell",
-  "type": "commonjs"
+  "type": "commonjs",
+  "dependencies": {
+    "confusing-browser-globals": "^1.0.11"
+  }
 }