docrev 0.9.11 → 0.9.14

package/lib/review.ts

@@ -1,327 +1,327 @@
-/**
- * Interactive review TUI for track changes
- */
-
-import * as readline from 'readline';
-import chalk from 'chalk';
-import type { Annotation, Comment } from './types.js';
-import { getTrackChanges, getComments, applyDecision } from './annotations.js';
-
-interface ReviewResult {
-  text: string;
-  accepted: number;
-  rejected: number;
-  skipped: number;
-}
-
-interface CommentReviewOptions {
-  author?: string;
-  addReply?: (text: string, comment: Comment, author: string, replyText: string) => string;
-  setCommentStatus?: (text: string, comment: Comment, resolved: boolean) => string;
-}
-
-interface CommentReviewResult {
-  text: string;
-  resolved: number;
-  replied: number;
-  skipped: number;
-}
-
-/**
- * Format an annotation for display
- */
-function formatAnnotation(annotation: Annotation, index: number, total: number): string {
-  const header = chalk.dim(`─── Change ${index + 1}/${total} (line ${annotation.line}) ───`);
-
-  let action: string;
-  let display: string;
-
-  switch (annotation.type) {
-    case 'insert':
-      action = chalk.green(`+ Insert: "${annotation.content}"`);
-      display =
-        chalk.dim(annotation.before || '') +
-        chalk.green.bold(`[${annotation.content}]`) +
-        chalk.dim(annotation.after || '');
-      break;
-    case 'delete':
-      action = chalk.red(`- Delete: "${annotation.content}"`);
-      display =
-        chalk.dim(annotation.before || '') +
-        chalk.red.strikethrough(`[${annotation.content}]`) +
-        chalk.dim(annotation.after || '');
-      break;
-    case 'substitute':
-      action = chalk.yellow(`~ Change: "${annotation.content}" → "${annotation.replacement}"`);
-      display =
-        chalk.dim(annotation.before || '') +
-        chalk.red.strikethrough(`[${annotation.content}]`) +
-        chalk.dim(' → ') +
-        chalk.green.bold(`[${annotation.replacement}]`) +
-        chalk.dim(annotation.after || '');
-      break;
-    default:
-      action = chalk.gray(`? Unknown: "${annotation.content}"`);
-      display = chalk.dim(annotation.before || '') + chalk.gray(`[${annotation.content}]`) + chalk.dim(annotation.after || '');
-  }
-
-  return `\n${header}\n\n  ${action}\n\n  ${display}\n`;
-}
-
-/**
- * Prompt for a single keypress
- */
-function promptKey(prompt: string, validKeys: string[]): Promise<string> {
-  return new Promise((resolve) => {
-    const rl = readline.createInterface({
-      input: process.stdin,
-      output: process.stdout,
-    });
-
-    // Enable raw mode for single keypress
-    if (process.stdin.isTTY) {
-      process.stdin.setRawMode(true);
-    }
-    process.stdin.resume();
-
-    process.stdout.write(prompt);
-
-    process.stdin.once('data', (key: Buffer) => {
-      const char = key.toString().toLowerCase();
-
-      if (process.stdin.isTTY) {
-        process.stdin.setRawMode(false);
-      }
-      rl.close();
-
-      if (char === '\u0003') {
-        // Ctrl+C
-        process.exit(0);
-      }
-
-      if (validKeys.includes(char)) {
-        console.log(char);
-        resolve(char);
-      } else {
-        console.log();
-        resolve(promptKey(prompt, validKeys));
-      }
-    });
-  });
-}
-
-/**
- * Run interactive review session
- */
-export async function interactiveReview(text: string): Promise<ReviewResult> {
-  const changes = getTrackChanges(text);
-  const comments = getComments(text);
-
-  if (changes.length === 0) {
-    console.log(chalk.green('No track changes found.'));
-    if (comments.length > 0) {
-      console.log(chalk.yellow(`${comments.length} comment(s) remain in the document.`));
-    }
-    return { text, accepted: 0, rejected: 0, skipped: 0 };
-  }
-
-  console.log(chalk.cyan(`\nFound ${changes.length} track change(s)\n`));
-
-  let accepted = 0;
-  let rejected = 0;
-  let skipped = 0;
-  let currentText = text;
-
-  for (let i = 0; i < changes.length; i++) {
-    const change = changes[i];
-    if (!change) continue;
-    console.log(formatAnnotation(change, i, changes.length));
-
-    const prompt = chalk.dim('[a]ccept [r]eject [s]kip | accept [A]ll reject a[L]l [q]uit: ');
-    const choice = await promptKey(prompt, ['a', 'r', 's', 'A', 'L', 'q']);
-
-    switch (choice) {
-      case 'q':
-        console.log(chalk.yellow('\nAborted. No changes saved.'));
-        return { text, accepted: 0, rejected: 0, skipped: changes.length };
-
-      case 'A':
-        // Accept all remaining
-        for (let j = i; j < changes.length; j++) {
-          const ch = changes[j];
-          if (ch) currentText = applyDecision(currentText, ch, true);
-        }
-        accepted += changes.length - i;
-        console.log(chalk.green(`\nAccepted all ${changes.length - i} remaining changes.`));
-        i = changes.length; // Exit loop
-        break;
-
-      case 'L':
-        // Reject all remaining
-        for (let j = i; j < changes.length; j++) {
-          const ch = changes[j];
-          if (ch) currentText = applyDecision(currentText, ch, false);
-        }
-        rejected += changes.length - i;
-        console.log(chalk.red(`\nRejected all ${changes.length - i} remaining changes.`));
-        i = changes.length; // Exit loop
-        break;
-
-      case 'a':
-        currentText = applyDecision(currentText, change, true);
-        accepted++;
-        break;
-
-      case 'r':
-        currentText = applyDecision(currentText, change, false);
-        rejected++;
-        break;
-
-      case 's':
-        skipped++;
-        break;
-    }
-  }
-
-  console.log(chalk.cyan('\n─── Summary ───'));
-  console.log(chalk.green(`Accepted: ${accepted}`));
-  console.log(chalk.red(`Rejected: ${rejected}`));
-  console.log(chalk.yellow(`Skipped: ${skipped}`));
-
-  if (comments.length > 0) {
-    console.log(chalk.blue(`\n${comments.length} comment(s) preserved.`));
-  }
-
-  return { text: currentText, accepted, rejected, skipped };
-}
-
-/**
- * List all comments
- */
-export function listComments(text: string): void {
-  const comments = getComments(text);
-
-  if (comments.length === 0) {
-    console.log(chalk.green('No comments found.'));
-    return;
-  }
-
-  console.log(chalk.cyan(`\nFound ${comments.length} comment(s):\n`));
-
-  for (let i = 0; i < comments.length; i++) {
-    const c = comments[i];
-    if (!c) continue;
-    const author = c.author || 'Anonymous';
-    const header = chalk.blue(`[${i + 1}] ${author}`) + chalk.dim(` (line ${c.line})`);
-
-    console.log(header);
-    console.log(`  ${c.content}`);
-    console.log(
-      chalk.dim(`  Context: ...${(c.before || '').slice(-25)}`) +
-        chalk.yellow('*') +
-        chalk.dim(`${(c.after || '').slice(0, 25)}...`)
-    );
-    console.log();
-  }
-}
-
-/**
- * Format a comment for interactive display
- */
-function formatComment(comment: Comment, index: number, total: number): string {
-  const statusIcon = comment.resolved ? chalk.green('✓') : chalk.yellow('○');
-  const author = comment.author || 'Anonymous';
-  const header = chalk.dim(`─── Comment ${index + 1}/${total} (line ${comment.line}) ───`);
-
-  const authorLine = chalk.blue(`${author}`) + ` ${statusIcon}`;
-  const context = chalk.dim(`Context: "...${(comment.before || '').slice(-40)}"`);
-
-  return `\n${header}\n\n  ${authorLine}\n  ${comment.content}\n\n  ${context}\n`;
-}
-
-/**
- * Run interactive comment review session
- */
-export async function interactiveCommentReview(text: string, options: CommentReviewOptions = {}): Promise<CommentReviewResult> {
-  const { author = 'Author', addReply, setCommentStatus } = options;
-  const comments = getComments(text, { pendingOnly: true }) as Comment[];
-
-  if (comments.length === 0) {
-    console.log(chalk.green('No pending comments found.'));
-    return { text, resolved: 0, replied: 0, skipped: 0 };
-  }
-
-  console.log(chalk.cyan(`\nReviewing ${comments.length} pending comment(s) as ${chalk.bold(author)}\n`));
-
-  let resolved = 0;
-  let replied = 0;
-  let skipped = 0;
-  let currentText = text;
-
-  for (let i = 0; i < comments.length; i++) {
-    const comment = comments[i];
-    if (!comment) continue;
-    console.log(formatComment(comment, i, comments.length));
-
-    const prompt = chalk.dim('[r]eply [m]ark resolved [s]kip | resolve [A]ll [q]uit: ');
-    const choice = await promptKey(prompt, ['r', 'm', 's', 'A', 'q']);
-
-    switch (choice) {
-      case 'q':
-        console.log(chalk.yellow('\nAborted.'));
-        return { text: currentText, resolved, replied, skipped: comments.length - i };
-
-      case 'A':
-        // Resolve all remaining
-        for (let j = i; j < comments.length; j++) {
-          const c = comments[j];
-          if (setCommentStatus && c) {
-            currentText = setCommentStatus(currentText, c, true);
-          }
-        }
-        resolved += comments.length - i;
-        console.log(chalk.green(`\nResolved all ${comments.length - i} remaining comments.`));
-        i = comments.length;
-        break;
-
-      case 'm':
-        if (setCommentStatus) {
-          currentText = setCommentStatus(currentText, comment, true);
-        }
-        resolved++;
-        console.log(chalk.green('  Marked as resolved'));
-        break;
-
-      case 'r':
-        // Get reply text
-        const rl = readline.createInterface({
-          input: process.stdin,
-          output: process.stdout,
-        });
-        const replyText = await new Promise<string>((resolve) => {
-          rl.question(chalk.cyan('  Reply: '), resolve);
-        });
-        rl.close();
-
-        if (replyText.trim() && addReply) {
-          currentText = addReply(currentText, comment, author, replyText.trim());
-          replied++;
-          console.log(chalk.green('  Reply added'));
-        } else {
-          console.log(chalk.dim('  No reply added'));
-        }
-        break;
-
-      case 's':
-        skipped++;
-        break;
-    }
-  }
-
-  console.log(chalk.cyan('\n─── Summary ───'));
-  console.log(chalk.green(`Resolved: ${resolved}`));
-  console.log(chalk.blue(`Replied: ${replied}`));
-  console.log(chalk.yellow(`Skipped: ${skipped}`));
-
-  return { text: currentText, resolved, replied, skipped };
-}
+/**
+ * Interactive review TUI for track changes
+ */
+
+import * as readline from 'readline';
+import chalk from 'chalk';
+import type { Annotation, Comment } from './types.js';
+import { getTrackChanges, getComments, applyDecision } from './annotations.js';
+
+interface ReviewResult {
+  text: string;
+  accepted: number;
+  rejected: number;
+  skipped: number;
+}
+
+interface CommentReviewOptions {
+  author?: string;
+  addReply?: (text: string, comment: Comment, author: string, replyText: string) => string;
+  setCommentStatus?: (text: string, comment: Comment, resolved: boolean) => string;
+}
+
+interface CommentReviewResult {
+  text: string;
+  resolved: number;
+  replied: number;
+  skipped: number;
+}
+
+/**
+ * Format an annotation for display
+ */
+function formatAnnotation(annotation: Annotation, index: number, total: number): string {
+  const header = chalk.dim(`─── Change ${index + 1}/${total} (line ${annotation.line}) ───`);
+
+  let action: string;
+  let display: string;
+
+  switch (annotation.type) {
+    case 'insert':
+      action = chalk.green(`+ Insert: "${annotation.content}"`);
+      display =
+        chalk.dim(annotation.before || '') +
+        chalk.green.bold(`[${annotation.content}]`) +
+        chalk.dim(annotation.after || '');
+      break;
+    case 'delete':
+      action = chalk.red(`- Delete: "${annotation.content}"`);
+      display =
+        chalk.dim(annotation.before || '') +
+        chalk.red.strikethrough(`[${annotation.content}]`) +
+        chalk.dim(annotation.after || '');
+      break;
+    case 'substitute':
+      action = chalk.yellow(`~ Change: "${annotation.content}" → "${annotation.replacement}"`);
+      display =
+        chalk.dim(annotation.before || '') +
+        chalk.red.strikethrough(`[${annotation.content}]`) +
+        chalk.dim(' → ') +
+        chalk.green.bold(`[${annotation.replacement}]`) +
+        chalk.dim(annotation.after || '');
+      break;
+    default:
+      action = chalk.gray(`? Unknown: "${annotation.content}"`);
+      display = chalk.dim(annotation.before || '') + chalk.gray(`[${annotation.content}]`) + chalk.dim(annotation.after || '');
+  }
+
+  return `\n${header}\n\n  ${action}\n\n  ${display}\n`;
+}
+
+/**
+ * Prompt for a single keypress
+ */
+function promptKey(prompt: string, validKeys: string[]): Promise<string> {
+  return new Promise((resolve) => {
+    const rl = readline.createInterface({
+      input: process.stdin,
+      output: process.stdout,
+    });
+
+    // Enable raw mode for single keypress
+    if (process.stdin.isTTY) {
+      process.stdin.setRawMode(true);
+    }
+    process.stdin.resume();
+
+    process.stdout.write(prompt);
+
+    process.stdin.once('data', (key: Buffer) => {
+      const char = key.toString().toLowerCase();
+
+      if (process.stdin.isTTY) {
+        process.stdin.setRawMode(false);
+      }
+      rl.close();
+
+      if (char === '\u0003') {
+        // Ctrl+C
+        process.exit(0);
+      }
+
+      if (validKeys.includes(char)) {
+        console.log(char);
+        resolve(char);
+      } else {
+        console.log();
+        resolve(promptKey(prompt, validKeys));
+      }
+    });
+  });
+}
+
+/**
+ * Run interactive review session
+ */
+export async function interactiveReview(text: string): Promise<ReviewResult> {
+  const changes = getTrackChanges(text);
+  const comments = getComments(text);
+
+  if (changes.length === 0) {
+    console.log(chalk.green('No track changes found.'));
+    if (comments.length > 0) {
+      console.log(chalk.yellow(`${comments.length} comment(s) remain in the document.`));
+    }
+    return { text, accepted: 0, rejected: 0, skipped: 0 };
+  }
+
+  console.log(chalk.cyan(`\nFound ${changes.length} track change(s)\n`));
+
+  let accepted = 0;
+  let rejected = 0;
+  let skipped = 0;
+  let currentText = text;
+
+  for (let i = 0; i < changes.length; i++) {
+    const change = changes[i];
+    if (!change) continue;
+    console.log(formatAnnotation(change, i, changes.length));
+
+    const prompt = chalk.dim('[a]ccept [r]eject [s]kip | accept [A]ll reject a[L]l [q]uit: ');
+    const choice = await promptKey(prompt, ['a', 'r', 's', 'A', 'L', 'q']);
+
+    switch (choice) {
+      case 'q':
+        console.log(chalk.yellow('\nAborted. No changes saved.'));
+        return { text, accepted: 0, rejected: 0, skipped: changes.length };
+
+      case 'A':
+        // Accept all remaining
+        for (let j = i; j < changes.length; j++) {
+          const ch = changes[j];
+          if (ch) currentText = applyDecision(currentText, ch, true);
+        }
+        accepted += changes.length - i;
+        console.log(chalk.green(`\nAccepted all ${changes.length - i} remaining changes.`));
+        i = changes.length; // Exit loop
+        break;
+
+      case 'L':
+        // Reject all remaining
+        for (let j = i; j < changes.length; j++) {
+          const ch = changes[j];
+          if (ch) currentText = applyDecision(currentText, ch, false);
+        }
+        rejected += changes.length - i;
+        console.log(chalk.red(`\nRejected all ${changes.length - i} remaining changes.`));
+        i = changes.length; // Exit loop
+        break;
+
+      case 'a':
+        currentText = applyDecision(currentText, change, true);
+        accepted++;
+        break;
+
+      case 'r':
+        currentText = applyDecision(currentText, change, false);
+        rejected++;
+        break;
+
+      case 's':
+        skipped++;
+        break;
+    }
+  }
+
+  console.log(chalk.cyan('\n─── Summary ───'));
+  console.log(chalk.green(`Accepted: ${accepted}`));
+  console.log(chalk.red(`Rejected: ${rejected}`));
+  console.log(chalk.yellow(`Skipped: ${skipped}`));
+
+  if (comments.length > 0) {
+    console.log(chalk.blue(`\n${comments.length} comment(s) preserved.`));
+  }
+
+  return { text: currentText, accepted, rejected, skipped };
+}
+
+/**
+ * List all comments
+ */
+export function listComments(text: string): void {
+  const comments = getComments(text);
+
+  if (comments.length === 0) {
+    console.log(chalk.green('No comments found.'));
+    return;
+  }
+
+  console.log(chalk.cyan(`\nFound ${comments.length} comment(s):\n`));
+
+  for (let i = 0; i < comments.length; i++) {
+    const c = comments[i];
+    if (!c) continue;
+    const author = c.author || 'Anonymous';
+    const header = chalk.blue(`[${i + 1}] ${author}`) + chalk.dim(` (line ${c.line})`);
+
+    console.log(header);
+    console.log(`  ${c.content}`);
+    console.log(
+      chalk.dim(`  Context: ...${(c.before || '').slice(-25)}`) +
+        chalk.yellow('*') +
+        chalk.dim(`${(c.after || '').slice(0, 25)}...`)
+    );
+    console.log();
+  }
+}
+
+/**
+ * Format a comment for interactive display
+ */
+function formatComment(comment: Comment, index: number, total: number): string {
+  const statusIcon = comment.resolved ? chalk.green('✓') : chalk.yellow('○');
+  const author = comment.author || 'Anonymous';
+  const header = chalk.dim(`─── Comment ${index + 1}/${total} (line ${comment.line}) ───`);
+
+  const authorLine = chalk.blue(`${author}`) + ` ${statusIcon}`;
+  const context = chalk.dim(`Context: "...${(comment.before || '').slice(-40)}"`);
+
+  return `\n${header}\n\n  ${authorLine}\n  ${comment.content}\n\n  ${context}\n`;
+}
+
+/**
+ * Run interactive comment review session
+ */
+export async function interactiveCommentReview(text: string, options: CommentReviewOptions = {}): Promise<CommentReviewResult> {
+  const { author = 'Author', addReply, setCommentStatus } = options;
+  const comments = getComments(text, { pendingOnly: true }) as Comment[];
+
+  if (comments.length === 0) {
+    console.log(chalk.green('No pending comments found.'));
+    return { text, resolved: 0, replied: 0, skipped: 0 };
+  }
+
+  console.log(chalk.cyan(`\nReviewing ${comments.length} pending comment(s) as ${chalk.bold(author)}\n`));
+
+  let resolved = 0;
+  let replied = 0;
+  let skipped = 0;
+  let currentText = text;
+
+  for (let i = 0; i < comments.length; i++) {
+    const comment = comments[i];
+    if (!comment) continue;
+    console.log(formatComment(comment, i, comments.length));
+
+    const prompt = chalk.dim('[r]eply [m]ark resolved [s]kip | resolve [A]ll [q]uit: ');
+    const choice = await promptKey(prompt, ['r', 'm', 's', 'A', 'q']);
+
+    switch (choice) {
+      case 'q':
+        console.log(chalk.yellow('\nAborted.'));
+        return { text: currentText, resolved, replied, skipped: comments.length - i };
+
+      case 'A':
+        // Resolve all remaining
+        for (let j = i; j < comments.length; j++) {
+          const c = comments[j];
+          if (setCommentStatus && c) {
+            currentText = setCommentStatus(currentText, c, true);
+          }
+        }
+        resolved += comments.length - i;
+        console.log(chalk.green(`\nResolved all ${comments.length - i} remaining comments.`));
+        i = comments.length;
+        break;
+
+      case 'm':
+        if (setCommentStatus) {
+          currentText = setCommentStatus(currentText, comment, true);
+        }
+        resolved++;
+        console.log(chalk.green('  Marked as resolved'));
+        break;
+
+      case 'r':
+        // Get reply text
+        const rl = readline.createInterface({
+          input: process.stdin,
+          output: process.stdout,
+        });
+        const replyText = await new Promise<string>((resolve) => {
+          rl.question(chalk.cyan('  Reply: '), resolve);
+        });
+        rl.close();
+
+        if (replyText.trim() && addReply) {
+          currentText = addReply(currentText, comment, author, replyText.trim());
+          replied++;
+          console.log(chalk.green('  Reply added'));
+        } else {
+          console.log(chalk.dim('  No reply added'));
+        }
+        break;
+
+      case 's':
+        skipped++;
+        break;
+    }
+  }
+
+  console.log(chalk.cyan('\n─── Summary ───'));
+  console.log(chalk.green(`Resolved: ${resolved}`));
+  console.log(chalk.blue(`Replied: ${replied}`));
+  console.log(chalk.yellow(`Skipped: ${skipped}`));
+
+  return { text: currentText, resolved, replied, skipped };
+}