chore: fully type check packages/*/src files

.github/workflows/ci.yml

@@ -27,6 +27,9 @@ jobs:
             - name: Lint Files
               run: npm run lint
 
+            - name: Type Check Files
+              run: npm run tsc
+
             - name: Check Formatting
               run: npm run fmt:check
 

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/*/lib/`.
+
+```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 tsc
+```
+
+Add `--watch` to run in a "watch" mode:
+
+```shell
+npm run tsc -- --watch
+```

package.json

@@ -8,6 +8,7 @@
     "build": "node scripts/build.js",
     "build:readme": "node tools/update-readme.js",
     "lint": "eslint .",
+    "tsc": "tsc",
     "lint:fix": "eslint --fix .",
     "fmt": "prettier --write .",
     "fmt:check": "prettier --check .",
@@ -27,6 +28,7 @@
     "!(*.{js,ts})": "prettier --write --ignore-unknown"
   },
   "devDependencies": {
+    "@types/mocha": "^10.0.7",
     "common-tags": "^1.8.2",
     "eslint": "^9.4.0",
     "eslint-config-eslint": "^11.0.0",

packages/compat/src/fixup-rules.js

@@ -161,6 +161,7 @@ export function fixupRule(ruleDefinition) {
 					currentNode =
 						args[methodName === "onCodePathSegmentLoop" ? 2 : 1];
 
+					// @ts-expect-error -- method.call is any from Object.entries, but we know its type is fine
 					return method.call(visitor, ...args);
 				};
 
@@ -171,6 +172,7 @@ export function fixupRule(ruleDefinition) {
 			visitor[methodName] = (...args) => {
 				currentNode = args[0];
 
+				// @ts-expect-error -- method.call is any from Object.entries, but we know its type is fine
 				return method.call(visitor, ...args);
 			};
 		}

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"
   }
 }

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"
   }
 }

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"
   }
 }

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"
   }
 }

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"
   }
 }

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";
 
 //-----------------------------------------------------------------------------

packages/plugin-kit/src/source-code.js

@@ -174,7 +174,7 @@ export class Directive {
 
 	/**
 	 * The node representing the directive.
-	 * @type {unknown}
+	 * @type {object}
 	 * @readonly
 	 */
 	node;
@@ -198,7 +198,7 @@ export class Directive {
 	 * Creates a new instance.
 	 * @param {Object} options The options for the directive.
 	 * @param {"disable"|"enable"|"disable-next-line"|"disable-line"} options.type The type of directive.
-	 * @param {unknown} options.node The node representing the directive.
+	 * @param {object} options.node The node representing the directive.
 	 * @param {string} options.value The value of the directive.
 	 * @param {string} options.justification The justification for the directive.
 	 */

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
   }
 }

scripts/build.js

@@ -67,8 +67,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.
  */

tsconfig.base.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "strict": true,
+    "target": "ES2022",
+
+    // TODO: Over time, enable these strict options
+    "noImplicitAny": false,
+    "strictNullChecks": false,
+    "useUnknownInCatchVariables": false
+  }
+}

tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.base.json",
+  "include": ["packages/*/src"],
+  "compilerOptions": {
+    "emitDeclarationOnly": false,
+    "noEmit": true
+  }
+}

types/levn.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @todo This should be contributed up to DefinitelyTyped to make a `@types/levn` package.
+ */
+declare module "levn" {
+	export interface ParseOptions {
+		explicit?: boolean | undefined;
+		customTypes?: Record<string, CustomParseType>;
+	}
+
+	export interface CustomParseType<Value = unknown> {
+		typeOf: string;
+		validate: (value: unknown) => boolean;
+		cast: (value: unknown) => CastedValue<Value>;
+	}
+
+	export interface CastedValue<Value = unknown> {
+		type: string;
+		value: Value;
+	}
+
+	// TODO: This comes from type-check.
+	export type ParsedType = unknown;
+
+	export function parse(
+		type: string,
+		string: string,
+		options?: unknown,
+	): unknown;
+
+	export function parsedTypeParse(
+		parsedType: string,
+		options?: unknown,
+	): unknown;
+
+	export const VERSION: string;
+}