@notedge/panduck 0.0.0 → 0.0.2

package/src/cli/exit-codes.ts

@@ -1,14 +1,14 @@
-/** Stable Panduck CLI exit codes (see Living CLI contract). */
-export const ExitCode = {
-    Success: 0,
-    LossPolicyViolation: 1,
-    InvalidArgs: 2,
-    InputUnsupported: 3,
-    ParseFailure: 4,
-    IrOrWriterFailure: 5,
-    OutputFailure: 6,
-    BudgetExceeded: 7,
-    BatchFailure: 8,
-} as const;
-
-export type ExitCodeValue = (typeof ExitCode)[keyof typeof ExitCode];
+/** Stable Panduck CLI exit codes (see Living CLI contract). */
+export const ExitCode = {
+    Success: 0,
+    LossPolicyViolation: 1,
+    InvalidArgs: 2,
+    InputUnsupported: 3,
+    ParseFailure: 4,
+    IrOrWriterFailure: 5,
+    OutputFailure: 6,
+    BudgetExceeded: 7,
+    BatchFailure: 8,
+} as const;
+
+export type ExitCodeValue = (typeof ExitCode)[keyof typeof ExitCode];

package/src/cli/format-registry.ts

@@ -1,170 +1,170 @@
-import type { PanduckBindings } from "../types.js";
-
-export type CapabilityState =
-    | "registered"
-    | "planned"
-    | "partial"
-    | "ready"
-    | "unavailable"
-    | "blocked";
-
-export type OperationKind = "read" | "write";
-
-export type OperationCapability = {
-    state: CapabilityState;
-    stages: string[];
-};
-
-export type FormatRecord = {
-    format: string;
-    container: string[];
-    aliases?: string[];
-    reader: OperationCapability;
-    writer: OperationCapability;
-    embeddedText?: string[];
-    coverage: {
-        state: CapabilityState;
-        known: string[];
-        unknown: string[];
-    };
-};
-
-const TEXT_READ_STAGES = ["probe", "decode", "validate"];
-const TEXT_WRITE_STAGES = ["ir", "validate"];
-const CONTAINER_READ_STAGES = ["probe", "index", "decode", "validate"];
-const CONTAINER_WRITE_STAGES = ["ir", "package", "validate"];
-
-function textFormat(
-    format: string,
-    reader: CapabilityState,
-    writer: CapabilityState,
-    known: string[],
-    unknown: string[],
-    aliases?: string[],
-): FormatRecord {
-    return {
-        format,
-        container: ["text"],
-        aliases,
-        reader: { state: reader, stages: TEXT_READ_STAGES },
-        writer: { state: writer, stages: TEXT_WRITE_STAGES },
-        coverage: { state: reader === "ready" && writer === "ready" ? "ready" : "partial", known, unknown },
-    };
-}
-
-function containerFormat(
-    format: string,
-    container: string[],
-    reader: CapabilityState,
-    writer: CapabilityState,
-    embeddedText: string[],
-    known: string[],
-    unknown: string[],
-): FormatRecord {
-    return {
-        format,
-        container,
-        reader: { state: reader, stages: CONTAINER_READ_STAGES },
-        writer: { state: writer, stages: CONTAINER_WRITE_STAGES },
-        embeddedText,
-        coverage: {
-            state:
-                reader === "ready" && writer === "ready"
-                    ? "ready"
-                    : reader === "planned" && writer === "planned"
-                      ? "planned"
-                      : "partial",
-            known,
-            unknown,
-        },
-    };
-}
-
-/** Static capability registry aligned with the Panduck Living CLI matrix. */
-export function baseFormatRegistry(): FormatRecord[] {
-    return [
-        textFormat("markdown", "partial", "ready", ["paragraph", "heading", "code_block", "link"], ["table", "footnote"]),
-        textFormat("notedown", "partial", "planned", ["paragraph", "heading", "list", "link"], ["macro", "table"]),
-        textFormat("org", "partial", "partial", ["headline", "paragraph"], ["drawer", "babel"]),
-        textFormat("rst", "partial", "partial", ["paragraph", "directive"], ["table"]),
-        textFormat("tex", "partial", "partial", ["paragraph", "command"], ["environment"]),
-        textFormat("html", "planned", "planned", ["paragraph", "heading"], ["script", "style"]),
-        containerFormat(
-            "docx",
-            ["zip", "opc"],
-            "partial",
-            "partial",
-            ["oak-xml"],
-            ["paragraph", "heading", "list", "table", "style", "hyperlink", "image", "bold", "italic", "footnote_reference", "footnote_body"],
-            ["tracked_changes", "comment"],
-        ),
-        containerFormat(
-            "epub",
-            ["zip", "ocf"],
-            "planned",
-            "planned",
-            ["oak-xml", "oak-xhtml"],
-            ["spine", "nav", "image"],
-            ["fixed_layout"],
-        ),
-        containerFormat(
-            "pdf",
-            ["pdf"],
-            "planned",
-            "planned",
-            [],
-            ["page", "text_run", "image"],
-            ["annotation", "form", "encryption"],
-        ),
-        containerFormat(
-            "doc",
-            ["ole"],
-            "planned",
-            "unavailable",
-            ["oak-xml"],
-            ["paragraph"],
-            ["field", "revision"],
-        ),
-    ];
-}
-
-/** Merges N-API `supportedFormats()` names into the static registry as `registered` floors. */
-export function getFormatRegistry(bindings?: PanduckBindings | null): FormatRecord[] {
-    const registered = new Set((bindings?.supportedFormats() ?? []).map((name) => name.toLowerCase()));
-    return baseFormatRegistry().map((record) => {
-        if (!registered.has(record.format)) {
-            return record;
-        }
-        const readerState = bumpRegistered(record.reader.state);
-        const writerState = bumpRegistered(record.writer.state);
-        return {
-            ...record,
-            reader: { ...record.reader, state: readerState },
-            writer: { ...record.writer, state: writerState },
-        };
-    });
-}
-
-function bumpRegistered(state: CapabilityState): CapabilityState {
-    if (state === "planned" || state === "registered") {
-        return "registered";
-    }
-    return state;
-}
-
-export function findFormat(registry: FormatRecord[], id: string): FormatRecord | undefined {
-    const needle = id.toLowerCase();
-    return registry.find(
-        (record) =>
-            record.format === needle || record.aliases?.some((alias) => alias.toLowerCase() === needle),
-    );
-}
-
-export function isOperationReady(record: FormatRecord, operation: OperationKind): boolean {
-    const capability = operation === "read" ? record.reader : record.writer;
-    return capability.state === "ready";
-}
-
-export function ebookAliasTarget(): string {
-    return "epub";
-}
+import type { PanduckBindings } from "../types.js";
+
+export type CapabilityState =
+    | "registered"
+    | "planned"
+    | "partial"
+    | "ready"
+    | "unavailable"
+    | "blocked";
+
+export type OperationKind = "read" | "write";
+
+export type OperationCapability = {
+    state: CapabilityState;
+    stages: string[];
+};
+
+export type FormatRecord = {
+    format: string;
+    container: string[];
+    aliases?: string[];
+    reader: OperationCapability;
+    writer: OperationCapability;
+    embeddedText?: string[];
+    coverage: {
+        state: CapabilityState;
+        known: string[];
+        unknown: string[];
+    };
+};
+
+const TEXT_READ_STAGES = ["probe", "decode", "validate"];
+const TEXT_WRITE_STAGES = ["ir", "validate"];
+const CONTAINER_READ_STAGES = ["probe", "index", "decode", "validate"];
+const CONTAINER_WRITE_STAGES = ["ir", "package", "validate"];
+
+function textFormat(
+    format: string,
+    reader: CapabilityState,
+    writer: CapabilityState,
+    known: string[],
+    unknown: string[],
+    aliases?: string[],
+): FormatRecord {
+    return {
+        format,
+        container: ["text"],
+        aliases,
+        reader: { state: reader, stages: TEXT_READ_STAGES },
+        writer: { state: writer, stages: TEXT_WRITE_STAGES },
+        coverage: { state: reader === "ready" && writer === "ready" ? "ready" : "partial", known, unknown },
+    };
+}
+
+function containerFormat(
+    format: string,
+    container: string[],
+    reader: CapabilityState,
+    writer: CapabilityState,
+    embeddedText: string[],
+    known: string[],
+    unknown: string[],
+): FormatRecord {
+    return {
+        format,
+        container,
+        reader: { state: reader, stages: CONTAINER_READ_STAGES },
+        writer: { state: writer, stages: CONTAINER_WRITE_STAGES },
+        embeddedText,
+        coverage: {
+            state:
+                reader === "ready" && writer === "ready"
+                    ? "ready"
+                    : reader === "planned" && writer === "planned"
+                      ? "planned"
+                      : "partial",
+            known,
+            unknown,
+        },
+    };
+}
+
+/** Static capability registry aligned with the Panduck Living CLI matrix. */
+export function baseFormatRegistry(): FormatRecord[] {
+    return [
+        textFormat("markdown", "partial", "ready", ["paragraph", "heading", "code_block", "link"], ["table", "footnote"]),
+        textFormat("notedown", "partial", "planned", ["paragraph", "heading", "list", "link"], ["macro", "table"]),
+        textFormat("org", "partial", "partial", ["headline", "paragraph"], ["drawer", "babel"]),
+        textFormat("rst", "partial", "partial", ["paragraph", "directive"], ["table"]),
+        textFormat("tex", "partial", "partial", ["paragraph", "command"], ["environment"]),
+        textFormat("html", "planned", "planned", ["paragraph", "heading"], ["script", "style"]),
+        containerFormat(
+            "docx",
+            ["zip", "opc"],
+            "partial",
+            "partial",
+            ["oak-xml"],
+            ["paragraph", "heading", "list", "table", "style", "hyperlink", "image", "bold", "italic", "footnote_reference", "footnote_body"],
+            ["tracked_changes", "comment"],
+        ),
+        containerFormat(
+            "epub",
+            ["zip", "ocf"],
+            "planned",
+            "planned",
+            ["oak-xml", "oak-xhtml"],
+            ["spine", "nav", "image"],
+            ["fixed_layout"],
+        ),
+        containerFormat(
+            "pdf",
+            ["pdf"],
+            "planned",
+            "planned",
+            [],
+            ["page", "text_run", "image"],
+            ["annotation", "form", "encryption"],
+        ),
+        containerFormat(
+            "doc",
+            ["ole"],
+            "planned",
+            "unavailable",
+            ["oak-xml"],
+            ["paragraph"],
+            ["field", "revision"],
+        ),
+    ];
+}
+
+/** Merges N-API `supportedFormats()` names into the static registry as `registered` floors. */
+export function getFormatRegistry(bindings?: PanduckBindings | null): FormatRecord[] {
+    const registered = new Set((bindings?.supportedFormats() ?? []).map((name) => name.toLowerCase()));
+    return baseFormatRegistry().map((record) => {
+        if (!registered.has(record.format)) {
+            return record;
+        }
+        const readerState = bumpRegistered(record.reader.state);
+        const writerState = bumpRegistered(record.writer.state);
+        return {
+            ...record,
+            reader: { ...record.reader, state: readerState },
+            writer: { ...record.writer, state: writerState },
+        };
+    });
+}
+
+function bumpRegistered(state: CapabilityState): CapabilityState {
+    if (state === "planned" || state === "registered") {
+        return "registered";
+    }
+    return state;
+}
+
+export function findFormat(registry: FormatRecord[], id: string): FormatRecord | undefined {
+    const needle = id.toLowerCase();
+    return registry.find(
+        (record) =>
+            record.format === needle || record.aliases?.some((alias) => alias.toLowerCase() === needle),
+    );
+}
+
+export function isOperationReady(record: FormatRecord, operation: OperationKind): boolean {
+    const capability = operation === "read" ? record.reader : record.writer;
+    return capability.state === "ready";
+}
+
+export function ebookAliasTarget(): string {
+    return "epub";
+}

