eslint-config-isaacscript 4.0.9 → 4.1.0

package/base-eslint.js

@@ -119,15 +119,15 @@ const SUGGESTIONS = {
   "class-methods-use-this": "off",
 
   /**
-   * Disabled since cyclomatic complexity is not a good enough general indicator of code complexity.
+   * Disabled since cyclomatic complexity is not a good enough general indicator of code complexity
+   * and leads to too many false positives.
    */
   complexity: "off",
 
   /** Disabled since this is handled by the `noImplicitReturns` TypeScript compiler flag. */
   "consistent-return": "off",
 
-  /** Disabled since capturing `this` is largely obviated by using modern arrow functions. */
-  "consistent-this": "off",
+  "consistent-this": "error",
 
   /**
    * Always requiring curly braces can partially ward against [Apple-style if statement
@@ -138,8 +138,8 @@ const SUGGESTIONS = {
   curly: ["error", "all"],
 
   /**
-   * Disabled since it is [generally bad in TypeScript
-   * projects](https://github.com/typescript-eslint/typescript-eslint/issues/5254#issuecomment-1168992749).
+   * Disabled since it would cause the `@typescript-eslint/switch-exhaustiveness-check` rule to not
+   * work properly.
    */
   "default-case": "off",
 
@@ -157,7 +157,10 @@ const SUGGESTIONS = {
   "func-name-matching": "error",
   "func-names": "error",
 
-  /** Disabled since it is common to use both function forms, depending on the situation. */
+  /**
+   * Disabled since it is common in the TypeScript ecosystem to use both function forms, depending
+   * on the situation.
+   */
   "func-style": "off",
 
   "grouped-accessor-pairs": "error",
@@ -239,7 +242,11 @@ const SUGGESTIONS = {
    */
   "no-console": "off",
 
-  /** Disabled because proper use of continues can reduce indentation for long blocks of code. */
+  /**
+   * Disabled because proper use of continues can reduce indentation for long blocks of code in the
+   * same way as the [early return
+   * pattern](https://medium.com/swlh/return-early-pattern-3d18a41bba8).
+   */
   "no-continue": "off",
 
   "no-delete-var": "error",

package/base-no-autofix.js

@@ -10,7 +10,19 @@ const config = {
   plugins: ["no-autofix"],
 
   rules: {
+    /**
+     * It is common during development to comment out code after an [early
+     * return](https://medium.com/swlh/return-early-pattern-3d18a41bba8). In these cases, the
+     * auto-fixer is harmful, since it would require us to manually go put the return statement back
+     * after uncommenting the code.
+     */
     "no-autofix/no-useless-return": "error",
+
+    /**
+     * It is common during development to comment out code that modifies a `let` variable. In these
+     * cases, the auto-fixer is harmful, since it would require us to manually go change the `const`
+     * back to a `let` after uncommenting the code.
+     */
     "no-autofix/prefer-const": "error",
   },
 };

package/mod.js

@@ -7,7 +7,7 @@ const config = {
   extends: [
     /**
      * The IsaacScript mod config extends the base configuration:
-     * https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-config-isaacscript/base.js
+     * https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-config-isaacscript/configs/base.js
      * (Normal TypeScript projects would just use the base configuration directly.)
      */
     "./base",

package/package.json

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