stego-cli 0.3.2 → 0.3.4

package/dist/stego-cli.js

@@ -8,6 +8,7 @@ import { createInterface } from "node:readline/promises";
 import { fileURLToPath } from "node:url";
 import { markdownExporter } from "./exporters/markdown-exporter.js";
 import { createPandocExporter } from "./exporters/pandoc-exporter.js";
+import { parseCommentAppendix } from "./comments/comment-domain.js";
 import { runCommentsCommand } from "./comments/comments-command.js";
 import { CommentsCommandError } from "./comments/errors.js";
 const STATUS_RANK = {
@@ -767,7 +768,7 @@ function writeInitRootPackageJson(targetRoot) {
     fs.writeFileSync(path.join(targetRoot, "package.json"), `${JSON.stringify(manifest, null, 2)}\n`, "utf8");
 }
 function printUsage() {
-    console.log(`Stego CLI\n\nCommands:\n  init [--force]\n  list-projects [--root <path>]\n  new-project --project <project-id> [--title <title>] [--root <path>]\n  new --project <project-id> [--i <prefix>|-i <prefix>] [--root <path>]\n  validate --project <project-id> [--file <project-relative-manuscript-path>] [--root <path>]\n  build --project <project-id> [--root <path>]\n  check-stage --project <project-id> --stage <draft|revise|line-edit|proof|final> [--file <project-relative-manuscript-path>] [--root <path>]\n  lint --project <project-id> [--manuscript|--spine] [--root <path>]\n  export --project <project-id> --format <md|docx|pdf|epub> [--output <path>] [--root <path>]\n  comments add <manuscript> [--message <text> | --input <path|->] [--author <name>] [--start-line <n> --start-col <n> --end-line <n> --end-col <n>] [--format <text|json>]\n`);
+    console.log(`Stego CLI\n\nCommands:\n  init [--force]\n  list-projects [--root <path>]\n  new-project --project <project-id> [--title <title>] [--root <path>]\n  new --project <project-id> [--i <prefix>|-i <prefix>] [--root <path>]\n  validate --project <project-id> [--file <project-relative-manuscript-path>] [--root <path>]\n  build --project <project-id> [--root <path>]\n  check-stage --project <project-id> --stage <draft|revise|line-edit|proof|final> [--file <project-relative-manuscript-path>] [--root <path>]\n  lint --project <project-id> [--manuscript|--spine] [--root <path>]\n  export --project <project-id> --format <md|docx|pdf|epub> [--output <path>] [--root <path>]\n  comments read <manuscript> [--format <text|json>]\n  comments add <manuscript> [--message <text> | --input <path|->] [--author <name>] [--start-line <n> --start-col <n> --end-line <n> --end-col <n>] [--cursor-line <n>] [--format <text|json>]\n  comments reply <manuscript> --comment-id <CMT-####> [--message <text> | --input <path|->] [--author <name>] [--format <text|json>]\n  comments set-status <manuscript> --comment-id <CMT-####> --status <open|resolved> [--thread] [--format <text|json>]\n  comments delete <manuscript> --comment-id <CMT-####> [--format <text|json>]\n  comments clear-resolved <manuscript> [--format <text|json>]\n  comments sync-anchors <manuscript> --input <path|-> [--format <text|json>]\n`);
 }
 function listProjects() {
     const ids = getProjectIds();
@@ -1375,252 +1376,29 @@ function parseMetadata(raw, chapterPath, required) {
     };
 }
 function parseStegoCommentsAppendix(body, relativePath, bodyStartLine) {
-    const lineEnding = body.includes("\r\n") ? "\r\n" : "\n";
-    const lines = body.split(/\r?\n/);
-    const startMarker = "<!-- stego-comments:start -->";
-    const endMarker = "<!-- stego-comments:end -->";
-    const issues = [];
-    const startIndexes = findTrimmedLineIndexes(lines, startMarker);
-    const endIndexes = findTrimmedLineIndexes(lines, endMarker);
-    if (startIndexes.length === 0 && endIndexes.length === 0) {
-        return { bodyWithoutComments: body, comments: [], issues };
-    }
-    if (startIndexes.length !== 1 || endIndexes.length !== 1) {
-        if (startIndexes.length !== 1) {
-            issues.push(makeIssue("error", "comments", `Expected exactly one '${startMarker}' marker.`, relativePath));
-        }
-        if (endIndexes.length !== 1) {
-            issues.push(makeIssue("error", "comments", `Expected exactly one '${endMarker}' marker.`, relativePath));
-        }
-        return { bodyWithoutComments: body, comments: [], issues };
-    }
-    const start = startIndexes[0];
-    const end = endIndexes[0];
-    if (end <= start) {
-        issues.push(makeIssue("error", "comments", `'${endMarker}' must appear after '${startMarker}'.`, relativePath, bodyStartLine + end));
-        return { bodyWithoutComments: body, comments: [], issues };
-    }
-    const blockLines = lines.slice(start + 1, end);
-    const comments = parseStegoCommentThreads(blockLines, relativePath, bodyStartLine + start + 1, issues);
-    let removeStart = start;
-    if (removeStart > 0 && lines[removeStart - 1].trim().length === 0) {
-        removeStart -= 1;
-    }
-    const kept = [...lines.slice(0, removeStart), ...lines.slice(end + 1)];
-    while (kept.length > 0 && kept[kept.length - 1].trim().length === 0) {
-        kept.pop();
-    }
+    const parsed = parseCommentAppendix(body);
+    const issues = parsed.errors.map((error) => parseCommentIssueFromParserError(error, relativePath, bodyStartLine));
+    const comments = parsed.comments.map((comment) => ({
+        id: comment.id,
+        resolved: comment.status === "resolved",
+        thread: comment.thread
+    }));
     return {
-        bodyWithoutComments: kept.join(lineEnding),
+        bodyWithoutComments: parsed.contentWithoutComments,
         comments,
         issues
     };
 }
-function parseStegoCommentThreads(lines, relativePath, baseLine, issues) {
-    const comments = [];
-    let index = 0;
-    while (index < lines.length) {
-        const trimmed = lines[index].trim();
-        if (!trimmed) {
-            index += 1;
-            continue;
-        }
-        const id = parseCommentThreadDelimiter(trimmed);
-        if (!id) {
-            issues.push(makeIssue("error", "comments", "Invalid comments appendix line. Expected comment delimiter '<!-- comment: CMT-0001 -->'.", relativePath, baseLine + index));
-            index += 1;
-            continue;
-        }
-        index += 1;
-        const rowLines = [];
-        const rowLineNumbers = [];
-        while (index < lines.length) {
-            const nextTrimmed = lines[index].trim();
-            if (parseCommentThreadDelimiter(nextTrimmed)) {
-                break;
-            }
-            rowLines.push(lines[index]);
-            rowLineNumbers.push(baseLine + index);
-            index += 1;
-        }
-        let resolved;
-        let sawMeta64 = false;
-        const thread = [];
-        let rowIndex = 0;
-        while (rowIndex < rowLines.length) {
-            const rawRow = rowLines[rowIndex];
-            const lineNumber = rowLineNumbers[rowIndex];
-            const trimmedRow = rawRow.trim();
-            if (!trimmedRow) {
-                rowIndex += 1;
-                continue;
-            }
-            if (thread.length > 0) {
-                issues.push(makeIssue("error", "comments", `Multiple message blocks found for ${id}. Create a new CMT id for each reply.`, relativePath, lineNumber));
-                break;
-            }
-            if (!sawMeta64) {
-                const metaMatch = trimmedRow.match(/^<!--\s*meta64:\s*(\S+)\s*-->\s*$/);
-                if (!metaMatch) {
-                    issues.push(makeIssue("error", "comments", `Invalid comment metadata row '${trimmedRow}'. Expected '<!-- meta64: <base64url-json> -->'.`, relativePath, lineNumber));
-                    rowIndex += 1;
-                    continue;
-                }
-                sawMeta64 = true;
-                const decoded = decodeCommentMeta64(metaMatch[1], id, relativePath, lineNumber, issues);
-                if (decoded) {
-                    resolved = decoded.resolved;
-                }
-                rowIndex += 1;
-                continue;
-            }
-            const headerQuote = extractQuotedLine(rawRow);
-            if (headerQuote === undefined) {
-                issues.push(makeIssue("error", "comments", `Invalid thread header '${trimmedRow}'. Expected blockquote header like '> _timestamp | author_'.`, relativePath, lineNumber));
-                rowIndex += 1;
-                continue;
-            }
-            const header = parseThreadHeader(headerQuote);
-            if (!header) {
-                issues.push(makeIssue("error", "comments", `Invalid thread header '${headerQuote.trim()}'. Expected '> _timestamp | author_'.`, relativePath, lineNumber));
-                rowIndex += 1;
-                continue;
-            }
-            rowIndex += 1;
-            while (rowIndex < rowLines.length) {
-                const separatorRaw = rowLines[rowIndex];
-                const separatorTrimmed = separatorRaw.trim();
-                if (!separatorTrimmed) {
-                    rowIndex += 1;
-                    continue;
-                }
-                const separatorQuote = extractQuotedLine(separatorRaw);
-                if (separatorQuote !== undefined && separatorQuote.trim().length === 0) {
-                    rowIndex += 1;
-                }
-                break;
-            }
-            const messageLines = [];
-            while (rowIndex < rowLines.length) {
-                const messageRaw = rowLines[rowIndex];
-                const messageLineNumber = rowLineNumbers[rowIndex];
-                const messageTrimmed = messageRaw.trim();
-                if (!messageTrimmed) {
-                    rowIndex += 1;
-                    if (messageLines.length > 0) {
-                        break;
-                    }
-                    continue;
-                }
-                const messageQuote = extractQuotedLine(messageRaw);
-                if (messageQuote === undefined) {
-                    issues.push(makeIssue("error", "comments", `Invalid thread line '${messageTrimmed}'. Expected blockquote content starting with '>'.`, relativePath, messageLineNumber));
-                    rowIndex += 1;
-                    if (messageLines.length > 0) {
-                        break;
-                    }
-                    continue;
-                }
-                if (parseThreadHeader(messageQuote)) {
-                    break;
-                }
-                messageLines.push(messageQuote);
-                rowIndex += 1;
-            }
-            while (messageLines.length > 0 && messageLines[messageLines.length - 1].trim().length === 0) {
-                messageLines.pop();
-            }
-            if (messageLines.length === 0) {
-                issues.push(makeIssue("error", "comments", `Thread entry for comment ${id} is missing message text.`, relativePath, lineNumber));
-                continue;
-            }
-            const message = messageLines.join("\n").trim();
-            thread.push(`${header.timestamp} | ${header.author} | ${message}`);
-        }
-        if (!sawMeta64) {
-            issues.push(makeIssue("error", "comments", `Comment ${id} is missing metadata row ('<!-- meta64: <base64url-json> -->').`, relativePath));
-            resolved = false;
-        }
-        if (thread.length === 0) {
-            issues.push(makeIssue("error", "comments", `Comment ${id} is missing valid blockquote thread entries.`, relativePath));
-        }
-        comments.push({ id, resolved: Boolean(resolved), thread });
-    }
-    return comments;
-}
-function parseCommentThreadDelimiter(line) {
-    const markerMatch = line.match(/^<!--\s*comment:\s*(CMT-\d{4,})\s*-->\s*$/i);
-    if (markerMatch?.[1]) {
-        return markerMatch[1].toUpperCase();
-    }
-    const legacyHeadingMatch = line.match(/^###\s+(CMT-\d{4,})\s*$/i);
-    if (legacyHeadingMatch?.[1]) {
-        return legacyHeadingMatch[1].toUpperCase();
-    }
-    return undefined;
-}
-function decodeCommentMeta64(encoded, commentId, relativePath, lineNumber, issues) {
-    let rawJson = "";
-    try {
-        rawJson = Buffer.from(encoded, "base64url").toString("utf8");
-    }
-    catch {
-        issues.push(makeIssue("error", "comments", `Invalid meta64 payload for comment ${commentId}; expected base64url-encoded JSON.`, relativePath, lineNumber));
-        return undefined;
-    }
-    let parsed;
-    try {
-        parsed = JSON.parse(rawJson);
-    }
-    catch {
-        issues.push(makeIssue("error", "comments", `Invalid meta64 JSON for comment ${commentId}.`, relativePath, lineNumber));
-        return undefined;
-    }
-    if (!isPlainObject(parsed)) {
-        issues.push(makeIssue("error", "comments", `Invalid meta64 object for comment ${commentId}.`, relativePath, lineNumber));
-        return undefined;
-    }
-    const allowedKeys = new Set(["status", "anchor", "paragraph_index", "signature", "excerpt"]);
-    for (const key of Object.keys(parsed)) {
-        if (!allowedKeys.has(key)) {
-            issues.push(makeIssue("error", "comments", `meta64 for comment ${commentId} contains unsupported key '${key}'.`, relativePath, lineNumber));
-            return undefined;
-        }
-    }
-    const status = typeof parsed.status === "string" ? parsed.status.trim().toLowerCase() : "";
-    if (status !== "open" && status !== "resolved") {
-        issues.push(makeIssue("error", "comments", `meta64 for comment ${commentId} must include status 'open' or 'resolved'.`, relativePath, lineNumber));
-        return undefined;
-    }
-    return { resolved: status === "resolved" };
-}
-function extractQuotedLine(raw) {
-    const quoteMatch = raw.match(/^\s*>\s?(.*)$/);
-    if (!quoteMatch) {
-        return undefined;
-    }
-    return quoteMatch[1];
-}
-function parseThreadHeader(value) {
-    const match = value.trim().match(/^_(.+?)\s*\|\s*(.+?)_\s*$/);
-    if (!match) {
-        return undefined;
-    }
-    const timestamp = match[1].trim();
-    const author = match[2].trim();
-    if (!timestamp || !author) {
-        return undefined;
-    }
-    return { timestamp, author };
-}
-function findTrimmedLineIndexes(lines, marker) {
-    const indexes = [];
-    for (let index = 0; index < lines.length; index += 1) {
-        if (lines[index].trim() === marker) {
-            indexes.push(index);
-        }
+function parseCommentIssueFromParserError(error, relativePath, bodyStartLine) {
+    const lineMatch = error.match(/^Line\\s+(\\d+):\\s+([\\s\\S]+)$/);
+    if (!lineMatch) {
+        return makeIssue("error", "comments", error, relativePath);
     }
-    return indexes;
+    const relativeLine = Number.parseInt(lineMatch[1], 10);
+    const absoluteLine = Number.isFinite(relativeLine)
+        ? bodyStartLine + relativeLine - 1
+        : undefined;
+    return makeIssue("error", "comments", lineMatch[2], relativePath, absoluteLine);
 }
 function coerceMetadataValue(value) {
     if (!value) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stego-cli",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "type": "module",
   "description": "Installable CLI for the Stego writing monorepo workflow.",
   "license": "Apache-2.0",

package/dist/comments/add-comment.js

@@ -1,182 +0,0 @@
-import fs from "node:fs";
-import path from "node:path";
-import { CommentsCommandError } from "./errors.js";
-const COMMENT_DELIMITER_REGEX = /^<!--\s*comment:\s*(CMT-(\d{4,}))\s*-->\s*$/i;
-const LEGACY_COMMENT_HEADING_REGEX = /^###\s+(CMT-(\d{4,}))\s*$/i;
-const START_SENTINEL = "<!-- stego-comments:start -->";
-const END_SENTINEL = "<!-- stego-comments:end -->";
-/** Adds one stego comment entry to a manuscript and writes the updated file. */
-export function addCommentToManuscript(request) {
-    const absolutePath = path.resolve(request.cwd, request.manuscriptPath);
-    if (!fs.existsSync(absolutePath) || !fs.statSync(absolutePath).isFile()) {
-        throw new CommentsCommandError("INVALID_USAGE", 2, `Manuscript file not found: ${request.manuscriptPath}`);
-    }
-    const raw = fs.readFileSync(absolutePath, "utf8");
-    const lineEnding = raw.includes("\r\n") ? "\r\n" : "\n";
-    const lines = raw.split(/\r?\n/);
-    const sentinelState = resolveSentinelState(lines);
-    const hasYamlFrontmatter = raw.startsWith(`---${lineEnding}`) || raw.startsWith("---\n");
-    if (!sentinelState.hasSentinels && !hasYamlFrontmatter) {
-        throw new CommentsCommandError("NOT_STEGO_MANUSCRIPT", 3, "File is not recognized as a Stego manuscript (missing frontmatter and comments sentinels).");
-    }
-    const commentId = getNextCommentId(lines, sentinelState);
-    const createdAt = new Date().toISOString();
-    const meta = buildMetaPayload(request.range, request.sourceMeta);
-    const meta64 = Buffer.from(JSON.stringify(meta), "utf8").toString("base64url");
-    const entryLines = buildCommentEntryLines(commentId, createdAt, request.author, request.message, meta64);
-    const nextLines = applyCommentEntry(lines, sentinelState, entryLines);
-    const nextContent = `${nextLines.join(lineEnding)}${lineEnding}`;
-    try {
-        fs.writeFileSync(absolutePath, nextContent, "utf8");
-    }
-    catch (error) {
-        const message = error instanceof Error ? error.message : String(error);
-        throw new CommentsCommandError("WRITE_FAILURE", 6, `Failed to update manuscript: ${message}`);
-    }
-    const result = {
-        ok: true,
-        manuscript: absolutePath,
-        commentId,
-        status: "open",
-        anchor: request.range
-            ? {
-                type: "selection",
-                excerptStartLine: request.range.startLine,
-                excerptStartCol: request.range.startCol,
-                excerptEndLine: request.range.endLine,
-                excerptEndCol: request.range.endCol
-            }
-            : { type: "file" },
-        createdAt
-    };
-    return result;
-}
-function buildMetaPayload(range, sourceMeta) {
-    const payload = {
-        status: "open"
-    };
-    if (range) {
-        payload.anchor = "selection";
-        payload.excerpt = {
-            start_line: range.startLine,
-            start_col: range.startCol,
-            end_line: range.endLine,
-            end_col: range.endCol
-        };
-    }
-    if (sourceMeta && Object.keys(sourceMeta).length > 0) {
-        payload.signature = sourceMeta;
-    }
-    return payload;
-}
-function buildCommentEntryLines(commentId, timestamp, author, message, meta64) {
-    const safeAuthor = author.trim() || "Saurus";
-    const normalizedMessageLines = message
-        .replace(/\r\n/g, "\n")
-        .split("\n")
-        .map((line) => line.trimEnd());
-    return [
-        `<!-- comment: ${commentId} -->`,
-        `<!-- meta64: ${meta64} -->`,
-        `> _${timestamp} | ${safeAuthor}_`,
-        ">",
-        ...normalizedMessageLines.map((line) => `> ${line}`)
-    ];
-}
-function applyCommentEntry(lines, sentinelState, entryLines) {
-    if (!sentinelState.hasSentinels) {
-        const baseLines = trimTrailingBlankLines(lines);
-        return [
-            ...baseLines,
-            "",
-            START_SENTINEL,
-            "",
-            ...entryLines,
-            "",
-            END_SENTINEL
-        ];
-    }
-    const startIndex = sentinelState.startIndex;
-    const endIndex = sentinelState.endIndex;
-    const block = lines.slice(startIndex + 1, endIndex);
-    const trimmedBlock = trimOuterBlankLines(block);
-    const nextBlock = trimmedBlock.length > 0
-        ? [...trimmedBlock, "", ...entryLines]
-        : [...entryLines];
-    return [
-        ...lines.slice(0, startIndex + 1),
-        ...nextBlock,
-        ...lines.slice(endIndex)
-    ];
-}
-function resolveSentinelState(lines) {
-    const startIndexes = findTrimmedLineIndexes(lines, START_SENTINEL);
-    const endIndexes = findTrimmedLineIndexes(lines, END_SENTINEL);
-    const hasAnySentinel = startIndexes.length > 0 || endIndexes.length > 0;
-    if (!hasAnySentinel) {
-        return {
-            hasSentinels: false,
-            startIndex: -1,
-            endIndex: -1
-        };
-    }
-    if (startIndexes.length !== 1 || endIndexes.length !== 1) {
-        throw new CommentsCommandError("COMMENT_APPENDIX_INVALID", 5, `Expected exactly one '${START_SENTINEL}' and one '${END_SENTINEL}' marker.`);
-    }
-    const startIndex = startIndexes[0];
-    const endIndex = endIndexes[0];
-    if (endIndex <= startIndex) {
-        throw new CommentsCommandError("COMMENT_APPENDIX_INVALID", 5, `'${END_SENTINEL}' must appear after '${START_SENTINEL}'.`);
-    }
-    return {
-        hasSentinels: true,
-        startIndex,
-        endIndex
-    };
-}
-function findTrimmedLineIndexes(lines, target) {
-    const indexes = [];
-    for (let index = 0; index < lines.length; index += 1) {
-        if (lines[index].trim() === target) {
-            indexes.push(index);
-        }
-    }
-    return indexes;
-}
-function getNextCommentId(lines, sentinelState) {
-    const candidateLines = sentinelState.hasSentinels
-        ? lines.slice(sentinelState.startIndex + 1, sentinelState.endIndex)
-        : lines;
-    let maxId = 0;
-    for (const line of candidateLines) {
-        const trimmed = line.trim();
-        const match = trimmed.match(COMMENT_DELIMITER_REGEX) ?? trimmed.match(LEGACY_COMMENT_HEADING_REGEX);
-        if (!match || !match[2]) {
-            continue;
-        }
-        const numeric = Number.parseInt(match[2], 10);
-        if (Number.isFinite(numeric) && numeric > maxId) {
-            maxId = numeric;
-        }
-    }
-    const next = maxId + 1;
-    return `CMT-${String(next).padStart(4, "0")}`;
-}
-function trimTrailingBlankLines(lines) {
-    const copy = [...lines];
-    while (copy.length > 0 && copy[copy.length - 1].trim().length === 0) {
-        copy.pop();
-    }
-    return copy;
-}
-function trimOuterBlankLines(lines) {
-    let start = 0;
-    let end = lines.length;
-    while (start < end && lines[start].trim().length === 0) {
-        start += 1;
-    }
-    while (end > start && lines[end - 1].trim().length === 0) {
-        end -= 1;
-    }
-    return lines.slice(start, end);
-}