eslint-config-isaacscript 1.0.62 → 1.0.63

package/base.js

@@ -16,12 +16,15 @@ module.exports = {
     // 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/master/packages/eslint-plugin/src/configs/README.md#recommended
-    // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/src/configs/recommended.ts
-    // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/src/configs/recommended-requiring-type-checking.ts
+    // 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 rules for max comment length that the "--fix" flag can fix
+    "plugin:comment-length/recommended",
+
     // This provides a version of the "eqeqeq" rule that the "--fix" flag can fix
     // https://github.com/Zamiell/eslint-plugin-eqeqeq-fix
     "plugin:eqeqeq-fix/recommended",
@@ -76,7 +79,7 @@ module.exports = {
   // (listed in alphabetical order)
   rules: {
     // Documentation:
-    // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/array-type.md
+    // 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" }],
@@ -90,7 +93,7 @@ module.exports = {
 
     // Documentation:
     // https://eslint.org/docs/rules/lines-between-class-members
-    // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/lines-between-class-members.md
+    // 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
@@ -102,7 +105,7 @@ module.exports = {
     ],
 
     // Documentation:
-    // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/naming-convention.md
+    // 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,
@@ -133,13 +136,13 @@ module.exports = {
     ],
 
     // Documentation:
-    // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-unnecessary-boolean-literal-compare.md
+    // 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/master/packages/eslint-plugin/docs/rules/no-unused-vars.md
+    // 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")
@@ -154,7 +157,7 @@ module.exports = {
     ],
 
     // Documentation:
-    // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-use-before-define.md
+    // 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
@@ -162,7 +165,7 @@ module.exports = {
     "@typescript-eslint/no-use-before-define": "off",
 
     // Documentation:
-    // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/quotes.md
+    // 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"
@@ -175,15 +178,15 @@ module.exports = {
     ],
 
     // Documentation:
-    // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/restrict-template-expressions.md
+    // 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/master/packages/eslint-plugin/src/configs/recommended-requiring-type-checking.ts
+    // 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/master/packages/eslint-plugin/docs/rules/restrict-template-expressions.md
+    // 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": [
@@ -199,6 +202,30 @@ 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/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/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:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-isaacscript",
-  "version": "1.0.62",
+  "version": "1.0.63",
   "description": "An ESLint config for IsaacScript projects.",
   "repository": {
     "type": "git",
@@ -9,6 +9,6 @@
   "license": "GPL-3.0",
   "author": "Zamiell",
   "devDependencies": {
-    "prettier": "^2.6.1"
+    "prettier": "^2.6.2"
   }
 }