build: add a script for publishing to npm

Sets up a script that we can use to publish to npm so that we don't have to remember the steps.

Author: crisbeto

README.md

@@ -132,7 +132,8 @@ If you've cloned this repo and want to work on the tool, you have to install its
 running `pnpm install`.
 Once they're installed, you can run the following commands:
 
-* `pnpm run release-build` - Builds the package in the `dist` directory for publishing to npm.
+* `pnpm run release-build` - Creates a release build of the package in `dist` directory.
+* `pnpm run npm-publish` - Builds the package and publishes it to npm.
 * `pnpm run eval` - Runs an eval from source.
 * `pnpm run report` - Runs the report app from source.
 * `pnpm run init` - Runs the init script from source.

package.json

@@ -3,7 +3,8 @@
   "version": "0.0.5",
   "scripts": {
     "build-runner": "tsc",
-    "release-build": "tsx release-build.ts",
+    "release-build": "tsx ./scripts/release-build.ts",
+    "npm-publish": "tsx ./scripts/npm-publish.ts",
     "web-codegen-scorer": "tsx ./runner/bin/cli.ts",
     "wcs": "pnpm -s web-codegen-scorer",
     "eval": "pnpm web-codegen-scorer eval",
@@ -92,4 +93,4 @@
     "prettier": "^3.5.3",
     "tsx": "^4.20.3"
   }
-}
+}

scripts/npm-publish.ts

@@ -0,0 +1,73 @@
+import { join } from 'path';
+import { spawn } from 'child_process';
+import { input } from '@inquirer/prompts';
+import { executeCommand } from '../runner/utils/exec.js';
+import { readFile, writeFile } from 'fs/promises';
+
+const root = join(import.meta.dirname, '..');
+const distDirectory = join(root, 'dist');
+const packageJsonPath = join(root, 'package.json');
+const registry = 'https://wombat-dressing-room.appspot.com';
+
+(async () => {
+  try {
+    const packageJson = JSON.parse(await readFile(packageJsonPath, 'utf8')) as {
+      version: string;
+    };
+
+    const version = await input({
+      message: `Which version would you like to publish? Current version is ${packageJson.version}`,
+      required: true,
+    });
+
+    // Build the project.
+    await executeCommand(
+      `pnpm release-build --version=${version}`,
+      root,
+      undefined,
+      {
+        forwardStdoutToParent: true,
+        forwardStderrToParent: true,
+      }
+    );
+
+    // Log into our registry.
+    await spawnInteractive('npm', ['login', '--registry', registry]);
+
+    // Publish to npm.
+    await executeCommand(
+      `npm --registry ${registry} publish --access public --tag latest`,
+      distDirectory,
+      undefined,
+      {
+        forwardStderrToParent: true,
+        forwardStdoutToParent: true,
+      }
+    );
+
+    // Write the package.json back to disk so the version is in sync.
+    packageJson.version = version;
+    await writeFile(packageJsonPath, JSON.stringify(packageJson, undefined, 2));
+
+    console.log('Done! 🎉');
+    console.log('Remember to push the changed package.json!');
+  } catch (e: unknown) {
+    // If the user presses ctrl + c, Inquirer will throw `ExitPromptError`. Ignore it.
+    if (!(e instanceof Error) || e.name !== 'ExitPromptError') {
+      throw e;
+    }
+  }
+})();
+
+function spawnInteractive(command: string, args: string[]) {
+  return new Promise<void>((resolve, reject) => {
+    const childProcess = spawn(command, args, {
+      shell: true,
+      stdio: 'inherit',
+    });
+
+    childProcess.on('close', (status) =>
+      status === 0 ? resolve() : reject(status)
+    );
+  });
+}

release-build.ts renamed to scripts/release-build.ts

@@ -1,23 +1,27 @@
-/// <reference types="node"/>
 import { join } from 'path';
 import { rm, cp, readFile, writeFile } from 'fs/promises';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { globSync as glob } from 'tinyglobby';
-import { executeCommand } from './runner/utils/exec.js';
+import { executeCommand } from '../runner/utils/exec.js';
 
-const root = import.meta.dirname;
+const root = join(import.meta.dirname, '..');
 const runnerSource = join(root, 'runner');
 const targetDirectory = join(root, 'dist');
 const reportAppSource = join(root, 'report-app');
 const reportAppDist = join(reportAppSource, 'dist');
 const browserAgentRelativePath = 'runner/testing/browser-agent';
 
 const args = yargs(hideBin(process.argv))
+  .version(false)
   .option('runner-only', {
     type: 'boolean',
     default: false,
   })
+  .option('version', {
+    type: 'string',
+    default: null,
+  })
   .parseSync();
 
 (async () => {
@@ -34,7 +38,7 @@ const args = yargs(hideBin(process.argv))
   // Generate the package.json.
   await writeFile(
     join(targetDirectory, 'package.json'),
-    await getPackageJson(join(root, 'package.json'))
+    await getPackageJson(join(root, 'package.json'), args.version)
   );
 
   // Copy the readme and license.
@@ -86,17 +90,29 @@ const args = yargs(hideBin(process.argv))
   }
 
   console.log(`Release output has been built in ${targetDirectory}`);
-
-  // TODO: also have `npm publish` here?
 })();
 
-async function getPackageJson(path: string): Promise<string> {
+async function getPackageJson(
+  path: string,
+  version: string | null
+): Promise<string> {
   const content = await readFile(path, 'utf8');
   const parsed = JSON.parse(content) as {
+    version: string;
     scripts?: unknown;
     devDependencies?: unknown;
   };
 
+  if (version) {
+    if (version === parsed.version) {
+      throw new Error(
+        `Specified version is the same version as the current one.`
+      );
+    } else {
+      parsed.version = version;
+    }
+  }
+
   // Delete some fields that aren't relevant for end users.
   delete parsed.scripts;
   delete parsed.devDependencies;

tsconfig.json

@@ -13,5 +13,5 @@
     "types": ["node"]
   },
   "include": ["runner/**/*.ts"],
-  "exclude": ["node_modules", "examples"]
+  "exclude": ["node_modules", "examples", "scripts"]
 }