linkedin-studio/scripts/editions/src/cli.ts
Kjell Tore Guttormsen 657539ef09 feat(linkedin-studio): N12 — editions-register CLI + phaseLog-telemetri (TDD) [skip-docs]
Two things were structurally invisible: WHICH editions are in flight (readable
only by opening every series folder's edition-state.json by hand) and HOW LONG an
edition takes (not recorded anywhere). At two editions a week both are
load-bearing — a production line cannot be dimensioned on numbers never collected.

Register (scripts/editions, new module beside distillate.ts): one row per edition
in ${LINKEDIN_STUDIO_DATA}/editions/register.json — series, edition, title, series
path, current phase, next action, slot, startedAt/completedAt. Data-dir placement
(M0) because the register spans ALL series; the distillate is per-series and stays
in the series root. Verbs: register-upsert / register-list / register-complete.

phaseLog: articles.NN.phaseLog[{phase, completedAt}] in edition-state, additive so
schemaVersion stays 1 — pre-N12 editions load unchanged and their absence reads as
"not measured", never as zero. Per-article, mirroring articles.NN.phase: lead time
is a property of an edition.

One call per transition, both writes: newsletter.md gains a phase-transition
protocol defined once beside the resumption table, and all 16 canonical phases
invoke it. register-upsert appends the phase-log entry AND mirrors the register
row. Deliberately one command, not two — telemetry the command layer must remember
to write separately is incomplete inside a week, and an incomplete log measures
nothing. Step 10 closes the row and prints the measured lead time.

Mirror discipline: resumption still reads edition-state.json and only that. Delete
the register and the next transition rebuilds it; a failed upsert is reported, never
a reason to stop the pipeline. startedAt is the one unrecoverable value, so it never
moves — re-upserting a completed edition reactivates the same row (what
/linkedin:pivot does), keeping the clock on real elapsed production time.

Deterministic: no clock in the core (now passed in, --at/--now at the edge, as the
distillate takes lockedAt). Idempotent where a re-run is legitimate (repeated
transition logs once; completing twice keeps the first completedAt), not where it is
real work (a phase recurring after another one is logged again — a pivot back through
cleared gates is production time that happened). Missing facts are refused at the
edge, not defaulted: a row naming the wrong phase is worse than no row.

TDD (Iron Law): all three test files written first and verified red before any
implementation existed (register.test.ts + editionState.test.ts failed on missing
modules, cli-register.test.ts on "unknown command: register-upsert").

Suites: editions 27 -> 72 (floor raised) · test-runner 173 -> 184 (Section 16s: 11
unconditional greps incl. a 16-phase coverage sweep + non-vacuity self-test;
anti-erosion floor 155 -> 166) · trends 300/0 · brain 134/0 · specifics-bank 45/0 ·
hooks 140/0 · tests 35/0 · render 60/0. tsc --noEmit clean.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01QxvWAjte7vPcF79QeSRvRJ
2026-07-25 06:55:44 +02:00

322 lines
12 KiB
JavaScript

#!/usr/bin/env node
/**
* CLI for series-level edition memory: the distillate (N11 — serie-nivå-vern)
* and the editions register (N12 — A1-11 / A1-12).
*
* node --import tsx src/cli.ts distil-append --distillate <path> --series <slug> --extract <extract.json>
* node --import tsx src/cli.ts distil-check --distillate <path> --skeleton <skeleton.json>
* [--threshold <0..1>] [--json]
* node --import tsx src/cli.ts register-upsert --edition-state <path> [--next <text>] [--slot <text>]
* [--path <series-root>] [--register <path>] [--at <ISO>]
* node --import tsx src/cli.ts register-list [--all] [--json] [--register <path>] [--now <ISO>]
* node --import tsx src/cli.ts register-complete --series <slug> --edition <NN>
* [--register <path>] [--at <ISO>]
*
* `distil-append` runs at Step 8 lock: the command layer writes the AI extract
* (the anecdotes/arguments/hooks the edition actually spent) to a JSON file, and
* this folds it in deterministically. `distil-check` runs at Step 2.5, before
* prose, and reports re-use into the annotation gate.
*
* `register-upsert` runs at EVERY phase transition — it appends the `phaseLog`
* entry to the edition-state AND mirrors the row into the register in one call,
* so the telemetry cannot drift out of step with the state it describes.
* `register-complete` runs at Step 10 when the edition is scheduled.
*
* Clock at the edge only: `--at` / `--now` override it so runs are reproducible.
*
* Exit code: 0 on success (INCLUDING a REUSE verdict — the check is advisory by
* design, unlike the binding gate's BLOCK), 1 on a failed operation, 2 on usage
* error.
*/
import { readFileSync } from "node:fs";
import {
DEFAULT_THRESHOLD,
appendEntry,
checkSkeleton,
loadDistillate,
saveDistillate,
} from "./distillate.js";
import {
appendPhase,
editionFacts,
readEditionState,
saveEditionState,
seriesRootFromStatePath,
} from "./editionState.js";
import {
completeEdition,
defaultRegisterPath,
elapsedDays,
listEditions,
loadRegister,
saveRegister,
upsertEdition,
} from "./register.js";
import type { DistillateEntry, EditionRow, SkeletonCandidate } from "./types.js";
function parseFlags(args: string[]): Record<string, string> {
const out: Record<string, string> = {};
for (let i = 0; i < args.length; i++) {
const a = args[i];
if (a.startsWith("--")) {
const key = a.slice(2);
const next = args[i + 1];
if (next === undefined || next.startsWith("--")) {
out[key] = "true";
} else {
out[key] = next;
i++;
}
}
}
return out;
}
function usage(msg: string): never {
console.error(`error: ${msg}`);
console.error(
"usage:\n" +
" distil-append --distillate <path> --series <slug> --extract <extract.json>\n" +
" distil-check --distillate <path> --skeleton <skeleton.json> [--threshold <0..1>] [--json]\n" +
" register-upsert --edition-state <path> [--next <text>] [--slot <text>] [--path <series-root>]\n" +
" [--register <path>] [--at <ISO>]\n" +
" register-list [--all] [--json] [--register <path>] [--now <ISO>]\n" +
" register-complete --series <slug> --edition <NN> [--register <path>] [--at <ISO>]",
);
process.exit(2);
}
/** A failed operation (as opposed to a malformed invocation). */
function fail(msg: string): never {
console.error(`error: ${msg}`);
process.exit(1);
}
/** A flag that was given a real value (not absent, not a bare boolean flag). */
function value(flags: Record<string, string>, key: string): string | undefined {
const v = flags[key];
return v === undefined || v === "true" ? undefined : v;
}
function readJson(path: string, what: string): unknown {
try {
return JSON.parse(readFileSync(path, "utf8"));
} catch (err) {
usage(`could not read ${what} at ${path}: ${(err as Error).message}`);
}
}
function stringList(raw: unknown): string[] {
if (!Array.isArray(raw)) return [];
return raw.filter((x): x is string => typeof x === "string" && x.trim().length > 0);
}
/** Validate the AI extract at the edge — a malformed extract must not become a silent empty entry. */
function toEntry(raw: unknown): DistillateEntry {
const o = (raw ?? {}) as Record<string, unknown>;
for (const field of ["editionId", "title", "lockedAt"]) {
const v = o[field];
if (typeof v !== "string" || v.trim().length === 0) {
usage(`extract is missing required string field: ${field}`);
}
}
return {
editionId: o.editionId as string,
title: o.title as string,
lockedAt: o.lockedAt as string,
anecdotes: stringList(o.anecdotes),
arguments: stringList(o.arguments),
hooks: stringList(o.hooks),
};
}
/**
* One edition as the operator reads it: what it is, where it stands, what the
* one next move is, and how long it has been running. This block IS the WIP
* answer — if it needs a follow-up file to be useful, the register has failed.
*/
function renderRow(row: EditionRow, now: string): string {
const days = elapsedDays(row.startedAt, row.completedAt ?? now);
const age =
days === null
? "age unknown"
: row.status === "complete"
? `lead time ${days} day(s)`
: `${days} day(s) in flight`;
return (
`\n · ${row.series}/${row.editionId}${row.title ? ` — "${row.title}"` : ""}\n` +
` phase: ${row.currentPhase} → next: ${row.nextAction ?? "—"}\n` +
` ${age} · slot: ${row.slot ?? "—"}\n` +
` ${row.path}`
);
}
function main(): void {
const [command, ...rest] = process.argv.slice(2);
const flags = parseFlags(rest);
const distillatePath = value(flags, "distillate");
const asJson = flags.json === "true";
if (command === "distil-append") {
if (!distillatePath) usage("distil-append needs --distillate <path>");
const series = value(flags, "series");
if (!series) usage("distil-append needs --series <slug>");
const extractPath = value(flags, "extract");
if (!extractPath) usage("distil-append needs --extract <extract.json>");
const entry = toEntry(readJson(extractPath, "extract"));
const res = appendEntry(loadDistillate(distillatePath, series), entry);
saveDistillate(distillatePath, res.distillate);
const units = entry.anecdotes.length + entry.arguments.length + entry.hooks.length;
console.log(
`${res.replaced ? "Replaced" : "Appended"} edition ${entry.editionId} (${units} narrative unit(s)) ` +
`in ${distillatePath}${res.distillate.editions.length} edition(s) in the series distillate`,
);
return;
}
if (command === "distil-check") {
if (!distillatePath) usage("distil-check needs --distillate <path>");
const skeletonPath = value(flags, "skeleton");
if (!skeletonPath) usage("distil-check needs --skeleton <skeleton.json>");
const rawThreshold = value(flags, "threshold");
let threshold = DEFAULT_THRESHOLD;
if (rawThreshold !== undefined) {
threshold = Number(rawThreshold);
if (!Number.isFinite(threshold) || threshold <= 0 || threshold > 1) {
usage("--threshold must be a number in (0, 1]");
}
}
const candidate = (readJson(skeletonPath, "skeleton") ?? {}) as SkeletonCandidate;
const report = checkSkeleton(loadDistillate(distillatePath, value(flags, "series") ?? ""), candidate, {
threshold,
});
if (asJson) {
console.log(JSON.stringify(report, null, 2));
return;
}
if (report.verdict === "CLEAR") {
console.log(
`CLEAR — nothing in this skeleton resembles the ${report.comparedAgainst} locked edition(s) ` +
`(threshold ${report.threshold}).`,
);
return;
}
console.log(
`REUSE — ${report.hits.length} unit(s) resemble earlier editions (threshold ${report.threshold}, ` +
`${report.comparedAgainst} edition(s) checked):`,
);
for (const hit of report.hits) {
console.log(`\n · ${hit.kind}${(hit.score * 100).toFixed(0)}% like edition ${hit.editionId}`);
console.log(` new: ${hit.candidate}`);
console.log(` then: ${hit.matched}`);
}
console.log("\nAdvisory: a deliberate callback is fine — an unnoticed retread is not.");
return;
}
if (command === "register-upsert") {
const statePath = value(flags, "edition-state");
if (!statePath) usage("register-upsert needs --edition-state <path>");
const at = value(flags, "at") ?? new Date().toISOString();
const registerPath = value(flags, "register") ?? defaultRegisterPath();
let state;
try {
state = readEditionState(statePath);
} catch (err) {
usage(`could not read edition-state at ${statePath}: ${(err as Error).message}`);
}
let facts;
try {
facts = editionFacts(state);
} catch (err) {
usage((err as Error).message);
}
// Log first, mirror second: the state file is the source of truth, and a
// register row for a transition that was never logged would be a lie.
const logged = appendPhase(state, facts.editionId, facts.currentPhase, at);
if (logged.appended) saveEditionState(statePath, logged.state);
const { register, row, created } = upsertEdition(
loadRegister(registerPath),
{
series: facts.series,
editionId: facts.editionId,
title: facts.title,
path: value(flags, "path") ?? seriesRootFromStatePath(statePath),
currentPhase: facts.currentPhase,
nextAction: value(flags, "next"),
slot: value(flags, "slot"),
},
at,
);
saveRegister(registerPath, register);
console.log(
`${created ? "Registered" : "Updated"} ${row.series}/${row.editionId} at phase ${row.currentPhase} ` +
`(${logged.appended ? "phase logged" : "phase already logged"}) — ${registerPath}`,
);
return;
}
if (command === "register-list") {
const registerPath = value(flags, "register") ?? defaultRegisterPath();
const includeComplete = flags.all === "true";
const now = value(flags, "now") ?? new Date().toISOString();
const rows = listEditions(loadRegister(registerPath), { includeComplete });
if (asJson) {
console.log(JSON.stringify(rows, null, 2));
return;
}
if (rows.length === 0) {
console.log(includeComplete ? "No editions in the register." : "No editions in flight.");
return;
}
console.log(
includeComplete
? `${rows.length} edition(s) in the register:`
: `${rows.length} edition(s) in flight:`,
);
for (const row of rows) console.log(renderRow(row, now));
return;
}
if (command === "register-complete") {
const series = value(flags, "series");
const editionId = value(flags, "edition");
if (!series || !editionId) usage("register-complete needs --series <slug> and --edition <NN>");
const at = value(flags, "at") ?? new Date().toISOString();
const registerPath = value(flags, "register") ?? defaultRegisterPath();
const { register, row } = completeEdition(loadRegister(registerPath), { series, editionId }, at);
if (!row) fail(`no register row for ${series}/${editionId} — nothing to complete`);
saveRegister(registerPath, register);
const lead = elapsedDays(row.startedAt, row.completedAt ?? at);
console.log(
`Completed ${row.series}/${row.editionId}` +
(lead === null ? "" : ` — lead time ${lead} day(s)`) +
`${registerPath}`,
);
return;
}
usage(command ? `unknown command: ${command}` : "no command given");
}
main();