convert tests to typescript

Author: bakkot

.eslintrc.json

@@ -12,14 +12,41 @@
     "node": true,
     "es6": true
   },
-  "parser": "@typescript-eslint/parser",
   "parserOptions": {
-    "sourceType": "script",
+    "sourceType": "module",
     "ecmaVersion": 2020
   },
   "overrides": [
+    {
+      "files": ["*.ts"],
+      "parser": "@typescript-eslint/parser",
+      "extends": [
+        "plugin:@typescript-eslint/eslint-recommended"
+      ],
+      "parserOptions": {
+        "//": "NB project is relative to the directory you run eslint from, see https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/parser#parseroptionsproject",
+        "project": "./tsconfig.json"
+      },
+      "rules": {
+        "@typescript-eslint/consistent-type-imports": "error",
+        "@typescript-eslint/no-use-before-define": [
+          "error",
+          {
+            "functions": false,
+            "typedefs": false
+          }
+        ],
+        "@typescript-eslint/no-unnecessary-type-assertion": "error",
+        "@typescript-eslint/no-unused-vars": "error",
+        "@typescript-eslint/no-explicit-any": "error",
+        "no-unused-vars": "off"
+      }
+    },
     {
       "files": ["js/**/*"],
+      "parserOptions": {
+        "sourceType": "script"
+      },
       "env": {
         "node": false,
         "browser": true,
@@ -45,13 +72,12 @@
     },
     {
       "files": ["test/**/*"],
-      "env": {
-        "mocha": true
+      "parserOptions": {
+        "project": "./test/tsconfig.json"
       }
     }
   ],
   "rules": {
-    "@typescript-eslint/consistent-type-imports": "error",
     "prettier/prettier": "error",
     "arrow-body-style": "error",
     "prefer-arrow-callback": "error",

.github/workflows/check.yml

@@ -25,6 +25,9 @@ jobs:
       - name: Build
         run: npm run build
 
+      - name: Typecheck
+        run: npm run typecheck
+
       - name: Test
         run: npm test
 

package-lock.json

@@ -18,6 +18,7 @@
 		"test-published-files": "npm pack && tar zxvf \"ecmarkup-$npm_package_version.tgz\" && cp -r test package/test && cd package && npm test && cd ..",
 		"posttest-published-files": "rm -rf \"ecmarkup-$npm_package_version.tgz\" package",
 		"lint": "eslint --ext .js,.ts js src test",
+		"typecheck": "tsc --noEmit && tsc -p test",
 		"format": "prettier --write ."
 	},
 	"bin": {
@@ -70,7 +71,7 @@
 		"@types/command-line-usage": "^5.0.2",
 		"@types/js-yaml": "^3.12.1",
 		"@types/jsdom": "^16.2.13",
-		"@types/node": "^13.1.8",
+		"@types/node": "^24.10.13",
 		"@types/parse5": "^6.0.2",
 		"@typescript-eslint/eslint-plugin": "^8.6.0",
 		"@typescript-eslint/parser": "^8.6.0",

package.json

@@ -414,7 +414,7 @@ export type BiblioEntry =
   | StepBiblioEntry;
 
 // see https://www.typescriptlang.org/docs/handbook/2/conditional-types.html#distributive-conditional-types
-type Unkey<T, S extends string> = T extends any ? Omit<T, S> : never;
+type Unkey<T, S extends string> = T extends unknown ? Omit<T, S> : never;
 
 type NonExportedKeys = 'location' | 'referencingIds' | 'namespace';
 export type PartialBiblioEntry = Unkey<BiblioEntry, NonExportedKeys>;

src/.eslintrc.json

@@ -51,8 +51,8 @@ export default class Eqn extends Builder {
     let contents;
     try {
       contents = emd.fragment(node.innerHTML);
-    } catch (e: any) {
-      utils.warnEmdFailure(spec.warn, node, e);
+    } catch (e) {
+      utils.warnEmdFailure(spec.warn, node, e as SyntaxError & { line?: number; column?: number });
       node.innerHTML = utils.wrapEmdFailure(node.innerHTML);
       return;
     }

src/Biblio.ts

@@ -1276,10 +1276,10 @@ ${await utils.readFile(path.join(__dirname, '../js/multipage.js'))}
     const solarizedStyle = this.doc.createElement('style');
     solarizedStyle.textContent = `
       @import url("https://cdnjs.cloudflare.com/ajax/libs/highlight.js/${
-        (hljs as any).versionString
+        (hljs as unknown as { versionString: string }).versionString
       }/styles/base16/solarized-light.min.css");
       @import url("https://cdnjs.cloudflare.com/ajax/libs/highlight.js/${
-        (hljs as any).versionString
+        (hljs as unknown as { versionString: string }).versionString
       }/styles/a11y-dark.min.css") (prefers-color-scheme: dark);
     `;
     this.doc.head.appendChild(solarizedStyle);
@@ -1340,18 +1340,20 @@ ${this.opts.multipage ? `<li><span>Navigate to/from multipage</span><code>m</cod
       return;
     }
 
-    let data: any;
+    let data: unknown;
     try {
       data = yaml.safeLoad(block.textContent!);
-    } catch (e: any) {
-      if (typeof e?.mark.line === 'number' && typeof e?.mark.column === 'number') {
+    } catch (e) {
+      const yamlError = e as { mark?: { line?: number; column?: number }; reason?: string };
+      const mark = yamlError?.mark;
+      if (typeof mark?.line === 'number' && typeof mark?.column === 'number') {
         this.warn({
           type: 'contents',
           ruleId: 'invalid-metadata',
-          message: `metadata block failed to parse: ${e.reason}`,
+          message: `metadata block failed to parse: ${yamlError.reason}`,
           node: block,
-          nodeRelativeLine: e.mark.line + 1,
-          nodeRelativeColumn: e.mark.column + 1,
+          nodeRelativeLine: mark.line + 1,
+          nodeRelativeColumn: mark.column + 1,
         });
       } else {
         this.warn({

src/Eqn.ts

@@ -30,9 +30,9 @@ export function parse<T extends readonly OptionDefinition[]>(
   try {
     // @ts-ignore the types are wrong about mutability
     args = commandLineArgs(options, { argv });
-  } catch (e: any) {
-    if (e?.name === 'UNKNOWN_OPTION') {
-      fail(`Unknown option ${e.optionName}`);
+  } catch (e) {
+    if (e != null && typeof e === 'object' && 'name' in e && e.name === 'UNKNOWN_OPTION') {
+      fail(`Unknown option ${(e as unknown as { optionName: string }).optionName}`);
     }
     throw e;
   }

src/Spec.ts

@@ -186,7 +186,7 @@ const build = debounce(async function build() {
       utils.logVerbose(warned ? 'Completed with errors.' : 'Done.');
     }
 
-    const pending: Promise<any>[] = [];
+    const pending: Promise<void>[] = [];
     if (args['write-biblio']) {
       if (args.verbose) {
         utils.logVerbose('Writing biblio file to ' + args['write-biblio']);
@@ -281,9 +281,9 @@ const build = debounce(async function build() {
         }
       }
     }
-  } catch (e: any) {
+  } catch (e) {
     if (args.watch) {
-      process.stderr.write(e.stack);
+      process.stderr.write(e instanceof Error ? e.stack ?? e.message : String(e));
     } else {
       throw e;
     }