eslint-config-isaacscript 3.2.0 → 3.3.1

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,131 @@
+// 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", {}],
+  },
+
+  // "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: [
     /**
@@ -176,21 +177,20 @@ module.exports = {
 
     // - jsdoc/require-param-type - Not needed in TypeScript.
 
-    // - jsdoc/require-param - It's overboard for every function to document every parameter.
-    // TODO
-    /*
     "jsdoc/require-param": [
       "warn",
       {
+        // We only activate the rule when there are one or more parameters.
+        // https://github.com/gajus/eslint-plugin-jsdoc/issues/920
         contexts: [
           {
             context: "FunctionDeclaration",
-            comment: 'JsdocBlock > JsdocTag[tag="param"]',
+            comment: 'JsdocBlock:has(JsdocTag[tag="param"])',
           },
         ],
       },
     ],
-    */
+
     // - jsdoc/require-property - Probably not needed in TypeScript.
 
     /**

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,11 @@ module.exports = {
      */
     "plugin:eslint-comments/recommended",
 
+    /** Rule modifications are split out into different files for better organization. */
+    "./base-eslint",
+
     /** Lint JSDoc comments. */
-    "./jsdoc",
+    "./base-jsdoc",
 
     /**
      * Disable any ESLint rules that conflict with Prettier:
@@ -57,7 +60,13 @@ module.exports = {
 
   plugins: [
     /**
-     * Use the "eslint-plugin-only-warn" plugin to change all errors to warnings:
+     * Activate the "no-type-assertion" plugin, which allows the "no-type-assertion" rule to be
+     * optionally enabled on a per-project basis.
+     */
+    "no-type-assertion",
+
+    /**
+     * 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
@@ -65,12 +74,6 @@ module.exports = {
      */
     "only-warn",
 
-    /**
-     * Activate the "no-type-assertion" plugin, which allows the "no-type-assertion" rule to be
-     * optionally enabled on a per-project basis.
-     */
-    "no-type-assertion",
-
     /**
      * Activate the "sort-exports" plugin, which allows the "sort-exports" rule to be optionally
      * enabled on a per-project basis.
@@ -357,7 +360,29 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/prefer-default-export.md
+     * 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/no-deprecated.md
+     *
+     * Defined at:
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/imports.js
+     *
+     * It is a useful rule and it is turned off in the parent configs with no explanation.
+     */
+    "import/no-deprecated": "off",
+
+    /**
+     * Documentation:
+     * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/prefer-default-export.md
      *
      * Defined at:
      * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/imports.js
@@ -446,6 +471,16 @@ module.exports = {
       },
     ],
 
+    /**
+     * 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
@@ -453,7 +488,7 @@ module.exports = {
      * 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.
+     * Array destructuring can result in non-intuitive code.
      */
     "prefer-destructuring": [
       "warn",
@@ -469,4 +504,22 @@ module.exports = {
       },
     ],
   },
+
+  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/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("path");
 
 const REPO_ROOT = path.join(__dirname, "..", "..");
 
@@ -16,6 +16,8 @@ module.exports = {
     tsconfigRootDir: REPO_ROOT,
   },
 
+  ignorePatterns: ["!.prettierrc.cjs"],
+
   rules: {
     "@nrwl/nx/enforce-module-boundaries": [
       "warn",

package/package.json

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