package/src/cli/index.ts

@@ -1,7 +1,7 @@
-export { buildPanduckCli } from "./cli.js";
-export { runCli } from "./main.js";
-export { ExitCode } from "./exit-codes.js";
-export { getFormatRegistry, baseFormatRegistry } from "./format-registry.js";
-export type { FormatRecord, CapabilityState, OperationKind } from "./format-registry.js";
-export { REPORT_SCHEMA_VERSION } from "./report.js";
-export type { PanduckReport } from "./report.js";
+export { buildPanduckCli } from "./cli.js";
+export { runCli } from "./main.js";
+export { ExitCode } from "./exit-codes.js";
+export { getFormatRegistry, baseFormatRegistry } from "./format-registry.js";
+export type { FormatRecord, CapabilityState, OperationKind } from "./format-registry.js";
+export { REPORT_SCHEMA_VERSION } from "./report.js";
+export type { PanduckReport } from "./report.js";

package/src/cli/main.ts

@@ -1,10 +1,10 @@
-import { buildPanduckCli } from "./cli.js";
-
-export async function runCli(argv: string[]): Promise<number> {
-    try {
-        return await buildPanduckCli().parse(argv);
-    } catch (error) {
-        console.error(`error: ${error instanceof Error ? error.message : String(error)}`);
-        return 2;
-    }
-}
+import { buildPanduckCli } from "./cli.js";
+
+export async function runCli(argv: string[]): Promise<number> {
+    try {
+        return await buildPanduckCli().parse(argv);
+    } catch (error) {
+        console.error(`error: ${error instanceof Error ? error.message : String(error)}`);
+        return 2;
+    }
+}

