eslint-config-isaacscript 1.3.0 → 3.0.0

package/base.js

@@ -20,15 +20,17 @@ module.exports = {
     "airbnb-typescript/base",
 
     /**
-     * We extend the Airbnb rules with the "recommended" and "recommended-requiring-type-checking"
-     * rules from the "typescript-eslint" plugin, which is also recommended by Matt Turnbull, the
-     * author of "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/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
      */
     "plugin:@typescript-eslint/recommended",
     "plugin:@typescript-eslint/recommended-requiring-type-checking",
+    "plugin:@typescript-eslint/strict",
 
     /**
      * This provides extra miscellaneous rules to keep code safe:
@@ -73,7 +75,7 @@ module.exports = {
   rules: {
     /**
      * Documentation:
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/array-type.md
+     * https://typescript-eslint.io/rules/array-type
      *
      * Not defined in the parent configs.
      *
@@ -88,7 +90,7 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/explicit-module-boundary-types.md
+     * https://typescript-eslint.io/rules/explicit-module-boundary-types
      *
      * Not defined in the parent configs.
      *
@@ -99,7 +101,7 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/lines-between-class-members.md
+     * 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
@@ -117,7 +119,7 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/naming-convention.md
+     * https://typescript-eslint.io/rules/naming-convention
      *
      * Defined at:
      * https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
@@ -151,7 +153,7 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/no-unnecessary-boolean-literal-compare.md
+     * https://typescript-eslint.io/rules/no-unnecessary-boolean-literal-compare
      *
      * Not defined in the parent configs.
      *
@@ -161,7 +163,7 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/no-unused-vars.md
+     * 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
@@ -181,7 +183,7 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/no-use-before-define.md
+     * 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
@@ -192,7 +194,20 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/quotes.md
+     * 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
@@ -212,7 +227,7 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/restrict-template-expressions.md
+     * 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
@@ -224,7 +239,7 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/restrict-template-expressions.md
+     * https://typescript-eslint.io/rules/strict-boolean-expressions
      *
      * Not defined in the parent configs.
      *
@@ -243,6 +258,58 @@ module.exports = {
       },
     ],
 
+    /**
+     * 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",
+
+    /**
+     * 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://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/docs/rules/disable-enable-pair.md
@@ -296,7 +363,7 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://eslint.org/docs/rules/no-console
+     * 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
@@ -307,7 +374,18 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://eslint.org/docs/rules/no-continue
+     * 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
@@ -318,7 +396,7 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://eslint.org/docs/rules/no-plusplus
+     * 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
@@ -335,7 +413,7 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://eslint.org/docs/rules/no-restricted-syntax
+     * 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
@@ -369,7 +447,7 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://eslint.org/docs/rules/prefer-destructuring
+     * 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

package/jsdoc.js

@@ -47,16 +47,17 @@ module.exports = {
       "warn",
       {
         definedTags: [
-          // Used by the TypeScript compiler:
+          // Ignore tags used by the TypeScript compiler:
           // https://www.typescriptlang.org/tsconfig#stripInternal
           "internal", // Used by TypeScript
 
-          // Add tags used in TypeDoc:
+          // Ignore tags used in TypeDoc:
           // https://typedoc.org/guides/doccomments/
           "category",
           "hidden",
+          "notExported",
 
-          // Add tags used in TypeScriptToLua:
+          // Ignore tags used in TypeScriptToLua:
           // https://typescripttolua.github.io/docs/advanced/compiler-annotations
           "noResolution",
           "noSelf",

package/mod.js

@@ -12,7 +12,7 @@ module.exports = {
   rules: {
     /**
      * Documentation:
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/naming-convention.md
+     * https://typescript-eslint.io/rules/naming-convention
      *
      * Defined at:
      * https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
@@ -54,7 +54,24 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/no-loop-func.md
+     * 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
+     *
+     * 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",
+      {
+        allowAsThisParameter: true,
+      },
+    ],
+
+    /**
+     * Documentation:
+     * https://typescript-eslint.io/rules/no-loop-func
      *
      * Defined at:
      * https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
@@ -67,7 +84,7 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-plugin-isaacscript/main/docs/rules/enum-member-number-separation.md
+     * https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-plugin-isaacscript/docs/rules/enum-member-number-separation.md
      *
      * Not defined in the parent configs.
      *
@@ -77,7 +94,7 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-plugin-isaacscript/main/docs/rules/no-invalid-default-map.md
+     * https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-plugin-isaacscript/docs/rules/no-invalid-default-map.md
      *
      * Not defined in the parent configs.
      *
@@ -87,7 +104,7 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://github.com/eslint/eslint/blob/master/docs/rules/no-bitwise.md
+     * https://eslint.org/docs/latest/rules/no-bitwise
      *
      * Defined at:
      * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js
@@ -98,7 +115,7 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://eslint.org/docs/rules/no-param-reassign
+     * 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
@@ -109,7 +126,7 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://eslint.org/docs/rules/no-restricted-globals
+     * 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
@@ -120,7 +137,7 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://eslint.org/docs/rules/no-underscore-dangle
+     * 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

package/package.json

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