feat: ✨ add eslint-comments rules

package.json

@@ -47,6 +47,7 @@
   },
   "prettier": "@jimmy.codes/prettier-config",
   "dependencies": {
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.4.1",
     "@eslint/js": "^9.14.0",
     "@tanstack/eslint-plugin-query": "^5.59.7",
     "@types/eslint": "9.6.1",

src/configs/eslint-comments.ts

@@ -0,0 +1,15 @@
+import comments from "@eslint-community/eslint-plugin-eslint-comments/configs";
+
+import { eslintCommentsRules } from "../rules/eslint-comments";
+
+const eslintCommentsConfig = () => {
+  return [
+    {
+      ...comments.recommended,
+      name: "jimmy.codes/eslint-comments",
+      rules: eslintCommentsRules,
+    },
+  ];
+};
+
+export default eslintCommentsConfig;

src/factory.spec.ts

@@ -6,7 +6,7 @@ vi.mock("local-pkg");
 
 describe("jimmyDotCodes", () => {
   describe("base", () => {
-    it.each(["node", "imports", "perfectionist", "unicorn"])(
+    it.each(["node", "imports", "perfectionist", "unicorn", "eslint-comments"])(
       "should create configuration w/ %s",
       (input) => {
         expect(jimmyDotCodes({ autoDetect: false })).toStrictEqual(
@@ -17,6 +17,7 @@ describe("jimmyDotCodes", () => {
       },
     );
   });
+
   it("should create configuration w/ typescript", () => {
     expect(
       jimmyDotCodes({ autoDetect: false, typescript: true }),
@@ -179,7 +180,7 @@ describe("jimmyDotCodes", () => {
 
     it("should include react-query when auto detection is enabled", () => {
       vi.mocked(isPackageExists).mockImplementation((name) => {
-        // eslint-disable-next-line jest/no-conditional-in-test
+        // eslint-disable-next-line jest/no-conditional-in-test -- this condition is only for the mock.
         return name === "react" || name === "@tanstack/react-query";
       });
 
@@ -240,7 +241,7 @@ describe("jimmyDotCodes", () => {
 
     it("should include test-library when auto detection is enabled", () => {
       vi.mocked(isPackageExists).mockImplementation((name) => {
-        // eslint-disable-next-line jest/no-conditional-in-test
+        // eslint-disable-next-line jest/no-conditional-in-test -- this condition is only for the mock.
         return name === "@testing-library/react" || name === "vitest";
       });
 

src/factory.ts

@@ -6,6 +6,7 @@ import type { Options, TypedConfigItem } from "./types";
 
 import { astroConfig } from "./configs/astro";
 import { commonjsConfig } from "./configs/commonjs";
+import eslintCommentsConfig from "./configs/eslint-comments";
 import importsConfig from "./configs/imports";
 import nodeConfig from "./configs/node";
 import perfectionistConfig from "./configs/perfectionist";
@@ -44,6 +45,7 @@ export const jimmyDotCodes = (
     ...perfectionistConfig(),
     ...nodeConfig(),
     ...unicornConfig(),
+    ...eslintCommentsConfig(),
     ...importsConfig({ typescript: isTypescriptEnabled }),
     ...(isTypescriptEnabled
       ? typescriptConfig(getTypescriptOptions(typescript))

src/rules.gen.d.ts

@@ -3,6 +3,57 @@
 import type { Linter } from 'eslint'
 
 export interface RuleOptions {
+  /**
+   * require a `eslint-enable` comment for every `eslint-disable` comment
+   * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/disable-enable-pair.html
+   */
+  "@eslint-community/eslint-comments/disable-enable-pair"?: Linter.RuleEntry<EslintCommunityEslintCommentsDisableEnablePair>;
+  /**
+   * disallow a `eslint-enable` comment for multiple `eslint-disable` comments
+   * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-aggregating-enable.html
+   */
+  "@eslint-community/eslint-comments/no-aggregating-enable"?: Linter.RuleEntry<
+    []
+  >;
+  /**
+   * disallow duplicate `eslint-disable` comments
+   * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-duplicate-disable.html
+   */
+  "@eslint-community/eslint-comments/no-duplicate-disable"?: Linter.RuleEntry<
+    []
+  >;
+  /**
+   * disallow `eslint-disable` comments about specific rules
+   * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-restricted-disable.html
+   */
+  "@eslint-community/eslint-comments/no-restricted-disable"?: Linter.RuleEntry<EslintCommunityEslintCommentsNoRestrictedDisable>;
+  /**
+   * disallow `eslint-disable` comments without rule names
+   * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-unlimited-disable.html
+   */
+  "@eslint-community/eslint-comments/no-unlimited-disable"?: Linter.RuleEntry<
+    []
+  >;
+  /**
+   * disallow unused `eslint-disable` comments
+   * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-unused-disable.html
+   */
+  "@eslint-community/eslint-comments/no-unused-disable"?: Linter.RuleEntry<[]>;
+  /**
+   * disallow unused `eslint-enable` comments
+   * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-unused-enable.html
+   */
+  "@eslint-community/eslint-comments/no-unused-enable"?: Linter.RuleEntry<[]>;
+  /**
+   * disallow ESLint directive-comments
+   * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/no-use.html
+   */
+  "@eslint-community/eslint-comments/no-use"?: Linter.RuleEntry<EslintCommunityEslintCommentsNoUse>;
+  /**
+   * require include descriptions in ESLint directive-comments
+   * @see https://eslint-community.github.io/eslint-plugin-eslint-comments/rules/require-description.html
+   */
+  "@eslint-community/eslint-comments/require-description"?: Linter.RuleEntry<EslintCommunityEslintCommentsRequireDescription>;
   /**
    * Exhaustive deps rule for useQuery
    * @see https://tanstack.com/query/latest/docs/eslint/exhaustive-deps
@@ -4952,6 +5003,52 @@ export interface RuleOptions {
 }
 
 /* ======= Declarations ======= */
+// ----- @eslint-community/eslint-comments/disable-enable-pair -----
+type EslintCommunityEslintCommentsDisableEnablePair =
+  | []
+  | [
+      {
+        allowWholeFile?: boolean;
+      },
+    ];
+// ----- @eslint-community/eslint-comments/no-restricted-disable -----
+type EslintCommunityEslintCommentsNoRestrictedDisable = string[];
+// ----- @eslint-community/eslint-comments/no-use -----
+type EslintCommunityEslintCommentsNoUse =
+  | []
+  | [
+      {
+        allow?: (
+          | "eslint"
+          | "eslint-disable"
+          | "eslint-disable-line"
+          | "eslint-disable-next-line"
+          | "eslint-enable"
+          | "eslint-env"
+          | "exported"
+          | "global"
+          | "globals"
+        )[];
+      },
+    ];
+// ----- @eslint-community/eslint-comments/require-description -----
+type EslintCommunityEslintCommentsRequireDescription =
+  | []
+  | [
+      {
+        ignore?: (
+          | "eslint"
+          | "eslint-disable"
+          | "eslint-disable-line"
+          | "eslint-disable-next-line"
+          | "eslint-enable"
+          | "eslint-env"
+          | "exported"
+          | "global"
+          | "globals"
+        )[];
+      },
+    ];
 // ----- @typescript-eslint/array-type -----
 type TypescriptEslintArrayType =
   | []

src/rules/__snapshots__/eslint-comments.spec.ts.snap

@@ -0,0 +1,12 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`should create eslintComments rules 1`] = `
+{
+  "@eslint-community/eslint-comments/disable-enable-pair": "error",
+  "@eslint-community/eslint-comments/no-aggregating-enable": "error",
+  "@eslint-community/eslint-comments/no-duplicate-disable": "error",
+  "@eslint-community/eslint-comments/no-unlimited-disable": "error",
+  "@eslint-community/eslint-comments/no-unused-enable": "error",
+  "@eslint-community/eslint-comments/require-description": "error",
+}
+`;

src/rules/eslint-comments.spec.ts

@@ -0,0 +1,5 @@
+import { eslintCommentsRules } from "./eslint-comments";
+
+test("should create eslintComments rules", () => {
+  expect(eslintCommentsRules).toMatchSnapshot();
+});

src/rules/eslint-comments.ts

@@ -0,0 +1,8 @@
+import comments from "@eslint-community/eslint-plugin-eslint-comments/configs";
+
+import type { Rules } from "../types";
+
+export const eslintCommentsRules = {
+  ...comments.recommended.rules,
+  "@eslint-community/eslint-comments/require-description": "error",
+} satisfies Rules;