@plexus-ms/lib 0.0.0-stage → 0.1.0

package/dist/context.d.ts

@@ -0,0 +1,41 @@
+import { type DirEntry, type ExecOptions, type Io } from './io.ts';
+import { type Plan } from './plan.ts';
+export interface Options {
+    dryRun?: boolean;
+    /** 0: every effect; 1: reads and inputs too; 2: subprocess output too. */
+    verbose?: number;
+    quiet?: boolean;
+    yes?: boolean;
+    json?: boolean;
+}
+export declare class Context {
+    readonly dryRun: boolean;
+    readonly verbose: number;
+    readonly quiet: boolean;
+    readonly yes: boolean;
+    readonly json: boolean;
+    readonly io: Io;
+    constructor(options: Options, io?: Io);
+    /** One line, if the verbosity allows the level (0 normal, 1 verbose, 2 debug). */
+    say(line: string, level?: number): void;
+    /** A final outcome line, `✓ ...` or `✗ ...`; shown even under --quiet. */
+    done(line: string, ok?: boolean): void;
+    /**
+     * The command's product. `data` is what --json prints; `human` renders it
+     * otherwise (default: strings as they are, arrays one item per line).
+     */
+    result<T>(data: T, human?: (data: T) => string): void;
+    /** Run a command for its output. Changes nothing; narrated only when verbose. */
+    read(command: string, args?: string[], options?: Omit<ExecOptions, 'inherit'>): Promise<string>;
+    readFile(path: string): Promise<string>;
+    readDir(path: string): Promise<DirEntry[]>;
+    /**
+     * Ask before applying. `--yes` and `--dry-run` answer yes; off a terminal
+     * without `--yes` the answer is an error, never a hang.
+     */
+    confirm(question: string): Promise<boolean>;
+    /** Narrate and perform each step in order; the first failure stops the run. */
+    apply(plan: Plan): Promise<void>;
+    private perform;
+}
+//# sourceMappingURL=context.d.ts.map

package/dist/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,WAAW,EAAE,KAAK,EAAE,EAAU,MAAM,SAAS,CAAC;AAC3E,OAAO,EAAkB,KAAK,IAAI,EAAa,MAAM,WAAW,CAAC;AAEjE,MAAM,WAAW,OAAO;IACtB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,0EAA0E;IAC1E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,qBAAa,OAAO;IAClB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC;gBAEJ,OAAO,EAAE,OAAO,EAAE,EAAE,GAAE,EAAa;IAW/C,kFAAkF;IAClF,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,SAAI,GAAG,IAAI;IAIlC,0EAA0E;IAC1E,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,UAAO,GAAG,IAAI;IAMnC;;;OAGG;IACH,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,GAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAoB,GAAG,IAAI;IAOlE,iFAAiF;IACjF,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,MAAM,EAAO,EAAE,OAAO,GAAE,IAAI,CAAC,WAAW,EAAE,SAAS,CAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAKvG,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAKvC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAO1C;;;OAGG;IACG,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IASjD,+EAA+E;IACzE,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAStC,OAAO,CAAC,OAAO;CAWhB"}

package/dist/context.js

@@ -0,0 +1,115 @@
+// The Context is what a verb runs in: the options, the injected Io, and the
+// three things a verb does with them.
+//
+//   read   look at the world; always performed, so a dry run sees real state
+//   apply  perform a Plan (plan.ts); every step is narrated with its exact
+//          shell line, and performed unless --dry-run
+//   result print the command's product: human-readable, or JSON under --json
+//
+// Plan, then confirm, then apply: validation and every read happen while
+// planning, so a failure there costs nothing, and by the time an effect runs
+// the verb knows the whole of what it is about to do. Narration goes to
+// stderr, results to stdout, so `plx <verb> | ...` composes like the script
+// it replaces. Conventions: compendium/miscellaneous/cli-design.md.
+import { realIo } from "./io.js";
+import { body, describe } from "./plan.js";
+export class Context {
+    dryRun;
+    verbose;
+    quiet;
+    yes;
+    json;
+    io;
+    constructor(options, io = realIo()) {
+        this.io = io;
+        this.dryRun = options.dryRun ?? false;
+        this.quiet = options.quiet ?? false;
+        this.verbose = this.quiet ? -1 : (options.verbose ?? 0);
+        this.yes = options.yes ?? false;
+        this.json = options.json ?? false;
+    }
+    // --- narration (stderr) ---------------------------------------------------
+    /** One line, if the verbosity allows the level (0 normal, 1 verbose, 2 debug). */
+    say(line, level = 0) {
+        if (this.verbose >= level)
+            this.io.stderr.write(`${line}\n`);
+    }
+    /** A final outcome line, `✓ ...` or `✗ ...`; shown even under --quiet. */
+    done(line, ok = true) {
+        this.io.stderr.write(`${ok ? '✓' : '✗'} ${line}\n`);
+    }
+    // --- results (stdout) -----------------------------------------------------
+    /**
+     * The command's product. `data` is what --json prints; `human` renders it
+     * otherwise (default: strings as they are, arrays one item per line).
+     */
+    result(data, human = renderHuman) {
+        const text = this.json ? JSON.stringify(data, null, 2) : human(data);
+        this.io.stdout.write(text.endsWith('\n') ? text : `${text}\n`);
+    }
+    // --- reads: always performed ---------------------------------------------
+    /** Run a command for its output. Changes nothing; narrated only when verbose. */
+    read(command, args = [], options = {}) {
+        this.say(`? ${describe({ kind: 'run', command, args, ...options })}`, 1);
+        return this.io.exec(command, args, options);
+    }
+    readFile(path) {
+        this.say(`? read ${path}`, 1);
+        return this.io.readFile(path);
+    }
+    readDir(path) {
+        this.say(`? list ${path}`, 2);
+        return this.io.readDir(path);
+    }
+    // --- effects: narrated always, performed unless --dry-run -----------------
+    /**
+     * Ask before applying. `--yes` and `--dry-run` answer yes; off a terminal
+     * without `--yes` the answer is an error, never a hang.
+     */
+    async confirm(question) {
+        if (this.yes || this.dryRun) {
+            this.say(`? ${question} yes (${this.yes ? '--yes' : '--dry-run'})`, 1);
+            return true;
+        }
+        if (!this.io.prompt)
+            throw new Error(`cannot ask "${question}" without a terminal; pass --yes`);
+        return this.io.prompt(question);
+    }
+    /** Narrate and perform each step in order; the first failure stops the run. */
+    async apply(plan) {
+        for (const step of plan) {
+            this.say(`${this.dryRun ? '[dry-run] ' : ''}${describe(step)}`);
+            const input = body(step);
+            if (input !== undefined)
+                this.say(indent(input), step.kind === 'write' ? 2 : 1);
+            if (!this.dryRun)
+                await this.perform(step);
+        }
+    }
+    perform(step) {
+        const inherit = this.verbose >= 2;
+        switch (step.kind) {
+            case 'run':
+                return this.io.exec(step.command, step.args, { cwd: step.cwd, input: step.input, inherit });
+            case 'ssh':
+                return this.io.exec('ssh', [step.host, 'bash', '-s'], { input: step.script, inherit });
+            case 'write':
+                return this.io.writeFile(step.path, step.content);
+        }
+    }
+}
+function renderHuman(data) {
+    if (typeof data === 'string')
+        return data;
+    if (Array.isArray(data))
+        return data.map(String).join('\n');
+    return JSON.stringify(data, null, 2);
+}
+function indent(text) {
+    return text
+        .trimEnd()
+        .split('\n')
+        .map((l) => `    ${l}`)
+        .join('\n');
+}
+//# sourceMappingURL=context.js.map

