Add basic type tests

.github/workflows/ci.yml

@@ -112,8 +112,11 @@ jobs:
       - name: 📥 Install dependencies
         run: npm install --legacy-peer-deps
 
+      - name: ▶️ Run check-exports script
+        run: npm run check-exports -- --format=table
+
       - name: ▶️ Run test:types script
-        run: npm run test:types -- --format=table
+        run: npm run test:types
 
   release:
     name: 🚀 Release

package.json

@@ -48,6 +48,7 @@
     "cross-spawn": "^7.0.3",
     "esbuild": "^0.19.3",
     "eslint": "^8.46.0",
+    "expect-type": "^1.1.0",
     "fs-extra": "^10.1.0",
     "mocha": "^10.4.0",
     "monaco-editor": "^0.47.0",
@@ -68,7 +69,8 @@
     "docs:watch": "vitepress dev docs",
     "lint": "eslint lib scripts tests",
     "test": "nyc mocha \"tests/lib/**/*.js\" --reporter dot --timeout 8000",
-    "test:types": "attw --pack",
+    "test:types": "tsc -p tsconfig.json",
+    "check-exports": "attw --pack",
     "coverage": "nyc report --reporter lcov && opener coverage/lcov-report/index.html",
     "watch": "npm run -s test -- --watch --growl"
   },

tests/types/configs.test-d.cts

@@ -0,0 +1,18 @@
+import configs = require("@eslint-community/eslint-plugin-eslint-comments/configs")
+import expectTypeModule = require("expect-type")
+
+import type { Linter } from "eslint"
+
+import expectTypeOf = expectTypeModule.expectTypeOf
+
+expectTypeOf(configs)
+  .toHaveProperty("recommended")
+  .toMatchTypeOf<Linter.FlatConfig>()
+
+expectTypeOf([configs.recommended]).toMatchTypeOf<Linter.FlatConfig[]>()
+
+expectTypeOf(configs.recommended).toMatchTypeOf<Linter.FlatConfig>()
+
+expectTypeOf(configs)
+  .toHaveProperty("recommended")
+  .toMatchTypeOf<Linter.FlatConfig>()

tests/types/configs.test-d.mts

@@ -0,0 +1,15 @@
+import configs from "@eslint-community/eslint-plugin-eslint-comments/configs"
+import type { Linter } from "eslint"
+import { expectTypeOf } from "expect-type"
+
+expectTypeOf(configs)
+  .toHaveProperty("recommended")
+  .toMatchTypeOf<Linter.FlatConfig>()
+
+expectTypeOf([configs.recommended]).toMatchTypeOf<Linter.FlatConfig[]>()
+
+expectTypeOf(configs.recommended).toMatchTypeOf<Linter.FlatConfig>()
+
+expectTypeOf(configs)
+  .toHaveProperty("recommended")
+  .toMatchTypeOf<Linter.FlatConfig>()

tsconfig.json

@@ -2,15 +2,14 @@
   "compilerOptions": {
     "allowSyntheticDefaultImports": false,
     "esModuleInterop": false,
-    "exactOptionalPropertyTypes": true,
     "forceConsistentCasingInFileNames": true,
     "isolatedModules": true,
     "lib": ["ESNext"],
     "module": "NodeNext",
     "moduleResolution": "NodeNext",
     "noEmit": true,
     "resolveJsonModule": true,
-    "skipLibCheck": false,
+    "skipLibCheck": true,
     "strict": true,
     "target": "ESNext",
     "useDefineForClassFields": true,