@dbx-tools/projen 0.9.32 → 0.9.36

package/src/dbx-tools-config.ts

@@ -1,11 +1,5 @@
-/**
- * In-memory `package.json` `dbxToolsConfig` record for a package.
- *
- * Values are read and written on the component's object; each write flushes the
- * record to the manifest through `project.package.addField`.
- */
-import { object } from "@dbx-tools/shared-core";
-import { Component, javascript } from "projen";
+/** Typed `package.json` `dbxToolsConfig` record for a package. */
+import { javascript } from "projen";
 
 /** `package.json` field name for the dbx-tools config object. */
 const DBX_TOOLS_CONFIG_KEY = "dbxToolsConfig";
@@ -16,70 +10,35 @@ export interface DBXToolsConfigOptions {
   readonly tags?: string[];
 }
 
-function readDBXToolsConfig(pkg: javascript.NodePackage): Record<string, unknown> {
-  try {
-    const manifest = pkg.manifest as unknown;
-    if (object.isRecord(manifest)) {
-      const config = manifest[DBX_TOOLS_CONFIG_KEY];
-      if (object.isRecord(config)) {
-        return config;
-      }
-    }
-  } catch {}
-  return {};
-}
-
-function loadConfig(dbxToolsConfig: DBXToolsConfig, pkg: javascript.NodePackage) {
-  const { tags, ...config } = readDBXToolsConfig(pkg);
-  if (Array.isArray(tags)) {
-    object
-      .sequence(tags)
-      .filter((v: unknown) => typeof v === "string")
-      .forEach((v: string) => dbxToolsConfig.tags.push(v));
-  }
-  Object.entries(config).forEach(([key, value]) => {
-    dbxToolsConfig[key] = value;
-  });
+interface DBXToolsConfigData {
+  readonly tags?: string[];
+  readonly packageRoots?: string[];
+  readonly syncResynthPaths?: string[];
 }
 
-/**
- * Owns a package's in-memory `dbxToolsConfig` object. Callers mutate it
- * directly - push to {@link DBXToolsConfig.tags}, or assign any other key
- * through the index signature. Every own key (i.e. not inherited from
- * `Component`) is collected by {@link DBXToolsConfig.data} and written through
- * `project.package.addField` at synth, so nothing is cached on a field.
- */
-export class DBXToolsConfig extends Component {
-  private readonly inheritedKeys: ReadonlySet<string>;
+/** Owns the typed in-memory `dbxToolsConfig` written to `package.json`. */
+export class DBXToolsConfig {
   readonly tags: string[];
-  [key: string]: unknown;
+  packageRoots?: string[];
+  syncResynthPaths?: string[];
 
   constructor(
-    override readonly project: javascript.NodeProject,
+    readonly project: javascript.NodeProject,
     options: DBXToolsConfigOptions = {},
   ) {
-    super(project);
-    this.inheritedKeys = new Set(Object.keys(this));
-    this.tags = [];
-    loadConfig(this, project.package);
-    options.tags?.forEach((v: string) => this.tags.push(v));
-  }
-
-  data(): Record<string, unknown> {
-    const dataRecord: Record<string, unknown> = {};
-    for (const [key, value] of Object.entries(this)) {
-      if (this.inheritedKeys.has(key)) continue;
-      dataRecord[key] = value;
-    }
-    dataRecord.tags = object.sequence(this.tags).distinct().toArray();
-    return dataRecord;
+    this.tags = [...(options.tags ?? [])];
+    project.package.addField(DBX_TOOLS_CONFIG_KEY, () => {
+      const data = this.data();
+      return Object.keys(data).length === 0 ? undefined : data;
+    });
   }
 
-  preSynthesize(): void {
-    let dataRecord: Record<string, unknown> | undefined = this.data();
-    if (object.isEmpty(dataRecord, { recursive: true })) {
-      dataRecord = undefined;
-    }
-    this.project.package.addField(DBX_TOOLS_CONFIG_KEY, dataRecord);
+  data(): DBXToolsConfigData {
+    const tags = [...new Set(this.tags)];
+    return {
+      ...(tags.length ? { tags } : {}),
+      ...(this.packageRoots?.length ? { packageRoots: this.packageRoots } : {}),
+      ...(this.syncResynthPaths?.length ? { syncResynthPaths: this.syncResynthPaths } : {}),
+    };
   }
 }

package/src/generated.ts

@@ -66,7 +66,13 @@ export function header(opts: HeaderOpts): string {
  */
 export function isGenerated(file: string): boolean {
   try {
-    return readFileSync(file, "utf8").startsWith(MARKER);
+    const source = readFileSync(file, "utf8");
+    return (
+      source.startsWith(MARKER) ||
+      source.startsWith("// ~~ Generated by projen") ||
+      source.startsWith("# ~~ Generated by projen") ||
+      /"\/\/"\s*:\s*"~~ Generated by projen/.test(source)
+    );
   } catch {
     return false;
   }

package/src/module-exports.ts

@@ -69,6 +69,7 @@ export interface PublicFunctionExport {
   readonly name: string;
   readonly sourceFile: string;
   readonly sourceName: string;
+  readonly async: boolean;
 }
 
 /** Declaration node types that are inherently type-only. */
@@ -149,10 +150,31 @@ export function moduleExports(file: string): ModuleExport[] {
  */
 export function publicFunctionExports(file: string): PublicFunctionExport[] {
   return [...collectPublicFunctions(resolve(file), new Set()).values()]
-    .map(({ name, sourceFile, sourceName }) => ({ name, sourceFile, sourceName }))
+    .map(({ name, sourceFile, sourceName, async }) => ({
+      name,
+      sourceFile,
+      sourceName,
+      async,
+    }))
     .sort((left, right) => left.name.localeCompare(right.name));
 }
 
+/** Names of namespace exports declared as `export * as name from "..."`. */
+export function publicNamespaceExports(file: string): string[] {
+  return moduleStatements(file)
+    .flatMap((statement) => {
+      if (statement.type !== "ExportAllDeclaration") return [];
+      const exported = (
+        statement as {
+          exported?: { name?: string; value?: string } | null;
+        }
+      ).exported;
+      const name = exported?.name ?? exported?.value;
+      return name ? [name] : [];
+    })
+    .sort((left, right) => left.localeCompare(right));
+}
+
 interface ResolvedFunctionExport extends PublicFunctionExport {
   readonly source: string;
 }
@@ -230,13 +252,15 @@ function collectPublicFunctions(
         const local = specifier.local?.name ?? specifier.local?.value;
         const exportedName = specifier.exported?.name ?? specifier.exported?.value;
         const target = local ? available.get(local) : undefined;
-        if (target && exportedName)
+        if (target && exportedName) {
           add({
             name: exportedName,
             source: target.source,
             sourceFile: target.sourceFile,
             sourceName: target.sourceName,
+            async: target.async,
           });
+        }
       }
       continue;
     }
@@ -252,6 +276,7 @@ function collectPublicFunctions(
           source: parsed.source,
           sourceFile: parsed.sourceFile,
           sourceName: parsed.sourceName,
+          async: parsed.async,
         });
       }
     }
@@ -267,6 +292,7 @@ interface FunctionNode {
   readonly generator?: boolean;
   readonly declare?: boolean;
   readonly body?: unknown;
+  readonly async?: boolean;
 }
 
 function parseFunctionNode(file: string, node: FunctionNode): ResolvedFunctionExport {
@@ -276,7 +302,13 @@ function parseFunctionNode(file: string, node: FunctionNode): ResolvedFunctionEx
   if (node.type === "TSDeclareFunction" || node.declare || !node.body) {
     throw new Error(`Declaration-only function export ${name} is not supported in ${file}`);
   }
-  return { name, source: `${file}#${name}`, sourceFile: file, sourceName: name };
+  return {
+    name,
+    source: `${file}#${name}`,
+    sourceFile: file,
+    sourceName: name,
+    async: node.async === true,
+  };
 }
 
 function resolveModuleSpecifier(importer: string, specifier: string): string {

package/src/openapi.ts

@@ -20,20 +20,11 @@
  * consuming workspace, which is where they already live. Speakeasy's `openapi`
  * binary is installed lazily through `@dbx-tools/core`'s binary cache.
  */
-import { execFile } from "node:child_process";
-import {
-  existsSync,
-  mkdirSync,
-  mkdtempSync,
-  readFileSync,
-  renameSync,
-  rmSync,
-  writeFileSync,
-} from "node:fs";
+import { mkdirSync, mkdtempSync, readFileSync, renameSync, rmSync, writeFileSync } from "node:fs";
 import { createRequire } from "node:module";
 import { isAbsolute, join, relative, resolve } from "node:path";
-import { promisify } from "node:util";
 import * as bin from "@dbx-tools/core/bin";
+import * as exec from "@dbx-tools/core/exec";
 import { find } from "@dbx-tools/path";
 import { log, object, stringUtils } from "@dbx-tools/shared-core";
 import type * as ts from "typescript";
@@ -46,7 +37,6 @@ import {
   toPosix,
   recordedPackages,
 } from "./packages.ts";
-import type { ReleaseUnitGraph } from "./release-catalog.ts";
 import { readWorkspaceVersion } from "./workspace-version.ts";
 
 const logger = log.logger("projen:openapi");
@@ -57,7 +47,6 @@ const OPENAPI_TAG = "openapi";
 const TSOA_IMPORT = /from\s+['"](?:tsoa|@tsoa\/runtime)['"]/;
 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);
 
 // prettier-ignore
 const CLIENT_SRC =
@@ -102,12 +91,6 @@ function inside(path: string, directory: string): boolean {
   return child === "" || (!child.startsWith("..") && !isAbsolute(child));
 }
 
-/** Whether one changed source belongs to any producing package directory. */
-export function isOpenapiProducerSource(path: string, producers: readonly string[]): boolean {
-  const absolute = resolve(path);
-  return object.sequence(producers).some((producer) => inside(absolute, producer));
-}
-
 /** Source roots consumed by TypeScript OpenAPI producers. */
 export function openapiWatchRoots(): string[] {
   return [
@@ -168,7 +151,10 @@ async function speakeasyOpenapiPath(): Promise<string> {
 /** Deduplicate inline schemas into `components.schemas` with Speakeasy. */
 export async function optimizeOpenapiSpec(specPath: string, executable?: string): Promise<void> {
   const openapi = executable ?? (await speakeasyOpenapiPath());
-  await execFileAsync(openapi, ["spec", "optimize", specPath, "--write", "--non-interactive"]);
+  await exec.spawn(openapi, ["spec", "optimize", specPath, "--write", "--non-interactive"], {
+    stdin: "ignore",
+    check: true,
+  });
 }
 
 type OpenApiTypeTools = {
@@ -234,28 +220,14 @@ export async function generateOpenapi(): Promise<string[]> {
           const runtime = lazyRequire<typeof ts>(require, "typescript", "openapi generation");
           return {
             generateSpec,
-            compilerOptions: {
-              experimentalDecorators: true,
-              target: runtime.ScriptTarget.ES2022,
-              module: runtime.ModuleKind.ESNext,
-              moduleResolution: runtime.ModuleResolutionKind.Bundler,
-              esModuleInterop: true,
-              skipLibCheck: true,
-            } satisfies ts.CompilerOptions,
+            runtime,
           };
         })()
       : undefined;
 
-  const releaseGraphPath = join(repoRoot, ".projen/release-units.json");
-  const releaseGraph = existsSync(releaseGraphPath)
-    ? (JSON.parse(readFileSync(releaseGraphPath, "utf8")) as ReleaseUnitGraph)
-    : undefined;
+  const version = readWorkspaceVersion(repoRoot);
   const written: string[] = [];
   for (const p of pkgs) {
-    const releaseProject = releaseGraph?.projects.find((project) => project.path === p.path);
-    const specVersion =
-      releaseGraph?.units.find((unit) => unit.id === releaseProject?.unit)?.version ??
-      readWorkspaceVersion(repoRoot);
     // The generated package's folder is the source's leaf folder name (`api`), not
     // its npm name - `p.name` is the (possibly-overridden) manifest name.
     const leaf = p.relPath.split("/").pop() ?? p.relPath;
@@ -268,6 +240,30 @@ export async function generateOpenapi(): Promise<string[]> {
     const tempDir = mkdtempSync(join(outDir, ".openapi-"));
     const tempSpecPath = join(tempDir, "openapi.json");
     try {
+      const tsconfigPath = join(p.dir, "tsconfig.json");
+      const config = typescript!.runtime.readConfigFile(
+        tsconfigPath,
+        typescript!.runtime.sys.readFile,
+      );
+      if (config.error) {
+        throw new Error(
+          typescript!.runtime.flattenDiagnosticMessageText(config.error.messageText, "\n"),
+        );
+      }
+      const parsed = typescript!.runtime.parseJsonConfigFileContent(
+        config.config,
+        typescript!.runtime.sys,
+        p.dir,
+      );
+      if (parsed.errors.length > 0) {
+        throw new Error(
+          parsed.errors
+            .map((error) =>
+              typescript!.runtime.flattenDiagnosticMessageText(error.messageText, "\n"),
+            )
+            .join("\n"),
+        );
+      }
       await typescript!.generateSpec(
         {
           entryFile: "",
@@ -277,9 +273,9 @@ export async function generateOpenapi(): Promise<string[]> {
           specFileBaseName: "openapi",
           specVersion: 3,
           name: `${p.relPath} API`,
-          version: specVersion,
+          version,
         },
-        typescript!.compilerOptions,
+        parsed.options,
       );
       await optimizeOpenapiSpec(tempSpecPath);
       makeWritable(specPath);

package/src/packages.ts

@@ -29,6 +29,7 @@ import * as projectUtils from "@dbx-tools/core/project-utils";
 import { find } from "@dbx-tools/path";
 import { json, object, stringUtils } from "@dbx-tools/shared-core";
 import { parse } from "yaml";
+import { isGenerated } from "./generated.ts";
 
 /** Resolve the nearest package/projenrc root at call time. */
 export function resolveRepoRoot(cwd: string = process.cwd()): string {
@@ -86,24 +87,9 @@ function nestingTagsFromSegments(segments: readonly string[]): string[] {
 /** Matches a barrel `index.<ext>` (as a basename or a posix path tail). */
 const BARREL_RE = /(^|\/)index\.(ts|tsx|js|jsx|mjs|cjs)$/;
 
-/** Basenames this toolchain generates (projen manifests/tsconfigs + bun app scaffolding). */
-const GENERATED_BASENAMES = new Set([
-  "package.json",
-  "tsconfig.json",
-  "tsconfig.dev.json",
-  "bunfig.toml",
-  "dev.ts",
-  "build.ts",
-]);
-
-/**
- * True if the file matches the watcher's generated-file heuristic: projen manifest
- * basenames, package-root barrels (`index.ts`), bun app scaffolding, or declaration
- * files. Other read-only toolchain output (e.g. openapi artifacts) is not covered here.
- */
+/** True when a durable generated-file marker identifies the file's owner. */
 export function isGeneratedFile(file: string): boolean {
-  const base = file.split(sep).pop() ?? "";
-  return GENERATED_BASENAMES.has(base) || BARREL_RE.test(base) || base.endsWith(".d.ts");
+  return isGenerated(file);
 }
 
 /** A re-exportable source module: ts/tsx/js/jsx/mjs/cjs, not a barrel/test/decl. */
@@ -291,19 +277,6 @@ export function syncResynthPaths(projectRoot: string = resolveRepoRoot()): strin
   return Array.isArray(paths) ? stringUtils.parseList(paths.map((p) => String(p))) : [];
 }
 
-/** Python projects with Node bindings registered for the root sync watcher. */
-export function pythonNodeBindingProjects(projectRoot: string = resolveRepoRoot()): string[] {
-  const configured = readDbxToolsConfig(projectRoot)?.pythonNodeBindings;
-  if (!Array.isArray(configured)) return [];
-  return [
-    ...new Set(
-      configured.flatMap((value) =>
-        typeof value === "string" && value.trim() ? [value.trim()] : [],
-      ),
-    ),
-  ].sort();
-}
-
 /**
  * The recorded workspace members from `pnpm-workspace.yaml` (the source of truth),
  * each augmented with the `tags` read back from its `package.json`. This is what

package/src/pnpm-workspace.ts

@@ -14,13 +14,11 @@
  *   `packages` straight through; nothing derives it from `project.subprojects`.
  *   The root's scan attaches packages AFTER construction, so the list is
  *   resolved in `preSynthesize`.
- * - **The catalog is accumulated.** pnpm's `catalog:` has no projen API at all,
- *   and tag mixins plus a consumer's `.projenrc.ts` add pins after construction.
+ * - **The catalog is accumulated.** Tag mixins and a consumer's `.projenrc.ts`
+ *   add pins after construction, after Projen has captured the options object.
  * - **Build allowances are the `allowBuilds` MAP.** projen's `allowScripts`
  *   renders `onlyBuiltDependencies`, and the pnpm this repo installs with (10.33)
- *   does not read that key at ALL - its only build gate is `allowBuilds`, which
- *   projen's schema does not type. Rendering the list would install with every
- *   build script silently skipped.
+ *   does not read that key at ALL - its only build gate is `allowBuilds`.
  *
  * Late mutation works because projen renders lazily (its `YamlFile` takes
  * `obj: () => toJson_PnpmWorkspaceYamlSchema(options)`) and because
@@ -44,16 +42,12 @@ import { BUN_VERSION } from "./bun-workflow.ts";
 import { toPosix } from "./packages.ts";
 
 /**
- * The pnpm `catalog:` version registry: dependency name -> version range. A
- * pnpm-workspace feature (packages reference it via a `catalog:` specifier), so
- * there is no projen type for it - it's just a string map.
+ * The pnpm `catalog:` version registry typed by Projen's workspace schema.
  */
-export type Catalog = Record<string, string>;
+export type Catalog = NonNullable<javascript.PnpmWorkspaceYamlOptions["catalog"]>;
 
 /**
- * pnpm's `allowBuilds`: dependency name -> may its install scripts run. Not in
- * projen's schema, whose build gate is the `onlyBuiltDependencies` LIST that
- * current pnpm ignores.
+ * Stronger local type for Projen's permissively typed `allowBuilds` field.
  */
 export type AllowBuilds = Record<string, boolean>;
 
@@ -80,13 +74,11 @@ const DEFAULT_CATALOG: Catalog = {
   // `@mastra/core`'s `^3.25.0 || ^4.0.0` peer range.
   zod: "4.3.6",
   typescript: "^5.9.3",
-  tsx: "^4.23.0",
   commander: "^15.0.0",
   "@clack/prompts": "^1.7.0",
   "openapi-fetch": "^0.17.0",
   tsoa: "^6.6.0",
   concurrently: "^10.0.3",
-  pnpm: "^11.0.6",
   "@databricks/appkit": "0.81.0",
   "@databricks/appkit-ui": "0.81.0",
   "@databricks/sdk-experimental": "^0.17.0",
@@ -125,7 +117,8 @@ const DEFAULT_OVERRIDES: Readonly<Record<string, string>> = {
 /**
  * pnpm settings this engine applies to every workspace, beyond members, catalog,
  * and allowances. Each is stated because pnpm's own default is the weaker choice
- * for a projen-managed monorepo; a caller's `workspaceYaml` overrides any.
+ * for a projen-managed monorepo; native `pnpmOptions.workspaceYamlOptions`
+ * override any.
  */
 const DEFAULT_WORKSPACE_YAML: javascript.PnpmWorkspaceYamlOptions = {
   // The catalog is GENERATED (`addCatalog` in `.projenrc.ts` / a tag mixin), so
@@ -150,8 +143,6 @@ export interface DBXToolsPNPMWorkspaceOptions {
   readonly catalog?: Catalog;
   /** Initial build allowances, merged over `{ esbuild: true }`. */
   readonly allowBuilds?: AllowBuilds;
-  /** Any other pnpm-workspace setting, typed by projen's schema. */
-  readonly workspaceYaml?: javascript.PnpmWorkspaceYamlOptions;
 }
 
 /**
@@ -167,25 +158,26 @@ export class PnpmWorkspaceState {
    * The options object handed to projen, whose members are mutated in place.
    * Held as the live reference the native component captured.
    *
-   * Widened with `allowBuilds`, which projen's schema type does not declare;
-   * projen renders unrecognized keys verbatim, so it reaches the file.
    */
-  readonly options: javascript.PnpmWorkspaceYamlOptions & { allowBuilds: AllowBuilds };
+  readonly options: javascript.PnpmWorkspaceYamlOptions;
 
   private readonly packages: string[] = [];
   private readonly catalog: Catalog;
   private readonly allowBuilds: AllowBuilds;
   private readonly overrides: Record<string, string>;
 
-  constructor(options: DBXToolsPNPMWorkspaceOptions = {}) {
+  constructor(
+    options: DBXToolsPNPMWorkspaceOptions & Pick<javascript.NodeProjectOptions, "pnpmOptions"> = {},
+  ) {
+    const workspaceOptions = options.pnpmOptions?.workspaceYamlOptions;
     this.catalog = { ...DEFAULT_CATALOG, ...options.catalog };
     this.allowBuilds = { ...DEFAULT_ALLOW_BUILDS, ...options.allowBuilds };
     // Seeded even when empty so `addOverride` has a reference projen already
     // captured; projen's `omitEmpty` drops the key while it stays empty.
-    this.overrides = { ...DEFAULT_OVERRIDES, ...options.workspaceYaml?.overrides };
+    this.overrides = { ...DEFAULT_OVERRIDES, ...workspaceOptions?.overrides };
     this.options = {
       ...DEFAULT_WORKSPACE_YAML,
-      ...options.workspaceYaml,
+      ...workspaceOptions,
       packages: this.packages,
       catalog: this.catalog,
       allowBuilds: this.allowBuilds,
@@ -238,8 +230,9 @@ export class PnpmWorkspaceState {
    * (e.g. a future projen that DOES create it under bun).
    */
   public attachWorkspaceFile(project: Project): void {
-    const exists = project.files.some((file) => file.path === "pnpm-workspace.yaml");
-    if (!exists) new javascript.PnpmWorkspaceYaml(project, this.options);
+    if (!javascript.PnpmWorkspaceYaml.of(project)) {
+      new javascript.PnpmWorkspaceYaml(project, this.options);
+    }
   }
 
   /**
@@ -280,7 +273,9 @@ export class PnpmWorkspaceState {
       pkg.addField("catalog", { ...this.catalog });
     }
     if (Object.keys(this.overrides).length > 0) {
-      pkg.addField("overrides", { ...this.overrides });
+      pkg.addPackageResolutions(
+        ...Object.entries(this.overrides).map(([name, version]) => `${name}@${version}`),
+      );
     }
     // projen renders bun's `trustedDependencies` from `allowedScripts`.
     const allowed = Object.entries(this.allowBuilds)