package/dist/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,sCAAsC;AACtC,EAAE;AACF,6EAA6E;AAC7E,2EAA2E;AAC3E,sDAAsD;AACtD,6EAA6E;AAC7E,EAAE;AACF,yEAAyE;AACzE,6EAA6E;AAC7E,wEAAwE;AACxE,4EAA4E;AAC5E,oEAAoE;AACpE,OAAO,EAA4C,MAAM,EAAE,MAAM,SAAS,CAAC;AAC3E,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAwB,MAAM,WAAW,CAAC;AAWjE,MAAM,OAAO,OAAO;IACT,MAAM,CAAU;IAChB,OAAO,CAAS;IAChB,KAAK,CAAU;IACf,GAAG,CAAU;IACb,IAAI,CAAU;IACd,EAAE,CAAK;IAEhB,YAAY,OAAgB,EAAE,KAAS,MAAM,EAAE;QAC7C,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,KAAK,CAAC;QACtC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC;QACpC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;QACxD,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,KAAK,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,KAAK,CAAC;IACpC,CAAC;IAED,6EAA6E;IAE7E,kFAAkF;IAClF,GAAG,CAAC,IAAY,EAAE,KAAK,GAAG,CAAC;QACzB,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK;YAAE,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC;IAC/D,CAAC;IAED,0EAA0E;IAC1E,IAAI,CAAC,IAAY,EAAE,EAAE,GAAG,IAAI;QAC1B,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,IAAI,CAAC,CAAC;IACtD,CAAC;IAED,6EAA6E;IAE7E;;;OAGG;IACH,MAAM,CAAI,IAAO,EAAE,QAA6B,WAAW;QACzD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACrE,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC;IACjE,CAAC;IAED,4EAA4E;IAE5E,iFAAiF;IACjF,IAAI,CAAC,OAAe,EAAE,OAAiB,EAAE,EAAE,UAAwC,EAAE;QACnF,IAAI,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QACzE,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED,QAAQ,CAAC,IAAY;QACnB,IAAI,CAAC,GAAG,CAAC,UAAU,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,OAAO,CAAC,IAAY;QAClB,IAAI,CAAC,GAAG,CAAC,UAAU,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,6EAA6E;IAE7E;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAC,QAAgB;QAC5B,IAAI,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAC5B,IAAI,CAAC,GAAG,CAAC,KAAK,QAAQ,SAAS,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,GAAG,EAAE,CAAC,CAAC,CAAC;YACvE,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,eAAe,QAAQ,kCAAkC,CAAC,CAAC;QAChG,OAAO,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IAED,+EAA+E;IAC/E,KAAK,CAAC,KAAK,CAAC,IAAU;QACpB,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;YACxB,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAChE,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;YACzB,IAAI,KAAK,KAAK,SAAS;gBAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAChF,IAAI,CAAC,IAAI,CAAC,MAAM;gBAAE,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IAEO,OAAO,CAAC,IAAU;QACxB,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC;QAClC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,KAAK;gBACR,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;YAC9F,KAAK,KAAK;gBACR,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;YACzF,KAAK,OAAO;gBACV,OAAO,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;CACF;AAED,SAAS,WAAW,CAAC,IAAa;IAChC,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IAC1C,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5D,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AACvC,CAAC;AAED,SAAS,MAAM,CAAC,IAAY;IAC1B,OAAO,IAAI;SACR,OAAO,EAAE;SACT,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;SACtB,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC"}

package/dist/copier.d.ts

@@ -0,0 +1,12 @@
+export declare const ANSWERS_FILE = ".copier-answers.yml";
+export declare const TEMPLATE_FILES: string[];
+export interface Answers {
+    /** The template's ref the project was last updated to, if recorded. */
+    commit?: string;
+    /** Where the template comes from, e.g. `gh:plexus-ms/preset-repo-web`. */
+    src?: string;
+    /** Every other answer, by question name. */
+    answers: Record<string, unknown>;
+}
+export declare function parseAnswers(text: string): Answers;
+//# sourceMappingURL=copier.d.ts.map

