chore: Convert all scripts to TypeScript (#1842)

Co-authored-by: Chris Olszewski <[email protected]>

Author: mjameswh

.eslintignore

@@ -1,4 +1,2 @@
 node_modules
 lib
-es2020
-commonjs

.eslintrc

@@ -2,7 +2,7 @@
   "root": true,
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
-    "project": "./packages/*/tsconfig.json"
+    "project": ["./packages/*/tsconfig.json"]
   },
   "plugins": ["@typescript-eslint", "eslint-plugin-tsdoc", "deprecation", "import"],
   "extends": [
@@ -12,7 +12,13 @@
     "prettier"
   ],
   "rules": {
-    "eqeqeq": ["error", "always", { "null": "ignore" }],
+    "eqeqeq": [
+      "error",
+      "always",
+      {
+        "null": "ignore"
+      }
+    ],
     "no-duplicate-imports": "error",
     "object-shorthand": ["error", "always"],
     "deprecation/deprecation": "warn",
@@ -27,7 +33,12 @@
         "varsIgnorePattern": "^_"
       }
     ],
-    "import/no-unresolved": ["error", { "ignore": ["^__temporal_"] }],
+    "import/no-unresolved": [
+      "error",
+      {
+        "ignore": ["^__temporal_"]
+      }
+    ],
     // TypeScript compilation already ensures that named imports exist in the referenced module
     "import/named": "off",
     "import/default": "error",

.github/workflows/ci.yml

@@ -181,7 +181,7 @@ jobs:
         run: pnpm run build --ignore @temporalio/core-bridge
 
       - name: Publish to Verdaccio
-        run: node scripts/publish-to-verdaccio.js --registry-dir ${{ steps.tmp-dir.outputs.dir }}/npm-registry
+        run: pnpm tsx scripts/publish-to-verdaccio.ts --registry-dir ${{ steps.tmp-dir.outputs.dir }}/npm-registry
 
       - name: Install Temporal CLI
         uses: temporalio/setup-temporal@v0
@@ -222,8 +222,8 @@ jobs:
       # Sample 1: hello-world to local server
       - name: Instantiate sample project using verdaccio artifacts - Hello World
         run: |
-          node scripts/init-from-verdaccio.js --registry-dir ${{ steps.tmp-dir.outputs.dir }}/npm-registry --sample https://github.com/temporalio/samples-typescript/tree/main/hello-world --target-dir ${{ steps.tmp-dir.outputs.dir }}/sample-hello-world
-          node scripts/test-example.js --work-dir "${{ steps.tmp-dir.outputs.dir }}/sample-hello-world"
+          pnpm tsx scripts/init-from-verdaccio.ts --registry-dir ${{ steps.tmp-dir.outputs.dir }}/npm-registry --sample https://github.com/temporalio/samples-typescript/tree/main/hello-world --target-dir ${{ steps.tmp-dir.outputs.dir }}/sample-hello-world
+          pnpm tsx scripts/test-example.ts --work-dir "${{ steps.tmp-dir.outputs.dir }}/sample-hello-world"
 
       # Sample 2: hello-world-mtls to cloud server
       - name: Instantiate sample project using verdaccio artifacts - Hello World MTLS
@@ -233,9 +233,9 @@ jobs:
             exit 0
           fi
 
-          node scripts/create-certs-dir.js ${{ steps.tmp-dir.outputs.dir }}/certs
-          node scripts/init-from-verdaccio.js --registry-dir ${{ steps.tmp-dir.outputs.dir }}/npm-registry --sample https://github.com/temporalio/samples-typescript/tree/main/hello-world-mtls --target-dir ${{ steps.tmp-dir.outputs.dir }}/sample-hello-world-mtls
-          node scripts/test-example.js --work-dir "${{ steps.tmp-dir.outputs.dir }}/sample-hello-world-mtls"
+          pnpm tsx scripts/create-certs-dir.ts ${{ steps.tmp-dir.outputs.dir }}/certs
+          pnpm tsx scripts/init-from-verdaccio.ts --registry-dir ${{ steps.tmp-dir.outputs.dir }}/npm-registry --sample https://github.com/temporalio/samples-typescript/tree/main/hello-world-mtls --target-dir ${{ steps.tmp-dir.outputs.dir }}/sample-hello-world-mtls
+          pnpm tsx scripts/test-example.ts --work-dir "${{ steps.tmp-dir.outputs.dir }}/sample-hello-world-mtls"
         env:
           # These env vars are used by the hello-world-mtls sample
           TEMPORAL_ADDRESS: ${{ vars.TEMPORAL_CLIENT_NAMESPACE }}.tmprl.cloud:7233
