Merge pull request #535 from zeromq/update [skip ci]

Author: aminya

package.json

@@ -5,9 +5,9 @@
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "typesVersions": {
-    ">=3.6": {
+    ">=3.7": {
       "lib/*": [
-        "lib/ts3.6/*"
+        "lib/ts3.7/*"
       ]
     }
   },
@@ -31,6 +31,7 @@
     "@types/semver": ">=7",
     "@types/shelljs": "^0.8.11",
     "@types/weak-napi": "^2.0.1",
+    "@types/which": "^2.0.1",
     "benchmark": ">=2",
     "chai": ">=4.3",
     "cross-env": "^7.0.3",
@@ -44,14 +45,15 @@
     "node-gyp": "^9.3.0",
     "npm-run-all2": "^6.0.4",
     "prebuildify": "^5.0.1",
-    "prettier": "^2.7.1",
+    "prettier": "^2.8.0",
     "rocha": "^2.5.10",
     "semver": ">=7",
     "tar-fs": "^2.1.1",
-    "ts-morph": "^16.0.0",
+    "ts-morph": "^17.0.1",
     "ts-node": "10.9",
     "typescript": "4.9",
-    "weak-napi": "^2.0.2"
+    "weak-napi": "^2.0.2",
+    "which": "^3.0.0"
   },
   "engines": {
     "node": ">= 10.2"
@@ -73,7 +75,7 @@
     "install": "(shx test -f ./script/build.js || run-s build.js) && node-gyp-build",
     "clean": "shx rm -rf ./build ./lib/ ./prebuilds",
     "clean.temp": "shx rm -rf ./tmp && shx mkdir -p tmp && shx touch tmp/.gitkeep",
-    "build.library": "shx rm -rf ./lib && tsc -p ./src/tsconfig.json && node script/ci/downlevel-dts.js",
+    "build.library": "shx rm -rf ./lib && tsc -p ./src/tsconfig.json && ts-node ./script/downlevel-dts.ts",
     "build.script": "tsc -p ./script/tsconfig.json",
     "build.js": "run-p build.script build.library",
     "build.doc": "typedoc --out docs --name zeromq.js --excludeProtected --excludePrivate --excludeNotExported --excludeExternals --externalPattern 'src/+(draft|native|compat).ts' --tsconfig tsconfig-build.json --mode file",

pnpm-lock.yaml

@@ -5,40 +5,58 @@
 
 /* eslint-env node */
 
-const {Project, ts} = require("ts-morph")
-const path = require("path")
-const fs = require("fs-extra")
+import {
+  Directory,
+  ExportDeclaration,
+  GetAccessorDeclaration,
+  ImportDeclaration,
+  Project,
+  SetAccessorDeclaration,
+  SourceFile,
+  ts,
+} from "ts-morph"
+import * as path from "path"
+import * as fs from "fs-extra"
 
-const project = new Project()
-const inputDir = project.addDirectoryAtPath(path.join(__dirname, "../../lib/"))
+async function main() {
+  const project = new Project()
+  const inputDir = project.addDirectoryAtPath(path.join(__dirname, "../lib/"))
 
-// Create output directory
-fs.emptyDirSync(path.join(inputDir.getPath().toString(), "ts3.6"))
-const ts36Dir = inputDir.createDirectory("ts3.6")
-project.saveSync()
+  // Create output directory
+  const oldestSupportedTS = "ts3.7"
 
-// Down-level all *.d.ts files in input directory
-const files = inputDir.addSourceFilesAtPaths("*.d.ts")
-for (const f of files) {
-  // Create copy for TypeScript 3.6+
-  copyTypingsFile(f, ts36Dir)
-  downlevelTS36(f)
-  downlevelTS34(f)
-  // Original file will be overwritten by down-leveled file when saved
+  fs.emptyDirSync(path.join(inputDir.getPath().toString(), oldestSupportedTS))
+  const tsDownDir = inputDir.createDirectory(oldestSupportedTS)
+  project.saveSync()
+
+  // Down-level all *.d.ts files in input directory
+  const files = inputDir.addSourceFilesAtPaths("*.d.ts")
+  for (const file of files) {
+    // Create copy for TypeScript 3.7
+    copyTypingsFile(file, tsDownDir)
+    downlevelTS36(file)
+    // Original file will be overwritten by down-leveled file when saved
+  }
+  project.saveSync()
 }
-project.saveSync()
+
+main().catch(err => {
+  throw err
+})
 
 /**
  * Copy typings source file *.d.ts to target dir
  */
-function copyTypingsFile(f, targetDir) {
-  const cf = f.copyToDirectory(targetDir, {overwrite: true})
-  const srcPath = f.getDirectoryPath()
+function copyTypingsFile(file: SourceFile, targetDir: Directory) {
+  const cFile = file.copyToDirectory(targetDir, {overwrite: true})
+  const srcPath = file.getDirectoryPath()
   const targetPath = targetDir.getPath()
-  revertModulePathChange(cf.getImportDeclarations(), srcPath, targetPath)
-  revertModulePathChange(cf.getExportDeclarations(), srcPath, targetPath)
+  revertModulePathChange(cFile.getImportDeclarations(), srcPath, targetPath)
+  revertModulePathChange(cFile.getExportDeclarations(), srcPath, targetPath)
 }
 
+type StandardizedFilePath = ReturnType<SourceFile["getDirectoryPath"]>
+
 /**
  * HELPER for reverting changed relative paths for import/export declarations in
  * copied files, so they to not point to the source-directory but the other
@@ -49,14 +67,18 @@ function copyTypingsFile(f, targetDir) {
  * [after copied to targetDir]  from "../<module-file>"
  * [reverted in targetDir]      from "./<module-file>"
  */
-function revertModulePathChange(importExportDecl, srcDir, targetDir) {
+function revertModulePathChange(
+  importExportDecl: ImportDeclaration[] | ExportDeclaration[],
+  srcDir: StandardizedFilePath,
+  targetDir: StandardizedFilePath,
+) {
   const absSrcDir = path.resolve(srcDir)
   for (const decl of importExportDecl) {
     if (!decl.isModuleSpecifierRelative()) {
       continue
     }
     const declPath = decl.getModuleSpecifierValue()
-    if (!declPath) {
+    if (declPath === undefined) {
       continue
     }
     const absDeclPath = path.resolve(path.join(targetDir, declPath))
@@ -69,9 +91,9 @@ function revertModulePathChange(importExportDecl, srcDir, targetDir) {
 /**
  * Down-level TypeScript 3.6 types in the given source file
  */
-function downlevelTS36(f) {
+function downlevelTS36(file: SourceFile) {
   // Replace get/set accessors with (read-only) properties
-  const gs = f.getDescendantsOfKind(ts.SyntaxKind.GetAccessor)
+  const gs = file.getDescendantsOfKind(ts.SyntaxKind.GetAccessor)
   for (const g of gs) {
     const comment = getLeadingComments(g)
     const s = g.getSetAccessor()
@@ -86,13 +108,13 @@ function downlevelTS36(f) {
       s.remove()
     }
   }
-  const ss = f.getDescendantsOfKind(ts.SyntaxKind.SetAccessor)
+  const ss = file.getDescendantsOfKind(ts.SyntaxKind.SetAccessor)
   for (const s of ss) {
     const g = s.getGetAccessor()
     if (!g) {
       const comment = getLeadingComments(s)
       const firstParam = s.getParameters()[0]
-      const firstParamTypeNode = firstParam && firstParam.getTypeNode()
+      const firstParamTypeNode = firstParam?.getTypeNode()
       const firstParamType = firstParamTypeNode
         ? firstParamTypeNode.getText()
         : "any"
@@ -103,49 +125,19 @@ function downlevelTS36(f) {
   }
 }
 
-/**
- * Down-level TypeScript 3.4 types in the given source file
- */
-function downlevelTS34(f) {
-  // Replace "es2018.asynciterable" with "esnext.asynciterable" in lib references
-  const refs = f.getLibReferenceDirectives()
-  for (const r of refs) {
-    if (r.getFileName() === "es2018.asynciterable") {
-      f.replaceText([r.getPos(), r.getEnd()], "esnext.asynciterable")
-    }
-  }
-  downlevelEs2018(f)
-}
-
-/**
- * Down-level es2018 to esnext library in the given source file
- */
-function downlevelEs2018(f) {
-  // Replace AsyncIterator<T1,T2> with AsyncIterator<T1>
-  const typeParams = f.getDescendantsOfKind(ts.SyntaxKind.TypeReference)
-  for (const t of typeParams) {
-    if (t.wasForgotten()) {
-      continue
-    }
-    const typeName = t.getTypeName().getText()
-    if (typeName === "AsyncIterator") {
-      const params = t.getTypeArguments()
-      if (params.length > 1) {
-        t.replaceWithText(`${typeName}<${params[0].getText()}>`)
-      }
-    }
-  }
-}
-
-function getModifiersText(node) {
+function getModifiersText(
+  node: GetAccessorDeclaration | SetAccessorDeclaration,
+) {
   const modifiersText = node
     .getModifiers()
     .map(m => m.getText())
     .join(" ")
   return modifiersText.length > 0 ? `${modifiersText} ` : ""
 }
 
-function getLeadingComments(node) {
+function getLeadingComments(
+  node: GetAccessorDeclaration | SetAccessorDeclaration,
+) {
   const t = node.getText()
   const tlen = t.length
   const ct = node.getText(true)
@@ -163,7 +155,10 @@ function getLeadingComments(node) {
     .replace(/(\r?\n)\s+$/gm, "$1")
 }
 
-function relativeModulePath(fromAbsModulePath, toAbsTargetDir) {
+function relativeModulePath(
+  fromAbsModulePath: string,
+  toAbsTargetDir: StandardizedFilePath,
+) {
   const fromModDir = path.dirname(fromAbsModulePath)
   const revertedPath = path.resolve(
     fromModDir,