feat: deno support

.github/workflows/pr.yml

@@ -82,3 +82,34 @@ jobs:
 
       - name: test
         run: bun test
+  build-deno:
+    needs: build
+    runs-on: ubuntu-latest
+
+    strategy:
+        max-parallel: 3
+        matrix:
+          deno-version:
+            - 2.1.9
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+
+      - name: Set up Deno ${{ matrix.deno-version }}
+        uses: denoland/setup-deno@v2
+        with:
+          deno-version: ${{ matrix.deno-version }}
+
+      - name: Install
+        run: npm ci
+
+      - name: lint
+        run: deno run lint
+
+      - name: test build
+        run: deno task test:build
+
+      - name: test
+        run: deno task test

.github/workflows/release.yml

@@ -128,3 +128,50 @@ jobs:
           push: true
           fetch: true
           pull: '--rebase --autostash'
+  build-deno:
+    name: "Deno ${{ matrix.deno-version }}"
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      max-parallel: 1
+      matrix:
+        deno-version:
+            - 2.1.9
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+
+      - name: Use Deno ${{ matrix.deno-version }}
+        uses: denoland/setup-deno@v2
+        with:
+          deno-version: ${{ matrix.deno-version }}
+
+      - name: Install
+        run: npm ci
+
+      - name: Lint
+        run: deno run lint
+
+      - name: Test build
+        run: deno task test:build
+
+      - name: Test
+        run: deno task test
+
+      - name: generate benchmarks with deno
+        run: ./start.sh DENO
+
+      - name: push
+        uses: EndBug/add-and-commit@v9
+        ## prevents forked repos from comitting results in PRs
+        if: github.repository == 'moltar/typescript-runtime-type-benchmarks'
+        with:
+          author_name: ${{ env.GIT_COMMIT_AUTHOR_NAME }}
+          author_email: ${{ env.GIT_COMMIT_AUTHOR_EMAIL }}
+          message: 'feat: ${{ matrix.deno-version }} adds auto-generated benchmarks and bar graph'
+          push: true
+          fetch: true
+          pull: '--rebase --autostash'

README.md

@@ -149,6 +149,11 @@ const res = isMyDataValid(data)
 * Use `curl -fsSl https://bun.sh/install | bash -s "bun-v1.0.x"` to switch to a specific bun version
 * `curl -fsSl https://bun.sh/install | bash -s "bun-v1.1.43"` - switch to bun 1.1.43
 
+#### Deno
+
+* Use `deno upgrade x.x.x` to switch to a specific Deno version
+* `deno upgrade stable` - switch to Deno x.x.x
+
 ## Adding new runtime version
 
 ### Node.js runtime
@@ -162,6 +167,11 @@ const res = isMyDataValid(data)
 * update bun version matrix in `.github/workflows/pr.yml` and `.github/workflows/release.yml`
 * update `BUN_VERSIONS` in `docs/dist/app.tsx` and run `npm run docs:build`
 
+### Deno runtime
+
+* update Deno version matrix in `.github/workflows/pr.yml` and `.github/workflows/release.yml`
+* update `DENO_VERSIONS` in `docs/dist/app.tsx` and run `npm run docs:build`
+
 ## Test cases
 
 * **Safe Parsing**

benchmarks/helpers/graph.ts

@@ -1,4 +1,4 @@
-import { writeFileSync } from 'fs';
+import { writeFileSync } from 'node:fs';
 import { optimize } from 'svgo';
 import { parse, View } from 'vega';
 import { compile } from 'vega-lite';

benchmarks/helpers/main.ts

@@ -1,11 +1,35 @@
 import { add, complete, cycle, suite } from 'benny';
-import { readFileSync, writeFileSync, existsSync, unlinkSync } from 'fs';
-import { join } from 'path';
+import { readFileSync, writeFileSync, existsSync, unlinkSync } from 'node:fs';
+import { join, dirname } from 'node:path';
 import { writePreviewGraph } from './graph';
 import { getRegisteredBenchmarks } from './register';
 import type { BenchmarkCase, BenchmarkResult } from './types';
 
-const DOCS_DIR = join(__dirname, '../../docs');
+/**
+ * A getDirname that works in CJS and ESM, since this file is directly shared
+ * across both kinds of projects.
+ * @TODO We can remove this once we've migrated all consumers to ESM.
+ *
+ * @see https://stackoverflow.com/a/79251101/13503626
+ */
+function pathFromStack() {
+  const { stack } = new Error();
+  if (!stack) {
+    throw new Error('Could not get stack');
+  }
+  const lines = stack.split('\n');
+  for (const line of lines) {
+    if (line.includes(' (/') || line.includes(' (file://')) {
+      // assumes UNIX-like paths
+      const location = line.split(' (')[1].replace('file://', '');
+      const filepath = location.split(':')[0];
+      const dirpath = dirname(filepath);
+      return { dirpath, filepath };
+    }
+  }
+  throw new Error('Could not get dirname');
+}
+const DOCS_DIR = join(pathFromStack().dirpath, '../../docs');
 const RUNTIME = process.env.RUNTIME || 'node';
 const RUNTIME_VERSION = process.env.RUNTIME_VERSION || process.version;
 const RUNTIME_FOR_PREVIEW = 'node';

deno.jsonc

@@ -0,0 +1,11 @@
+{
+    "unstable": [
+        // https://docs.deno.com/runtime/reference/cli/unstable_flags/#--unstable-sloppy-imports: needed because Deno can only read ESM modules but project lacks file extension in imports (.ts)
+        "sloppy-imports",
+        // https://docs.deno.com/runtime/reference/cli/unstable_flags/#--unstable-detect-cjs: needed as some of the packages are CJS but masquerade as ESM
+        "detect-cjs"
+    ],
+    "compilerOptions": {
+        "experimentalDecorators": true
+    }
+}