@@ -255,8 +255,8 @@ jobs:
       # Sample 3: fetch-esm to local server
       - name: Instantiate sample project using verdaccio artifacts - Fetch ESM
         run: |
-          node scripts/init-from-verdaccio.js --registry-dir ${{ steps.tmp-dir.outputs.dir }}/npm-registry --sample https://github.com/temporalio/samples-typescript/tree/main/fetch-esm --target-dir ${{ steps.tmp-dir.outputs.dir }}/sample-fetch-esm
-          node scripts/test-example.js --work-dir "${{ steps.tmp-dir.outputs.dir }}/sample-fetch-esm" --script-name workflow-local --expected-output "Hello World And Hello Wonderful Temporal!"
+          pnpm tsx scripts/init-from-verdaccio.ts --registry-dir ${{ steps.tmp-dir.outputs.dir }}/npm-registry --sample https://github.com/temporalio/samples-typescript/tree/main/fetch-esm --target-dir ${{ steps.tmp-dir.outputs.dir }}/sample-fetch-esm
+          pnpm tsx scripts/test-example.ts --work-dir "${{ steps.tmp-dir.outputs.dir }}/sample-fetch-esm" --script-name workflow-local --expected-output "Hello World And Hello Wonderful Temporal!"
 
       # End samples
 

.github/workflows/release.yml

@@ -181,7 +181,7 @@ jobs:
         run: pnpm run build --ignore @temporalio/core-bridge
 
       - name: Publish to Verdaccio
-        run: node scripts/publish-to-verdaccio.js --registry-dir ./tmp/registry
+        run: pnpm tsx scripts/publish-to-verdaccio.ts --registry-dir ./tmp/registry
 
       - name: Save Verdaccio repo artifact
         uses: actions/upload-artifact@v4
@@ -250,7 +250,7 @@ jobs:
 
       # Note: here, `npx create` fails on windows if shell is bash.
       - name: Instantiate sample project using verdaccio artifacts
-        run: node scripts/init-from-verdaccio.js --registry-dir ./tmp/registry --sample ${{ matrix.sample }} --target-dir ${{ runner.temp }}/example
+        run: pnpm tsx scripts/init-from-verdaccio.ts --registry-dir ./tmp/registry --sample ${{ matrix.sample }} --target-dir ${{ runner.temp }}/example
 
       - name: Install Temporal CLI
         if: matrix.server == 'cli'
@@ -269,7 +269,7 @@ jobs:
         # We write the certs to disk because it serves the sample. Written into /tmp/temporal-certs
       - name: Create certs dir
         shell: bash
-        run: node scripts/create-certs-dir.js "${{ runner.temp }}/certs"
+        run: pnpm tsx scripts/create-certs-dir.ts "${{ runner.temp }}/certs"
         if: matrix.server == 'cloud'
         env:
           # These env vars are used by the hello-world-mtls sample
@@ -279,14 +279,14 @@ jobs:
           TEMPORAL_CLIENT_KEY: ${{ secrets.TEMPORAL_CLIENT_KEY }}
 
       - name: Test run a workflow (non-cloud)
-        run: node scripts/test-example.js --work-dir "${{ runner.temp }}/example"
+        run: pnpm tsx scripts/test-example.ts --work-dir "${{ runner.temp }}/example"
         shell: bash
         if: matrix.server == 'cli'
 
       - name: Test run a workflow (cloud)
         if: matrix.server == 'cloud'
         # The required environment variables must be present for releases (this must be run from the official repo)
-        run: node scripts/test-example.js --work-dir "${{ runner.temp }}/example"
+        run: pnpm tsx scripts/test-example.ts --work-dir "${{ runner.temp }}/example"
         shell: bash
         env:
           # These env vars are used by the hello-world-mtls sample

.prettierignore

@@ -4,8 +4,6 @@ packages/core-bridge/target
 packages/core-bridge/bridge-macros/target
 sdk-core
 lib
