refactor: rely on typescript and tsx

enisdenjo · enisdenjo · commit 782b82fbc006 · 2023-07-06T18:17:33.000+03:00
diff --git a/.github/workflows/audits.yml b/.github/workflows/audits.yml
@@ -38,12 +38,10 @@ jobs:
           cache: yarn
       - name: Install
         run: yarn install --immutable
-      - name: Build
-        run: yarn build:esm
       - name: Start
         run: yarn workspace ${{ matrix.workspace }} start &
       - name: Audit
-        run: node scripts/audit-implementation.mjs implementations/${{ matrix.workspace }}
+        run: yarn tsx scripts/audit-implementation.ts implementations/${{ matrix.workspace }}
       - name: Summary
         run: cat implementations/${{ matrix.workspace }}/README.md >> $GITHUB_STEP_SUMMARY
       - name: Upload audit report
@@ -88,8 +86,6 @@ jobs:
           cache: yarn
       - name: Install
         run: yarn install --immutable
-      - name: Build
-        run: yarn build:esm
       - name: Bake
         uses: docker/bake-action@v2
         with:
@@ -101,7 +97,7 @@ jobs:
       - name: Start
         run: yarn workspace ${{ matrix.workspace }} start --detach --wait
       - name: Audit
-        run: node scripts/audit-implementation.mjs implementations/${{ matrix.workspace }}
+        run: yarn tsx scripts/audit-implementation.ts implementations/${{ matrix.workspace }}
       - name: Summary
         run: cat implementations/${{ matrix.workspace }}/README.md >> $GITHUB_STEP_SUMMARY
       - name: Upload audit report
@@ -141,10 +137,8 @@ jobs:
           cache: yarn
       - name: Install
         run: yarn install --immutable
-      - name: Build
-        run: yarn build:esm
       - name: Audit
-        run: node scripts/audit-implementation.mjs implementations/${{ matrix.workspace.name }}
+        run: yarn tsx scripts/audit-implementation.ts implementations/${{ matrix.workspace.name }}
       - name: Summary
         run: cat implementations/${{ matrix.workspace.name }}/README.md >> $GITHUB_STEP_SUMMARY
       - name: Upload audit report
@@ -176,7 +170,7 @@ jobs:
         with:
           name: audit-reports
       - name: Render servers table
-        run: node scripts/render-servers-table.mjs
+        run: yarn tsx scripts/render-servers-table.mjs
       - name: Diff
         run: git diff --minimal
       - name: Commit
diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml
@@ -30,12 +30,10 @@ jobs:
       - name: Download k6
         run: |
           curl https://github.com/grafana/k6/releases/download/${{ env.K6_VERSION }}/k6-${{ env.K6_VERSION }}-linux-amd64.tar.gz -L | tar xvz --strip-components 1
-      - name: Build
-        run: yarn run build:esm
       - name: Run
-        run: node benchmark/servers/http.mjs &
+        run: yarn tsx benchmark/servers/http.ts &
       - name: Benchmark
-        run: ./k6 run benchmark/k6.mjs --summary-export summary.json
+        run: ./k6 run benchmark/k6.ts --summary-export summary.json
       - name: Summary
         run: |
           echo '```json' >> $GITHUB_STEP_SUMMARY
@@ -58,12 +56,10 @@ jobs:
       - name: Download k6
         run: |
           curl https://github.com/grafana/k6/releases/download/${{ env.K6_VERSION }}/k6-${{ env.K6_VERSION }}-linux-amd64.tar.gz -L | tar xvz --strip-components 1
-      - name: Build
-        run: yarn run build:esm
       - name: Run
-        run: node benchmark/servers/express.mjs &
+        run: yarn tsx benchmark/servers/express.ts &
       - name: Benchmark
-        run: ./k6 run benchmark/k6.mjs --summary-export summary.json
+        run: ./k6 run benchmark/k6.ts --summary-export summary.json
       - name: Summary
         run: |
           echo '```json' >> $GITHUB_STEP_SUMMARY