package/dist/copier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"copier.d.ts","sourceRoot":"","sources":["../src/copier.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,YAAY,wBAAwB,CAAC;AAClD,eAAO,MAAM,cAAc,UAAgC,CAAC;AAE5D,MAAM,WAAW,OAAO;IACtB,uEAAuE;IACvE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0EAA0E;IAC1E,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAUlD"}

package/dist/copier.js

@@ -0,0 +1,19 @@
+// Copier's bookkeeping in a generated project (§ 3 PLX-Updates): the answers
+// file records the template (`_src_path`) and the version it was last synced
+// to (`_commit`), plus the answers given. A template is a directory carrying a
+// `copier.yml`.
+import { parse } from 'yaml';
+export const ANSWERS_FILE = '.copier-answers.yml';
+export const TEMPLATE_FILES = ['copier.yml', 'copier.yaml'];
+export function parseAnswers(text) {
+    const data = parse(text);
+    if (data === null || typeof data !== 'object' || Array.isArray(data))
+        throw new Error('answers file is not a mapping');
+    const { _commit, _src_path, ...answers } = data;
+    return {
+        commit: _commit === undefined ? undefined : String(_commit),
+        src: _src_path === undefined ? undefined : String(_src_path),
+        answers,
+    };
+}
+//# sourceMappingURL=copier.js.map

package/dist/copier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"copier.js","sourceRoot":"","sources":["../src/copier.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,6EAA6E;AAC7E,+EAA+E;AAC/E,gBAAgB;AAChB,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAE7B,MAAM,CAAC,MAAM,YAAY,GAAG,qBAAqB,CAAC;AAClD,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;AAW5D,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,MAAM,IAAI,GAAY,KAAK,CAAC,IAAI,CAAC,CAAC;IAClC,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAClE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,OAAO,EAAE,GAAG,IAA+B,CAAC;IAC3E,OAAO;QACL,MAAM,EAAE,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;QAC3D,GAAG,EAAE,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC;QAC5D,OAAO;KACR,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export { Context, type Options } from './context.ts';
+export { ANSWERS_FILE, type Answers, parseAnswers, TEMPLATE_FILES } from './copier.ts';
+export { type DirEntry, ExecError, type ExecOptions, type Io, realIo, render } from './io.ts';
+export { type Declaration, MARKER_FILE, parseMarker, splitFrontmatter } from './marker.ts';
+export { type Directory, type GitFacet, isNotable, type Kind, kindOf, shortRemote, type TemplateFacet, } from './model.ts';
+export { overview, PRUNED } from './overview.ts';
+export { body, describe, type Plan, run, type Step, ssh, write } from './plan.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,KAAK,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACvF,OAAO,EAAE,KAAK,QAAQ,EAAE,SAAS,EAAE,KAAK,WAAW,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAC9F,OAAO,EAAE,KAAK,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC3F,OAAO,EACL,KAAK,SAAS,EACd,KAAK,QAAQ,EACb,SAAS,EACT,KAAK,IAAI,EACT,MAAM,EACN,WAAW,EACX,KAAK,aAAa,GACnB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC"}

package/dist/index.js

@@ -0,0 +1,16 @@
+// @plexus-ms/lib: the core layer of plx, usable without the CLI.
+//
+// A verb here is either a reader returning data, or a pure planner returning
+// a Plan (plan.ts) from what was read. The Context (context.ts) reads through
+// an injected Io (io.ts) and applies plans, narrating every step; the CLI
+// package is an adapter that maps argv onto this. The parsers of Plexus's own
+// file shapes (marker.ts, copier.ts) live here, once, for every verb.
+// Conventions: compendium/miscellaneous/cli-design.md.
+export { Context } from "./context.js";
+export { ANSWERS_FILE, parseAnswers, TEMPLATE_FILES } from "./copier.js";
+export { ExecError, realIo, render } from "./io.js";
+export { MARKER_FILE, parseMarker, splitFrontmatter } from "./marker.js";
+export { isNotable, kindOf, shortRemote, } from "./model.js";
+export { overview, PRUNED } from "./overview.js";
+export { body, describe, run, ssh, write } from "./plan.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,iEAAiE;AACjE,EAAE;AACF,6EAA6E;AAC7E,8EAA8E;AAC9E,0EAA0E;AAC1E,8EAA8E;AAC9E,sEAAsE;AACtE,uDAAuD;AACvD,OAAO,EAAE,OAAO,EAAgB,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,YAAY,EAAgB,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACvF,OAAO,EAAiB,SAAS,EAA6B,MAAM,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAC9F,OAAO,EAAoB,WAAW,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC3F,OAAO,EAGL,SAAS,EAET,MAAM,EACN,WAAW,GAEZ,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAa,GAAG,EAAa,GAAG,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC"}

package/dist/io.d.ts

@@ -0,0 +1,40 @@
+import type { Writable } from 'node:stream';
+export interface ExecOptions {
+    cwd?: string;
+    env?: NodeJS.ProcessEnv;
+    /** Fed to the process's stdin, then closed. */
+    input?: string;
+    /** Pass the process's output through to the terminal instead of capturing it. */
+    inherit?: boolean;
+}
+export interface Io {
+    stdout: Writable;
+    stderr: Writable;
+    /**
+     * Ask a yes/no question of a human, or undefined when there is none: off a
+     * terminal, or in a program that brings no prompt (the CLI supplies one).
+     */
+    prompt?: (question: string) => Promise<boolean>;
+    /** Run a process to completion; resolves with its stdout, rejects with ExecError on nonzero exit. */
+    exec(command: string, args: string[], options?: ExecOptions): Promise<string>;
+    readFile(path: string): Promise<string>;
+    writeFile(path: string, content: string): Promise<void>;
+    /** The entries of a directory, in no particular order. */
+    readDir(path: string): Promise<DirEntry[]>;
+}
+export interface DirEntry {
+    name: string;
+    directory: boolean;
+}
+export declare class ExecError extends Error {
+    readonly command: string;
+    readonly code: number | null;
+    readonly stderr: string;
+    constructor(command: string, code: number | null, stderr: string);
+}
+/** True when a human is on both ends of the terminal. */
+export declare const isInteractive: () => boolean;
+export declare function realIo(prompt?: Io['prompt']): Io;
+/** The command line as a shell would need it typed: args quoted when they must be. */
+export declare function render(command: string, args: string[]): string;
+//# sourceMappingURL=io.d.ts.map

