bin/bootstrap.mjs

Functions

Imports

It imports no other module of this repo. No module of this repo imports it.

Source

1#!/usr/bin/env node
2// The install step every Worker repository runs as its postinstall: copy each wrangler*.jsonc.example at the root to its
3// real name once, never overwriting (a real config carrying live ids survives any number of reinstalls), then run
4// `wrangler types`. Since wrangler 4.135.0, `wrangler types` on a terminal asks whether to update Cloudflare skills, and
5// npm hides a lifecycle script's output, so the question is invisible and the install waits forever. Wrangler has no
6// switch for it; it skips the prompt when stdin is not a terminal. So node starts wrangler directly with stdin detached,
7// which behaves the same under cmd.exe, PowerShell and Linux CI.
8//
9//   devkit-bootstrap                         copy the examples, then wrangler types
10//   devkit-bootstrap -- --strict-vars=false  arguments after -- go to wrangler types
11//   devkit-bootstrap --types-only            wrangler types alone (a typecheck script)
12//   devkit-bootstrap --check                 fail if a package.json script runs a bare `wrangler types`, which hangs
13//
14// WRANGLER_ENTRY stands a stub in for wrangler (the tests).
15
16import { spawnSync } from "node:child_process";
17import { constants, copyFileSync, readFileSync, readdirSync, realpathSync } from "node:fs";
18import { createRequire } from "node:module";
19import { dirname, join } from "node:path";
20import { pathToFileURL } from "node:url";
21
22/** The examples at `root` whose real file is missing, as [example, target]. */
23export function missingConfigs(/** @type {string} */ root) {
24  const names = readdirSync(root);
25  return names
26    .filter((n) => /^wrangler[\w.-]*\.jsonc\.example$/.test(n) && !names.includes(n.slice(0, -".example".length)))
27    .map((n) => [n, n.slice(0, -".example".length)]);
28}
29
30/** The package.json scripts that run a bare `wrangler types`, as [name, command]. */
31export function bareTypes(/** @type {Record<string, string>} */ scripts) {
32  return Object.entries(scripts ?? {}).filter(([, command]) => /(^|[\s&|;])wrangler types\b/.test(String(command)));
33}
34
35function wranglerEntry(/** @type {string} */ root) {
36  if (process.env.WRANGLER_ENTRY) return process.env.WRANGLER_ENTRY;
37  // wrangler's "exports" hides bin/, so it is found through package.json's bin field.
38  const pkgPath = createRequire(join(root, "package.json")).resolve("wrangler/package.json");
39  const { bin } = JSON.parse(readFileSync(pkgPath, "utf8"));
40  return join(dirname(pkgPath), typeof bin === "string" ? bin : bin.wrangler);
41}
42
43function main() {
44  const root = process.cwd();
45  const argv = process.argv.slice(2);
46  const dash = argv.indexOf("--");
47  const own = dash >= 0 ? argv.slice(0, dash) : argv;
48
49  if (own.includes("--check")) {
50    const bare = bareTypes(JSON.parse(readFileSync(join(root, "package.json"), "utf8")).scripts);
51    for (const [name, command] of bare) console.error(`devkit-bootstrap: ${name} runs a bare \`wrangler types\` (${command}), which waits on a hidden prompt. Use devkit-bootstrap --types-only.`);
52    process.exit(bare.length ? 1 : 0);
53  }
54
55  if (!own.includes("--types-only")) {
56    for (const [example, target] of missingConfigs(root)) {
57      try {
58        copyFileSync(join(root, example), join(root, target), constants.COPYFILE_EXCL);
59        console.log(`devkit-bootstrap: created ${target} from ${example}. Fill in its placeholders before deploying or running against real resources.`);
60      } catch (error) {
61        if (/** @type {NodeJS.ErrnoException} */ (error).code !== "EEXIST") throw error;
62      }
63    }
64  }
65
66  const result = spawnSync(process.execPath, [wranglerEntry(root), "types", ...(dash >= 0 ? argv.slice(dash + 1) : [])], { cwd: root, stdio: ["ignore", "inherit", "inherit"] });
67  if (result.error) throw result.error;
68  process.exit(result.status ?? 1);
69}
70
71// Run through node_modules/.bin, argv[1] is the link and import.meta.url the file it points to.
72if (process.argv[1] && import.meta.url === pathToFileURL(realpathSync(process.argv[1])).href) main();