@@ -86,12 +82,10 @@ jobs:
       - name: Download k6
         run: |
           curl https://github.com/grafana/k6/releases/download/${{ env.K6_VERSION }}/k6-${{ env.K6_VERSION }}-linux-amd64.tar.gz -L | tar xvz --strip-components 1
-      - name: Build
-        run: yarn run build:esm
       - name: Run
-        run: node benchmark/servers/fastify.mjs &
+        run: yarn tsx benchmark/servers/fastify.ts &
       - name: Benchmark
-        run: ./k6 run benchmark/k6.mjs --summary-export summary.json
+        run: ./k6 run benchmark/k6.ts --summary-export summary.json
       - name: Summary
         run: |
           echo '```json' >> $GITHUB_STEP_SUMMARY
@@ -114,12 +108,10 @@ jobs:
       - name: Download k6
         run: |
           curl https://github.com/grafana/k6/releases/download/${{ env.K6_VERSION }}/k6-${{ env.K6_VERSION }}-linux-amd64.tar.gz -L | tar xvz --strip-components 1
-      - name: Build
-        run: yarn run build:esm
       - name: Run
-        run: node benchmark/servers/koa.mjs &
+        run: yarn tsx benchmark/servers/koa.ts &
       - name: Benchmark
-        run: ./k6 run benchmark/k6.mjs --summary-export summary.json
+        run: ./k6 run benchmark/k6.ts --summary-export summary.json
       - name: Summary
         run: |
           echo '```json' >> $GITHUB_STEP_SUMMARY
@@ -142,12 +134,10 @@ jobs:
       - name: Download k6
         run: |
           curl https://github.com/grafana/k6/releases/download/${{ env.K6_VERSION }}/k6-${{ env.K6_VERSION }}-linux-amd64.tar.gz -L | tar xvz --strip-components 1
-      - name: Build
-        run: yarn run build:esm
       - name: Run
-        run: node benchmark/servers/uWebSockets.mjs &
+        run: yarn tsx benchmark/servers/uWebSockets.ts &
       - name: Benchmark
-        run: ./k6 run benchmark/k6.mjs --summary-export summary.json
+        run: ./k6 run benchmark/k6.ts --summary-export summary.json
       - name: Summary
         run: |
           echo '```json' >> $GITHUB_STEP_SUMMARY
@@ -181,7 +171,7 @@ jobs:
       - name: Run
         run: deno run -A benchmark/servers/deno.ts &
       - name: Benchmark
-        run: ./k6 run benchmark/k6.mjs --summary-export summary.json
+        run: ./k6 run benchmark/k6.ts --summary-export summary.json
       - name: Summary
         run: |
           echo '```json' >> $GITHUB_STEP_SUMMARY
@@ -208,12 +198,10 @@ jobs:
       - name: Download k6
         run: |
           curl https://github.com/grafana/k6/releases/download/${{ env.K6_VERSION }}/k6-${{ env.K6_VERSION }}-linux-amd64.tar.gz -L | tar xvz --strip-components 1
-      - name: Build
-        run: yarn run build:esm
       - name: Run
-        run: bun run benchmark/servers/bun.mjs &
+        run: bun run benchmark/servers/bun.ts &
       - name: Benchmark
-        run: ./k6 run benchmark/k6.mjs --summary-export summary.json
+        run: ./k6 run benchmark/k6.ts --summary-export summary.json
       - name: Summary
         run: |
           echo '```json' >> $GITHUB_STEP_SUMMARY
diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml
@@ -23,7 +23,7 @@ jobs:
       - name: Build
         run: yarn build:umd
       - name: Inject
-        run: node scripts/inject-audits-website.mjs
+        run: yarn tsx scripts/inject-audits-website.ts
       - name: Upload website
         uses: actions/upload-pages-artifact@v1
         with:
diff --git a/benchmark/k6.ts b/benchmark/k6.ts
@@ -1,14 +1,14 @@
 import { check, fail } from 'k6';
+import { Options } from 'k6/options';
 import { Counter, Trend } from 'k6/metrics';
-import http from 'k6/http';
+import http, { RefinedResponse } from 'k6/http';
 
 const port = parseInt(__ENV.PORT || '');
 if (isNaN(port)) {
   throw new Error('Missing PORT environment variable!');
 }
 