package/dist/io.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"io.d.ts","sourceRoot":"","sources":["../src/io.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,WAAW,WAAW;IAC1B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IACxB,+CAA+C;IAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iFAAiF;IACjF,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,EAAE;IACjB,MAAM,EAAE,QAAQ,CAAC;IACjB,MAAM,EAAE,QAAQ,CAAC;IACjB;;;OAGG;IACH,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAChD,qGAAqG;IACrG,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9E,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACxC,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxD,0DAA0D;IAC1D,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,qBAAa,SAAU,SAAQ,KAAK;IAClC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAEZ,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,EAAE,MAAM,EAAE,MAAM;CAMjE;AAED,yDAAyD;AACzD,eAAO,MAAM,aAAa,QAAO,OAAwE,CAAC;AAE1G,wBAAgB,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,EAAE,CAiChD;AAED,sFAAsF;AACtF,wBAAgB,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CAE9D"}

package/dist/io.js

@@ -0,0 +1,62 @@
+// Everything a verb does to the world goes through an Io, injected into the
+// Context (context.ts). The real one wraps node; a test hands in a fake and
+// asserts what was asked of it, with no subprocess and no filesystem.
+import { spawn } from 'node:child_process';
+import { readdir, readFile, writeFile } from 'node:fs/promises';
+export class ExecError extends Error {
+    command;
+    code;
+    stderr;
+    constructor(command, code, stderr) {
+        super(`${command} exited with ${code ?? 'signal'}${stderr ? `\n${stderr.trimEnd()}` : ''}`);
+        this.command = command;
+        this.code = code;
+        this.stderr = stderr;
+    }
+}
+/** True when a human is on both ends of the terminal. */
+export const isInteractive = () => process.stdin.isTTY === true && process.stderr.isTTY === true;
+export function realIo(prompt) {
+    return {
+        stdout: process.stdout,
+        stderr: process.stderr,
+        prompt: prompt && isInteractive() ? prompt : undefined,
+        exec: (command, args, options = {}) => new Promise((resolve, reject) => {
+            const child = spawn(command, args, {
+                cwd: options.cwd,
+                env: options.env,
+                stdio: [options.input === undefined ? 'ignore' : 'pipe', options.inherit ? 'inherit' : 'pipe', 'pipe'],
+            });
+            let stdout = '';
+            let stderr = '';
+            child.stdout?.on('data', (chunk) => {
+                stdout += chunk;
+            });
+            child.stderr?.on('data', (chunk) => {
+                stderr += chunk;
+                if (options.inherit)
+                    process.stderr.write(chunk);
+            });
+            child.on('error', reject);
+            child.on('close', (code) => {
+                if (code === 0)
+                    resolve(stdout);
+                else
+                    reject(new ExecError(render(command, args), code, stderr));
+            });
+            if (options.input !== undefined)
+                child.stdin?.end(options.input);
+        }),
+        readFile: (path) => readFile(path, 'utf8'),
+        writeFile: (path, content) => writeFile(path, content),
+        readDir: async (path) => (await readdir(path, { withFileTypes: true })).map((e) => ({ name: e.name, directory: e.isDirectory() })),
+    };
+}
+/** The command line as a shell would need it typed: args quoted when they must be. */
+export function render(command, args) {
+    return [command, ...args].map(quote).join(' ');
+}
+function quote(arg) {
+    return /^[\w./:@%+=,-]+$/.test(arg) ? arg : `'${arg.replaceAll("'", "'\\''")}'`;
+}
+//# sourceMappingURL=io.js.map

package/dist/io.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"io.js","sourceRoot":"","sources":["../src/io.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,4EAA4E;AAC5E,sEAAsE;AACtE,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAiChE,MAAM,OAAO,SAAU,SAAQ,KAAK;IACzB,OAAO,CAAS;IAChB,IAAI,CAAgB;IACpB,MAAM,CAAS;IAExB,YAAY,OAAe,EAAE,IAAmB,EAAE,MAAc;QAC9D,KAAK,CAAC,GAAG,OAAO,gBAAgB,IAAI,IAAI,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC5F,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED,yDAAyD;AACzD,MAAM,CAAC,MAAM,aAAa,GAAG,GAAY,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,KAAK,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,KAAK,IAAI,CAAC;AAE1G,MAAM,UAAU,MAAM,CAAC,MAAqB;IAC1C,OAAO;QACL,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,MAAM,EAAE,MAAM,IAAI,aAAa,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;QACtD,IAAI,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,GAAG,EAAE,EAAE,EAAE,CACpC,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC9B,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE;gBACjC,GAAG,EAAE,OAAO,CAAC,GAAG;gBAChB,GAAG,EAAE,OAAO,CAAC,GAAG;gBAChB,KAAK,EAAE,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC;aACvG,CAAC,CAAC;YACH,IAAI,MAAM,GAAG,EAAE,CAAC;YAChB,IAAI,MAAM,GAAG,EAAE,CAAC;YAChB,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;gBACzC,MAAM,IAAI,KAAK,CAAC;YAClB,CAAC,CAAC,CAAC;YACH,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;gBACzC,MAAM,IAAI,KAAK,CAAC;gBAChB,IAAI,OAAO,CAAC,OAAO;oBAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACnD,CAAC,CAAC,CAAC;YACH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAC1B,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE;gBACzB,IAAI,IAAI,KAAK,CAAC;oBAAE,OAAO,CAAC,MAAM,CAAC,CAAC;;oBAC3B,MAAM,CAAC,IAAI,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;YAClE,CAAC,CAAC,CAAC;YACH,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS;gBAAE,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACnE,CAAC,CAAC;QACJ,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAC1C,SAAS,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC;QACtD,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CACtB,CAAC,MAAM,OAAO,CAAC,IAAI,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;KAC5G,CAAC;AACJ,CAAC;AAED,sFAAsF;AACtF,MAAM,UAAU,MAAM,CAAC,OAAe,EAAE,IAAc;IACpD,OAAO,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACjD,CAAC;AAED,SAAS,KAAK,CAAC,GAAW;IACxB,OAAO,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC;AAClF,CAAC"}

