test: improve typescript compat tests

zeromq · Jun 17, 2024 · 11dc0f8 · 11dc0f8
1 parent 9df82f3
commit 11dc0f8
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 12 deletions.
diff --git a/test/typings-compatibility/template/package.json b/test/typings-compatibility/template/package.json
@@ -8,6 +8,7 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "typescript": "x.x.x"
+    "typescript": "x.x.x",
+    "@types/node": "y.y.y"
   }
 }
diff --git a/test/unit/typings-compatibility-test.ts b/test/unit/typings-compatibility-test.ts
@@ -20,16 +20,30 @@ import {assert} from "chai"
  *       EXCLUDE_TYPINGS_COMPAT_TESTS=true
  */
 
-type TestDef = {version: string; minTarget: string; requiredLibs?: string[]}
+type TestDef = {
+  tscVersion: string
+  nodeTypesVersion: string
+  minTarget: string
+  requiredLibs?: string[]
+}
 
 const tsVersions: TestDef[] = [
+  // the oldest supported version
+  {tscVersion: "3.7.x", nodeTypesVersion: "10.x", minTarget: "es3"},
+
+  // 4.0
+  {tscVersion: "4.0", nodeTypesVersion: "14.x", minTarget: "es5"},
+
   // 4.x
-  {version: "4.x", minTarget: "es3"},
+  {tscVersion: "4.x", nodeTypesVersion: "18.x", minTarget: "es6"},
+
+  // 5.x
+  {tscVersion: "5.x", nodeTypesVersion: "22.x", minTarget: "ES2022"},
 ]
 
 // use ./typings-test.ts for tsc test, but change the import location for zmq
 // to be used from `test/typings-compatibility/ts-x.x.x/typings-test.ts`:
-const zmqImportLoc = "../../../"
+const zmqImportLoc = "../../../lib"
 const srcFile = path.resolve(__dirname, "typings-test.ts")
 const srcStr = readFile(srcFile, "utf8").then(content => {
   // replace import statement `import * as zmq from ...`:
@@ -71,9 +85,9 @@ async function run(
 }
 
 function getItLabelDetails(tsVer: TestDef): string {
-  const lbl = `v${tsVer.version} for (minimal) compile target ${JSON.stringify(
-    tsVer.minTarget,
-  )}`
+  const lbl = `v${
+    tsVer.tscVersion
+  } for (minimal) compile target ${JSON.stringify(tsVer.minTarget)}`
   if (!tsVer.requiredLibs || tsVer.requiredLibs.length === 0) {
     return lbl
   }
@@ -98,12 +112,15 @@ describe("compatibility of typings for typescript versions", async function () {
     // the typescript package to complete
     this.timeout(30000)
 
-    const tscTargetPath = path.resolve(tscTestBasePath, `ts-${tsVer.version}`)
+    const tscTargetPath = path.resolve(
+      tscTestBasePath,
+      `ts-${tsVer.tscVersion}`,
+    )
 
     it(`it should compile successfully with typescript version ${
-      tsVer.version
+      tsVer.tscVersion
       // eslint-disable-next-line no-loop-func
-    }, tsc ${getItLabelDetails(tsVer)}`, async function () {
+    }, tsc ${getItLabelDetails(tsVer)}`, async () => {
       await prepareTestPackage(tscTargetPath, tsVer, execCmd)
 
       const cmd = ["npm", "pnpm"].includes(execCmd) ? `${execCmd} run` : execCmd
@@ -146,8 +163,9 @@ async function prepareTestPackage(
         path.resolve(templateSrcPath, "package.json"),
       )
 
-      pkgJson.name = `test-typings-ts-${tsVer.version}`
-      pkgJson.devDependencies.typescript = `${tsVer.version}`
+      pkgJson.name = `test-typings-ts-${tsVer.tscVersion}`
+      pkgJson.devDependencies.typescript = `${tsVer.tscVersion}`
+      pkgJson.devDependencies["@types/node"] = tsVer.nodeTypesVersion
       return writeJson(path.resolve(tscTargetPath, "package.json"), pkgJson)
     })(),
     (async () => {