-/** @type {import("k6/options").Options} */
-export const options = {
+export const options: Options = {
   scenarios: {
     get: {
       executor: 'constant-vus',
@@ -27,8 +27,10 @@ export const options = {
   },
 };
 
-/** @type {Record<string, { runs: Counter, oks: Counter, duration: Trend }>} */
-const scenarioMetrics = {};
+const scenarioMetrics: Record<
+  string,
+  { runs: Counter; oks: Counter; duration: Trend }
+> = {};
 for (const scenario of Object.keys(options.scenarios || {})) {
   scenarioMetrics[scenario] = {
     runs: new Counter(`query_runs(${scenario})`),
@@ -47,8 +49,7 @@ export default function () {
   const begin = Date.now();
   metrics.runs.add(1);
 
-  /** @type {import("k6/http").RefinedResponse<'text'>} */
-  let res;
+  let res: RefinedResponse<'text'>;
   switch (scenario) {
     case 'get':
       res = http.get(`http://localhost:${port}/graphql?query={hello}`);
diff --git a/benchmark/schema.ts b/benchmark/schema.ts
diff --git a/benchmark/servers/bun.ts b/benchmark/servers/bun.ts
@@ -1,5 +1,5 @@
-import { createHandler } from '../../lib/use/fetch.mjs';
-import { schema } from '../schema.mjs';
+import { createHandler } from '../../src/use/fetch';
+import { schema } from '../schema';
 
 const port = parseInt(process.env.PORT || '');
 if (isNaN(port)) {
@@ -10,8 +10,7 @@ const handler = createHandler({ schema });
 
 export default {
   port,
-  /** @param {Request} req */
-  fetch(req) {
+  fetch(req: Request) {
     const [path, _search] = req.url.split('?');
     if (path.endsWith('/graphql')) {
       return handler(req);
diff --git a/benchmark/servers/deno.ts b/benchmark/servers/deno.ts
@@ -1,7 +1,9 @@
 // @ts-expect-error this is deno
 import { serve } from 'https://deno.land/std@0.190.0/http/server.ts';
+// @ts-expect-error this is deno
 import { createHandler } from '../../lib/use/fetch.mjs';
-import { schema } from '../schema.mjs';
+// @ts-expect-error this is deno
+import { schema } from '../schema.ts';
 
 const port = parseInt(
   // @ts-expect-error this is deno
diff --git a/benchmark/servers/express.ts b/benchmark/servers/express.ts
@@ -1,6 +1,6 @@
 import express from 'express';
-import { createHandler } from '../../lib/use/express.mjs';
-import { schema } from '../schema.mjs';
+import { createHandler } from '../../src/use/express';
+import { schema } from '../schema';
 
 const port = parseInt(process.env.PORT || '');
 if (isNaN(port)) {
diff --git a/benchmark/servers/fastify.ts b/benchmark/servers/fastify.ts
@@ -1,6 +1,6 @@
 import Fastify from 'fastify';
-import { createHandler } from '../../lib/use/fastify.mjs';
-import { schema } from '../schema.mjs';
+import { createHandler } from '../../src/use/fastify';
+import { schema } from '../schema';
 
 const port = parseInt(process.env.PORT || '');
 if (isNaN(port)) {
diff --git a/benchmark/servers/http.ts b/benchmark/servers/http.ts
@@ -1,6 +1,6 @@
 import http from 'http';
-import { schema } from '../schema.mjs';
-import { createHandler } from '../../lib/use/http.mjs';
+import { schema } from '../schema';
+import { createHandler } from '../../src/use/http';
 
 const port = parseInt(process.env.PORT || '');
 if (isNaN(port)) {
diff --git a/benchmark/servers/koa.ts b/benchmark/servers/koa.ts
@@ -1,7 +1,7 @@
 import Koa from 'koa';
 import mount from 'koa-mount';
-import { createHandler } from '../../lib/use/koa.mjs';
-import { schema } from '../schema.mjs';
+import { createHandler } from '../../src/use/koa';
+import { schema } from '../schema';
 
 const port = parseInt(process.env.PORT || '');
 if (isNaN(port)) {
diff --git a/benchmark/servers/uWebSockets.ts b/benchmark/servers/uWebSockets.ts
@@ -1,6 +1,6 @@
 import uWS from 'uWebSockets.js';
-import { createHandler } from '../../lib/use/uWebSockets.mjs';
-import { schema } from '../schema.mjs';
+import { createHandler } from '../../src/use/uWebSockets';
+import { schema } from '../schema';
 
 const port = parseInt(process.env.PORT || '');
 if (isNaN(port)) {
diff --git a/package.json b/package.json
@@ -96,7 +96,7 @@
     "check:lint": "eslint 'src'",
     "check:type": "tsc --noEmit",
     "test": "NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 jest",
-    "build:esm": "tsc -b tsconfig.esm.json && node scripts/esm-post-process.mjs",
+    "build:esm": "tsc -b tsconfig.esm.json && tsx scripts/esm-post-process.ts",
     "build:cjs": "tsc -b tsconfig.cjs.json",
     "build:umd": "rollup --configPlugin typescript --config rollup.config.ts",
     "build": "yarn build:esm && yarn build:cjs && yarn build:umd",
@@ -150,6 +150,7 @@
     "rollup-plugin-gzip": "^3.1.0",
     "semantic-release": "^21.0.7",
     "tslib": "^2.6.0",
+    "tsx": "^3.12.7",
     "typedoc": "^0.24.8",
     "typedoc-plugin-markdown": "^3.15.3",
     "typescript": "^5.1.6",
diff --git a/scripts/audit-implementation.ts b/scripts/audit-implementation.ts
@@ -7,8 +7,7 @@
  * Usage example from root of project:
  *
  * ```sh
- * yarn build:esm
- * PORT=4000 node scripts/audit-implementation.mjs [reportsDir]
+ * PORT=4000 yarn tsx scripts/audit-implementation.mjs [reportsDir]
  * ```
  *
  * Note that graphql-http has to be built before running this script!
@@ -19,7 +18,7 @@ import os from 'os';
 import fetch from 'node-fetch';
 import fs from 'fs/promises';
 import path from 'path';
-import { auditServer, renderAuditResultsToHTML } from '../lib/index.mjs';
+import { auditServer, renderAuditResultsToHTML } from '../src';
 
 async function main() {
   const serverUrl = new URL(
diff --git a/scripts/esm-post-process.ts b/scripts/esm-post-process.ts
@@ -25,10 +25,7 @@ const rootDir = 'lib';
   // we dont delete raw d.ts files, they're still needed for imports/exports
 })();
 
-/**
- * @param {string} filePath
- */
-async function buildEsm(filePath) {
+async function buildEsm(filePath: string) {
   const pathParts = filePath.split('.');
   const fileExt = pathParts.pop();
 
diff --git a/scripts/inject-audits-website.ts b/scripts/inject-audits-website.ts
diff --git a/scripts/render-servers-table.ts b/scripts/render-servers-table.ts
@@ -23,14 +23,12 @@ main().catch((err) => {
   process.exit(1);
 });
 
-/** @param {string} implsDir */
-async function renderTable(implsDir) {
+async function renderTable(implsDir: string) {
   let out = `<!-- prettier-ignore-start -->
 | Name | Audit |
 |------|-------|`;
   for (const implDir of (await fs.readdir(implsDir)).sort()) {
-    /** @type {{ error: number }} */
-    const report = JSON.parse(
+    const report: { error: number } = JSON.parse(
       (
         await fs.readFile(path.join(implsDir, implDir, 'report.json'))
       ).toString(),
@@ -39,8 +37,7 @@ async function renderTable(implsDir) {
       continue;
     }
 
-    /** @type {Record<string, unknown>} */
-    const pkg = JSON.parse(
+    const pkg: Record<string, unknown> = JSON.parse(
       (
         await fs.readFile(path.join(implsDir, implDir, 'package.json'))
       ).toString(),
diff --git a/yarn.lock b/yarn.lock