package/dist/marker.d.ts

@@ -0,0 +1,16 @@
+export interface Declaration {
+    /** The Plexus version the unit was last brought up to, e.g. `0.62.0`. */
+    plexus: string;
+    /** The module codes it follows, e.g. `PLX-Repo`. */
+    modules: string[];
+    /** The prose after the frontmatter: what the unit is, and its owned deviations. */
+    body: string;
+}
+export declare const MARKER_FILE = "PLEXUS.md";
+export declare function parseMarker(text: string): Declaration;
+/** The YAML between the leading `---` lines, as a plain object, and the rest. */
+export declare function splitFrontmatter(text: string): {
+    data: Record<string, unknown>;
+    body: string;
+};
+//# sourceMappingURL=marker.d.ts.map

package/dist/marker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"marker.d.ts","sourceRoot":"","sources":["../src/marker.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,WAAW;IAC1B,yEAAyE;IACzE,MAAM,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,mFAAmF;IACnF,IAAI,EAAE,MAAM,CAAC;CACd;AAED,eAAO,MAAM,WAAW,cAAc,CAAC;AAEvC,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAQrD;AAED,iFAAiF;AACjF,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAM9F"}

package/dist/marker.js

@@ -0,0 +1,26 @@
+// The declaration marker, PLEXUS.md (§ 1.4 PLX): YAML frontmatter with the
+// Plexus version and the declared modules, then free-form prose. This is the
+// one reader of that shape; every verb that needs a marker parses it here.
+import { parse } from 'yaml';
+export const MARKER_FILE = 'PLEXUS.md';
+export function parseMarker(text) {
+    const { data, body } = splitFrontmatter(text);
+    const plexus = data.plexus;
+    const modules = data.modules;
+    if (typeof plexus !== 'string' && typeof plexus !== 'number')
+        throw new Error('marker: `plexus` must be a version');
+    if (!Array.isArray(modules) || !modules.every((m) => typeof m === 'string'))
+        throw new Error('marker: `modules` must be a list of module codes');
+    return { plexus: String(plexus), modules, body };
+}
+/** The YAML between the leading `---` lines, as a plain object, and the rest. */
+export function splitFrontmatter(text) {
+    const match = /^---\r?\n([\s\S]*?)\r?\n---(?:\r?\n|$)([\s\S]*)$/.exec(text);
+    if (!match)
+        throw new Error('no frontmatter: expected a `---` block at the top');
+    const data = parse(match[1] ?? '');
+    if (data === null || typeof data !== 'object' || Array.isArray(data))
+        throw new Error('frontmatter is not a mapping');
+    return { data: data, body: match[2] ?? '' };
+}
+//# sourceMappingURL=marker.js.map

package/dist/marker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"marker.js","sourceRoot":"","sources":["../src/marker.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAC3E,6EAA6E;AAC7E,2EAA2E;AAC3E,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAW7B,MAAM,CAAC,MAAM,WAAW,GAAG,WAAW,CAAC;AAEvC,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;IAC7B,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACpH,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC;QACzE,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AACnD,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,gBAAgB,CAAC,IAAY;IAC3C,MAAM,KAAK,GAAG,kDAAkD,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5E,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;IACjF,MAAM,IAAI,GAAY,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAC5C,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IACtH,OAAO,EAAE,IAAI,EAAE,IAA+B,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;AACzE,CAAC"}

package/dist/model.d.ts

@@ -0,0 +1,35 @@
+import type { Answers } from './copier.ts';
+import type { Declaration } from './marker.ts';
+export interface Directory {
+    name: string;
+    path: string;
+    git?: GitFacet;
+    template?: TemplateFacet;
+    copier?: Answers;
+    declaration?: Declaration;
+    /** Marker files that could not be read; shown, never fatal. */
+    problems?: string[];
+    children: Directory[];
+}
+export interface GitFacet {
+    /** The checked-out branch, or the short commit when detached. */
+    branch: string;
+    /** Uncommitted tracked or untracked changes. */
+    dirty: boolean;
+    /** The most recent tag reachable from the default branch, if any. */
+    tag?: string;
+    /** The `origin` remote, shortened: `gh:org/repo` for GitHub. */
+    remote?: string;
+}
+export interface TemplateFacet {
+    /** The template repo's most recent tag, if any. */
+    tag?: string;
+}
+export type Kind = 'app' | 'platform' | 'repo';
+/** What a declaration makes a directory, by the modules it follows. */
+export declare function kindOf(declaration: Declaration): Kind | undefined;
+/** A git remote URL as a short handle: `gh:org/repo` for GitHub, the URL otherwise. */
+export declare function shortRemote(url: string): string;
+/** Whether a directory, or anything below it, carries a facet worth showing. */
+export declare function isNotable(dir: Directory): boolean;
+//# sourceMappingURL=model.d.ts.map

package/dist/model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,QAAQ,CAAC;IACf,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,EAAE,SAAS,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,QAAQ;IACvB,iEAAiE;IACjE,MAAM,EAAE,MAAM,CAAC;IACf,gDAAgD;IAChD,KAAK,EAAE,OAAO,CAAC;IACf,qEAAqE;IACrE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,gEAAgE;IAChE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,mDAAmD;IACnD,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,IAAI,GAAG,KAAK,GAAG,UAAU,GAAG,MAAM,CAAC;AAE/C,uEAAuE;AACvE,wBAAgB,MAAM,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI,GAAG,SAAS,CAMjE;AAED,uFAAuF;AACvF,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAI/C;AAED,gFAAgF;AAChF,wBAAgB,SAAS,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAEjD"}

