Replacing ts-node with swc-node/register (#1210)

Closes #1170 

It seems that `ts-node` is abandoned by its maintainers, so I'm going to
replace it by `swc-node/register` the same way I did for `merge-sx`.

.github/workflows/node.js.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [18.0.0, 18.x, 20.1.0, 20.x]
+        node-version: [18.0.0, 18.6.0, 18.x, 20.1.0, 20.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
     steps:
     - name: Get yarn cache dir
@@ -51,6 +51,8 @@ jobs:
     - name: Integration test
       run: yarn test:int
     - name: ESM test
+      # see https://github.com/RobinTail/express-zod-api/pull/1210#issuecomment-1751489201
+      if: matrix.node-version != '18.0.0'
       run: yarn test:esm
   finish:
     needs: build

.npmignore

@@ -4,7 +4,7 @@ tsconfig.build.json
 tsconfig.esm.json
 example
 .husky
-jest.config.ts
+jest.config.json
 tests
 .idea
 yarn-error.log

SECURITY.md

@@ -23,6 +23,6 @@
 Found a vulnerability or other security issue?
 
 Please urgently inform me privately by
-[email](https://github.com/RobinTail/express-zod-api/blob/master/package.json#L133).
+[email](https://github.com/RobinTail/express-zod-api/blob/master/package.json#L135).
 
 I will try to fix it as soon as possible.

example/example.swagger.yaml

@@ -429,4 +429,3 @@ tags:
     description: Everything about the files processing
 servers:
   - url: https://example.com
-

example/generate-client.ts

@@ -1,4 +1,9 @@
+import { writeFileSync } from "node:fs";
 import { Integration } from "../src";
 import { routing } from "./routing";
 
-console.log(new Integration({ routing }).print());
+writeFileSync(
+  "example/example.client.ts",
+  new Integration({ routing }).print(),
+  "utf-8",
+);

example/generate-open-api-schema.ts

@@ -1,14 +1,17 @@
+import { writeFileSync } from "node:fs";
 import { Documentation } from "../src";
 import { config } from "./config";
 import { routing } from "./routing";
 import manifest from "../package.json";
 
-console.log(
+writeFileSync(
+  "example/example.swagger.yaml",
   new Documentation({
     routing,
     config,
     version: manifest.version,
     title: "Example API",
     serverUrl: "https://example.com",
   }).getSpecAsYaml(),
+  "utf-8",
 );

jest.config.json

@@ -0,0 +1,12 @@
+{
+  "transform": {
+    "^.+\\.ts$": "@swc/jest"
+  },
+  "testEnvironment": "node",
+  "verbose": true,
+  "forceExit": true,
+  "collectCoverage": true,
+  "collectCoverageFrom": ["src/**"],
+  "coverageReporters": ["json-summary", "text", "html", "lcov"],
+  "testTimeout": 10000
+}

package.json

@@ -4,16 +4,17 @@
   "description": "A Typescript library to help you get an API server up and running with I/O schema validation and custom middlewares in minutes.",
   "license": "MIT",
   "scripts": {
-    "start": "ts-node example/index.ts",
+    "start": "yarn tsnode example/index.ts",
     "build": "yarn build:compile && yarn build:tests && yarn build:assets",
     "build:compile": "tsup && attw --pack",
     "build:tests": "yarn build:int && yarn build:esm",
-    "build:int": "ts-node tools/integration-test.ts && yarn install --cwd ./tests/integration",
-    "build:esm": "ts-node tools/esm-test.ts && yarn install --cwd ./tests/esm",
+    "build:int": "yarn tsnode tools/integration-test.ts && yarn install --cwd ./tests/integration",
+    "build:esm": "yarn tsnode tools/esm-test.ts && yarn install --cwd ./tests/esm",
     "build:assets": "yarn build:swagger && yarn build:client && yarn build:license",
-    "build:swagger": "ts-node example/generate-open-api-schema.ts > example/example.swagger.yaml",
-    "build:client": "ts-node example/generate-client.ts > example/example.client.ts && yarn prettier example/example.client.ts --write",
-    "build:license": "ts-node tools/license.ts > ./LICENSE",
+    "build:swagger": "yarn tsnode example/generate-open-api-schema.ts",
+    "build:client": "yarn tsnode example/generate-client.ts && yarn prettier example/example.client.ts --write",
+    "build:license": "yarn tsnode tools/license.ts",
+    "build:logo": "yarn tsnode tools/startup-logo.ts",
     "test": "yarn test:types && yarn test:jest && yarn test:badge",
     "test:int": "jest ./tests/integration",
     "test:esm": "jest ./tests/esm",
@@ -23,6 +24,7 @@
     "test:badge": "make-coverage-badge --output-path ./coverage.svg",
     "lint": "eslint src example tests tools && yarn prettier *.md --check",
     "mdfix": "prettier *.md --write",
+    "tsnode": "node -r @swc-node/register",
     "precommit": "yarn build && yarn lint && yarn test && git add example/example.swagger.yaml example/example.client.ts ./LICENSE ./coverage.svg",
     "prepublishOnly": "yarn build && yarn lint && yarn test",
     "postversion": "git push && git push --tags",
@@ -81,7 +83,8 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.11.0",
-    "@swc/core": "^1.3.82",
+    "@swc-node/register": "^1.6.8",
+    "@swc/core": "^1.3.92",
     "@swc/jest": "^0.2.29",
     "@tsconfig/node18": "^18.2.1",
     "@types/cors": "^2.8.14",
@@ -112,7 +115,6 @@
     "mockdate": "^3.0.5",
     "prettier": "3.0.3",
     "strip-ansi": "^6.0.1",
-    "ts-node": "^10.9.1",
     "tsd": "^0.29.0",
     "tsup": "^7.2.0",
     "typescript": "^5.2.2",

tests/helpers.ts

@@ -1,4 +1,4 @@
-import jestConfig from "../jest.config";
+import jestConfig from "../jest.config.json";
 import { z } from "zod";
 import { SchemaHandler, walkSchema } from "../src/schema-walker";
 

tests/system/client.spec.ts

@@ -16,7 +16,7 @@ describe("Example", () => {
   };
 
   beforeAll(() => {
-    example = spawn("ts-node", ["example/index.ts"]);
+    example = spawn("node", ["-r", "@swc-node/register", "example/index.ts"]);
     example.stdout.on("data", listener);
   });
 

tests/system/example.spec.ts

@@ -13,7 +13,7 @@ describe("Example", () => {
   };
 
   beforeAll(() => {
-    example = spawn("ts-node", ["example/index.ts"]);
+    example = spawn("node", ["-r", "@swc-node/register", "example/index.ts"]);
     example.stdout.on("data", listener);
   });
 

tools/esm-test.ts

@@ -5,22 +5,21 @@ import { getTSConfigBase } from "./tsconfig-base";
 
 const tsconfigBase = getTSConfigBase();
 
-// @todo revert "start" to "ts-node-esm quick-start.ts" when the ts-node issue fixed
-// @link https://github.com/TypeStrong/ts-node/issues/1997
 const packageJson = `
 {
   "name": "express-zod-api-esm-test",
   "version": "1.0.0",
   "scripts": {
-    "launch": "node --no-warnings=ExperimentalWarning --loader ts-node/esm",
-    "postinstall": "yarn launch fix-package.ts",
-    "start": "yarn launch quick-start.ts"
+    "tsnode": "node --loader @swc-node/register/esm",
+    "postinstall": "yarn tsnode fix-package.ts",
+    "start": "yarn tsnode quick-start.ts"
   },
   "type": "module",
   "dependencies": {
     "@tsconfig/node${tsconfigBase}": "latest",
     "express-zod-api": "../../dist",
-    "ts-node": "10.9.1",
+    "@swc/core": "1.3.92",
+    "@swc-node/register": "1.6.8",
     "typescript": "5.2.2",
     "@types/node": "*"
   }

tools/integration-test.ts

@@ -9,13 +9,15 @@ const packageJson = `
   "name": "express-zod-api-integration-test",
   "version": "1.0.0",
   "scripts": {
-    "postinstall": "ts-node fix-package.ts",
-    "start": "ts-node quick-start.ts"
+    "tsnode": "node -r @swc-node/register",
+    "postinstall": "yarn tsnode fix-package.ts",
+    "start": "yarn tsnode quick-start.ts"
   },
   "dependencies": {
     "@tsconfig/node${tsconfigBase}": "latest",
     "express-zod-api": "../../dist",
-    "ts-node": "10.9.1",
+    "@swc/core": "1.3.92",
+    "@swc-node/register": "1.6.8",
     "typescript": "5.2.2",
     "@types/node": "*"
   }

tools/license.ts

@@ -1,3 +1,4 @@
+import { writeFileSync } from "node:fs";
 import manifest from "../package.json";
 
 const ownLicense = `
@@ -24,4 +25,4 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 `;
 
-console.log(ownLicense.trim());
+writeFileSync("LICENSE", ownLicense.trimStart(), "utf-8");

tsconfig.json

@@ -6,8 +6,5 @@
     "strictNullChecks": true,
     "resolveJsonModule": true
   },
-  "exclude": ["tests/integration", "tests/esm"],
-  "ts-node": {
-    "swc": false
-  }
+  "exclude": ["tests/integration", "tests/esm"]
 }