@paleo/workspace 0.22.0 → 0.23.0

package/dist/helpers.js

@@ -81,8 +81,8 @@ export function copyAndPatchFile(ctx, relPath, source, patchFn, label, force, op
     else {
         if (!existsSync(source.path)) {
             if (!optional) {
-                console.error(`Error: source ${source.path} not found. Bootstrap the main worktree first ` +
-                    "(`workspace setup`), provide a `source`, or mark the entry as optional.");
+                console.error(`Error: config source ${source.path} not found. Bootstrap it first ` +
+                    "(`workspace setup`, or commit the template), or mark the entry as optional.");
                 process.exit(1);
             }
             ctx.log(`Warning: source ${source.path} not found, skipping (optional).`);

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 export { runWorkspace } from "./workspace.js";
 export { defaultWorktreeDirName } from "./worktree.js";
 export type { WorktreeDirNameFn } from "./worktree.js";
-export type { WorkspaceConfig, SetupContext, FinalizeResult, SummaryContext, PatchContext, ConfigFileEntry, ConfigFileSource, ConfigFileSourceSpec, PurgeContext, } from "./workspace.js";
+export type { WorkspaceConfig, SetupContext, FinalizeResult, SummaryContext, PatchContext, ConfigFileEntry, ConfigFileSource, MainWorktreeConfigFileSource, NewWorktreeConfigFileSource, ContentConfigFileSource, PurgeContext, } from "./workspace.js";
 export { runDevServer } from "./dev-server.js";
 export type { DevServerConfig, DevServerSummaryContext, ServerDescriptor, ServerContext, SpawnServer, CallbackServer, } from "./dev-server.js";
 export type { ResolvedSlot } from "./slots.js";

package/dist/workspace.d.ts

@@ -1,3 +1,4 @@
+import { type ResolvedFileSource } from "./helpers.js";
 import { type SlotStatus } from "./slots.js";
 import { type WorktreeDirNameFn } from "./worktree.js";
 /** Configuration accepted by {@link runWorkspace}. */
@@ -32,7 +33,7 @@ export interface WorkspaceConfig {
      * Holds the setup log and dev-server logs.
      */
     runtimeDir: string;
-    /** Config files copied from the main worktree and patched per slot. */
+    /** Gitignored files seeded into each worktree (from main, a committed template, or content) and patched per slot. */
     configFiles: ConfigFileEntry[];
     /**
      * Runs before `configFiles` are copied. Use this to bootstrap source files the kernel expects
@@ -132,41 +133,37 @@ export interface PurgeContext {
     extra?: unknown;
     verbose: boolean;
 }
-/** A `{ path }` (relative to the main worktree) or `{ content }` (verbatim) initial source. */
-export type ConfigFileSourceSpec = {
-    path: string;
-} | {
-    content: string;
-};
-/**
- * Overrides where a {@link ConfigFileEntry}'s initial content comes from. Defaults to reading
- * `entry.path` from the main worktree.
- *
- * - `{ path }` — read this path (relative to the main worktree) instead of `entry.path`,
- *   e.g. seed from a committed example: `{ path: "packages/api/.env.local.example" }`.
- * - `{ content }` — use this string as the initial content verbatim.
- * - a callback returning either of the above, resolved per worktree with the same
- *   {@link PatchContext} the `patch` callback receives.
- */
-export type ConfigFileSource = ConfigFileSourceSpec | ((ctx: PatchContext) => ConfigFileSourceSpec);
-/** One config file seeded from its source (the main worktree by default) and patched per slot. */
+/** One config file seeded from its source and patched per slot. */
 export interface ConfigFileEntry {
     /** Path relative to the worktree root. Written to the current worktree. */
     path: string;
+    /** Where the initial content comes from. */
+    source: ConfigFileSource;
+    /** Rewrites the source content per slot. Omit to copy the content verbatim. */
+    patch?: (content: string, ctx: PatchContext) => string;
     /**
-     * Overrides the initial content's source. Defaults to reading `path` from the main worktree.
-     * Use this to seed from a committed example or supplied content instead. See {@link ConfigFileSource}.
-     */
-    source?: ConfigFileSource;
-    /** Returns the patched content given the source content and the slot's ports. */
-    patch: (content: string, ctx: PatchContext) => string;
-    /**
-     * When `true`, a missing `{ path }` source logs a warning and skips the entry.
-     * Default: required (missing source aborts setup). Bootstrap the main worktree first via
-     * `workspace setup`, or seed sources in `preSetup`. Ignored for `{ content }` sources.
+     * When `true`, a missing source file logs a warning and skips the entry instead of aborting.
+     * Applies to `mainWorktree` and `newWorktree` sources; ignored for `content`.
      */
     optional?: boolean;
 }
+/** Where a {@link ConfigFileEntry}'s initial content comes from. */
+export type ConfigFileSource = MainWorktreeConfigFileSource | NewWorktreeConfigFileSource | ContentConfigFileSource;
+/** Copies the gitignored file at the entry's `path` from the main worktree. */
+export interface MainWorktreeConfigFileSource {
+    kind: "mainWorktree";
+}
+/** Copies a committed template from the new worktree's own checkout. */
+export interface NewWorktreeConfigFileSource {
+    kind: "newWorktree";
+    /** Path of the template, relative to the worktree root (e.g. a committed `.example` file). */
+    path: string;
+}
+/** Uses the given content verbatim. The function form may be async. */
+export interface ContentConfigFileSource {
+    kind: "content";
+    content: string | (() => string | Promise<string>);
+}
 /** Context passed to {@link ConfigFileEntry.patch}. */
 export interface PatchContext {
     slot: number;
@@ -175,3 +172,4 @@ export interface PatchContext {
     currentWorktree: string;
 }
 export declare function runWorkspace(config: WorkspaceConfig): Promise<void>;
+export declare function resolveConfigSource(entry: ConfigFileEntry, ctx: PatchContext): Promise<ResolvedFileSource>;

package/dist/workspace.js

@@ -148,7 +148,7 @@ async function runSetup(command, ctx, run, config, registryDir) {
     }
     linkSharedDirectories(setupCtx, config.sharedDirs, verboseLog);
     linkWorkspaceRegistry(setupCtx, config.runtimeDir, verboseLog);
-    generateConfigFiles(setupCtx, config.configFiles, slot, ports, command.force, verboseLog);
+    await generateConfigFiles(setupCtx, config.configFiles, slot, ports, command.force, verboseLog);
     teeLog(config.printSummary({
         slot,
         branch,
@@ -701,7 +701,7 @@ function linkWorkspaceRegistry(ctx, runtimeDir, log, opts) {
     symlinkSync(relative(runtimeRoot, mainDir), link);
     log("Created workspace-registry symlink → main worktree.");
 }
-function generateConfigFiles(ctx, entries, slot, ports, force, log) {
+async function generateConfigFiles(ctx, entries, slot, ports, force, log) {
     for (const entry of entries) {
         const patchCtx = {
             slot,
@@ -709,17 +709,26 @@ function generateConfigFiles(ctx, entries, slot, ports, force, log) {
             mainWorktree: ctx.mainWorktree,
             currentWorktree: ctx.currentWorktree,
         };
-        copyAndPatchFile({ currentWorktree: ctx.currentWorktree, log }, entry.path, resolveConfigSource(entry, patchCtx), (content) => entry.patch(content, patchCtx), entry.path, force, entry.optional ?? false);
+        const { patch } = entry;
+        const patchFn = patch
+            ? (content) => patch(content, patchCtx)
+            : (content) => content;
+        copyAndPatchFile({ currentWorktree: ctx.currentWorktree, log }, entry.path, await resolveConfigSource(entry, patchCtx), patchFn, entry.path, force, entry.optional ?? false);
+    }
+}
+export async function resolveConfigSource(entry, ctx) {
+    const { source } = entry;
+    switch (source.kind) {
+        case "mainWorktree":
+            return { path: join(ctx.mainWorktree, entry.path) };
+        case "newWorktree":
+            return { path: join(ctx.currentWorktree, source.path) };
+        case "content":
+            return {
+                content: typeof source.content === "function" ? await source.content() : source.content,
+            };
     }
 }
-function resolveConfigSource(entry, ctx) {
-    const spec = typeof entry.source === "function" ? entry.source(ctx) : entry.source;
-    if (spec === undefined)
-        return { path: join(ctx.mainWorktree, entry.path) };
-    if ("content" in spec)
-        return { content: spec.content };
-    return { path: join(ctx.mainWorktree, spec.path) };
-}
 function resolveRemoveTarget(command, ctx, registry) {
     if (command.branch === undefined) {
         if (ctx.isMainWorktree) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paleo/workspace",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "description": "Run multiple git-worktree dev environments side by side.",
   "keywords": [
     "workspace",