package/dist/model.js

@@ -0,0 +1,22 @@
+/** What a declaration makes a directory, by the modules it follows. */
+export function kindOf(declaration) {
+    const has = (code) => declaration.modules.includes(code);
+    if (has('PLX-App'))
+        return 'app';
+    if (has('PLX-Platform'))
+        return 'platform';
+    if (has('PLX-Repo'))
+        return 'repo';
+    return undefined;
+}
+/** A git remote URL as a short handle: `gh:org/repo` for GitHub, the URL otherwise. */
+export function shortRemote(url) {
+    const bare = url.replace(/\.git$/, '').replace(/\/$/, '');
+    const m = /^(?:git@github\.com:|github\.com:|ssh:\/\/git@github\.com\/|https?:\/\/github\.com\/)(.+)$/.exec(bare);
+    return m ? `gh:${m[1]}` : bare;
+}
+/** Whether a directory, or anything below it, carries a facet worth showing. */
+export function isNotable(dir) {
+    return Boolean(dir.git || dir.template || dir.copier || dir.declaration || dir.problems?.length);
+}
+//# sourceMappingURL=model.js.map

package/dist/model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.js","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAqCA,uEAAuE;AACvE,MAAM,UAAU,MAAM,CAAC,WAAwB;IAC7C,MAAM,GAAG,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACjE,IAAI,GAAG,CAAC,SAAS,CAAC;QAAE,OAAO,KAAK,CAAC;IACjC,IAAI,GAAG,CAAC,cAAc,CAAC;QAAE,OAAO,UAAU,CAAC;IAC3C,IAAI,GAAG,CAAC,UAAU,CAAC;QAAE,OAAO,MAAM,CAAC;IACnC,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,uFAAuF;AACvF,MAAM,UAAU,WAAW,CAAC,GAAW;IACrC,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC1D,MAAM,CAAC,GAAG,4FAA4F,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClH,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AACjC,CAAC;AAED,gFAAgF;AAChF,MAAM,UAAU,SAAS,CAAC,GAAc;IACtC,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;AACnG,CAAC"}

package/dist/overview.d.ts

@@ -0,0 +1,6 @@
+import type { Context } from './context.ts';
+import { type Directory } from './model.ts';
+/** Heavy or generated directories never descended into. `.git` is the repo marker and is handled apart. */
+export declare const PRUNED: Set<string>;
+export declare function overview(ctx: Context, root: string): Promise<Directory>;
+//# sourceMappingURL=overview.d.ts.map

package/dist/overview.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"overview.d.ts","sourceRoot":"","sources":["../src/overview.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAG5C,OAAO,EAAE,KAAK,SAAS,EAA6D,MAAM,YAAY,CAAC;AAEvG,2GAA2G;AAC3G,eAAO,MAAM,MAAM,aAsBjB,CAAC;AAEH,wBAAsB,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAG7E"}

package/dist/overview.js

@@ -0,0 +1,119 @@
+// overview: the map of a folder of repos (the toolbox's overview.sh, moved).
+//
+// Walk a directory, note for every directory whether it is a git repo, a
+// copier template, a copier-managed project, or a declared Plexus unit, and
+// return the tree of directories that carry such a facet, with the ancestors
+// needed to reach them. Reads only: there is nothing to plan or apply.
+//
+//   plx overview            # map the current directory
+//   plx overview ~/dev      # map somewhere else
+import { join } from 'node:path';
+import { ANSWERS_FILE, parseAnswers, TEMPLATE_FILES } from "./copier.js";
+import { MARKER_FILE, parseMarker } from "./marker.js";
+import { isNotable, shortRemote } from "./model.js";
+/** Heavy or generated directories never descended into. `.git` is the repo marker and is handled apart. */
+export const PRUNED = new Set([
+    'node_modules',
+    '.hg',
+    '.svn',
+    '.next',
+    '.nuxt',
+    '.turbo',
+    '.svelte-kit',
+    'dist',
+    'build',
+    'out',
+    '.output',
+    '.venv',
+    'venv',
+    '__pycache__',
+    'target',
+    '.cache',
+    '.pnpm-store',
+    'coverage',
+    'vendor',
+    '.terraform',
+    '.gradle',
+]);
+export async function overview(ctx, root) {
+    const dir = await walk(ctx, root, root.replace(/\/+$/, '').split('/').pop() || root);
+    return dir;
+}
+async function walk(ctx, path, name) {
+    const entries = await ctx.readDir(path);
+    const files = new Set(entries.filter((e) => !e.directory).map((e) => e.name));
+    const names = new Set(entries.map((e) => e.name));
+    const dir = { name, path, children: [] };
+    // `.git` is a directory for a checkout and a file for a worktree or submodule.
+    if (names.has('.git'))
+        dir.git = await gitFacet(ctx, path);
+    if (TEMPLATE_FILES.some((f) => files.has(f)))
+        dir.template = await templateFacet(ctx, path);
+    if (files.has(ANSWERS_FILE)) {
+        await facet(ctx, dir, ANSWERS_FILE, (text) => {
+            dir.copier = parseAnswers(text);
+        });
+    }
+    if (files.has(MARKER_FILE)) {
+        await facet(ctx, dir, MARKER_FILE, (text) => {
+            dir.declaration = parseMarker(text);
+        });
+    }
+    const subdirs = entries
+        .filter((e) => e.directory && e.name !== '.git' && !PRUNED.has(e.name))
+        .map((e) => e.name)
+        .sort();
+    for (const sub of subdirs) {
+        const child = await walk(ctx, join(path, sub), sub);
+        if (isNotable(child) || child.children.length > 0)
+            dir.children.push(child);
+    }
+    return dir;
+}
+async function facet(ctx, dir, file, read) {
+    try {
+        read(await ctx.readFile(join(dir.path, file)));
+    }
+    catch (error) {
+        dir.problems ??= [];
+        dir.problems.push(`${file}: ${error instanceof Error ? error.message : String(error)}`);
+    }
+}
+/** A git read that may legitimately fail (no remote, no tag, detached): undefined then. */
+async function git(ctx, cwd, args) {
+    try {
+        const out = (await ctx.read('git', args, { cwd })).trim();
+        return out === '' ? undefined : out;
+    }
+    catch {
+        return undefined;
+    }
+}
+async function gitFacet(ctx, cwd) {
+    const branch = (await git(ctx, cwd, ['symbolic-ref', '--short', '-q', 'HEAD'])) ??
+        (await git(ctx, cwd, ['rev-parse', '--short', 'HEAD'])) ??
+        '?';
+    const dirty = (await git(ctx, cwd, ['status', '--porcelain'])) !== undefined;
+    const remote = await git(ctx, cwd, ['remote', 'get-url', 'origin']);
+    // The most recent tag reachable from the default branch: origin/HEAD, else a local main or master.
+    let defaultRef = await git(ctx, cwd, ['symbolic-ref', '--short', '-q', 'refs/remotes/origin/HEAD']);
+    for (const b of ['main', 'master']) {
+        if (defaultRef)
+            break;
+        if (await git(ctx, cwd, ['rev-parse', '--verify', '-q', `refs/heads/${b}`]))
+            defaultRef = b;
+    }
+    const tag = defaultRef ? await git(ctx, cwd, ['describe', '--tags', '--abbrev=0', defaultRef]) : undefined;
+    const facet = { branch, dirty };
+    if (tag)
+        facet.tag = tag;
+    if (remote)
+        facet.remote = shortRemote(remote);
+    return facet;
+}
+async function templateFacet(ctx, cwd) {
+    const tag = (await git(ctx, cwd, ['describe', '--tags', '--abbrev=0'])) ??
+        (await git(ctx, cwd, ['tag', '--list', '--sort=-v:refname']))?.split('\n')[0];
+    return tag ? { tag } : {};
+}
+//# sourceMappingURL=overview.js.map

