eslint-config-isaacscript 3.3.0 → 3.4.0

package/README.md

@@ -4,6 +4,32 @@
 
 This is a sharable configuration for ESLint that is intended to be used in TypeScript and IsaacScript projects.
 
-This package is consumed by the [`isaacscript-lint`](https://github.com/IsaacScript/isaacscript/tree/main/packages/isaacscript-lint) meta-linting package.
+This package is consumed by the [`isaacscript-lint`](https://github.com/IsaacScript/isaacscript/tree/main/packages/isaacscript-lint) meta-linting package. It is recommended that instead of consuming this package directly, you instead list `isaacscript-lint` as a dependency, as it includes all of the corresponding plugins and so on.
+
+For TypeScript projects, set up your `.eslintrc.cjs` file to extend from the config like this:
+
+```js
+// This is the configuration file for ESLint, the TypeScript linter:
+// https://eslint.org/docs/user-guide/configuring
+module.exports = {
+  extends: [
+    // The linter base is the shared IsaacScript config:
+    // https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-config-isaacscript/base.js
+    "eslint-config-isaacscript/base",
+  ],
+
+  // Don't bother linting the compiled output.
+  ignorePatterns: ["**/dist/**"],
+
+  parserOptions: {
+    // ESLint needs to know about the project's TypeScript settings in order for TypeScript-specific
+    // things to lint correctly. We do not point this at "./tsconfig.json" because certain files
+    // (such at this file) should be linted but not included in the actual project output.
+    project: "./tsconfig.eslint.json",
+  },
+
+  rules: {},
+};
+```
 
 Please see the [IsaacScript webpage](https://isaacscript.github.io/) for more information.

package/base-eslint.js

@@ -0,0 +1,284 @@
+// 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.
+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", {}],
+
+    /**
+     * Documentation:
+     * https://eslint.org/docs/latest/rules/consistent-return
+     *
+     * Defined at:
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/best-practices.js
+     *
+     * We prefer the "noImplicitReturns" compiler flag over the "consistent-return" ESLint rule,
+     * since it is type-aware:
+     * https://github.com/typescript-eslint/typescript-eslint/issues/5254
+     */
+    "consistent-return": ["off"],
+
+    /**
+     * Documentation:
+     * https://eslint.org/docs/latest/rules/curly
+     *
+     * Defined at:
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/best-practices.js
+     *
+     * Always requiring curly braces can partially ward against Apple-style if statement bugs:
+     * https://www.imperialviolet.org/2014/02/22/applebug.html
+     *
+     * Additionally, this rule needs to be set to "all" to work properly with
+     * `eslint-prettier-config`:
+     * https://github.com/prettier/eslint-config-prettier#curly
+     */
+    curly: ["warn", "all"],
+
+    /**
+     * Documentation:
+     * https://eslint.org/docs/latest/rules/default-case
+     *
+     * Defined at:
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/best-practices.js
+     *
+     * This rule is generally bad to have on in TypeScript projects:
+     * https://github.com/typescript-eslint/typescript-eslint/issues/5254
+     */
+    "default-case": "off",
+
+    /**
+     * Documentation:
+     * https://eslint.org/docs/latest/rules/no-console
+     *
+     * Defined at:
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/errors.js
+     *
+     * Command-line programs commonly write to standard out and standard error.
+     */
+    "no-console": "off",
+
+    /**
+     * Documentation:
+     * https://eslint.org/docs/latest/rules/no-constant-binary-expression
+     *
+     * Not defined in parent configs.
+     *
+     * This rule was released in 2022 and is known to catch many subtle bugs:
+     * https://github.com/eslint/eslint.org/pull/240/files
+     */
+    "no-constant-binary-expression": "warn",
+
+    /**
+     * Documentation:
+     * https://eslint.org/docs/latest/rules/no-continue
+     *
+     * Defined at:
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js
+     *
+     * Proper use of continues can reduce indentation for long blocks of code.
+     */
+    "no-continue": "off",
+
+    /**
+     * Documentation:
+     * https://eslint.org/docs/latest/rules/no-plusplus
+     *
+     * Defined at:
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js
+     *
+     * Airbnb disallows these because it can lead to errors with minified code. When using Prettier,
+     * it adds semi-colons everywhere, so we don't have to worry about this.
+     */
+    "no-plusplus": "off",
+
+    /**
+     * Documentation:
+     * https://eslint.org/docs/latest/rules/no-restricted-syntax
+     *
+     * Defined at:
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js
+     *
+     * - We move the selector for "for..of" loops, since they are commonly used.
+     * - We add a selector for "empty" invocations of the "array.push()" method.
+     */
+    "no-restricted-syntax": [
+      "warn",
+      {
+        selector: "ForInStatement",
+        message:
+          "for..in loops iterate over the entire prototype chain, which is virtually never what you want. Use Object.{keys,values,entries}, and iterate over the resulting array.",
+      },
+      {
+        selector: "LabeledStatement",
+        message:
+          "Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand.",
+      },
+      {
+        selector: "WithStatement",
+        message:
+          "`with` is disallowed in strict mode because it makes code impossible to predict and optimize.",
+      },
+      {
+        selector:
+          "CallExpression[callee.property.name='push'][arguments.length=0]",
+        message: "push must always be called with at least one argument.",
+      },
+    ],
+
+    /**
+     * Documentation:
+     * https://eslint.org/docs/latest/rules/no-unused-expressions
+     *
+     * Not defined in parent configs.
+     *
+     * An unused expression which has no effect on the state of the program indicates a logic error.
+     */
+    "no-unused-expressions": "warn",
+
+    /**
+     * Documentation:
+     * https://eslint.org/docs/latest/rules/prefer-destructuring
+     *
+     * Defined at:
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/es6.js
+     *
+     * Array destructuring can result in non-intuitive code.
+     */
+    "prefer-destructuring": [
+      "warn",
+      {
+        VariableDeclarator: {
+          array: false,
+          object: true,
+        },
+        AssignmentExpression: {
+          array: false,
+          object: false,
+        },
+      },
+    ],
+
+    // "constructor-super" is disabled due to conflicting with the TypeScript compiler:
+    // https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+
+    // "for-direction" is enabled here:
+    // https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/errors.js
+
+    // "getter-return" is disabled due to conflicting with the TypeScript compiler:
+    // https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+
+    // "no-async-promise-executor"
+
+    // "no-await-in-loop"
+
+    // "no-class-assign"
+
+    // "no-compare-neg-zero"
+
+    // "no-cond-assign"
+
+    // "no-const-assign" is disabled due to conflicting with the TypeScript compiler:
+    // https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+
+    // "no-constant-binary-expression"
+
+    // "no-constant-condition"
+
+    // "no-constructor-return"
+
+    // "no-control-regex"
+
+    // "no-debugger"
+
+    // "no-dupe-args" is disabled due to conflicting with the TypeScript compiler:
+    // https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+
+    // "no-dupe-class-members" is disabled due to conflicting with the TypeScript compiler:
+    // https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+
+    // "no-dupe-else-if"
+
+    // "no-dupe-keys" is disabled due to conflicting with the TypeScript compiler:
+    // https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+
+    // "no-duplicate-case"
+
+    // "no-duplicate-imports"
+
+    // "no-empty-character-class"
+
+    // "no-empty-pattern"
+
+    // "no-ex-assign"
+
+    // "no-fallthrough"
+
+    // "no-func-assign" is disabled due to conflicting with the TypeScript compiler:
+    // https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+
+    // "no-import-assign" is disabled due to conflicting with the TypeScript compiler:
+    // https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+
+    // "no-inner-declarations"
+
+    // "no-invalid-regexp"
+
+    // "no-irregular-whitespace"
+
+    // "no-loss-of-precision"
+
+    // "no-misleading-character-class"
+
+    // "no-new-native-nonconstructor"
+
+    // "no-new-symbol" is disabled due to conflicting with the TypeScript compiler:
+    // https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+
+    // "no-obj-calls" is disabled due to conflicting with the TypeScript compiler:
+    // https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+
+    // "no-promise-executor-return"
+
+    // "no-prototype-builtins"
+
+    // "no-self-assign"
+
+    // "no-self-compare"
+
+    // "no-setter-return"
+
+    // "no-sparse-arrays"
+
+    // "no-template-curly-in-string"
+
+    // "no-redeclare" is disabled due to conflicting with the TypeScript compiler:
+    // https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+
+    // "no-setter-return" is disabled due to conflicting with the TypeScript compiler:
+    // https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+
+    // "no-this-before-super" is disabled due to conflicting with the TypeScript compiler:
+    // https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+
+    // "no-undef" is disabled due to conflicting with the TypeScript compiler:
+    // https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+
+    // "no-unreachable" is disabled due to conflicting with the TypeScript compiler:
+    // https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+
+    // "no-unsafe-negation" is disabled due to conflicting with the TypeScript compiler:
+    // https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+
+    // "valid-typeof" is disabled due to conflicting with the TypeScript compiler:
+    // https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+  },
+};

package/{jsdoc.js → base-jsdoc.js}

@@ -1,5 +1,6 @@
 // This is a shared configuration file for ESLint:
 // https://eslint.org/docs/latest/user-guide/configuring
+// This config contains only rules from the "jsdoc" ESLint plugin.
 module.exports = {
   plugins: [
     /**

package/base-typescript-eslint.js

@@ -0,0 +1,221 @@
+// 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 "@typescript-eslint"
+// plugin.
+module.exports = {
+  rules: {
+    /**
+     * Documentation:
+     * https://typescript-eslint.io/rules/array-type
+     *
+     * Not defined in the parent configs.
+     *
+     * Prefer the "string[]" syntax over "Array<string>".
+     */
+    "@typescript-eslint/array-type": [
+      "warn",
+      {
+        default: "array-simple",
+      },
+    ],
+
+    /**
+     * Documentation:
+     * https://typescript-eslint.io/rules/explicit-module-boundary-types
+     *
+     * Not defined in the parent configs.
+     *
+     * Specifying explicit return types can help prevent bugs, but only require it on exported
+     * functions.
+     */
+    "@typescript-eslint/explicit-module-boundary-types": "warn",
+
+    /**
+     * Documentation:
+     * https://typescript-eslint.io/rules/lines-between-class-members
+     *
+     * Defined at:
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js
+     *
+     * Airbnb has "exceptAfterSingleLine" turned off by default. A list of single-line variable
+     * declarations at the top of a class is common in TypeScript.
+     */
+    "@typescript-eslint/lines-between-class-members": [
+      "warn",
+      "always",
+      {
+        exceptAfterSingleLine: true,
+      },
+    ],
+
+    /**
+     * Documentation:
+     * https://typescript-eslint.io/rules/naming-convention
+     *
+     * 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.
+     */
+    "@typescript-eslint/naming-convention": [
+      "warn",
+      // Allow camelCase variables (23.2), PascalCase variables (23.8), and UPPER_CASE variables
+      // (23.10).
+      {
+        selector: "variable",
+        format: ["camelCase", "PascalCase", "UPPER_CASE"],
+        leadingUnderscore: "allow",
+      },
+      // Allow camelCase functions (23.2), and PascalCase functions (23.8).
+      {
+        selector: "function",
+        format: ["camelCase", "PascalCase"],
+        leadingUnderscore: "allow",
+      },
+      // 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"],
+      },
+    ],
+
+    /**
+     * Documentation:
+     * https://typescript-eslint.io/rules/no-unnecessary-boolean-literal-compare
+     *
+     * Not defined in the parent configs.
+     *
+     * This prevents useless code after refactoring variables to pure booleans.
+     */
+    "@typescript-eslint/no-unnecessary-boolean-literal-compare": "warn",
+
+    /**
+     * Documentation:
+     * https://typescript-eslint.io/rules/no-unused-vars
+     *
+     * Defined at:
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/variables.js
+     *
+     * We want to lint unused arguments (the default is "after-used"). We also want to ignore
+     * arguments/variables that start with an underscore. This matches the behavior of the
+     * TypeScript compiler flag "--noUnusedLocals".
+     */
+    "@typescript-eslint/no-unused-vars": [
+      "warn",
+      {
+        args: "all",
+        argsIgnorePattern: "^_",
+        varsIgnorePattern: "^_",
+      },
+    ],
+
+    /**
+     * Documentation:
+     * https://typescript-eslint.io/rules/no-use-before-define
+     *
+     * Defined at:
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/variables.js
+     *
+     * This allows code to be structured in a more logical order.
+     */
+    "@typescript-eslint/no-use-before-define": "off",
+
+    /**
+     * Documentation:
+     * https://typescript-eslint.io/rules/prefer-optional-chain
+     *
+     * Defined at:
+     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/strict.ts
+     *
+     * This can modify the type of boolean declarations to "boolean | undefined", which is undesired
+     * in some circumstances:
+     * https://github.com/typescript-eslint/typescript-eslint/issues/5269
+     */
+    "@typescript-eslint/prefer-optional-chain": "off",
+
+    /**
+     * Documentation:
+     * https://typescript-eslint.io/rules/quotes
+     *
+     * Defined at:
+     * https://github.com/prettier/eslint-config-prettier/blob/main/%40typescript-eslint.js
+     *
+     * In order to forbid unnecessary backticks, we must re-enable the "@typescript-eslint/quotes"
+     * rule as specified in the eslint-config-prettier documentation:
+     * https://github.com/prettier/eslint-config-prettier#enforce-backticks
+     */
+    "@typescript-eslint/quotes": [
+      "warn",
+      "double",
+      {
+        avoidEscape: true,
+        allowTemplateLiterals: false,
+      },
+    ],
+
+    /**
+     * Documentation:
+     * https://typescript-eslint.io/rules/restrict-template-expressions
+     *
+     * Defined at:
+     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/recommended-requiring-type-checking.ts
+     *
+     * This rule disallows booleans and nulls in template expressions. However, a common use-case of
+     * template strings is to coerce everything to a string.
+     */
+    "@typescript-eslint/restrict-template-expressions": "off",
+
+    /**
+     * Documentation:
+     * https://typescript-eslint.io/rules/strict-boolean-expressions
+     *
+     * Not defined in the parent configs.
+     *
+     * This rule prevents bugs when refactoring a boolean to a number.
+     */
+    "@typescript-eslint/strict-boolean-expressions": [
+      "warn",
+      {
+        allowString: false,
+        allowNumber: false,
+        allowNullableObject: false,
+        allowNullableBoolean: false,
+        allowNullableString: false,
+        allowNullableNumber: false,
+        allowAny: false,
+      },
+    ],
+
+    /**
+     * Documentation:
+     * https://typescript-eslint.io/rules/switch-exhaustiveness-check/
+     *
+     * Not defined in the parent configs.
+     *
+     * This rule ensures type-safety with switch statements, which can be especially helpful when
+     * values are added or removed from an enum.
+     */
+    "@typescript-eslint/switch-exhaustiveness-check": "warn",
+  },
+
+  overrides: [
+    // Disable some TypeScript-specific rules in JavaScript files.
+    {
+      files: ["*.js", "*.cjs", "*.mjs", "*.jsx"],
+      rules: {
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        "@typescript-eslint/no-unsafe-argument": "off",
+        "@typescript-eslint/no-unsafe-assignment": "off",
+        "@typescript-eslint/no-unsafe-call": "off",
+        "@typescript-eslint/no-unsafe-member-access": "off",
+        "@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

@@ -1,5 +1,6 @@
 // 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 all TypeScript projects.
 module.exports = {
   extends: [
     /**
@@ -23,7 +24,6 @@ module.exports = {
      * We extend the Airbnb rules with the "recommended", "recommended-requiring-type-checking", and
      * "strict" rules from the "typescript-eslint" plugin, which is also recommended by Matt
      * Turnbull, the author of "airbnb-typescript/base":
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/README.md#recommended
      * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/recommended.ts
      * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/recommended-requiring-type-checking.ts
      * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/strict.ts
@@ -44,8 +44,16 @@ module.exports = {
      */
     "plugin:eslint-comments/recommended",
 
-    /** Lint JSDoc comments. */
-    "./jsdoc",
+    /**
+     * Lint Node-specific things:
+     * https://github.com/eslint-community/eslint-plugin-n
+     */
+    "plugin:n/recommended",
+
+    /** Rule modifications are split out into different files for better organization. */
+    "./base-eslint",
+    "./base-typescript-eslint",
+    "./base-jsdoc",
 
     /**
      * Disable any ESLint rules that conflict with Prettier:
@@ -57,437 +65,269 @@ module.exports = {
 
   plugins: [
     /**
-     * Use the "eslint-plugin-only-warn" plugin to change all errors to warnings:
-     * https://github.com/bfanger/eslint-plugin-only-warn
-     *
-     * This allows the end-user to more easily distinguish between errors from the TypeScript
-     * compiler (which show up in red) and ESLint rule violations (which show up in yellow).
+     * Activate the "no-autofix" plugin, which allows the fixer for specific rules to be turned off:
+     * https://github.com/aladdin-add/eslint-plugin/tree/master/packages/no-autofix
      */
-    "only-warn",
+    "no-autofix",
 
     /**
      * Activate the "no-type-assertion" plugin, which allows the "no-type-assertion" rule to be
-     * optionally enabled on a per-project basis.
+     * optionally enabled on a per-project basis:
+     * https://github.com/Dremora/eslint-plugin-no-type-assertion
      */
     "no-type-assertion",
 
     /**
-     * Activate the "sort-exports" plugin, which allows the "sort-exports" rule to be optionally
-     * enabled on a per-project basis.
+     * Activate the "eslint-plugin-only-warn" plugin to change all errors to warnings:
+     * https://github.com/bfanger/eslint-plugin-only-warn
+     *
+     * This allows the end-user to more easily distinguish between errors from the TypeScript
+     * compiler (which show up in red) and ESLint rule violations (which show up in yellow).
      */
-    "sort-exports",
-  ],
+    "only-warn",
 
-  rules: {
     /**
-     * Documentation:
-     * https://typescript-eslint.io/rules/array-type
-     *
-     * Not defined in the parent configs.
-     *
-     * Prefer the "string[]" syntax over "Array<string>".
+     * Activate the "sort-exports" plugin, which allows the "sort-exports" rule to be optionally
+     * enabled on a per-project basis:
+     * https://github.com/jrdrg/eslint-plugin-sort-exports
      */
-    "@typescript-eslint/array-type": [
-      "warn",
-      {
-        default: "array-simple",
-      },
-    ],
+    "sort-exports",
 
     /**
-     * Documentation:
-     * https://typescript-eslint.io/rules/explicit-module-boundary-types
-     *
-     * Not defined in the parent configs.
-     *
-     * Specifying explicit return types can help prevent bugs, but only require it on exported
-     * functions.
+     * Activate the "unicorn" plugin, which allows for various miscellaneous useful rules:
+     * https://github.com/sindresorhus/eslint-plugin-unicorn
      */
-    "@typescript-eslint/explicit-module-boundary-types": "warn",
+    "unicorn",
+  ],
 
+  rules: {
     /**
      * Documentation:
-     * https://typescript-eslint.io/rules/lines-between-class-members
+     * https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/docs/rules/disable-enable-pair.md
      *
      * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js
+     * https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/lib/configs/recommended.js
      *
-     * Airbnb has "exceptAfterSingleLine" turned off by default. A list of single-line variable
-     * declarations at the top of a class is common in TypeScript.
+     * By default, it does not allow "eslint-disable" comments for a whole file, which is standard
+     * practice.
      */
-    "@typescript-eslint/lines-between-class-members": [
+    "eslint-comments/disable-enable-pair": [
       "warn",
-      "always",
       {
-        exceptAfterSingleLine: true,
+        allowWholeFile: true,
       },
     ],
 
     /**
      * Documentation:
-     * https://typescript-eslint.io/rules/naming-convention
+     * https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/docs/rules/no-unlimited-disable.md
      *
      * Defined at:
-     * https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+     * https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/lib/configs/recommended.js
      *
-     * Modify the Airbnb config to allow for a leading underscore, which signifies that it is
-     * temporarily not being used.
+     * If a line breaks two or more ESLint rules, then it is useful to use a single "eslint-disable"
+     * comment.
      */
-    "@typescript-eslint/naming-convention": [
-      "warn",
-      // Allow camelCase variables (23.2), PascalCase variables (23.8), and UPPER_CASE variables
-      // (23.10).
-      {
-        selector: "variable",
-        format: ["camelCase", "PascalCase", "UPPER_CASE"],
-        leadingUnderscore: "allow",
-      },
-      // Allow camelCase functions (23.2), and PascalCase functions (23.8).
-      {
-        selector: "function",
-        format: ["camelCase", "PascalCase"],
-        leadingUnderscore: "allow",
-      },
-      // 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"],
-      },
-    ],
+    "eslint-comments/no-unlimited-disable": "off",
 
     /**
      * Documentation:
-     * https://typescript-eslint.io/rules/no-unnecessary-boolean-literal-compare
+     * https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/docs/rules/no-unused-disable.md
      *
      * Not defined in the parent configs.
      *
-     * This prevents useless code after refactoring variables to pure booleans.
+     * This can help clean up unnecessary comments.
      */
-    "@typescript-eslint/no-unnecessary-boolean-literal-compare": "warn",
+    "eslint-comments/no-unused-disable": "warn",
 
     /**
      * Documentation:
-     * https://typescript-eslint.io/rules/no-unused-vars
+     * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/extensions.md
      *
      * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/variables.js
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/imports.js
+     * https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
      *
-     * We want to lint unused arguments (the default is "after-used"). We also want to ignore
-     * arguments/variables that start with an underscore. This matches the behavior of the
-     * TypeScript compiler flag "--noUnusedLocals".
+     * This rule is useful in commonjs codebases that want to ban file extensions on imports.
+     * However, ESM is now the standard and file extensions should be used. Furthermore, in
+     * TypeScript codebases, the compiler will alert us to any errors on a file extension in an
+     * import statement.
      */
-    "@typescript-eslint/no-unused-vars": [
-      "warn",
-      {
-        args: "all",
-        argsIgnorePattern: "^_",
-        varsIgnorePattern: "^_",
-      },
-    ],
+    "import/extensions": "off",
 
     /**
      * Documentation:
-     * https://typescript-eslint.io/rules/no-use-before-define
+     * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-default-export.md
      *
-     * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/variables.js
+     * Not defined in the parent configs.
      *
-     * This allows code to be structured in a more logical order.
+     * The case against default exports is layed out here:
+     * https://basarat.gitbook.io/typescript/main-1/defaultisbad
      */
-    "@typescript-eslint/no-use-before-define": "off",
+    "import/no-default-export": "warn",
 
     /**
      * Documentation:
-     * https://typescript-eslint.io/rules/prefer-optional-chain
+     * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-deprecated.md
      *
      * Defined at:
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/strict.ts
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/imports.js
      *
-     * This can modify the type of boolean declarations to "boolean | undefined", which is undesired
-     * in some circumstances:
-     * https://github.com/typescript-eslint/typescript-eslint/issues/5269
+     * It is a useful rule and it is turned off in the parent configs with no explanation.
      */
-    "@typescript-eslint/prefer-optional-chain": "off",
+    "import/no-deprecated": "off",
 
     /**
      * Documentation:
-     * https://typescript-eslint.io/rules/quotes
+     * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-unresolved.md
      *
      * Defined at:
-     * https://github.com/prettier/eslint-config-prettier/blob/main/%40typescript-eslint.js
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/imports.js
      *
-     * In order to forbid unnecessary backticks, we must re-enable the "@typescript-eslint/quotes"
-     * rule as specified in the eslint-config-prettier documentation:
-     * https://github.com/prettier/eslint-config-prettier#enforce-backticks
+     * This rule is not necessary in TypeScript codebases, since the compiler would error if you had
+     * a typo in an import statement.
      */
-    "@typescript-eslint/quotes": [
-      "warn",
-      "double",
-      {
-        avoidEscape: true,
-        allowTemplateLiterals: false,
-      },
-    ],
+    "import/no-unresolved": "off",
 
     /**
      * Documentation:
-     * https://typescript-eslint.io/rules/restrict-template-expressions
+     * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/prefer-default-export.md
      *
      * Defined at:
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/recommended-requiring-type-checking.ts
-     *
-     * This rule disallows booleans and nulls in template expressions. However, a common use-case of
-     * template strings is to coerce everything to a string.
-     */
-    "@typescript-eslint/restrict-template-expressions": "off",
-
-    /**
-     * Documentation:
-     * https://typescript-eslint.io/rules/strict-boolean-expressions
-     *
-     * Not defined in the parent configs.
-     *
-     * This rule prevents bugs when refactoring a boolean to a number.
-     */
-    "@typescript-eslint/strict-boolean-expressions": [
-      "warn",
-      {
-        allowString: false,
-        allowNumber: false,
-        allowNullableObject: false,
-        allowNullableBoolean: false,
-        allowNullableString: false,
-        allowNullableNumber: false,
-        allowAny: false,
-      },
-    ],
-
-    /**
-     * Documentation:
-     * https://typescript-eslint.io/rules/switch-exhaustiveness-check/
-     *
-     * Not defined in the parent configs.
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/imports.js
      *
-     * This rule ensures type-safety with switch statements, which can be especially helpful when
-     * values are added or removed from an enum.
+     * The case against default exports is layed out here:
+     * https://basarat.gitbook.io/typescript/main-1/defaultisbad
      */
-    "@typescript-eslint/switch-exhaustiveness-check": "warn",
+    "import/prefer-default-export": "off",
 
     /**
      * Documentation:
-     * https://eslint.org/docs/latest/rules/consistent-return
+     * https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-extraneous-import.md
      *
      * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/best-practices.js
+     * https://github.com/eslint-community/eslint-plugin-n/blob/master/lib/configs/_commons.js
      *
-     * We prefer the "noImplicitReturns" compiler flag over the "consistent-return" ESLint rule,
-     * since it is type-aware:
-     * https://github.com/typescript-eslint/typescript-eslint/issues/5254
+     * The TypeScript compiler will warn us if an import does not exist, so this rule is
+     * unnecessary.
      */
-    "consistent-return": ["off"],
+    "n/no-extraneous-import": "off",
 
     /**
      * Documentation:
-     * https://eslint.org/docs/latest/rules/curly
+     * https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-extraneous-require.md
      *
      * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/best-practices.js
+     * https://github.com/eslint-community/eslint-plugin-n/blob/master/lib/configs/_commons.js
      *
-     * Always requiring curly braces can partially ward against Apple-style if statement bugs:
-     * https://www.imperialviolet.org/2014/02/22/applebug.html
-     *
-     * Additionally, this rule needs to be set to "all" to work properly with
-     * `eslint-prettier-config`:
-     * https://github.com/prettier/eslint-config-prettier#curly
+     * Require statements are not used in TypeScript code.
      */
-    curly: ["warn", "all"],
+    "n/no-extraneous-require": "off",
 
     /**
      * Documentation:
-     * https://eslint.org/docs/latest/rules/default-case
+     * https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-missing-import.md
      *
      * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/best-practices.js
+     * https://github.com/eslint-community/eslint-plugin-n/blob/master/lib/configs/_commons.js
      *
-     * This rule is generally bad to have on in TypeScript projects:
-     * https://github.com/typescript-eslint/typescript-eslint/issues/5254
+     * The TypeScript compiler will warn us if an import does not exist, so this rule is
+     * unnecessary.
      */
-    "default-case": "off",
+    "n/no-missing-import": "off",
 
     /**
      * Documentation:
-     * https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/docs/rules/disable-enable-pair.md
+     * https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-process-exit.md
      *
      * Defined at:
-     * https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/lib/configs/recommended.js
+     * https://github.com/eslint-community/eslint-plugin-n/blob/master/lib/configs/_commons.js
      *
-     * By default, it does not allow "eslint-disable" comments for a whole file, which is standard
-     * practice.
+     * Using "process.exit" allows the ability to exit command-line applications without verbose
+     * output.
      */
-    "eslint-comments/disable-enable-pair": [
-      "warn",
-      {
-        allowWholeFile: true,
-      },
-    ],
+    "n/no-process-exit": "off",
 
     /**
      * Documentation:
-     * https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/docs/rules/no-unlimited-disable.md
+     * https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-unsupported-features/es-syntax.md
      *
      * Defined at:
-     * https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/lib/configs/recommended.js
+     * https://github.com/eslint-community/eslint-plugin-n/blob/master/lib/configs/_commons.js
      *
-     * If a line breaks two or more ESLint rules, then it is useful to use a single "eslint-disable"
-     * comment.
-     */
-    "eslint-comments/no-unlimited-disable": "off",
-
-    /**
-     * Documentation:
-     * https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/docs/rules/no-unused-disable.md
-     *
-     * Not defined in the parent configs.
-     *
-     * This can help clean up unnecessary comments.
+     * This rule requires adding `parserOptions.ecmaVersion` to every ESLint configuration file. The
+     * rule does not provide enough value to make that modification worth it.
      */
-    "eslint-comments/no-unused-disable": "warn",
+    "n/no-unsupported-features/es-syntax": "off",
 
     /**
      * Documentation:
-     * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-default-export.md
-     *
-     * Not defined in the parent configs.
-     *
-     * The case against default exports is layed out here:
-     * https://basarat.gitbook.io/typescript/main-1/defaultisbad
-     */
-    "import/no-default-export": "warn",
-
-    /**
-     * Documentation:
-     * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/prefer-default-export.md
+     * https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-unsupported-features/es-syntax.md
      *
      * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/imports.js
+     * https://github.com/eslint-community/eslint-plugin-n/blob/master/lib/configs/_commons.js
      *
-     * The case against default exports is layed out here:
-     * https://basarat.gitbook.io/typescript/main-1/defaultisbad
+     * This rule requires adding `parserOptions.ecmaVersion` to every ESLint configuration file. The
+     * rule does not provide enough value to make that modification worth it.
      */
-    "import/prefer-default-export": "off",
+    "n/no-unsupported-features/es-builtins": "off",
 
     /**
      * Documentation:
-     * https://eslint.org/docs/latest/rules/no-console
+     * https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-unsupported-features/node-builtins.md
      *
      * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/errors.js
-     *
-     * Command-line programs commonly write to standard out and standard error.
-     */
-    "no-console": "off",
-
-    /**
-     * Documentation:
-     * https://eslint.org/docs/latest/rules/no-constant-binary-expression
+     * https://github.com/eslint-community/eslint-plugin-n/blob/master/lib/configs/_commons.js
      *
-     * Not defined in parent configs.
-     *
-     * This rule was released in 2022 and is known to catch many subtle bugs:
-     * https://github.com/eslint/eslint.org/pull/240/files
+     * The TypeScript compiler will prevent us from using Node modules that are not present in the
+     * corresponding specified Node output environment, so this rule is unnecessary.
      */
-    "no-constant-binary-expression": "warn",
+    "n/no-unsupported-features/node-builtins": "off",
 
     /**
      * Documentation:
-     * https://eslint.org/docs/latest/rules/no-continue
+     * https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/shebang.md
      *
      * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js
+     * https://github.com/eslint-community/eslint-plugin-n/blob/master/lib/configs/_commons.js
      *
-     * Proper use of continues can reduce indentation for long blocks of code.
+     * We need to configure this rule to be Typescript-aware.
      */
-    "no-continue": "off",
+    "n/shebang": [
+      "error",
+      {
+        convertPath: {
+          "src/**/*.ts": ["^src/(.+?)\\.ts$", "src/$1.js"],
+        },
+      },
+    ],
 
     /**
      * Documentation:
-     * https://eslint.org/docs/latest/rules/no-plusplus
+     * https://github.com/aladdin-add/eslint-plugin/tree/master/packages/no-autofix
      *
-     * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js
-     *
-     * Airbnb disallows these because it can lead to errors with minified code. When using Prettier,
-     * it adds semi-colons everywhere, so we don't have to worry about this.
+     * We want to disable the autofix for this rule, since it is almost always unwanted.
      */
-    "no-plusplus": "off",
+    "no-useless-return": "off",
+    "no-autofix/no-useless-return": "warn",
 
     /**
      * Documentation:
-     * https://eslint.org/docs/latest/rules/no-restricted-syntax
+     * https://github.com/aladdin-add/eslint-plugin/tree/master/packages/no-autofix
      *
-     * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js
-     *
-     * - We move the selector for "for..of" loops, since they are commonly used.
-     * - We add a selector for "empty" invocations of the "array.push()" method.
+     * We want to disable the autofix for this rule, since it is almost always unwanted.
      */
-    "no-restricted-syntax": [
-      "warn",
-      {
-        selector: "ForInStatement",
-        message:
-          "for..in loops iterate over the entire prototype chain, which is virtually never what you want. Use Object.{keys,values,entries}, and iterate over the resulting array.",
-      },
-      {
-        selector: "LabeledStatement",
-        message:
-          "Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand.",
-      },
-      {
-        selector: "WithStatement",
-        message:
-          "`with` is disallowed in strict mode because it makes code impossible to predict and optimize.",
-      },
-      {
-        selector:
-          "CallExpression[callee.property.name='push'][arguments.length=0]",
-        message: "push must always be called with at least one argument.",
-      },
-    ],
+    "prefer-const": "off",
+    "no-autofix/prefer-const": "warn",
 
     /**
      * Documentation:
-     * https://eslint.org/docs/latest/rules/no-unused-expressions
+     * https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-node-protocol.md
      *
      * Not defined in parent configs.
      *
-     * An unused expression which has no effect on the state of the program indicates a logic error.
-     */
-    "no-unused-expressions": "warn",
-
-    /**
-     * Documentation:
-     * https://eslint.org/docs/latest/rules/prefer-destructuring
-     *
-     * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/es6.js
-     *
-     * Array destructuring can result in non-intuitive code.
+     * Enforce the new "node:" prefix as an extra safety measure.
      */
-    "prefer-destructuring": [
-      "warn",
-      {
-        VariableDeclarator: {
-          array: false,
-          object: true,
-        },
-        AssignmentExpression: {
-          array: false,
-          object: false,
-        },
-      },
-    ],
+    "unicorn/prefer-node-protocol": "warn",
   },
 };

package/mod.js

@@ -1,5 +1,6 @@
 // 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 = {
   extends: [
     /**

package/monorepo.js

@@ -1,4 +1,4 @@
-const path = require("path"); // eslint-disable-line @typescript-eslint/no-var-requires
+const path = require("node:path");
 
 const REPO_ROOT = path.join(__dirname, "..", "..");
 
@@ -16,6 +16,9 @@ module.exports = {
     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",

package/package.json

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