package/src/cli/options.ts

@@ -1,127 +1,127 @@
-import type { ParsedOptions } from "@vmz/commander";
-
-import { ExitCode } from "./exit-codes.js";
-import type { LossPolicy } from "./report.js";
-
-export type AssetPolicy = "preserve" | "copy" | "embed" | "drop";
-export type LinkPolicy = "preserve" | "rewrite" | "drop";
-export type DiagnosticsMode = "silent" | "human" | "json";
-export type InspectStage = "probe" | "index" | "decode" | "validate";
-
-export type SharedCliOptions = {
-    from?: string;
-    to?: string;
-    profile?: string;
-    config?: string;
-    json: boolean;
-    budgets: Record<string, number>;
-    loss: LossPolicy;
-    strict: boolean;
-    allowPartial: boolean;
-    diagnostics: DiagnosticsMode;
-    overwrite: boolean;
-    logFile?: string;
-};
-
-const LOSS_VALUES = new Set<LossPolicy>(["allow", "warn", "deny"]);
-const ASSET_VALUES = new Set<AssetPolicy>(["preserve", "copy", "embed", "drop"]);
-const LINK_VALUES = new Set<LinkPolicy>(["preserve", "rewrite", "drop"]);
-const DIAG_VALUES = new Set<DiagnosticsMode>(["silent", "human", "json"]);
-const STAGE_VALUES = new Set<InspectStage>(["probe", "index", "decode", "validate"]);
-
-export function readFlag(options: ParsedOptions, key: string): boolean {
-    return options[key] === true;
-}
-
-export function readString(options: ParsedOptions, key: string): string | undefined {
-    const value = options[key];
-    if (typeof value === "string" && value.length > 0) {
-        return value;
-    }
-    return undefined;
-}
-
-export function readSharedOptions(options: ParsedOptions): SharedCliOptions {
-    const loss = parseEnum(readString(options, "loss") ?? "warn", LOSS_VALUES, "loss");
-    const diagnostics = parseEnum(
-        readString(options, "diagnostics") ?? "human",
-        DIAG_VALUES,
-        "diagnostics",
-    );
-    return {
-        from: readString(options, "from"),
-        to: readString(options, "to"),
-        profile: readString(options, "profile"),
-        config: readString(options, "config"),
-        json: readFlag(options, "json"),
-        budgets: parseBudgets(options.budget),
-        loss,
-        strict: readFlag(options, "strict"),
-        allowPartial: readFlag(options, "allow-partial"),
-        diagnostics,
-        overwrite: readFlag(options, "overwrite"),
-        logFile: readString(options, "log-file"),
-    };
-}
-
-export function parseAssetPolicy(value: string | undefined): AssetPolicy {
-    return parseEnum(value ?? "preserve", ASSET_VALUES, "asset-policy");
-}
-
-export function parseLinkPolicy(value: string | undefined): LinkPolicy {
-    return parseEnum(value ?? "preserve", LINK_VALUES, "link-policy");
-}
-
-export function parseInspectStage(value: string | undefined): InspectStage {
-    return parseEnum(value ?? "probe", STAGE_VALUES, "stage");
-}
-
-function parseEnum<T extends string>(value: string, allowed: Set<T>, name: string): T {
-    if (!allowed.has(value as T)) {
-        throw new CliOptionError(name, value);
-    }
-    return value as T;
-}
-
-export function parseBudgets(raw: string | boolean | string[] | undefined): Record<string, number> {
-    const entries = normalizeRepeatable(raw);
-    const budgets: Record<string, number> = {};
-    for (const item of entries) {
-        const eq = item.indexOf("=");
-        if (eq <= 0) {
-            throw new CliOptionError("budget", item);
-        }
-        const key = item.slice(0, eq).trim();
-        const value = Number(item.slice(eq + 1).trim());
-        if (!Number.isFinite(value) || value < 0) {
-            throw new CliOptionError("budget", item);
-        }
-        budgets[key] = value;
-    }
-    return budgets;
-}
-
-function normalizeRepeatable(raw: string | boolean | string[] | undefined): string[] {
-    if (raw === undefined || raw === false) {
-        return [];
-    }
-    if (Array.isArray(raw)) {
-        return raw;
-    }
-    if (typeof raw === "string") {
-        return [raw];
-    }
-    return [];
-}
-
-export class CliOptionError extends Error {
-    readonly field: string;
-    readonly value: string;
-    readonly exitCode = ExitCode.InvalidArgs;
-
-    constructor(field: string, value: string) {
-        super(`invalid ${field}: ${value}`);
-        this.field = field;
-        this.value = value;
-    }
-}
+import type { ParsedOptions } from "@vmz/commander";
+
+import { ExitCode } from "./exit-codes.js";
+import type { LossPolicy } from "./report.js";
+
+export type AssetPolicy = "preserve" | "copy" | "embed" | "drop";
+export type LinkPolicy = "preserve" | "rewrite" | "drop";
+export type DiagnosticsMode = "silent" | "human" | "json";
+export type InspectStage = "probe" | "index" | "decode" | "validate";
+
+export type SharedCliOptions = {
+    from?: string;
+    to?: string;
+    profile?: string;
+    config?: string;
+    json: boolean;
+    budgets: Record<string, number>;
+    loss: LossPolicy;
+    strict: boolean;
+    allowPartial: boolean;
+    diagnostics: DiagnosticsMode;
+    overwrite: boolean;
+    logFile?: string;
+};
+
+const LOSS_VALUES = new Set<LossPolicy>(["allow", "warn", "deny"]);
+const ASSET_VALUES = new Set<AssetPolicy>(["preserve", "copy", "embed", "drop"]);
+const LINK_VALUES = new Set<LinkPolicy>(["preserve", "rewrite", "drop"]);
+const DIAG_VALUES = new Set<DiagnosticsMode>(["silent", "human", "json"]);
+const STAGE_VALUES = new Set<InspectStage>(["probe", "index", "decode", "validate"]);
+
+export function readFlag(options: ParsedOptions, key: string): boolean {
+    return options[key] === true;
+}
+
+export function readString(options: ParsedOptions, key: string): string | undefined {
+    const value = options[key];
+    if (typeof value === "string" && value.length > 0) {
+        return value;
+    }
+    return undefined;
+}
+
+export function readSharedOptions(options: ParsedOptions): SharedCliOptions {
+    const loss = parseEnum(readString(options, "loss") ?? "warn", LOSS_VALUES, "loss");
+    const diagnostics = parseEnum(
+        readString(options, "diagnostics") ?? "human",
+        DIAG_VALUES,
+        "diagnostics",
+    );
+    return {
+        from: readString(options, "from"),
+        to: readString(options, "to"),
+        profile: readString(options, "profile"),
+        config: readString(options, "config"),
+        json: readFlag(options, "json"),
+        budgets: parseBudgets(options.budget),
+        loss,
+        strict: readFlag(options, "strict"),
+        allowPartial: readFlag(options, "allow-partial"),
+        diagnostics,
+        overwrite: readFlag(options, "overwrite"),
+        logFile: readString(options, "log-file"),
+    };
+}
+
+export function parseAssetPolicy(value: string | undefined): AssetPolicy {
+    return parseEnum(value ?? "preserve", ASSET_VALUES, "asset-policy");
+}
+
+export function parseLinkPolicy(value: string | undefined): LinkPolicy {
+    return parseEnum(value ?? "preserve", LINK_VALUES, "link-policy");
+}
+
+export function parseInspectStage(value: string | undefined): InspectStage {
+    return parseEnum(value ?? "probe", STAGE_VALUES, "stage");
+}
+
+function parseEnum<T extends string>(value: string, allowed: Set<T>, name: string): T {
+    if (!allowed.has(value as T)) {
+        throw new CliOptionError(name, value);
+    }
+    return value as T;
+}
+
+export function parseBudgets(raw: string | boolean | string[] | undefined): Record<string, number> {
+    const entries = normalizeRepeatable(raw);
+    const budgets: Record<string, number> = {};
+    for (const item of entries) {
+        const eq = item.indexOf("=");
+        if (eq <= 0) {
+            throw new CliOptionError("budget", item);
+        }
+        const key = item.slice(0, eq).trim();
+        const value = Number(item.slice(eq + 1).trim());
+        if (!Number.isFinite(value) || value < 0) {
+            throw new CliOptionError("budget", item);
+        }
+        budgets[key] = value;
+    }
+    return budgets;
+}
+
+function normalizeRepeatable(raw: string | boolean | string[] | undefined): string[] {
+    if (raw === undefined || raw === false) {
+        return [];
+    }
+    if (Array.isArray(raw)) {
+        return raw;
+    }
+    if (typeof raw === "string") {
+        return [raw];
+    }
+    return [];
+}
+
+export class CliOptionError extends Error {
+    readonly field: string;
+    readonly value: string;
+    readonly exitCode = ExitCode.InvalidArgs;
+
+    constructor(field: string, value: string) {
+        super(`invalid ${field}: ${value}`);
+        this.field = field;
+        this.value = value;
+    }
+}