package/dist/overview.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"overview.js","sourceRoot":"","sources":["../src/overview.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,EAAE;AACF,yEAAyE;AACzE,4EAA4E;AAC5E,6EAA6E;AAC7E,uEAAuE;AACvE,EAAE;AACF,wDAAwD;AACxD,iDAAiD;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACzE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAiC,SAAS,EAAE,WAAW,EAAsB,MAAM,YAAY,CAAC;AAEvG,2GAA2G;AAC3G,MAAM,CAAC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC;IAC5B,cAAc;IACd,KAAK;IACL,MAAM;IACN,OAAO;IACP,OAAO;IACP,QAAQ;IACR,aAAa;IACb,MAAM;IACN,OAAO;IACP,KAAK;IACL,SAAS;IACT,OAAO;IACP,MAAM;IACN,aAAa;IACb,QAAQ;IACR,QAAQ;IACR,aAAa;IACb,UAAU;IACV,QAAQ;IACR,YAAY;IACZ,SAAS;CACV,CAAC,CAAC;AAEH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,GAAY,EAAE,IAAY;IACvD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,CAAC;IACrF,OAAO,GAAG,CAAC;AACb,CAAC;AAED,KAAK,UAAU,IAAI,CAAC,GAAY,EAAE,IAAY,EAAE,IAAY;IAC1D,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9E,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAClD,MAAM,GAAG,GAAc,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IAEpD,+EAA+E;IAC/E,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC;QAAE,GAAG,CAAC,GAAG,GAAG,MAAM,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC3D,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAAE,GAAG,CAAC,QAAQ,GAAG,MAAM,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC5F,IAAI,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;QAC5B,MAAM,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC,IAAI,EAAE,EAAE;YAC3C,GAAG,CAAC,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC;IACD,IAAI,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;QAC3B,MAAM,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,CAAC,IAAI,EAAE,EAAE;YAC1C,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,OAAO,GAAG,OAAO;SACpB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SACtE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;SAClB,IAAI,EAAE,CAAC;IACV,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;QACpD,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC;YAAE,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9E,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,KAAK,UAAU,KAAK,CAAC,GAAY,EAAE,GAAc,EAAE,IAAY,EAAE,IAA4B;IAC3F,IAAI,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IACjD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,GAAG,CAAC,QAAQ,KAAK,EAAE,CAAC;QACpB,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC1F,CAAC;AACH,CAAC;AAED,2FAA2F;AAC3F,KAAK,UAAU,GAAG,CAAC,GAAY,EAAE,GAAW,EAAE,IAAc;IAC1D,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC1D,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC;IACtC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,KAAK,UAAU,QAAQ,CAAC,GAAY,EAAE,GAAW;IAC/C,MAAM,MAAM,GACV,CAAC,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,cAAc,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;QAChE,CAAC,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,WAAW,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;QACvD,GAAG,CAAC;IACN,MAAM,KAAK,GAAG,CAAC,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC;IAC7E,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;IACpE,mGAAmG;IACnG,IAAI,UAAU,GAAG,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,cAAc,EAAE,SAAS,EAAE,IAAI,EAAE,0BAA0B,CAAC,CAAC,CAAC;IACpG,KAAK,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC;QACnC,IAAI,UAAU;YAAE,MAAM;QACtB,IAAI,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,WAAW,EAAE,UAAU,EAAE,IAAI,EAAE,cAAc,CAAC,EAAE,CAAC,CAAC;YAAE,UAAU,GAAG,CAAC,CAAC;IAC9F,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3G,MAAM,KAAK,GAAa,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IAC1C,IAAI,GAAG;QAAE,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC;IACzB,IAAI,MAAM;QAAE,KAAK,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IAC/C,OAAO,KAAK,CAAC;AACf,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,GAAY,EAAE,GAAW;IACpD,MAAM,GAAG,GACP,CAAC,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,UAAU,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC;QAC3D,CAAC,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,mBAAmB,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAChF,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AAC5B,CAAC"}

