docrev 0.11.2 → 0.12.0

package/lib/trackchanges.ts

@@ -1,166 +0,0 @@
-/**
- * Track changes module - Apply markdown annotations as Word track changes
- *
- * Converts CriticMarkup insertions/deletions/substitutions to pandoc-native
- * track-change spans (`[text]{.insertion}` / `[text]{.deletion}`). Pandoc's
- * docx writer emits well-formed `w:ins`/`w:del` run-level revisions from these
- * spans in a single pass, so the output is valid OOXML that Word accepts and
- * that composes with comment injection (see lib/wordcomments.ts).
- */
-
-import * as fs from 'fs';
-import * as path from 'path';
-import { execSync } from 'child_process';
-import AdmZip from 'adm-zip';
-
-interface NativeTrackChangeOptions {
-  author?: string;
-  /** ISO-8601 timestamp for the revisions. Defaults to now (no milliseconds). */
-  date?: string;
-}
-
-export interface NativeTrackChangeStats {
-  insertions: number;
-  deletions: number;
-  substitutions: number;
-}
-
-interface ConvertResult {
-  text: string;
-  stats: NativeTrackChangeStats;
-}
-
-interface ApplyResult {
-  success: boolean;
-  message: string;
-  stats?: NativeTrackChangeStats;
-}
-
-/** Word/pandoc want revision dates without milliseconds: 2026-07-05T08:33:00Z */
-function isoDateNoMillis(): string {
-  return new Date().toISOString().replace(/\.\d{3}Z$/, 'Z');
-}
-
-/**
- * Escape a value for use inside a pandoc span attribute (`author="..."`).
- * Pandoc attribute values are double-quoted; a literal `"` or `\` would break
- * the attribute, so both are backslash-escaped.
- */
-function escapeSpanAttr(value: string): string {
-  return value.replace(/\\/g, '\\\\').replace(/"/g, '\\"');
-}
-
-/**
- * Convert CriticMarkup insertions/deletions/substitutions to pandoc-native
- * track-change spans. Comments (`{>>...<<}`) and highlights (`{==...==}`) are
- * left untouched — the caller decides how to handle those (strip, or thread
- * them via wordcomments.ts).
- *
- * A single pandoc pass over the result emits valid `w:ins`/`w:del` revisions,
- * so this composes with the full rev filter chain (crossref, citeproc,
- * reference-doc, macros) instead of post-processing document.xml by hand.
- *
- * @param text - Markdown with CriticMarkup annotations
- * @param options - Author/date for the revisions
- * @returns Converted markdown plus per-type counts
- */
-export function criticToNativeTrackChanges(
-  text: string,
-  options: NativeTrackChangeOptions = {}
-): ConvertResult {
-  const author = escapeSpanAttr(options.author ?? 'Author');
-  const date = escapeSpanAttr(options.date ?? isoDateNoMillis());
-  const insAttr = `{.insertion author="${author}" date="${date}"}`;
-  const delAttr = `{.deletion author="${author}" date="${date}"}`;
-
-  const stats: NativeTrackChangeStats = { insertions: 0, deletions: 0, substitutions: 0 };
-  let result = text;
-
-  // Substitutions first so `{~~old~>new~~}` is consumed before the insertion/
-  // deletion passes could see its inner delimiters. Emit delete-then-insert so
-  // Word shows the struck-through original followed by the replacement.
-  result = result.replace(/\{~~([\s\S]+?)~>([\s\S]+?)~~\}/g, (_m, oldText, newText) => {
-    stats.substitutions++;
-    return `[${oldText}]${delAttr}[${newText}]${insAttr}`;
-  });
-
-  // Insertions: {++text++}
-  result = result.replace(/\{\+\+([\s\S]+?)\+\+\}/g, (_m, content) => {
-    stats.insertions++;
-    return `[${content}]${insAttr}`;
-  });
-
-  // Deletions: {--text--}
-  result = result.replace(/\{--([\s\S]+?)--\}/g, (_m, content) => {
-    stats.deletions++;
-    return `[${content}]${delAttr}`;
-  });
-
-  return { text: result, stats };
-}
-
-/**
- * Enable tracked-revision display in a docx's settings.xml (in place).
- *
- * The `w:ins`/`w:del` elements already render as tracked changes without this,
- * but `w:trackRevisions` tells Word to keep tracking the author's further
- * edits — the expected state for a "return to author" review document.
- */
-export function enableTrackRevisions(docxPath: string): void {
-  const zip = new AdmZip(docxPath);
-  const settingsEntry = zip.getEntry('word/settings.xml');
-  if (!settingsEntry) return;
-  let settingsXml = zip.readAsText(settingsEntry);
-  if (settingsXml.includes('w:trackRevisions')) return;
-  // trackRevisions must appear early in the ordered settings sequence; placing
-  // it right after the opening tag keeps Word from rejecting the schema order.
-  settingsXml = settingsXml.replace(/(<w:settings[^>]*>)/, '$1<w:trackRevisions/>');
-  if (!settingsXml.includes('<w:trackRevisions/>')) {
-    // No opening tag matched (unexpected) — fall back to before the close tag.
-    settingsXml = settingsXml.replace('</w:settings>', '<w:trackRevisions/></w:settings>');
-  }
-  zip.updateFile('word/settings.xml', Buffer.from(settingsXml, 'utf-8'));
-  zip.writeZip(docxPath);
-}
-
-/**
- * Build a standalone Word document with track changes from annotated markdown.
- *
- * Used by `rev apply <md> <docx>` for a single markdown file outside a rev
- * project (no crossref/citeproc/reference-doc). Comments are dropped — use the
- * project build (`rev build docx --show-changes`) for the full filter chain and
- * threaded comments.
- *
- * @param mdPath - Path to markdown file with CriticMarkup
- * @param docxPath - Output path for Word document
- * @param options - Author name for the revisions
- * @returns Result with success status and message
- */
-export async function buildWithTrackChanges(
-  mdPath: string,
-  docxPath: string,
-  options: NativeTrackChangeOptions = {}
-): Promise<ApplyResult> {
-  if (!fs.existsSync(mdPath)) {
-    return { success: false, message: `File not found: ${mdPath}` };
-  }
-
-  const { author = 'Author' } = options;
-  const content = fs.readFileSync(mdPath, 'utf-8');
-  const { text: converted, stats } = criticToNativeTrackChanges(content, { author });
-
-  const total = stats.insertions + stats.deletions + stats.substitutions;
-  const tempMd = path.join(path.dirname(mdPath), `.temp-tc-${process.pid}.md`);
-
-  try {
-    fs.writeFileSync(tempMd, converted, 'utf-8');
-    execSync(`pandoc "${tempMd}" -o "${docxPath}"`, { encoding: 'utf-8' });
-    if (total > 0) enableTrackRevisions(docxPath);
-    return { success: true, message: `Created ${docxPath} with track changes`, stats };
-  } catch (err) {
-    const error = err as Error;
-    return { success: false, message: error.message };
-  } finally {
-    try { fs.unlinkSync(tempMd); } catch { /* best-effort cleanup */ }
-  }
-}

package/lib/tui.ts

@@ -1,450 +0,0 @@
-/**
- * TUI (Text User Interface) components for enhanced visual display
- * Uses box-drawing characters and colors for a richer terminal experience
- */
-
-import chalk from 'chalk';
-import * as readline from 'readline';
-import type { Annotation } from './types.js';
-import type { DocumentSession } from './undo.js';
-
-// =============================================================================
-// Interfaces
-// =============================================================================
-
-interface BoxOptions {
-  title?: string;
-  content?: string[];
-  width?: number;
-  borderColor?: string;
-}
-
-interface TuiReviewOptions {
-  author?: string;
-  addReply?: (text: string, comment: Annotation, author: string, reply: string) => string;
-  setStatus?: (text: string, comment: Annotation, resolved: boolean) => string;
-}
-
-interface TuiReviewResult {
-  text: string;
-  resolved: number;
-  replied: number;
-  skipped: number;
-}
-
-// =============================================================================
-// Utility Functions
-// =============================================================================
-
-/**
- * Strip ANSI codes for length calculation
- */
-export function stripAnsi(str: string): string {
-  return str.replace(/\x1b\[[0-9;]*m/g, '');
-}
-
-/**
- * Word wrap text to fit within width
- */
-function wordWrap(text: string, width: number): string[] {
-  const words = text.split(/\s+/);
-  const lines: string[] = [];
-  let currentLine = '';
-
-  for (const word of words) {
-    if (currentLine.length + word.length + 1 <= width) {
-      currentLine += (currentLine ? ' ' : '') + word;
-    } else {
-      if (currentLine) lines.push(currentLine);
-      currentLine = word;
-    }
-  }
-
-  if (currentLine) lines.push(currentLine);
-  return lines;
-}
-
-// =============================================================================
-// Screen Functions
-// =============================================================================
-
-/**
- * Clear the terminal screen
- */
-export function clearScreen(): void {
-  process.stdout.write('\x1B[2J\x1B[H');
-}
-
-/**
- * Move cursor to position
- */
-export function moveCursor(row: number, col: number): void {
-  process.stdout.write(`\x1B[${row};${col}H`);
-}
-
-/**
- * Get terminal dimensions
- */
-export function getTerminalSize(): { rows: number; cols: number } {
-  return {
-    rows: process.stdout.rows || 24,
-    cols: process.stdout.columns || 80,
-  };
-}
-
-// =============================================================================
-// Drawing Functions
-// =============================================================================
-
-/**
- * Draw a box with content
- */
-export function drawBox({ title = '', content = [], width = 60, borderColor = 'dim' }: BoxOptions = {}): string[] {
-  const border = {
-    tl: '\u256D', tr: '\u256E', bl: '\u2570', br: '\u256F',
-    h: '\u2500', v: '\u2502',
-  };
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const colorFn = ((chalk as any)[borderColor] as ((str: string) => string)) || chalk.dim;
-  const lines: string[] = [];
-
-  // Top border with title
-  if (title) {
-    const titleDisplay = ` ${title} `;
-    const remaining = width - titleDisplay.length - 2;
-    lines.push(
-      colorFn(border.tl + border.h) +
-      chalk.bold(titleDisplay) +
-      colorFn(border.h.repeat(Math.max(0, remaining)) + border.tr)
-    );
-  } else {
-    lines.push(colorFn(border.tl + border.h.repeat(width - 2) + border.tr));
-  }
-
-  // Content lines
-  for (const line of content) {
-    const plainLen = stripAnsi(line).length;
-    const padding = Math.max(0, width - 4 - plainLen);
-    lines.push(
-      colorFn(border.v) + ' ' + line + ' '.repeat(padding) + ' ' + colorFn(border.v)
-    );
-  }
-
-  // Bottom border
-  lines.push(colorFn(border.bl + border.h.repeat(width - 2) + border.br));
-
-  return lines;
-}
-
-/**
- * Draw a status bar at the bottom of the screen
- */
-export function statusBar(left: string, right: string = ''): string {
-  const { cols } = getTerminalSize();
-  const leftLen = stripAnsi(left).length;
-  const rightLen = stripAnsi(right).length;
-  const padding = Math.max(0, cols - leftLen - rightLen);
-
-  return chalk.inverse(left + ' '.repeat(padding) + right);
-}
-
-/**
- * Draw a progress indicator
- */
-export function progressIndicator(current: number, total: number, width: number = 20): string {
-  const ratio = current / total;
-  const filled = Math.round(ratio * width);
-  const empty = width - filled;
-
-  const bar = chalk.cyan('\u2588'.repeat(filled)) + chalk.dim('\u2591'.repeat(empty));
-  return `${bar} ${current}/${total}`;
-}
-
-/**
- * Format a comment for TUI display
- */
-export function formatCommentCard(comment: Annotation, index: number, total: number, width: number = 70): string[] {
-  const statusIcon = comment.resolved ? chalk.green('\u2713') : chalk.yellow('\u25CB');
-  const author = comment.author || 'Anonymous';
-
-  const content: string[] = [];
-
-  // Author and status line
-  content.push(chalk.blue(author) + ' ' + statusIcon);
-  content.push('');
-
-  // Comment text (word-wrap)
-  const wrappedText = wordWrap(comment.content, width - 6);
-  for (const line of wrappedText) {
-    content.push(line);
-  }
-
-  // Context
-  if (comment.before) {
-    content.push('');
-    const context = comment.before.trim().slice(-50);
-    content.push(chalk.dim(`Context: "...${context}"`));
-  }
-
-  // Line number
-  content.push('');
-  content.push(chalk.dim(`Line ${comment.line}`));
-
-  return drawBox({
-    title: `Comment ${index + 1}/${total}`,
-    content,
-    width,
-    borderColor: comment.resolved ? 'green' : 'cyan',
-  });
-}
-
-/**
- * Draw the action menu
- */
-export function actionMenu(options: [string, string][]): string {
-  return options
-    .map(([key, desc]) => chalk.bold(`[${key}]`) + chalk.dim(desc))
-    .join('  ');
-}
-
-// =============================================================================
-// Interactive TUI Review
-// =============================================================================
-
-/**
- * Prompt for a single keypress
- */
-function promptKey(validKeys: string[]): Promise<string> {
-  return new Promise((resolve) => {
-    const rl = readline.createInterface({
-      input: process.stdin,
-      output: process.stdout,
-    });
-
-    if (process.stdin.isTTY) {
-      process.stdin.setRawMode(true);
-    }
-    process.stdin.resume();
-
-    process.stdin.once('data', (key: Buffer) => {
-      const char = key.toString();
-
-      if (process.stdin.isTTY) {
-        process.stdin.setRawMode(false);
-      }
-      rl.close();
-
-      if (char === '\u0003') {
-        // Ctrl+C
-        clearScreen();
-        process.exit(0);
-      }
-
-      if (validKeys.includes(char.toLowerCase()) || validKeys.includes(char)) {
-        resolve(char);
-      } else {
-        resolve(promptKey(validKeys));
-      }
-    });
-  });
-}
-
-/**
- * Prompt for text input
- */
-function promptText(prompt: string): Promise<string> {
-  return new Promise((resolve) => {
-    const rl = readline.createInterface({
-      input: process.stdin,
-      output: process.stdout,
-    });
-    rl.question(prompt, (answer: string) => {
-      rl.close();
-      resolve(answer);
-    });
-  });
-}
-
-/**
- * Run TUI comment review session
- */
-export async function tuiCommentReview(text: string, options: TuiReviewOptions = {}): Promise<TuiReviewResult> {
-  const { getComments } = await import('./annotations.js');
-  const { createDocumentSession } = await import('./undo.js');
-  const { author = 'Author', addReply, setStatus } = options;
-
-  const comments = getComments(text, { pendingOnly: true });
-
-  if (comments.length === 0) {
-    console.log(chalk.green('No pending comments found.'));
-    return { text, resolved: 0, replied: 0, skipped: 0 };
-  }
-
-  // Create session with undo support
-  const session: DocumentSession = createDocumentSession(text);
-
-  let currentIndex = 0;
-  let resolved = 0;
-  let replied = 0;
-  let skipped = 0;
-  let message = '';
-
-  const render = (): void => {
-    clearScreen();
-
-    const { cols } = getTerminalSize();
-    const cardWidth = Math.min(cols - 4, 80);
-
-    // Header
-    console.log(chalk.cyan.bold(`  Reviewing ${comments.length} comment(s) as ${author}`));
-    const undoInfo = session.info();
-    const undoStatus = session.canUndo()
-      ? chalk.dim(` | ${undoInfo.undoSteps} undo`)
-      : '';
-    console.log(chalk.dim(`  ${progressIndicator(currentIndex + 1, comments.length)}${undoStatus}`));
-    console.log();
-
-    // Current comment card
-    const comment = comments[currentIndex];
-    const card = formatCommentCard(comment, currentIndex, comments.length, cardWidth);
-    for (const line of card) {
-      console.log('  ' + line);
-    }
-
-    console.log();
-
-    // Status message
-    if (message) {
-      console.log('  ' + message);
-      console.log();
-      message = '';
-    }
-
-    // Action menu with undo
-    const menuItems: [string, string][] = [
-      ['r', 'eply'],
-      ['m', 'ark resolved'],
-      ['s', 'kip'],
-      ['n', 'ext'],
-      ['p', 'rev'],
-    ];
-
-    if (session.canUndo()) {
-      menuItems.push(['u', 'ndo']);
-    }
-
-    menuItems.push(['A', 'll resolve'], ['q', 'uit']);
-
-    console.log('  ' + actionMenu(menuItems));
-    console.log();
-  };
-
-  // Main loop
-  while (currentIndex < comments.length) {
-    render();
-
-    const validKeys = session.canUndo()
-      ? ['r', 'm', 's', 'n', 'p', 'u', 'A', 'q']
-      : ['r', 'm', 's', 'n', 'p', 'A', 'q'];
-
-    const choice = await promptKey(validKeys);
-    const comment = comments[currentIndex];
-
-    switch (choice) {
-      case 'q':
-        clearScreen();
-        console.log(chalk.yellow('Aborted.'));
-        return { text: session.getText(), resolved, replied, skipped: comments.length - currentIndex };
-
-      case 'u':
-        if (session.canUndo()) {
-          const undone = session.undo();
-          if (undone) {
-            message = chalk.yellow(`Undone: ${undone.description}`);
-            if (undone.description.includes('Resolved')) resolved = Math.max(0, resolved - 1);
-            if (undone.description.includes('Reply')) replied = Math.max(0, replied - 1);
-            if (currentIndex > 0) currentIndex--;
-          }
-        }
-        break;
-
-      case 'A': {
-        let newText = session.getText();
-        for (let j = currentIndex; j < comments.length; j++) {
-          if (setStatus) {
-            newText = setStatus(newText, comments[j], true);
-          }
-        }
-        session.applyChange(newText, `Resolved ${comments.length - currentIndex} comments`);
-        resolved += comments.length - currentIndex;
-        currentIndex = comments.length;
-        break;
-      }
-
-      case 'm':
-        if (setStatus) {
-          const newText = setStatus(session.getText(), comment, true);
-          session.applyChange(newText, `Resolved comment #${currentIndex + 1}`);
-        }
-        resolved++;
-        currentIndex++;
-        break;
-
-      case 'r': {
-        console.log();
-        const replyText = await promptText(chalk.cyan('  Reply: '));
-        if (replyText.trim() && addReply) {
-          const newText = addReply(session.getText(), comment, author, replyText.trim());
-          session.applyChange(newText, `Reply to comment #${currentIndex + 1}`);
-          replied++;
-        }
-        currentIndex++;
-        break;
-      }
-
-      case 's':
-        skipped++;
-        currentIndex++;
-        break;
-
-      case 'n':
-        if (currentIndex < comments.length - 1) {
-          currentIndex++;
-        }
-        break;
-
-      case 'p':
-        if (currentIndex > 0) {
-          currentIndex--;
-        }
-        break;
-    }
-  }
-
-  // Summary
-  clearScreen();
-  console.log(chalk.cyan.bold('  Review Complete'));
-  console.log();
-
-  const undoInfo = session.info();
-  const summaryBox = drawBox({
-    title: 'Summary',
-    content: [
-      chalk.green(`Resolved: ${resolved}`),
-      chalk.blue(`Replied:  ${replied}`),
-      chalk.yellow(`Skipped:  ${skipped}`),
-      undoInfo.undoSteps > 1 ? chalk.dim(`Changes:  ${undoInfo.undoSteps}`) : '',
-    ].filter(Boolean),
-    width: 30,
-    borderColor: 'cyan',
-  });
-
-  for (const line of summaryBox) {
-    console.log('  ' + line);
-  }
-
-  console.log();
-
-  return { text: session.getText(), resolved, replied, skipped };
-}