@dbx-tools/projen 0.9.6 → 0.9.8

package/src/bun-app.ts

@@ -23,6 +23,7 @@
  * `src/`), they are outside the package's `tsconfig` include, so their `Bun.*`
  * usage never trips the `app` package's DOM-only `compile`.
  */
+import { stringUtils } from "@dbx-tools/shared-core";
 import { type Project, TextFile } from "projen";
 
 /** Unmanaged dev-server override module, merged over the generated options if present. */
@@ -90,34 +91,38 @@ export class BunfigFile extends TextFile {
 /** `dev.ts`: a `Bun.serve()` fullstack dev server with React HMR. */
 export class BunDevServerFile extends TextFile {
   constructor(project: Project) {
-    super(project, "dev.ts", {
-      marker: true,
-      readonly: true,
-      lines: String.raw`
-import { existsSync } from "node:fs";
-import index from "./index.html";
+    // prettier-ignore
+    const source = (
+      // ============================================================================
+      /*ts*/`
+      import { existsSync } from "node:fs";
+      import index from "./index.html";
 
-// Unmanaged override (${BUN_DEV_OVERRIDE}): its default export is merged over the
-// generated serve options - later wins - so a package tweaks the dev server
-// without editing this generated file.
-let options: Bun.ServeFunctionOptions<unknown, {}> = {
-  port: Number(process.env.PORT ?? 5173),
-  development: { hmr: true, console: true },
-  routes: { "/*": index },
-};
+      // Unmanaged override (${BUN_DEV_OVERRIDE}): its default export is merged over the
+      // generated serve options - later wins - so a package tweaks the dev server
+      // without editing this generated file.
+      let options: Bun.ServeFunctionOptions<unknown, {}> = {
+        port: Number(process.env.PORT ?? 5173),
+        development: { hmr: true, console: true },
+        routes: { "/*": index },
+      };
 
-const overrideUrl = new URL("./${BUN_DEV_OVERRIDE}", import.meta.url);
-if (existsSync(overrideUrl)) {
-  const mod = await import(overrideUrl.href);
-  const override = typeof mod.default === "function" ? await mod.default() : mod.default;
-  options = { ...options, ...override };
-}
+      const overrideUrl = new URL("./${BUN_DEV_OVERRIDE}", import.meta.url);
+      if (existsSync(overrideUrl)) {
+        const mod = await import(overrideUrl.href);
+        const override = typeof mod.default === "function" ? await mod.default() : mod.default;
+        options = { ...options, ...override };
+      }
 
-const server = Bun.serve(options);
-console.log("dev server running at " + server.url.href);
-`
-        .trimStart()
-        .split("\n"),
+      const server = Bun.serve(options);
+      console.log("dev server running at " + server.url.href);
+      `
+      // ============================================================================
+    );
+    super(project, "dev.ts", {
+      marker: true,
+      readonly: true,
+      lines: stringUtils.dedentLines(source, { trimEnd: false }),
     });
   }
 }
@@ -125,73 +130,79 @@ console.log("dev server running at " + server.url.href);
 /** `build.ts`: a `Bun.build()` production bundle (Tailwind via the plugin API). */
 export class BunBuildFile extends TextFile {
   constructor(project: Project) {
-    super(project, "build.ts", {
-      marker: true,
-      readonly: true,
-      lines: String.raw`
-import { existsSync } from "node:fs";
-import { cp, rm } from "node:fs/promises";
-import { basename } from "node:path";
-import tailwind from "bun-plugin-tailwind";
+    // Raw template preserves backslashes in generated regular expression literals.
+    // prettier-ignore
+    const source = (
+      String.raw
+      // ============================================================================
+      /*ts*/`
+      import { existsSync } from "node:fs";
+      import { cp, rm } from "node:fs/promises";
+      import { basename } from "node:path";
+      import tailwind from "bun-plugin-tailwind";
 
-// Unmanaged override (${BUN_BUILD_OVERRIDE}): its default export is merged over
-// the generated build options - later wins.
-let options: Bun.BuildConfig = {
-  entrypoints: ["./index.html"],
-  outdir: "./dist",
-  define: { "process.env.NODE_ENV": JSON.stringify("production") },
-  minify: true,
-  splitting: true,
-  publicPath: "/",
-  external: ["/fonts/*"],
-  sourcemap: "none",
-  plugins: [tailwind],
-};
+      // Unmanaged override (${BUN_BUILD_OVERRIDE}): its default export is merged over
+      // the generated build options - later wins.
+      let options: Bun.BuildConfig = {
+        entrypoints: ["./index.html"],
+        outdir: "./dist",
+        define: { "process.env.NODE_ENV": JSON.stringify("production") },
+        minify: true,
+        splitting: true,
+        publicPath: "/",
+        external: ["/fonts/*"],
+        sourcemap: "none",
+        plugins: [tailwind],
+      };
 
-const overrideUrl = new URL("./${BUN_BUILD_OVERRIDE}", import.meta.url);
-if (existsSync(overrideUrl)) {
-  const mod = await import(overrideUrl.href);
-  const override = typeof mod.default === "function" ? await mod.default() : mod.default;
-  options = { ...options, ...override, plugins: [...(options.plugins ?? []), ...(override.plugins ?? [])] };
-}
+      const overrideUrl = new URL("./${BUN_BUILD_OVERRIDE}", import.meta.url);
+      if (existsSync(overrideUrl)) {
+        const mod = await import(overrideUrl.href);
+        const override = typeof mod.default === "function" ? await mod.default() : mod.default;
+        options = { ...options, ...override, plugins: [...(options.plugins ?? []), ...(override.plugins ?? [])] };
+      }
 
-const outdir = options.outdir ?? "./dist";
-await rm(outdir, { recursive: true, force: true });
+      const outdir = options.outdir ?? "./dist";
+      await rm(outdir, { recursive: true, force: true });
 
-const result = await Bun.build(options);
-if (!result.success) {
-  for (const message of result.logs) console.error(message);
-  process.exit(1);
-}
+      const result = await Bun.build(options);
+      if (!result.success) {
+        for (const message of result.logs) console.error(message);
+        process.exit(1);
+      }
 
-// Fix a Bun bug: with \`splitting: true\` and an HTML entrypoint, the emitted
-// HTML's <script src> is wired to an arbitrary chunk instead of the JS
-// entry-point, so the app never boots (a blank page). Rewrite the HTML script
-// (and stylesheet) to the real entry-point outputs. No-op when they already
-// match (e.g. splitting off), so it is always safe to run.
-const htmlOut = result.outputs.find((o) => o.path.endsWith(".html"));
-const entryJs = result.outputs.find((o) => o.kind === "entry-point" && o.path.endsWith(".js"));
-const entryCss = result.outputs.find((o) => o.kind === "entry-point" && o.path.endsWith(".css"));
-if (htmlOut && entryJs) {
-  let html = await Bun.file(htmlOut.path).text();
-  const jsName = basename(entryJs.path);
-  html = html.replace(/(<script[^>]*\bsrc=")([^"]*\/)?[^"/]+\.js(")/i, "$1$2" + jsName + "$3");
-  if (entryCss) {
-    const cssName = basename(entryCss.path);
-    html = html.replace(/(<link[^>]*\bhref=")([^"]*\/)?[^"/]+\.css(")/i, "$1$2" + cssName + "$3");
-  }
-  await Bun.write(htmlOut.path, html);
-}
+      // Fix a Bun bug: with \`splitting: true\` and an HTML entrypoint, the emitted
+      // HTML's <script src> is wired to an arbitrary chunk instead of the JS
+      // entry-point, so the app never boots (a blank page). Rewrite the HTML script
+      // (and stylesheet) to the real entry-point outputs. No-op when they already
+      // match (e.g. splitting off), so it is always safe to run.
+      const htmlOut = result.outputs.find((o) => o.path.endsWith(".html"));
+      const entryJs = result.outputs.find((o) => o.kind === "entry-point" && o.path.endsWith(".js"));
+      const entryCss = result.outputs.find((o) => o.kind === "entry-point" && o.path.endsWith(".css"));
+      if (htmlOut && entryJs) {
+        let html = await Bun.file(htmlOut.path).text();
+        const jsName = basename(entryJs.path);
+        html = html.replace(/(<script[^>]*\bsrc=")([^"]*\/)?[^"/]+\.js(")/i, "$1$2" + jsName + "$3");
+        if (entryCss) {
+          const cssName = basename(entryCss.path);
+          html = html.replace(/(<link[^>]*\bhref=")([^"]*\/)?[^"/]+\.css(")/i, "$1$2" + cssName + "$3");
+        }
+        await Bun.write(htmlOut.path, html);
+      }
 
-const publicDir = "./public";
-if (existsSync(publicDir)) {
-  await cp(publicDir, outdir, { recursive: true });
-}
+      const publicDir = "./public";
+      if (existsSync(publicDir)) {
+        await cp(publicDir, outdir, { recursive: true });
+      }
 
-console.log("built " + result.outputs.length + " files to " + options.outdir);
-`
-        .trimStart()
-        .split("\n"),
+      console.log("built " + result.outputs.length + " files to " + options.outdir);
+      `
+      // ============================================================================
+    );
+    super(project, "build.ts", {
+      marker: true,
+      readonly: true,
+      lines: stringUtils.dedentLines(source, { trimEnd: false }),
     });
   }
 }