package/dist/plan.d.ts

@@ -0,0 +1,28 @@
+export type Step = {
+    kind: 'run';
+    command: string;
+    args: string[];
+    cwd?: string;
+    input?: string;
+} | {
+    kind: 'ssh';
+    host: string;
+    script: string;
+} | {
+    kind: 'write';
+    path: string;
+    content: string;
+};
+export type Plan = Step[];
+export declare const run: (command: string, args?: string[], options?: {
+    cwd?: string;
+    input?: string;
+}) => Step;
+/** Feed a bash script to a host: the remote half of a verb stays bash, carried verbatim. */
+export declare const ssh: (host: string, script: string) => Step;
+export declare const write: (path: string, content: string) => Step;
+/** One line, the shell equivalent of the step. */
+export declare function describe(step: Step): string;
+/** What a step feeds in, shown at higher verbosity under its description. */
+export declare function body(step: Step): string | undefined;
+//# sourceMappingURL=plan.d.ts.map

package/dist/plan.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.d.ts","sourceRoot":"","sources":["../src/plan.ts"],"names":[],"mappings":"AASA,MAAM,MAAM,IAAI,GACZ;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,EAAE,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAC9E;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAC7C;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAErD,MAAM,MAAM,IAAI,GAAG,IAAI,EAAE,CAAC;AAE1B,eAAO,MAAM,GAAG,GAAI,SAAS,MAAM,EAAE,OAAM,MAAM,EAAO,EAAE,UAAS;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAO,KAAG,IAKzG,CAAC;AAEH,4FAA4F;AAC5F,eAAO,MAAM,GAAG,GAAI,MAAM,MAAM,EAAE,QAAQ,MAAM,KAAG,IAAuC,CAAC;AAE3F,eAAO,MAAM,KAAK,GAAI,MAAM,MAAM,EAAE,SAAS,MAAM,KAAG,IAA0C,CAAC;AAEjG,kDAAkD;AAClD,wBAAgB,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAS3C;AAED,6EAA6E;AAC7E,wBAAgB,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,GAAG,SAAS,CASnD"}

package/dist/plan.js

@@ -0,0 +1,40 @@
+// A Plan is what a command decides to do, as data: the effects, in order.
+//
+// A command's core computes a Plan from what it read (pure, testable by
+// comparing plans), the Context applies it (context.ts). Printing a plan is
+// the dry run; applying it is the real run; both come from the one Plan, so
+// they cannot drift. Describing a step gives the exact shell a stranded
+// operator would type instead.
+import { render } from "./io.js";
+export const run = (command, args = [], options = {}) => ({
+    kind: 'run',
+    command,
+    args,
+    ...options,
+});
+/** Feed a bash script to a host: the remote half of a verb stays bash, carried verbatim. */
+export const ssh = (host, script) => ({ kind: 'ssh', host, script });
+export const write = (path, content) => ({ kind: 'write', path, content });
+/** One line, the shell equivalent of the step. */
+export function describe(step) {
+    switch (step.kind) {
+        case 'run':
+            return `$ ${step.cwd ? `(cd ${step.cwd} && ` : ''}${render(step.command, step.args)}${step.cwd ? ')' : ''}`;
+        case 'ssh':
+            return `$ ${render('ssh', [step.host, 'bash', '-s'])} <<'EOF'`;
+        case 'write':
+            return `> ${step.path} (${Buffer.byteLength(step.content)} bytes)`;
+    }
+}
+/** What a step feeds in, shown at higher verbosity under its description. */
+export function body(step) {
+    switch (step.kind) {
+        case 'run':
+            return step.input;
+        case 'ssh':
+            return `${step.script.trimEnd()}\nEOF`;
+        case 'write':
+            return step.content;
+    }
+}
+//# sourceMappingURL=plan.js.map

package/dist/plan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.js","sourceRoot":"","sources":["../src/plan.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,EAAE;AACF,wEAAwE;AACxE,4EAA4E;AAC5E,4EAA4E;AAC5E,wEAAwE;AACxE,+BAA+B;AAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AASjC,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,OAAe,EAAE,OAAiB,EAAE,EAAE,UAA4C,EAAE,EAAQ,EAAE,CAAC,CAAC;IAClH,IAAI,EAAE,KAAK;IACX,OAAO;IACP,IAAI;IACJ,GAAG,OAAO;CACX,CAAC,CAAC;AAEH,4FAA4F;AAC5F,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,IAAY,EAAE,MAAc,EAAQ,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;AAE3F,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,OAAe,EAAQ,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;AAEjG,kDAAkD;AAClD,MAAM,UAAU,QAAQ,CAAC,IAAU;IACjC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,KAAK;YACR,OAAO,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAC9G,KAAK,KAAK;YACR,OAAO,KAAK,MAAM,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,UAAU,CAAC;QACjE,KAAK,OAAO;YACV,OAAO,KAAK,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;IACvE,CAAC;AACH,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,IAAI,CAAC,IAAU;IAC7B,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,KAAK;YACR,OAAO,IAAI,CAAC,KAAK,CAAC;QACpB,KAAK,KAAK;YACR,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC;QACzC,KAAK,OAAO;YACV,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,42 @@
 {
   "name": "@plexus-ms/lib",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "The Plexus verbs as a library: the plan-then-apply core behind plx, and the one parser of Plexus's own file shapes",
+  "license": "GPL-3.0-or-later",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/plexus-ms/packages.git",
+    "directory": "packages/lib"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=24"
+  },
+  "scripts": {
+    "build": "tsc",
+    "check": "tsc --noEmit",
+    "test": "node --test",
+    "prepack": "tsc"
+  },
+  "dependencies": {
+    "yaml": "^2.9.1"
+  },
+  "devDependencies": {
+    "@types/node": "^26.1.2",
+    "typescript": "catalog:"
+  }
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.