-es2020
-commonjs
 .docusaurus
 packages/*/CHANGELOG.md
 packages/docs/docs/api

CONTRIBUTING.md

@@ -93,13 +93,10 @@ If building fails, resetting your environment may help:
 pnpm dlx lerna clean -y && pnpm install --frozen-lockfile
 ```
 
-If `pnpm install` fails in `@temporalio/core-bridge` on the command `node ./scripts/build.js`, you may
+If `pnpm install` fails in `@temporalio/core-bridge` on the command `pnpm tsx ./scripts/build.ts`, you may
 need to do `rustup update`.
 
-To update to the latest version of the Core SDK, run `git submodule update` followed by `npm run build` to recompile.
-
-> For cross compilation on MacOS follow [these instructions](https://github.com/temporalio/sdk-typescript/blob/main/docs/building.md)
-> (only required for publishing packages).
+To update to the latest version of the Core SDK, run `git submodule update` followed by `pnpm run build` to recompile.
 
 ## Development
 
@@ -135,14 +132,17 @@ To replicate the `test-npm-init` CI test locally, you can start with the below s
 > If you've run `npx @temporalio/create` before, you may need to delete the version of the package that's stored in `~/.npm/_npx/`.
 
 ```
-rm -rf /tmp/registry
 pnpm install --frozen-lockfile
 pnpm run rebuild
-node scripts/publish-to-verdaccio.js --registry-dir /tmp/registry
-node scripts/init-from-verdaccio.js --registry-dir /tmp/registry --sample hello-world
-cd /tmp/registry/example
-npm run build
-node ~/path-to/sdk-typescript/scripts/test-example.js --work-dir /tmp/registry/example
+
+TMP_DIR=$( mktemp -d )
+
+pnpm tsx scripts/publish-to-verdaccio.ts --registry-dir "$TMP_DIR"
+pnpm tsx scripts/init-from-verdaccio.ts --registry-dir "$TMP_DIR" --sample hello-world
+
+cd "$TMP_DIR/example"
+pnpm run build
+pnpm tsx scripts/test-example.ts --work-dir "$TMP_DIR/example"
 ```
 
 ### Style Guide
@@ -195,7 +195,9 @@ To install both tools: `npm i -g npm-check npm-check-updates`.
 
 ## Publishing
 
-First, follow the instructions in [docs/building.md](docs/building.md).
+First, download the latest native artifacts from GitHub Actions.
+
+Then run the following commands:
 
 ```sh
 cargo install git-cliff
@@ -249,7 +251,7 @@ ls packages/core-bridge/releases/
 pnpm exec lerna version patch --force-publish='*' # or major|minor|etc, or leave out to be prompted. either way, you get a confirmation dialog.
 
 git checkout -B fix-deps
-node scripts/prepublish.mjs
+pnpm tsx scripts/prepublish.ts
 git commit -am 'Fix dependencies'
 pnpm exec lerna publish from-package # add `--dist-tag next` for pre-release versions
 git checkout -

docs/building.md

@@ -24,17 +24,16 @@
     "rebuild": "pnpm run clean && pnpm run build",
     "build": "lerna run --stream build",
     "build.watch": "pnpm run build:protos && tsc --build --watch packages/*/tsconfig.json",
-    "build:protos": "node ./packages/proto/scripts/compile-proto.js",
+    "build:protos": "tsx ./packages/proto/scripts/compile-proto.ts",
     "test": "lerna run --stream test",
     "test.watch": "lerna run --stream test.watch",
     "ci-stress": "node ./packages/test/lib/load/run-all-stress-ci-scenarios.js",
     "ci-nightly": "node ./packages/test/lib/load/run-all-nightly-scenarios.js",
-    "wait-namespace": "node ./scripts/wait-on-temporal.mjs",
     "lint": "eslint packages/*/src --ext .ts --no-error-on-unmatched-pattern --fix && prettier --write . && lerna run --no-bail --stream lint",
     "lint.check": "eslint packages/*/src --ext .ts --no-error-on-unmatched-pattern && prettier --end-of-line auto --check .  && lerna run --no-bail --stream lint.check",
     "lint.prune": "ts-prune --error -p tsconfig.prune.json --ignore \"used in module\" --skip \".d.ts\"",
     "format": "prettier --write . && lerna run --no-bail --stream format",
-    "clean": "node ./scripts/clean.mjs",
+    "clean": "tsx ./scripts/clean.ts",
     "docs": "cd packages/docs && pnpm run maybe-install-deps-and-build-docs",
     "ava": "pnpm -C packages/test exec ava"
   },
@@ -81,6 +80,7 @@
     "lerna": "^8.2.4",
     "prettier": "^3.1.1",
     "ts-prune": "^0.10.3",
+    "tsx": "^4.20.6",
     "typescript": "^5.6.3",
     "verdaccio": "^6.2.2"
   },

etc/mac-cargo-config.toml

@@ -0,0 +1,7 @@
+export const targets: string[];
+
+export class PrebuildError extends Error {}
+
+export function getPrebuiltTargetName(): string;
+
+export function getPrebuiltPath(): string;