eslint-config-isaacscript 1.0.68 → 1.0.71

package/.cspell.json

@@ -1,24 +1,14 @@
 {
-    "version": "0.1",
-    "language": "en",
-    "dictionaries": [
-        "en_US"
-    ],
+    "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+    "version": "0.2",
     "words": [
         "backticks",
-        "chdir",
-        "config",
-        "deno",
-        "eqeqeq",
-        "eslint",
         "isaacscript",
         "plusplus",
         "sarisia",
         "technote",
-        "turnbull",
-        "unexported",
+        "Turnbull",
         "unfixable",
-        "winpty",
-        "zamiell"
+        "Zamiell"
     ]
-}
+}

package/.eslintrc.js

@@ -1,4 +1,4 @@
-// This is a shared configuration file for ESLint
+// This is a shared configuration file for ESLint:
 // https://eslint.org/docs/user-guide/configuring
 module.exports = {
   plugins: ["prettier"],

package/.github/workflows/ci.yml

@@ -12,8 +12,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v2
         with:
-          # The default version is 14
-          # The ESLint config requires Node 16 to work properly
+          # The default version is 14. The ESLint config requires Node 16 to work properly.
           node-version: '16'
 
       - name: Retrieve the cached "node_modules" directory (if present)
@@ -33,7 +32,7 @@ jobs:
   discord:
     name: Discord Failure Notification
     needs: [lint]
-    if: always() # This is needed to always run this job, even if the other jobs fail
+    if: always() # This is needed to always run this job, even if the other jobs fail.
     runs-on: ubuntu-latest
     steps:
       - uses: technote-space/workflow-conclusion-action@v2

package/.prettierrc.js

@@ -1,10 +1,9 @@
-// This is the configuration file for Prettier, the auto-formatter
+// This is the configuration file for Prettier, the auto-formatter:
 // https://prettier.io/docs/en/configuration.html
 module.exports = {
   // https://prettier.io/docs/en/options.html#trailing-commas
   // The default is "es5" - Trailing commas where valid in ES5 (objects, arrays, etc.)
-  // However, always having trailing commas is objectively better
-  // The Airbnb style guide agrees:
+  // However, always having trailing commas is objectively better. The Airbnb style guide agrees:
   // https://github.com/airbnb/javascript#commas--dangling
   // Prettier itself also acknowledges Nik Graf's blog in their official blog:
   // https://prettier.io/blog/2020/03/21/2.0.0.html#change-default-value-for-trailingcomma-to-es5-6963httpsgithubcomprettierprettierpull6963-by-fiskerhttpsgithubcomfisker

package/.vscode/extensions.json

@@ -1,5 +1,5 @@
 // These are Visual Studio Code extensions that are intended to be used with this particular
-// repository
+// repository:
 // https://go.microsoft.com/fwlink/?LinkId=827846
 {
   "recommendations": [

package/.vscode/settings.json

@@ -1,30 +1,30 @@
-// These are Visual Studio Code settings that should apply to this particular repository
+// These are Visual Studio Code settings that should apply to this particular repository.
 {
   // ----------------
   // Vanilla settings
   // ----------------
 
-  // This matches the Airbnb JavaScript style guide
+  // This matches the Airbnb JavaScript style guide.
   "editor.rulers": [100],
   "editor.tabSize": 2,
 
-  // Linux line endings are used in this project
+  // Linux line endings are used in this project.
   "files.eol": "\n",
 
-  // Automatically removing all trailing whitespace when saving a file
+  // Automatically removing all trailing whitespace when saving a file.
   "files.trimTrailingWhitespace": true,
 
   // ----------
   // JavaScript
   // ----------
 
-  // Automatically run the formatter when a JavaScript file is saved
+  // Automatically run the formatter when certain files are saved.
   "[javascript]": {
+    "editor.codeActionsOnSave": [
+      "source.fixAll.eslint",
+    ],
     "editor.defaultFormatter": "esbenp.prettier-vscode",
     "editor.formatOnSave": true,
-    "editor.codeActionsOnSave": {
-      "source.fixAll.eslint": true,
-    },
     "editor.tabSize": 2,
   },
 }

package/base.js

@@ -1,127 +1,174 @@
-// This is a shared configuration file for ESLint
+// This is a shared configuration file for ESLint:
 // https://eslint.org/docs/user-guide/configuring
 module.exports = {
   extends: [
-    // The linter base is the Airbnb style guide,
-    // which is the most popular JavaScript style guide in the world:
-    // https://github.com/airbnb/javascript
-    // The actual ESLint config is located here:
-    // https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules
-    // The TypeScript config extends it:
-    // https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
-    // This includes the "parser" declaration of "@typescript-eslint/parser"
+    /**
+     * The linter base is the Airbnb style guide, which is the most popular JavaScript style guide
+     * in the world: https://github.com/airbnb/javascript
+     *
+     * The actual ESLint config is located here:
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules
+     */
     "airbnb-base",
+
+    /**
+     * The TypeScript config extends it:
+     * https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+     * (This includes the "parser" declaration of "@typescript-eslint/parser".)
+     */
     "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"
-    // 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
+    /**
+     * 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":
+     * 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
+     */
     "plugin:@typescript-eslint/recommended",
     "plugin:@typescript-eslint/recommended-requiring-type-checking",
 
-    // This provides extra miscellaneous rules to keep code safe
+    /**
+     * This provides extra miscellaneous rules to keep code safe:
+     * https://github.com/IsaacScript/eslint-plugin-isaacscript
+     */
     "plugin:isaacscript/recommended",
 
-    // Find unused "eslint-disable" comments
-    // https://github.com/mysticatea/eslint-plugin-eslint-comments
+    /**
+     * Find unused "eslint-disable" comments:
+     * https://github.com/mysticatea/eslint-plugin-eslint-comments
+     */
     "plugin:eslint-comments/recommended",
 
-    // This provides rules to lint JSDoc comments
+    /** Lint JSDoc comments. */
     "./jsdoc",
 
-    // Disable any ESLint rules that conflict with Prettier
-    // (otherwise, we will have unfixable ESLint errors)
-    // https://github.com/prettier/eslint-config-prettier
+    /**
+     * Disable any ESLint rules that conflict with Prettier:
+     * https://github.com/prettier/eslint-config-prettier
+     * (Otherwise, we will have unfixable ESLint errors.)
+     */
     "prettier",
   ],
 
   plugins: [
-    // Use the "eslint-plugin-only-warn" plugin to change all errors to warnings
-    // 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)
+    /**
+     * 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).
+     */
     "only-warn",
 
-    // Activate the "sort-exports" plugin, which allows the "sort-exports" rule to be optionally
-    // enabled on a per-project basis
+    /**
+     * Activate the "sort-exports" plugin, which allows the "sort-exports" rule to be optionally
+     * enabled on a per-project basis.
+     */
     "sort-exports",
   ],
 
-  // We modify the linting rules from the base for some specific things
-  // (listed in alphabetical order)
   rules: {
-    // Documentation:
-    // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/array-type.md
-    // Not defined in the parent configs
-    // Prefer the "string[]" syntax over "Array<string>"
-    "@typescript-eslint/array-type": ["warn", { default: "array-simple" }],
+    /**
+     * Documentation:
+     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/array-type.md
+     *
+     * Not defined in the parent configs.
+     *
+     * Prefer the "string[]" syntax over "Array<string>".
+     */
+    "@typescript-eslint/array-type": [
+      "warn",
+      {
+        default: "array-simple",
+      },
+    ],
 
-    // Documentation:
-    // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/explicit-module-boundary-types.md
-    // Not defined in the parent configs
-    // Specifying explicit return types can help prevent bugs, but only require it on exported
-    // functions
+    /**
+     * Documentation:
+     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/explicit-module-boundary-types.md
+     *
+     * 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://eslint.org/docs/rules/lines-between-class-members
-    // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/lines-between-class-members.md
-    // 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
+    /**
+     * Documentation:
+     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/lines-between-class-members.md
+     *
+     * 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 },
+      {
+        exceptAfterSingleLine: true,
+      },
     ],
 
-    // Documentation:
-    // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/naming-convention.md
-    // 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
+    /**
+     * Documentation:
+     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/naming-convention.md
+     *
+     * 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)
+      // 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)
+      // 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
+      // 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://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/no-unnecessary-boolean-literal-compare.md
-    // Not defined in the parent configs
-    // This prevents useless code after refactoring variables to pure booleans
+    /**
+     * Documentation:
+     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/no-unnecessary-boolean-literal-compare.md
+     *
+     * 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://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/no-unused-vars.md
-    // 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"
+    /**
+     * Documentation:
+     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/no-unused-vars.md
+     *
+     * 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",
       {
@@ -131,39 +178,57 @@ module.exports = {
       },
     ],
 
-    // Documentation:
-    // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/no-use-before-define.md
-    // https://eslint.org/docs/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
+    /**
+     * Documentation:
+     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/no-use-before-define.md
+     *
+     * 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://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/quotes.md
-    // 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
+    /**
+     * Documentation:
+     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/quotes.md
+     *
+     * 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 },
+      {
+        avoidEscape: true,
+        allowTemplateLiterals: false,
+      },
     ],
 
-    // Documentation:
-    // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/restrict-template-expressions.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
+    /**
+     * Documentation:
+     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/restrict-template-expressions.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://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/restrict-template-expressions.md
-    // Not defined in the parent configs
-    // This rule prevents bugs when refactoring a boolean to a number
+    /**
+     * Documentation:
+     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/restrict-template-expressions.md
+     *
+     * Not defined in the parent configs.
+     *
+     * This rule prevents bugs when refactoring a boolean to a number.
+     */
     "@typescript-eslint/strict-boolean-expressions": [
       "warn",
       {
@@ -177,36 +242,16 @@ module.exports = {
       },
     ],
 
-    // Documentation:
-    // https://github.com/lasselupe33/eslint-plugin-comment-length
-    // Defined at:
-    // https://github.com/lasselupe33/eslint-plugin-comment-length/blob/master/rules/src/index.ts
-    // Auto-fix long comments. We specify 100 to match the ruler and the Airbnb style guide.
-    "comment-length-2/limit-multi-line-comments": [
-      "warn",
-      {
-        maxLength: 100,
-      },
-    ],
-
-    // Documentation:
-    // https://github.com/lasselupe33/eslint-plugin-comment-length
-    // Defined at:
-    // https://github.com/lasselupe33/eslint-plugin-comment-length/blob/master/rules/src/index.ts
-    // Auto-fix long comments. We specify 100 to match the ruler and the Airbnb style guide.
-    "comment-length-2/limit-single-line-comments": [
-      "warn",
-      {
-        maxLength: 100,
-      },
-    ],
-
-    // Documentation:
-    // https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/docs/rules/disable-enable-pair.md
-    // Defined at:
-    // https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/lib/configs/recommended.js
-    // By default, it does not allow "eslint-disable" comments for a whole file,
-    // which is standard practice
+    /**
+     * Documentation:
+     * https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/docs/rules/disable-enable-pair.md
+     *
+     * Defined at:
+     * https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/lib/configs/recommended.js
+     *
+     * By default, it does not allow "eslint-disable" comments for a whole file, which is standard
+     * practice.
+     */
     "eslint-comments/disable-enable-pair": [
       "warn",
       {
@@ -214,56 +259,85 @@ module.exports = {
       },
     ],
 
-    // Documentation:
-    // https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/docs/rules/no-unlimited-disable.md
-    // Defined at:
-    // https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/lib/configs/recommended.js
-    // If a line breaks two or more ESLint rules,
-    // then it is useful to use a single "eslint-disable" comment
+    /**
+     * Documentation:
+     * https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/docs/rules/no-unlimited-disable.md
+     *
+     * Defined at:
+     * https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/lib/configs/recommended.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 parent configs
-    // This can help clean up unnecessary comments
+    /**
+     * 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.
+     */
     "eslint-comments/no-unused-disable": "warn",
 
-    // Documentation:
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/prefer-default-export.md
-    // Defined at:
-    // https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/imports.js
-    // The case against default exports is layed out here:
-    // https://basarat.gitbook.io/typescript/main-1/defaultisbad
+    /**
+     * Documentation:
+     * https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/prefer-default-export.md
+     *
+     * Defined at:
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/imports.js
+     *
+     * The case against default exports is layed out here:
+     * https://basarat.gitbook.io/typescript/main-1/defaultisbad
+     */
     "import/prefer-default-export": "off",
 
-    // Documentation:
-    // https://eslint.org/docs/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
+    /**
+     * Documentation: https://eslint.org/docs/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/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
+    /**
+     * Documentation: https://eslint.org/docs/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/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;
-    // we don't have to worry about this in for loops though
-    "no-plusplus": ["warn", { allowForLoopAfterthoughts: true }],
+    /**
+     * Documentation: https://eslint.org/docs/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. We don't have to
+     * worry about this in for loops though.
+     */
+    "no-plusplus": [
+      "warn",
+      {
+        allowForLoopAfterthoughts: true,
+      },
+    ],
 
-    // Documentation:
-    // https://eslint.org/docs/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
+    /**
+     * Documentation: https://eslint.org/docs/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",
       {
@@ -288,13 +362,15 @@ module.exports = {
       },
     ],
 
-    // Documentation:
-    // https://eslint.org/docs/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
-    // Object destructuring is disgustingly verbose in TypeScript
-    // e.g. "const foo: string = bar.foo;" vs "const { foo }: { foo: string } = bar;"
+    /**
+     * Documentation: https://eslint.org/docs/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.
+     * - Object destructuring is disgustingly verbose in TypeScript.
+     */
     "prefer-destructuring": "off",
   },
 };

package/jsdoc.js

@@ -1,65 +1,185 @@
-// This is a shared configuration file for ESLint
+// This is a shared configuration file for ESLint:
 // https://eslint.org/docs/user-guide/configuring
 module.exports = {
   plugins: [
-    // Lint JSDoc style comments
-    // https://github.com/gajus/eslint-plugin-jsdoc
+    /** Lint JSDoc style comments: https://github.com/gajus/eslint-plugin-jsdoc */
     "jsdoc",
   ],
 
   rules: {
-    // jsdoc/check-access         - Not needed in TypeScript.
-    // jsdoc/check-alignment      - Overlaps with `isaacscript-limit-jsdoc-comments`.
-    // jsdoc/check-examples       - Not worth it since some ESLint rules may not apply to examples.
-    // jsdoc/check-indentation    - Overlaps with `isaacscript-limit-jsdoc-comments`.
-    // jsdoc/check-line-alignment - This is not a common formatting scheme in the wild. It's also
-    //                              not recommended by the plugin.
-
-    // Documentation:
-    // https://github.com/gajus/eslint-plugin-jsdoc#check-param-names
-    // Ensures that parameter names in JSDoc match those in the function declaration.
+    // - jsdoc/check-access - Not needed in TypeScript.
+    // - jsdoc/check-alignment - Overlaps with `isaacscript/limit-jsdoc-comments`.
+    // - jsdoc/check-examples - Not worth it since some ESLint rules may not apply to examples.
+    // - jsdoc/check-indentation - Overlaps with `isaacscript/limit-jsdoc-comments`.
+    // - jsdoc/check-line-alignment - This is not a common formatting scheme in the wild. It's also
+    //   not recommended by the plugin.
+
+    /**
+     * Documentation: https://github.com/gajus/eslint-plugin-jsdoc#check-param-names
+     *
+     * Ensures that parameter names in JSDoc match those in the function declaration.
+     */
     "jsdoc/check-param-names": "warn",
 
-    // jsdoc/check-property-names - Not needed in TypeScript.
-    // jsdoc/check-syntax         - Not needed in TypeScript.
+    // - jsdoc/check-property-names - Not needed in TypeScript.
+    // - jsdoc/check-syntax - Not needed in TypeScript.
 
-    // Documentation:
-    // https://github.com/gajus/eslint-plugin-jsdoc#check-tag-names
-    // Allow the use of TypeScriptToLua compiler annotations as documented here:
-    // https://typescripttolua.github.io/docs/advanced/compiler-annotations
+    /**
+     * Documentation: https://github.com/gajus/eslint-plugin-jsdoc#check-tag-names
+     *
+     * Reports invalid block tag names.
+     */
     "jsdoc/check-tag-names": [
       "warn",
       {
         definedTags: [
-          "category", // Used in TypeDoc
-          "hidden", // Used in TypeDoc
+          // Used by the TypeScript compiler:
+          // https://www.typescriptlang.org/tsconfig#stripInternal
           "internal", // Used by TypeScript
-          "noResolution", // Used in TypeScriptToLua as a compiler annotation
-          "noSelf", // Used in TypeScriptToLua as a compiler annotation
+
+          // Add tags used in TypeDoc:
+          // https://typedoc.org/guides/doccomments/
+          "category",
+          "hidden",
+
+          // Add tags used in TypeScriptToLua:
+          // https://typescripttolua.github.io/docs/advanced/compiler-annotations
+          "noResolution",
+          "noSelf",
         ],
       },
     ],
 
-    // jsdoc/check-types  - Not needed in TypeScript.
+    // - jsdoc/check-types - Not needed in TypeScript.
 
-    // Documentation:
-    // https://github.com/gajus/eslint-plugin-jsdoc#check-values
-    // Validates the content of some uncommon JSDoc tags
+    /**
+     * Documentation: https://github.com/gajus/eslint-plugin-jsdoc#check-values
+     *
+     * Validates the content of some uncommon JSDoc tags.
+     */
     "jsdoc/check-values": "warn",
 
-    // Documentation:
-    // https://github.com/gajus/eslint-plugin-jsdoc#check-values
-    // Validates the content of some uncommon JSDoc tags
+    /**
+     * Documentation: https://github.com/gajus/eslint-plugin-jsdoc#check-values
+     *
+     * Validates that specific tags are never empty.
+     */
     "jsdoc/empty-tags": "warn",
 
-    // Documentation:
-    // https://github.com/gajus/eslint-plugin-jsdoc#implements-on-classes
-    // Reports issues with incorrect usage of @implements
+    /**
+     * Documentation: https://github.com/gajus/eslint-plugin-jsdoc#implements-on-classes
+     *
+     * Reports issues with incorrect usage of `@implements`.
+     */
     "jsdoc/implements-on-classes": "warn",
 
-    // Documentation:
-    // https://github.com/gajus/eslint-plugin-jsdoc#match-description
-    // JSDoc comments should always be full sentences
-    "jsdoc/match-description": ["warn"],
+    // - jsdoc/match-description - Overlaps with `isaacscript/jsdoc-full-sentences`.
+    // - jsdoc/match-name - Only needed for projects with specific JSDoc requirements.
+    // - jsdoc/multiline-blocks - Overlaps with `isaacscript/limit-jsdoc-comments`.
+    // - jsdoc/newline-after-description - Overlaps with `isaacscript/limit-jsdoc-comments`.
+    // - jsdoc/no-bad-blocks - Provides little value, since it only detects JSDoc comments with tags
+    //   in them.
+    // - jsdoc/no-defaults - Provides little value, since the @default tag is rare.
+    // - jsdoc/no-missing-syntax - Not generally relevant.
+    // - jsdoc/no-multi-asterisks - Overlaps with `isaacscript/limit-jsdoc-comments`.
+    // - jsdoc/no-restricted-syntax - Not generally relevant.
+
+    /**
+     * Documentation: https://github.com/gajus/eslint-plugin-jsdoc#no-types
+     *
+     * Disallows types being used on `@param` or `@returns`.
+     */
+    "jsdoc/no-types": "warn",
+
+    // - jsdoc/no-undefined-types - Not needed in TypeScript.
+
+    /**
+     * Documentation: https://github.com/gajus/eslint-plugin-jsdoc#require-asterisk-prefix
+     *
+     * Requires that each JSDoc line starts with an `*`.
+     */
+    "jsdoc/require-asterisk-prefix": "warn",
+
+    // - jsdoc/require-description-complete-sentence - Overlaps with
+    //   `isaacscript/jsdoc-complete-sentences`.
+    // - jsdoc/require-description - It's overboard for every function to have a description.
+    // - jsdoc/require-example - It's overboard for every function to require an example.
+    // - jsdoc/require-file-overview - It's overboard for every file to require an overview.
+
+    /**
+     * Documentation:
+     * https://github.com/gajus/eslint-plugin-jsdoc#require-hyphen-before-param-description
+     *
+     * Disallow hyphens before parameter descriptions, as it is non-standard syntax.
+     */
+    "jsdoc/require-hyphen-before-param-description": ["warn", "never"],
+
+    // - jsdoc/require-jsdoc - It's overboard for every function to have a JSDoc comment.
+
+    /**
+     * Documentation:
+     * https://github.com/gajus/eslint-plugin-jsdoc#require-param-description
+     *
+     * Requires that each `@param` tag has a description.
+     */
+    "jsdoc/require-param-description": "warn",
+
+    /**
+     * Documentation:
+     * https://github.com/gajus/eslint-plugin-jsdoc#require-param-name
+     *
+     * Requires that each `@param` tag has a name.
+     */
+    "jsdoc/require-param-name": "warn",
+
+    // - jsdoc/require-param-type - Not needed in TypeScript.
+    // - jsdoc/require-param - It's overboard for every function to document every parameter.
+    // - jsdoc/require-property - Probably not needed in TypeScript.
+
+    /**
+     * Documentation:
+     * https://github.com/gajus/eslint-plugin-jsdoc#require-property-description
+     *
+     * Requires that each `@property` tag has a description.
+     */
+    "jsdoc/require-property-description": "warn",
+
+    /**
+     * Documentation:
+     * https://github.com/gajus/eslint-plugin-jsdoc#require-property-name
+     *
+     * Requires that each `@property` tag has a name.
+     */
+    "jsdoc/require-property-name": "warn",
+
+    // - jsdoc/require-property-type - Not needed in TypeScript.
+    // - jsdoc/require-returns-check - It's overboard for every function to document every return
+    // value.
+
+    /**
+     * Documentation:
+     * https://github.com/gajus/eslint-plugin-jsdoc#require-returns-description
+     *
+     * Requires that each `@returns` tag has a description.
+     */
+    "jsdoc/require-returns-description": "warn",
+
+    // - jsdoc/require-returns-type - Not needed in TypeScript.
+    // - jsdoc/require-returns - It's overboard for every function to document every return value.
+    // - jsdoc/require-throws - It's overboard to document every throw statement.
+    // - jsdoc/require-yields - It's overboard to document every yield.
+    // - 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/valid-types - Not needed in TypeScript.
   },
 };

package/lint.sh

@@ -2,7 +2,7 @@
 
 set -e # Exit on any errors
 
-# Get the directory of this script
+# Get the directory of this script:
 # https://stackoverflow.com/questions/59895/getting-the-source-directory-of-a-bash-script-from-within
 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
 

package/mod.js

@@ -1,52 +1,109 @@
-// This is a shared configuration file for ESLint
+// This is a shared configuration file for ESLint:
 // https://eslint.org/docs/user-guide/configuring
 module.exports = {
   extends: [
-    // The mod config extends the base configuration:
-    // https://github.com/IsaacScript/eslint-config-isaacscript/blob/main/base.js
+    /**
+     * The mod config extends the base configuration:
+     * https://github.com/IsaacScript/eslint-config-isaacscript/blob/main/base.js
+     */
     "./base",
   ],
 
-  // We modify the linting rules from the base for some specific things
-  // (listed in alphabetical order)
   rules: {
-    // Documentation:
-    // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/no-loop-func.md
-    // https://eslint.org/docs/rules/no-loop-func
-    // Defined at:
-    // https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
-    // This rule throws false positives with API functions
-    // It can be worked around by supplying lists of globals to ESLint, but this is ugly
-    // See: https://github.com/typescript-eslint/typescript-eslint/issues/2780
+    /**
+     * Documentation:
+     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/naming-convention.md
+     *
+     * 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.
+     *
+     * Additionally, ensure that all enums match the Isaac convention of using UPPER_CASE.
+     */
+    "@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"],
+      },
+      // The vanilla Isaac enums all use UPPER_CASE:
+      // https://wofsauge.github.io/IsaacDocs/rep/enums/CollectibleType.html
+      {
+        selector: "enumMember",
+        format: ["UPPER_CASE"],
+      },
+    ],
+
+    /**
+     * Documentation:
+     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/no-loop-func.md
+     *
+     * Defined at:
+     * https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
+     *
+     * This rule throws false positives with API functions. It can be worked around by supplying
+     * lists of globals to ESLint, but this is ugly. See:
+     * https://github.com/typescript-eslint/typescript-eslint/issues/2780
+     */
     "@typescript-eslint/no-loop-func": "off",
 
-    // Documentation:
-    // https://github.com/eslint/eslint/blob/master/docs/rules/no-bitwise.md
-    // Defined at:
-    // https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js
-    // Isaac enums use bitwise operators (e.g. "EntityFlag")
+    /**
+     * Documentation: https://github.com/eslint/eslint/blob/master/docs/rules/no-bitwise.md
+     *
+     * Defined at:
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js
+     *
+     * Isaac enums use bitwise operators (e.g. "EntityFlag").
+     */
     "no-bitwise": "off",
 
-    // Documentation:
-    // https://eslint.org/docs/rules/no-param-reassign
-    // Defined at:
-    // https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/best-practices.js
-    // The Isaac API callback functions expect you to modify the provided object
+    /**
+     * Documentation: https://eslint.org/docs/rules/no-param-reassign
+     *
+     * Defined at:
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/best-practices.js
+     *
+     * The Isaac API callback functions expect you to modify the provided object.
+     */
     "no-param-reassign": "off",
 
-    // Documentation:
-    // https://eslint.org/docs/rules/no-restricted-globals
-    // Defined at:
-    // https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/variables.js
-    // print is used with Lua mods
+    /**
+     * Documentation: https://eslint.org/docs/rules/no-restricted-globals
+     *
+     * Defined at:
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/variables.js
+     *
+     * "print" is used with Lua mods.
+     */
     "no-restricted-globals": "off",
 
-    // Documentation:
-    // https://eslint.org/docs/rules/no-underscore-dangle
-    // Defined at:
-    // https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js
-    // We keep the Airbnb specification but allow calling functions that overload Lua operators:
-    // https://moddingofisaac.com/docs/class_vector.html
+    /**
+     * Documentation: https://eslint.org/docs/rules/no-underscore-dangle
+     *
+     * Defined at:
+     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js
+     *
+     * We keep the Airbnb specification but allow calling functions that overload Lua operators:
+     * https://moddingofisaac.com/docs/class_vector.html
+     */
     "no-underscore-dangle": [
       "warn",
       {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-isaacscript",
-  "version": "1.0.68",
+  "version": "1.0.71",
   "description": "An ESLint config for IsaacScript projects.",
   "repository": {
     "type": "git",

package/publish.sh

@@ -2,7 +2,7 @@
 
 set -e # Exit on any errors
 
-# Get the directory of this script
+# Get the directory of this script:
 # https://stackoverflow.com/questions/59895/getting-the-source-directory-of-a-bash-script-from-within
 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
 

package/update.sh

@@ -2,7 +2,7 @@
 
 set -e # Exit on any errors
 
-# Get the directory of this script
+# Get the directory of this script:
 # https://stackoverflow.com/questions/59895/getting-the-source-directory-of-a-bash-script-from-within
 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"