eslint-config-isaacscript 1.0.66 → 1.0.69

package/README.md

@@ -1,7 +1,7 @@
-[![npm version](https://img.shields.io/npm/v/eslint-config-isaacscript.svg)](https://www.npmjs.com/package/eslint-config-isaacscript)
-
 # eslint-config-isaacscript
 
+[![npm version](https://img.shields.io/npm/v/eslint-config-isaacscript.svg)](https://www.npmjs.com/package/eslint-config-isaacscript)
+
 This is a helper configuration for ESLint that is intended to be used in IsaacScript projects.
 
 Please see the [IsaacScript webpage](https://isaacscript.github.io/) for more information.

package/base.js

@@ -22,9 +22,6 @@ module.exports = {
     "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-2/recommended",
-
     // This provides extra miscellaneous rules to keep code safe
     "plugin:isaacscript/recommended",
 
@@ -32,18 +29,8 @@ module.exports = {
     // https://github.com/mysticatea/eslint-plugin-eslint-comments
     "plugin:eslint-comments/recommended",
 
-    // Lint JSDoc style comments
-    // https://github.com/gajus/eslint-plugin-jsdoc
-    "plugin:jsdoc/recommended",
-
-    // This prevents implicit iteration of Maps and Sets,
-    // which is helpful to prevent bugs when refactoring
-    // https://github.com/Zamiell/eslint-plugin-no-implicit-map-set-loops
-    "plugin:no-implicit-map-set-loops/recommended",
-
-    // This prevents void return types on unexported functions
-    // https://github.com/Zamiell/eslint-plugin-no-void-return-type
-    "plugin:no-void-return-type/recommended",
+    // This provides rules to lint JSDoc comments
+    "./jsdoc",
 
     // Disable any ESLint rules that conflict with Prettier
     // (otherwise, we will have unfixable ESLint errors)
@@ -68,7 +55,7 @@ module.exports = {
     // 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>"
+    // Prefer the "string[]" syntax over "Array<string>"
     "@typescript-eslint/array-type": ["warn", { default: "array-simple" }],
 
     // Documentation:
@@ -133,13 +120,14 @@ module.exports = {
     // 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 function arguments that start with an underscore
+    // 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",
       {
         args: "all",
         argsIgnorePattern: "^_",
+        varsIgnorePattern: "^_",
       },
     ],
 
@@ -189,30 +177,6 @@ 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:
@@ -248,77 +212,6 @@ module.exports = {
     // https://basarat.gitbook.io/typescript/main-1/defaultisbad
     "import/prefer-default-export": "off",
 
-    // Documentation:
-    // https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-tag-names
-    // Defined at:
-    // https://github.com/gajus/eslint-plugin-jsdoc/blob/master/src/index.js
-    // Allow the use of TypeScriptToLua compiler annotations as documented here:
-    // https://typescripttolua.github.io/docs/advanced/compiler-annotations
-    "jsdoc/check-tag-names": [
-      "warn",
-      {
-        definedTags: [
-          "category", // Used in TypeDoc
-          "hidden", // Used in TypeDoc
-          "internal", // Used by TypeScript
-          "noResolution", // Used in TypeScriptToLua as a compiler annotation
-          "noSelf", // Used in TypeScriptToLua as a compiler annotation
-        ],
-      },
-    ],
-
-    // Documentation:
-    // https://github.com/gajus/eslint-plugin-jsdoc#user-content-eslint-plugin-jsdoc-rules-match-description
-    // Not defined in parent configs
-    // Needed for catching superfluous leading and trailing newlines as documented here:
-    // https://github.com/gajus/eslint-plugin-jsdoc/issues/847
-    "jsdoc/match-description": [
-      "warn",
-      {
-        matchDescription: "^\\S[\\s\\S]*\\S$",
-        contexts: [
-          {
-            comment: "JsdocBlock[endLine!=0]:not(:has(JsdocTag))",
-          },
-        ],
-      },
-    ],
-
-    // Documentation:
-    // https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-jsdoc
-    // Defined at:
-    // https://github.com/gajus/eslint-plugin-jsdoc/blob/master/src/index.js
-    // Do not require JSDoc comments for every function, as that is excessive
-    "jsdoc/require-jsdoc": "off",
-
-    // Documentation:
-    // https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param
-    // Defined at:
-    // https://github.com/gajus/eslint-plugin-jsdoc/blob/master/src/index.js
-    // Do not require parameters for every function, as that is excessive when using TypeScript
-    "jsdoc/require-param": "off",
-
-    // Documentation:
-    // https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param-type
-    // Defined at:
-    // https://github.com/gajus/eslint-plugin-jsdoc/blob/master/src/index.js
-    // Since we are using TypeScript, requiring parameter types would be superfluous
-    "jsdoc/require-param-type": "off",
-
-    // Documentation:
-    // https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns
-    // Defined at:
-    // https://github.com/gajus/eslint-plugin-jsdoc/blob/master/src/index.js
-    // Do not require return listing for every function, as that is excessive when using TypeScript
-    "jsdoc/require-returns": "off",
-
-    // Documentation:
-    // https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns-type
-    // Defined at:
-    // https://github.com/gajus/eslint-plugin-jsdoc/blob/master/src/index.js
-    // Since we are using TypeScript, requiring parameter types would be superfluous
-    "jsdoc/require-returns-type": "off",
-
     // Documentation:
     // https://eslint.org/docs/rules/no-console
     // Defined at:

package/jsdoc.js

@@ -0,0 +1,65 @@
+// 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
+    "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-param-names": "warn",
+
+    // 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
+    "jsdoc/check-tag-names": [
+      "warn",
+      {
+        definedTags: [
+          "category", // Used in TypeDoc
+          "hidden", // Used in TypeDoc
+          "internal", // Used by TypeScript
+          "noResolution", // Used in TypeScriptToLua as a compiler annotation
+          "noSelf", // Used in TypeScriptToLua as a compiler annotation
+        ],
+      },
+    ],
+
+    // 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
+    "jsdoc/check-values": "warn",
+
+    // Documentation:
+    // https://github.com/gajus/eslint-plugin-jsdoc#check-values
+    // Validates the content of some uncommon JSDoc tags
+    "jsdoc/empty-tags": "warn",
+
+    // 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"],
+  },
+};

package/package.json

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