chore: add type definitions for the eslint-config-eslint package (#…

…19050)

feat: Add type definitions for `eslint-config-eslint`

Resolves #19043

.github/workflows/ci.yml

@@ -114,17 +114,36 @@ jobs:
             wdio-logs/*.log
 
   test_types:
-    name: Types Test
+    name: Test Types of ${{ matrix.package.name }}
     runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        package:
+          [
+            { name: eslint, directory: . },
+            {
+              name: eslint-config-eslint,
+              directory: packages/eslint-config-eslint,
+            },
+            {
+              name: '@eslint/js',
+              directory: packages/js,
+            },
+          ]
+
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: "lts/*"
       - name: Install Packages
         run: npm install
-      - name: Test eslint types
-        run: npm run test:types
-      - name: Test @eslint/js types
+
+      - name: Install Packages for ${{ matrix.package.name }}
+        working-directory: ${{ matrix.package.directory }}
+        run: npm install
+
+      - name: Test types for ${{ matrix.package.name }}
+        working-directory: ${{ matrix.package.directory }}
         run: npm run test:types
-        working-directory: packages/js

.github/workflows/types-integration.yml

@@ -150,20 +150,30 @@ jobs:
   are-the-types-wrong:
     name: Are the types wrong?
     runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        package:
+          [
+            { name: eslint, directory: . },
+            {
+              name: eslint-config-eslint,
+              directory: packages/eslint-config-eslint,
+            },
+          ]
+
     steps:
-      - name: Checkout eslint
+      - name: Checkout ${{ matrix.package.name }}
         uses: actions/checkout@v4
-        with:
-          path: eslint
 
       - uses: actions/setup-node@v4
         with:
           node-version: "lts/*"
 
       - name: Install Packages
-        working-directory: eslint
+        working-directory: ${{ matrix.package.directory }}
         run: npm install
 
       - name: Check validity of type definitions
-        working-directory: eslint
+        working-directory: ${{ matrix.package.directory }}
         run: npm run lint:types

eslint.config.js

@@ -70,6 +70,9 @@ function createInternalFilesPatterns(pattern = null) {
         }));
 }
 
+/**
+ * @type {import("./lib/types/index.js").Linter.Config[]}
+ */
 module.exports = [
     ...eslintConfigESLintCJS.map(config => ({
         ...config,
@@ -296,7 +299,7 @@ module.exports = [
         languageOptions: {
             parser: tsParser,
             parserOptions: {
-                project: ["tests/lib/types/tsconfig.json", "packages/js/tests/types/tsconfig.json"]
+                project: ["tests/lib/types/tsconfig.json", "packages/js/tests/types/tsconfig.json", "packages/eslint-config-eslint/tsconfig.json"]
             }
         },
         plugins: {

knip.jsonc

@@ -35,7 +35,8 @@
         },
         // Workspaces with default configs:
         "packages/*": {
-            "ignore": ["tests/types/**"]
+            "ignore": ["tests/types/**"],
+            "ignoreDependencies": ["eslint"]
         },
         "tools/internal-rules": {}
     }

packages/eslint-config-eslint/base.js

@@ -6,6 +6,9 @@ const eslintCommentsPluginConfigs = require("@eslint-community/eslint-plugin-esl
 const unicorn = require("eslint-plugin-unicorn");
 
 // extends eslint recommended config
+/**
+ * @type {import("eslint").Linter.Config[]}
+ */
 const jsConfigs = [js.configs.recommended, {
     name: "eslint-config-eslint/js",
     rules: {
@@ -142,6 +145,9 @@ const jsConfigs = [js.configs.recommended, {
 }];
 
 // extends eslint-plugin-jsdoc's recommended config
+/**
+ * @type {import("eslint").Linter.Config[]}
+ */
 const jsdocConfigs = [jsdoc.configs["flat/recommended"], {
     name: "eslint-config-eslint/jsdoc",
     settings: {
@@ -234,6 +240,9 @@ const jsdocConfigs = [jsdoc.configs["flat/recommended"], {
 }];
 
 // extends eslint-plugin-unicorn's config
+/**
+ * @type {import("eslint").Linter.Config[]}
+ */
 const unicornConfigs = [{
     name: "eslint-config-eslint/unicorn",
     plugins: { unicorn },
@@ -253,6 +262,9 @@ const unicornConfigs = [{
 }];
 
 // extends @eslint-community/eslint-plugin-eslint-comments's recommended config
+/**
+ * @type {import("eslint").Linter.Config[]}
+ */
 const eslintCommentsConfigs = [eslintCommentsPluginConfigs.recommended, {
     name: "eslint-config-eslint/eslint-comments",
     rules: {
@@ -262,6 +274,9 @@ const eslintCommentsConfigs = [eslintCommentsPluginConfigs.recommended, {
     }
 }];
 
+/**
+ * @type {import("eslint").Linter.Config[]}
+ */
 module.exports = [
     { name: "eslint-config-eslint/base", linterOptions: { reportUnusedDisableDirectives: "error" } },
     ...jsConfigs,

packages/eslint-config-eslint/cjs.js

@@ -3,6 +3,9 @@
 const baseConfigs = require("./base");
 const { cjsConfigs } = require("./nodejs");
 
+/**
+ * @type {import("eslint").Linter.Config[]}
+ */
 module.exports = [
     ...baseConfigs,
     ...cjsConfigs