eslint-config-isaacscript 3.7.1 → 3.7.2

package/base-eslint.js

@@ -1,8 +1,10 @@
-// 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 = {
+/**
+ * This ESLint config only contains built-in rules from ESLint itself:
+ * https://eslint.org/docs/latest/rules/
+ *
+ * @type {import("eslint").Linter.Config}
+ */
+const config = {
   rules: {
     // -----------------
     // Possible Problems
@@ -133,16 +135,6 @@ 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
@@ -289,3 +281,5 @@ module.exports = {
     // class-methods-use-this
   },
 };
+
+module.exports = config;

package/base-jsdoc.js

@@ -1,14 +1,11 @@
-// 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: [
-    /**
-     * Lint JSDoc style comments:
-     * https://github.com/gajus/eslint-plugin-jsdoc
-     */
-    "jsdoc",
-  ],
+/**
+ * This ESLint config only contains rules from `eslint-plugin-jsdoc`:
+ * https://github.com/gajus/eslint-plugin-jsdoc
+ *
+ * @type {import("eslint").Linter.Config}
+ */
+const config = {
+  plugins: ["jsdoc"],
 
   /**
    * Instead of using the recommended config, we specifically turn on every rule that is useful.
@@ -237,15 +234,7 @@ module.exports = {
     // - jsdoc/require-yields-check - It's overboard to document every yield.
     // - jsdoc/sort-tags - Not very useful since there are typically only `@param` and `@return`
     //   tags.
-
-    /**
-     * Documentation:
-     * https://github.com/gajus/eslint-plugin-jsdoc#tag-lines
-     *
-     * Enforces no lines between tags.
-     */
-    "jsdoc/tag-lines": "warn",
-
+    // - jsdoc/tag-lines - Not needed with `isaacscript/format-jsdoc-comments`.
     // - jsdoc/valid-types - Not needed in TypeScript.
   },
 
@@ -259,3 +248,5 @@ module.exports = {
     },
   ],
 };
+
+module.exports = config;

package/base-typescript-eslint.js

@@ -1,8 +1,21 @@
-// 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 = {
+/**
+ * This config only contains rules from `@typescript-eslint` plugin.
+ *
+ * @type {import("eslint").Linter.Config}
+ */
+const config = {
+  /** This plugin has three separate configs that are recommended to extend from. */
+  extends: [
+    // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/recommended.ts
+    "plugin:@typescript-eslint/recommended",
+
+    // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/recommended-requiring-type-checking.ts
+    "plugin:@typescript-eslint/recommended-requiring-type-checking",
+
+    // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/strict.ts
+    "plugin:@typescript-eslint/strict",
+  ],
+
   rules: {
     /**
      * Documentation:
@@ -166,6 +179,10 @@ module.exports = {
       },
     ],
 
+    // This is part of the recommended config, but we turn it off because of this issue:
+    // https://github.com/typescript-eslint/typescript-eslint/issues/7067
+    "@typescript-eslint/no-unsafe-enum-comparison": "off",
+
     /**
      * Documentation:
      * https://typescript-eslint.io/rules/restrict-template-expressions
@@ -228,3 +245,5 @@ module.exports = {
     },
   ],
 };
+
+module.exports = config;

package/base.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 all TypeScript projects.
-module.exports = {
+/**
+ * This ESLint config is meant to be used as a base for all TypeScript projects.
+ *
+ *  @type {import("eslint").Linter.Config}
+ */
+const config = {
   extends: [
     /**
      * The linter base is the Airbnb style guide, which is the most popular JavaScript style guide
@@ -20,18 +22,6 @@ module.exports = {
      */
     "airbnb-typescript/base",
 
-    /**
-     * 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/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
-     */
-    "plugin:@typescript-eslint/recommended",
-    "plugin:@typescript-eslint/recommended-requiring-type-checking",
-    "plugin:@typescript-eslint/strict",
-
     /**
      * This provides extra miscellaneous rules to keep code safe:
      * https://github.com/IsaacScript/isaacscript/tree/main/packages/eslint-plugin-isaacscript
@@ -382,3 +372,5 @@ module.exports = {
     },
   ],
 };
+
+module.exports = config;

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:
@@ -228,3 +230,5 @@ module.exports = {
     ],
   },
 };
+
+module.exports = config;

package/monorepo.js

@@ -2,9 +2,12 @@ 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 = {
+/**
+ * This config is meant to be used in the IsaacScript monorepo.
+ *
+ * @type {import("eslint").Linter.Config}
+ */
+const config = {
   plugins: ["@nrwl/nx"],
 
   // From:
@@ -43,3 +46,5 @@ module.exports = {
     ],
   },
 };
+
+module.exports = config;

package/package.json

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