chore: fully type check packages/*/src files (#117)

JoshuaKGoldberg · nzakas · web-flow · commit 88525272b717 · 2024-11-22T16:14:32.000+01:00
Co-authored-by: Nicholas C. Zakas &lt;nicholas@humanwhocodes.com&gt;
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,40 @@
+# Contributing
+
+Please be sure to read the contribution guidelines before making or requesting a change.
+
+## Code of Conduct
+
+This project adheres to the [OpenJS Foundation Code of Conduct](https://eslint.org/conduct). We kindly request that you read over our code of conduct before contributing.
+
+## Commands
+
+### Building
+
+[Rollup](https://rollupjs.org) and [TypeScript](https://www.typescriptlang.org) are used to turn source files in `packages/*/src/` into outputs in `packages/*/dist/`.
+
+```shell
+npm run build
+```
+
+### Linting
+
+ESLint is linted using ESLint.
+[Building](#building) the project must be done before it can lint itself.
+
+```shell
+npm run lint
+```
+
+### Type Checking
+
+This project is written in JavaScript and uses [TypeScript](https://www.typescriptlang.org) to validate types declared in JSDoc comments.
+
+```shell
+npm run test:types
+```
+
+Add `--watch` to run in a "watch" mode:
+
+```shell
+npm run test:types -- --watch
+```
diff --git a/package.json b/package.json
@@ -11,7 +11,8 @@
     "lint:fix": "eslint --fix .",
     "fmt": "prettier --write .",
     "fmt:check": "prettier --check .",
-    "test:jsr": "npm run test:jsr --workspaces --if-present"
+    "test:jsr": "npm run test:jsr --workspaces --if-present",
+    "test:types": "tsc"
   },
   "workspaces": [
     "packages/*"
@@ -27,6 +28,7 @@
     "!(*.{js,ts})": "prettier --write --ignore-unknown"
   },
   "devDependencies": {
+    "@types/mocha": "^10.0.7",
     "eslint": "^9.11.1",
     "eslint-config-eslint": "^11.0.0",
     "got": "^14.4.1",
diff --git a/packages/compat/tsconfig.json b/packages/compat/tsconfig.json
@@ -1,13 +1,7 @@
 {
+  "extends": "../../tsconfig.base.json",
   "files": ["src/index.js"],
   "compilerOptions": {
-    "declaration": true,
-    "emitDeclarationOnly": true,
-    "allowJs": true,
-    "checkJs": true,
-    "outDir": "dist/esm",
-    "target": "ES2022",
-    "moduleResolution": "NodeNext",
-    "module": "NodeNext"
+    "outDir": "dist/esm"
   }
 }
diff --git a/packages/config-array/tsconfig.json b/packages/config-array/tsconfig.json
@@ -1,13 +1,7 @@
 {
+  "extends": "../../tsconfig.base.json",
   "files": ["src/index.js"],
   "compilerOptions": {
-    "declaration": true,
-    "emitDeclarationOnly": true,
-    "allowJs": true,
-    "checkJs": true,
-    "outDir": "dist/esm",
-    "target": "ES2022",
-    "moduleResolution": "NodeNext",
-    "module": "NodeNext"
+    "outDir": "dist/esm"
   }
 }
diff --git a/packages/core/tsconfig.json b/packages/core/tsconfig.json
@@ -1,13 +1,7 @@
 {
+  "extends": "../../tsconfig.base.json",
   "files": ["src/types.ts"],
   "compilerOptions": {
-    "declaration": true,
-    "emitDeclarationOnly": true,
-    "allowJs": true,
-    "checkJs": true,
-    "outDir": "dist/esm",
-    "target": "ES2022",
-    "moduleResolution": "NodeNext",
-    "module": "NodeNext"
+    "outDir": "dist/esm"
   }
 }
diff --git a/packages/migrate-config/tsconfig.json b/packages/migrate-config/tsconfig.json
@@ -1,13 +1,7 @@
 {
+  "extends": "../../tsconfig.base.json",
   "files": ["src/migrate-config-cli.js"],
   "compilerOptions": {
-    "declaration": true,
-    "emitDeclarationOnly": true,
-    "allowJs": true,
-    "checkJs": true,
-    "outDir": "dist/esm",
-    "target": "ES2022",
-    "moduleResolution": "NodeNext",
-    "module": "NodeNext"
+    "outDir": "dist/esm"
   }
 }
diff --git a/packages/object-schema/tsconfig.json b/packages/object-schema/tsconfig.json
@@ -1,13 +1,7 @@
 {
+  "extends": "../../tsconfig.base.json",
   "files": ["src/index.js"],
   "compilerOptions": {
-    "declaration": true,
-    "emitDeclarationOnly": true,
-    "allowJs": true,
-    "checkJs": true,
-    "outDir": "dist/esm",
-    "target": "ES2022",
-    "moduleResolution": "NodeNext",
-    "module": "NodeNext"
+    "outDir": "dist/esm"
   }
 }
diff --git a/packages/plugin-kit/package.json b/packages/plugin-kit/package.json
@@ -47,6 +47,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@eslint/core": "^0.9.0",
+    "@types/levn": "^0.4.0",
     "c8": "^9.1.0",
     "mocha": "^10.4.0",
     "rollup": "^4.16.2",
diff --git a/packages/plugin-kit/src/@types/levn.d.ts b/packages/plugin-kit/src/@types/levn.d.ts
diff --git a/packages/plugin-kit/src/config-comment-parser.js b/packages/plugin-kit/src/config-comment-parser.js
@@ -9,7 +9,6 @@
 // Imports
 //------------------------------------------------------------------------------
 
-// @ts-ignore -- don't feel like fighting with TypeScript right now
 import levn from "levn";
 
 //-----------------------------------------------------------------------------
@@ -125,7 +124,8 @@ export class ConfigCommentParser {
 	parseJSONLikeConfig(string) {
 		// Parses a JSON-like comment by the same way as parsing CLI option.
 		try {
-			const items = levn.parse("Object", string) || {};
+			const items =
+				/** @type {RulesConfig} */ (levn.parse("Object", string)) || {};
 
 			/*
 			 * When the configuration has any invalid severities, it should be completely
diff --git a/packages/plugin-kit/tsconfig.json b/packages/plugin-kit/tsconfig.json
@@ -1,15 +1,8 @@
 {
+  "extends": "../../tsconfig.base.json",
   "files": ["src/index.js"],
   "compilerOptions": {
-    "declaration": true,
-    "emitDeclarationOnly": true,
-    "allowJs": true,
-    "checkJs": true,
     "outDir": "dist/esm",
-    "target": "ES2022",
-    "moduleResolution": "NodeNext",
-    "module": "NodeNext",
-    "strict": true,
-    "typeRoots": ["node_modules/@types", "src/@types"]
+    "strict": true
   }
 }
diff --git a/scripts/build.js b/scripts/build.js
@@ -73,8 +73,8 @@ async function calculatePackageDependencies(packageDirs) {
 }
 
 /**
- * Creates an array of directories to be built in order to sastify dependencies.
- * @param {Map<string,{name:string,dir:string,dependencies:Set<string>}} dependencies The
+ * Creates an array of directories to be built in order to satisfy dependencies.
+ * @param {Map<string,{name:string,dir:string,dependencies:Set<string>}>} dependencies The
  * dependencies between packages.
  * @returns {Array<string>} An array of directories to be built in order.
  */