package/src/bun-workflow.ts

@@ -1,4 +1,5 @@
 /** Shared Bun setup and package-cache steps for generated workflows. */
+import { stringUtils } from "@dbx-tools/shared-core";
 import { TextFile, javascript } from "projen";
 
 export const BUN_VERSION = "1.3.14";
@@ -16,61 +17,68 @@ const DEFAULT_CACHE_IGNORE_PATHS = [
 
 function cacheKeyScript(extraIgnorePaths: readonly string[]): string {
   const ignorePaths = [...new Set(extraIgnorePaths)].sort();
-  return `#!/usr/bin/env node
-import { createHash } from "node:crypto";
-import { readdirSync, readFileSync } from "node:fs";
-import { join, sep } from "node:path";
+  // prettier-ignore
+  const source = (
+    // ============================================================================
+    /*js*/`
+  #!/usr/bin/env node
+  import { createHash } from "node:crypto";
+  import { readdirSync, readFileSync } from "node:fs";
+  import { join, sep } from "node:path";
 
-const root = process.cwd();
-const ignoredNames = new Set(${JSON.stringify(DEFAULT_CACHE_IGNORE_PATHS)});
-const ignoredPaths = new Set(${JSON.stringify(ignorePaths)});
-const manifests = [];
-const walk = (directory) => {
-  for (const entry of readdirSync(directory, { withFileTypes: true })) {
-    const path = join(directory, entry.name);
-    const relativePath = path.slice(root.length + 1).split(sep).join("/");
-    if (ignoredNames.has(entry.name) || ignoredPaths.has(relativePath)) continue;
-    if (entry.isDirectory()) walk(path);
-    else if (entry.name === "package.json") manifests.push(path);
-  }
-};
-walk(root);
+  const root = process.cwd();
+  const ignoredNames = new Set(${JSON.stringify(DEFAULT_CACHE_IGNORE_PATHS)});
+  const ignoredPaths = new Set(${JSON.stringify(ignorePaths)});
+  const manifests = [];
+  const walk = (directory) => {
+    for (const entry of readdirSync(directory, { withFileTypes: true })) {
+      const path = join(directory, entry.name);
+      const relativePath = path.slice(root.length + 1).split(sep).join("/");
+      if (ignoredNames.has(entry.name) || ignoredPaths.has(relativePath)) continue;
+      if (entry.isDirectory()) walk(path);
+      else if (entry.name === "package.json") manifests.push(path);
+    }
+  };
+  walk(root);
 
-const dependencyFields = [
-  "catalog",
-  "dependencies",
-  "devDependencies",
-  "optionalDependencies",
-  "overrides",
-  "peerDependencies",
-  "peerDependenciesMeta",
-  "resolutions",
-  "trustedDependencies",
-];
-const canonical = (value) => {
-  if (Array.isArray(value)) return value.map(canonical);
-  if (!value || typeof value !== "object") return value;
-  return Object.fromEntries(
-    Object.entries(value)
-      .sort(([left], [right]) => left.localeCompare(right))
-      .map(([key, child]) => [key, canonical(child)]),
+  const dependencyFields = [
+    "catalog",
+    "dependencies",
+    "devDependencies",
+    "optionalDependencies",
+    "overrides",
+    "peerDependencies",
+    "peerDependenciesMeta",
+    "resolutions",
+    "trustedDependencies",
+  ];
+  const canonical = (value) => {
+    if (Array.isArray(value)) return value.map(canonical);
+    if (!value || typeof value !== "object") return value;
+    return Object.fromEntries(
+      Object.entries(value)
+        .sort(([left], [right]) => left.localeCompare(right))
+        .map(([key, child]) => [key, canonical(child)]),
+    );
+  };
+  const dependencies = manifests
+    .sort()
+    .map((path) => {
+      const manifest = JSON.parse(readFileSync(path, "utf8"));
+      return [
+        path.slice(root.length + 1),
+        Object.fromEntries(
+          dependencyFields
+            .filter((field) => manifest[field] !== undefined)
+            .map((field) => [field, canonical(manifest[field])]),
+        ),
+      ];
+    });
+  process.stdout.write(createHash("sha256").update(JSON.stringify(dependencies)).digest("hex"));
+  `
+    // ============================================================================
   );
-};
-const dependencies = manifests
-  .sort()
-  .map((path) => {
-    const manifest = JSON.parse(readFileSync(path, "utf8"));
-    return [
-      path.slice(root.length + 1),
-      Object.fromEntries(
-        dependencyFields
-          .filter((field) => manifest[field] !== undefined)
-          .map((field) => [field, canonical(manifest[field])]),
-      ),
-    ];
-  });
-process.stdout.write(createHash("sha256").update(JSON.stringify(dependencies)).digest("hex"));
-`;
+  return stringUtils.dedent(source, { trimEnd: false });
 }
 
 const configured = new WeakMap<javascript.NodeProject, string>();

package/src/openapi.ts

@@ -37,7 +37,7 @@ import { join } from "node:path";
 import { promisify } from "node:util";
 import * as bin from "@dbx-tools/core/bin";
 import { find } from "@dbx-tools/path";
-import { log } from "@dbx-tools/shared-core";
+import { log, stringUtils } from "@dbx-tools/shared-core";
 import type * as ts from "typescript";
 import { lazyRequire } from "./_lazy-require.ts";
 import { makeReadonly, makeWritable, stampGenerated } from "./generated.ts";
@@ -61,14 +61,21 @@ const SPEAKEASY_OPENAPI_VERSION = "1.24.0";
 const SPEAKEASY_OPENAPI_RELEASE_URL = `https://github.com/speakeasy-api/openapi/releases/download/v${SPEAKEASY_OPENAPI_VERSION}`;
 const execFileAsync = promisify(execFile);
 
-const CLIENT_SRC = `import createClient, { type ClientOptions } from "openapi-fetch";
-import type { paths } from "./schema";
+// prettier-ignore
+const CLIENT_TEMPLATE = (
+  // ============================================================================
+  /*ts*/`
+  import createClient, { type ClientOptions } from "openapi-fetch";
+  import type { paths } from "./schema";
 
-/** Create a typed OpenAPI client (openapi-fetch); safe to use in the browser. */
-export function createApiClient(options?: ClientOptions) {
-  return createClient<paths>(options);
-}
-`;
+  /** Create a typed OpenAPI client (openapi-fetch); safe to use in the browser. */
+  export function createApiClient(options?: ClientOptions) {
+    return createClient<paths>(options);
+  }
+  `
+  // ============================================================================
+);
+const CLIENT_SRC = stringUtils.dedent(CLIENT_TEMPLATE, { trimEnd: false });
 
 /** True if any module file in `<pkg>/src` matches {@link TSOA_IMPORT}. */
 function hasTsoaControllers(pkg: Pick<RecordedPackage, "dir">): boolean {

package/src/project-py.ts

@@ -766,23 +766,28 @@ export class DBXToolsPythonWorkspace extends Component {
     ];
     const helper = ".projen/pypi-trusted-publisher-instructions.mjs";
     new TextFile(project.root, helper, {
-      lines: [
-        "#!/usr/bin/env node",
-        'import { parseArgs } from "node:util";',
-        "",
-        "const { values } = parseArgs({",
-        '  options: { secretFile: { type: "string" } },',
-        "});",
-        `const beforeAuthentication = ${JSON.stringify(linesBeforeAuthentication)};`,
-        `const afterAuthentication = ${JSON.stringify(linesAfterAuthentication)};`,
-        "const authentication = values.secretFile",
-        "  ? [",
-        "      `- If browser authentication is required, read credentials from ${values.secretFile} directly into the browser without printing, logging, or exposing secret values.`,",
-        "      `- If ${values.secretFile} is absent, invalid, or insufficient for authentication, pause and ask the user to complete authentication.`,",
-        "    ]",
-        '  : ["- If browser authentication is required, pause and ask the user to complete authentication."];',
-        'process.stdout.write(`${[...beforeAuthentication, ...authentication, ...afterAuthentication].join("\\n").trimEnd()}\\n`);',
-      ],
+      // prettier-ignore
+      lines: stringUtils.dedent(
+        // ============================================================================
+        /*js*/`
+          #!/usr/bin/env node
+          import { parseArgs } from "node:util";
+
+          const { values } = parseArgs({
+            options: { secretFile: { type: "string" } },
+          });
+          const beforeAuthentication = ${JSON.stringify(linesBeforeAuthentication)};
+          const afterAuthentication = ${JSON.stringify(linesAfterAuthentication)};
+          const authentication = values.secretFile
+            ? [
+                \`- If browser authentication is required, read credentials from \${values.secretFile} directly into the browser without printing, logging, or exposing secret values.\`,
+                \`- If \${values.secretFile} is absent, invalid, or insufficient for authentication, pause and ask the user to complete authentication.\`,
+              ]
+            : ["- If browser authentication is required, pause and ask the user to complete authentication."];
+          process.stdout.write(\`\${[...beforeAuthentication, ...authentication, ...afterAuthentication].join("\\n").trimEnd()}\\n\`);
+        `
+        // ============================================================================
+      ).split("\n"),
     });
     project.root.addTask("pypiTrustedPublisherInstructions", {
       description: "Print system-browser instructions for PyPI trusted publishers",

package/src/project-rs.ts

@@ -289,9 +289,11 @@ export interface RustReleaseBinaryMapping {
   readonly command: string;
   readonly description: string;
   readonly binaryName: string;
+  readonly hidden: boolean;
   readonly unit: string;
   readonly component: string;
   readonly version: string;
+  readonly tagPrefix: string;
   readonly tag: string;
   readonly repository: string;
   readonly assets: readonly RustReleaseBinaryAssetMapping[];
@@ -379,17 +381,40 @@ function planRustReleaseBinaries(
   resolved: ResolvedRustWorkspaceOptions,
 ): RustReleaseBinaryMapping[] {
   const commands = new Set<string>();
-  const binaries = packages
-    .filter((pkg) => Boolean(pkg.packageOptions.cli))
-    .map((pkg) => {
-      if (!pkg.packageOptions.release) {
+  const binaries = packages.flatMap((pkg) => {
+    const configuredBinaries = [
+      ...(pkg.packageOptions.cli
+        ? [
+            {
+              name: pkg.packageOptions.binaryName ?? pkg.crateName,
+              defaultCommand: pkg.packageOptions.directory,
+              description: pkg.packageOptions.description,
+              release: pkg.packageOptions.release,
+              excludedOs: pkg.packageOptions.releaseExcludeOs,
+              cli: pkg.packageOptions.cli,
+            },
+          ]
+        : []),
+      ...(pkg.packageOptions.binaries ?? [])
+        .filter((binary) => Boolean(binary.cli))
+        .map((binary) => ({
+          name: binary.name,
+          defaultCommand: binary.name,
+          description: binary.description ?? pkg.packageOptions.description,
+          release: binary.release,
+          excludedOs: binary.releaseExcludeOs,
+          cli: binary.cli!,
+        })),
+    ];
+    return configuredBinaries.map((binary) => {
+      if (!binary.release) {
         throw new Error(`${pkg.crateName} must set release when cli is configured`);
       }
-      const configured = pkg.packageOptions.cli;
+      const configured = binary.cli;
       const command =
         typeof configured === "object" && configured.command
           ? configured.command
-          : pkg.packageOptions.directory;
+          : binary.defaultCommand;
       if (!/^[a-z0-9][a-z0-9-]*$/.test(command)) {
         throw new Error(`Invalid Rust CLI command: ${command}`);
       }
@@ -399,24 +424,31 @@ function planRustReleaseBinaries(
       commands.add(command);
       const description =
         (typeof configured === "object" ? configured.description : undefined) ??
-        pkg.packageOptions.description ??
+        binary.description ??
         pkg.crateName;
-      const excludedOs = new Set(pkg.packageOptions.releaseExcludeOs ?? []);
-      const binaryName = pkg.packageOptions.binaryName ?? pkg.crateName;
+      const hidden = typeof configured === "object" && configured.hidden === true;
+      const excludedOs = new Set(binary.excludedOs ?? []);
+      const binaryName = binary.name;
       const identity = isDBXToolsJavaScriptProject()(project)
         ? project.releaseCatalog.releaseIdentityFor(pkg)
         : {
             component: defaultReleaseUnitId("rust", pkg.crateName),
             version: readWorkspaceVersion(project.outdir),
           };
+      const tagPrefix =
+        isDBXToolsJavaScriptProject()(project) && project.releaseCatalog.mode === "independent"
+          ? `${identity.component}-v`
+          : "v";
       return {
         command,
         description,
         binaryName,
+        hidden,
         unit: "id" in identity ? identity.id : identity.component,
         component: identity.component,
         version: identity.version,
-        tag: `${identity.component}-v${identity.version}`,
+        tagPrefix,
+        tag: `${tagPrefix}${identity.version}`,
         repository: resolved.repository,
         assets: resolved.nativeTargets
           .filter((target) => !excludedOs.has(target.os))
@@ -427,6 +459,7 @@ function planRustReleaseBinaries(
           })),
       };
     });
+  });
   if (binaries.length && !resolved.repository) {
     throw new Error("A repository URL is required when Rust CLI commands are configured");
   }
@@ -894,6 +927,10 @@ export class DBXToolsRustWorkspace extends Component {
           identity: pkg.crateName,
           publish: !pkg.packageOptions.private || pkg.packageOptions.release === true,
           sourcePaths: [`${toPosix(relative(project.outdir, pkg.outdir))}/src`],
+        });
+      }
+      for (const pkg of this.packages) {
+        project.releaseCatalog.configureProject(pkg, {
           dependencies: [
             ...rustReleaseDependencies(
               project,
@@ -921,7 +958,7 @@ export class DBXToolsRustWorkspace extends Component {
     if (isDBXToolsJavaScriptProject()(project)) {
       for (const binary of this.releaseBinaries) {
         project.releaseCatalog.registerArtifact(binary.unit, {
-          id: `${binary.unit}:github-binary`,
+          id: `${binary.unit}:github-binary:${binary.binaryName}`,
           kind: "github-binary",
           name: binary.binaryName,
           generated: true,

package/src/release-catalog.ts

@@ -311,7 +311,10 @@ export class DBXToolsReleaseCatalog extends Component {
   /** Replace grouping metadata for an already registered project. */
   configureProject(
     project: Project,
-    options: Pick<ReleaseProjectRegistration, "unit" | "component" | "publish" | "sourcePaths">,
+    options: Pick<
+      ReleaseProjectRegistration,
+      "unit" | "component" | "publish" | "sourcePaths" | "dependencies"
+    >,
   ): void {
     const current = this.projects.get(project);
     if (!current) throw new Error(`Release project is not registered: ${project.outdir}`);