diff --git a/tsconfig.base.json b/tsconfig.base.json
@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "target": "ES2022"
+  }
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.base.json",
+  "include": ["packages/*/src"],
+  "compilerOptions": {
+    "emitDeclarationOnly": false,
+    "noEmit": true
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,7 @@`
`1`	`1`	`{`
	`2`	`+ "extends": "../../tsconfig.base.json",`
`2`	`3`	`"files": ["src/index.js"],`
`3`	`4`	`"compilerOptions": {`
`4`		`- "declaration": true,`
`5`		`- "emitDeclarationOnly": true,`
`6`		`- "allowJs": true,`
`7`		`- "checkJs": true,`
`8`		`- "outDir": "dist/esm",`
`9`		`- "target": "ES2022",`
`10`		`- "moduleResolution": "NodeNext",`
`11`		`- "module": "NodeNext"`
	`5`	`+ "outDir": "dist/esm"`
`12`	`6`	`}`
`13`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,7 @@`
`1`	`1`	`{`
	`2`	`+ "extends": "../../tsconfig.base.json",`
`2`	`3`	`"files": ["src/types.ts"],`
`3`	`4`	`"compilerOptions": {`
`4`		`- "declaration": true,`
`5`		`- "emitDeclarationOnly": true,`
`6`		`- "allowJs": true,`
`7`		`- "checkJs": true,`
`8`		`- "outDir": "dist/esm",`
`9`		`- "target": "ES2022",`
`10`		`- "moduleResolution": "NodeNext",`
`11`		`- "module": "NodeNext"`
	`5`	`+ "outDir": "dist/esm"`
`12`	`6`	`}`
`13`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,7 @@`
`1`	`1`	`{`
	`2`	`+ "extends": "../../tsconfig.base.json",`
`2`	`3`	`"files": ["src/migrate-config-cli.js"],`
`3`	`4`	`"compilerOptions": {`
`4`		`- "declaration": true,`
`5`		`- "emitDeclarationOnly": true,`
`6`		`- "allowJs": true,`
`7`		`- "checkJs": true,`
`8`		`- "outDir": "dist/esm",`
`9`		`- "target": "ES2022",`
`10`		`- "moduleResolution": "NodeNext",`
`11`		`- "module": "NodeNext"`
	`5`	`+ "outDir": "dist/esm"`
`12`	`6`	`}`
`13`	`7`	`}`