docrev 0.11.0 → 0.11.2

package/lib/pdf-comments.ts

@@ -1,263 +1,263 @@
-/**
- * PDF comment rendering for dual export
- *
- * Converts CriticMarkup comments to LaTeX margin notes for PDF output
- */
-
-import { escapeLatex } from './utils.js';
-
-/**
- * LaTeX preamble for margin comments
- * Uses todonotes package with custom styling
- */
-export const MARGIN_NOTES_PREAMBLE = `
-% Margin notes for comments
-\\usepackage[colorinlistoftodos,textsize=scriptsize]{todonotes}
-\\usepackage{xcolor}
-
-% Define comment colors by author
-\\definecolor{commentblue}{RGB}{59, 130, 246}
-\\definecolor{commentgreen}{RGB}{34, 197, 94}
-\\definecolor{commentorange}{RGB}{249, 115, 22}
-\\definecolor{commentpurple}{RGB}{168, 85, 247}
-\\definecolor{commentgray}{RGB}{107, 114, 128}
-
-% Custom margin note command
-\\newcommand{\\margincomment}[2][]{%
-  \\todo[linecolor=commentblue,backgroundcolor=commentblue!10,bordercolor=commentblue,size=\\scriptsize,#1]{#2}%
-}
-
-% Author-specific commands
-\\newcommand{\\reviewercomment}[2]{%
-  \\todo[linecolor=commentgreen,backgroundcolor=commentgreen!10,bordercolor=commentgreen,size=\\scriptsize]{\\textbf{#1:} #2}%
-}
-
-% Increase margin for notes (if needed)
-% \\setlength{\\marginparwidth}{2.5cm}
-`;
-
-/**
- * Simpler preamble using marginpar (no extra packages needed)
- */
-export const SIMPLE_MARGIN_PREAMBLE = `
-% Simple margin notes for comments
-\\usepackage{xcolor}
-\\definecolor{commentcolor}{RGB}{59, 130, 246}
-
-\\newcommand{\\margincomment}[1]{%
-  \\marginpar{\\raggedright\\scriptsize\\textcolor{commentcolor}{#1}}%
-}
-`;
-
-/**
- * Options for converting comments to margin notes
- */
-export interface CommentConversionOptions {
-  useTodonotes?: boolean;
-  stripResolved?: boolean;
-}
-
-/**
- * Result of comment conversion
- */
-export interface CommentConversionResult {
-  markdown: string;
-  commentCount: number;
-  preamble: string;
-}
-
-/**
- * Convert CriticMarkup comments to LaTeX margin notes
- * {>>Author: comment text<<} -> \margincomment{Author: comment text}
- *
- * @param markdown - Markdown with CriticMarkup comments
- * @param options - { useTodonotes: boolean, stripResolved: boolean }
- * @returns Converted markdown with comment count and preamble
- */
-export function convertCommentsToMarginNotes(
-  markdown: string,
-  options: CommentConversionOptions = {}
-): CommentConversionResult {
-  const { useTodonotes = true, stripResolved = true } = options;
-
-  let commentCount = 0;
-
-  // Pattern for CriticMarkup comments: {>>author: text<<} or {>>text<<}
-  // Also handle resolved comments: {>>✓ author: text<<}
-  const commentPattern = /\{>>(✓\s*)?([^<]+)<<\}/g;
-
-  const converted = markdown.replace(commentPattern, (match, resolved, content) => {
-    // Skip resolved comments if requested
-    if (resolved && stripResolved) {
-      return '';
-    }
-
-    commentCount++;
-
-    // Escape LaTeX special characters
-    const escaped = escapeLatex(content.trim());
-
-    if (useTodonotes) {
-      // Check if content has author prefix (Author: text)
-      const authorMatch = escaped.match(/^([^:]+):\s*([\s\S]+)$/);
-      if (authorMatch) {
-        const [, author, text] = authorMatch;
-        return `\\reviewercomment{${author}}{${text}}`;
-      }
-      return `\\margincomment{${escaped}}`;
-    } else {
-      return `\\margincomment{${escaped}}`;
-    }
-  });
-
-  const preamble = useTodonotes ? MARGIN_NOTES_PREAMBLE : SIMPLE_MARGIN_PREAMBLE;
-
-  return {
-    markdown: converted,
-    commentCount,
-    preamble,
-  };
-}
-
-/**
- * Result of track changes conversion
- */
-export interface TrackChangesResult {
-  markdown: string;
-  preamble: string;
-}
-
-/**
- * Convert track changes to visible LaTeX formatting
- * {++inserted++} -> \textcolor{green}{inserted}
- * {--deleted--} -> \textcolor{red}{\sout{deleted}}
- * {~~old~>new~~} -> \textcolor{red}{\sout{old}}\textcolor{green}{new}
- *
- * @param markdown - Markdown with track changes
- * @returns Converted markdown and preamble
- */
-export function convertTrackChangesToLatex(markdown: string): TrackChangesResult {
-  let result = markdown;
-
-  // Insertions: {++text++} -> green text
-  result = result.replace(/\{\+\+([^+]+)\+\+\}/g, (match, text) => {
-    return `\\textcolor{green}{${escapeLatex(text)}}`;
-  });
-
-  // Deletions: {--text--} -> red strikethrough
-  result = result.replace(/\{--([^-]+)--\}/g, (match, text) => {
-    return `\\textcolor{red}{\\sout{${escapeLatex(text)}}}`;
-  });
-
-  // Substitutions: {~~old~>new~~} -> red strikethrough + green new
-  result = result.replace(/\{~~([^~]+)~>([^~]+)~~\}/g, (match, oldText, newText) => {
-    return `\\textcolor{red}{\\sout{${escapeLatex(oldText)}}}\\textcolor{green}{${escapeLatex(newText)}}`;
-  });
-
-  const preamble = `
-% Track changes visualization
-\\usepackage{xcolor}
-\\usepackage[normalem]{ulem}
-\\definecolor{green}{RGB}{34, 197, 94}
-\\definecolor{red}{RGB}{239, 68, 68}
-`;
-
-  return { markdown: result, preamble };
-}
-
-/**
- * Options for combined preamble
- */
-export interface PreambleOptions {
-  comments?: boolean;
-  trackChanges?: boolean;
-  useTodonotes?: boolean;
-}
-
-/**
- * Get combined preamble for comments and track changes
- * @param options - { comments: boolean, trackChanges: boolean, useTodonotes: boolean }
- * @returns Combined LaTeX preamble
- */
-export function getCombinedPreamble(options: PreambleOptions = {}): string {
-  const { comments = true, trackChanges = false, useTodonotes = true } = options;
-
-  let preamble = '';
-
-  if (comments) {
-    preamble += useTodonotes ? MARGIN_NOTES_PREAMBLE : SIMPLE_MARGIN_PREAMBLE;
-  }
-
-  if (trackChanges) {
-    preamble += `
-% Track changes visualization
-\\usepackage[normalem]{ulem}
-`;
-    if (!comments) {
-      preamble += `\\usepackage{xcolor}\n`;
-    }
-    preamble += `
-\\definecolor{insertgreen}{RGB}{34, 197, 94}
-\\definecolor{deletered}{RGB}{239, 68, 68}
-`;
-  }
-
-  return preamble;
-}
-
-/**
- * Options for preparing markdown for annotated PDF
- */
-export interface AnnotatedPdfOptions {
-  showTrackChanges?: boolean;
-  useTodonotes?: boolean;
-  stripResolved?: boolean;
-}
-
-/**
- * Result of preparing markdown for annotated PDF
- */
-export interface AnnotatedPdfResult {
-  markdown: string;
-  preamble: string;
-  commentCount: number;
-}
-
-/**
- * Prepare markdown for PDF with visible comments
- * Converts comments to margin notes and optionally shows track changes
- *
- * @param markdown - Markdown content
- * @param options - { showTrackChanges: boolean, useTodonotes: boolean }
- * @returns Converted markdown with preamble and comment count
- */
-export function prepareMarkdownForAnnotatedPdf(
-  markdown: string,
-  options: AnnotatedPdfOptions = {}
-): AnnotatedPdfResult {
-  const { showTrackChanges = false, useTodonotes = true, stripResolved = true } = options;
-
-  let result = markdown;
-  let preamble = '';
-  let commentCount = 0;
-
-  // Convert comments to margin notes
-  const commentResult = convertCommentsToMarginNotes(result, { useTodonotes, stripResolved });
-  result = commentResult.markdown;
-  commentCount = commentResult.commentCount;
-  preamble += commentResult.preamble;
-
-  // Optionally show track changes
-  if (showTrackChanges) {
-    const trackResult = convertTrackChangesToLatex(result);
-    result = trackResult.markdown;
-    // Add ulem package if not already in todonotes preamble
-    if (!useTodonotes) {
-      preamble += trackResult.preamble;
-    } else {
-      preamble += `\\usepackage[normalem]{ulem}\n`;
-    }
-  }
-
-  return { markdown: result, preamble, commentCount };
-}
+/**
+ * PDF comment rendering for dual export
+ *
+ * Converts CriticMarkup comments to LaTeX margin notes for PDF output
+ */
+
+import { escapeLatex } from './utils.js';
+
+/**
+ * LaTeX preamble for margin comments
+ * Uses todonotes package with custom styling
+ */
+export const MARGIN_NOTES_PREAMBLE = `
+% Margin notes for comments
+\\usepackage[colorinlistoftodos,textsize=scriptsize]{todonotes}
+\\usepackage{xcolor}
+
+% Define comment colors by author
+\\definecolor{commentblue}{RGB}{59, 130, 246}
+\\definecolor{commentgreen}{RGB}{34, 197, 94}
+\\definecolor{commentorange}{RGB}{249, 115, 22}
+\\definecolor{commentpurple}{RGB}{168, 85, 247}
+\\definecolor{commentgray}{RGB}{107, 114, 128}
+
+% Custom margin note command
+\\newcommand{\\margincomment}[2][]{%
+  \\todo[linecolor=commentblue,backgroundcolor=commentblue!10,bordercolor=commentblue,size=\\scriptsize,#1]{#2}%
+}
+
+% Author-specific commands
+\\newcommand{\\reviewercomment}[2]{%
+  \\todo[linecolor=commentgreen,backgroundcolor=commentgreen!10,bordercolor=commentgreen,size=\\scriptsize]{\\textbf{#1:} #2}%
+}
+
+% Increase margin for notes (if needed)
+% \\setlength{\\marginparwidth}{2.5cm}
+`;
+
+/**
+ * Simpler preamble using marginpar (no extra packages needed)
+ */
+export const SIMPLE_MARGIN_PREAMBLE = `
+% Simple margin notes for comments
+\\usepackage{xcolor}
+\\definecolor{commentcolor}{RGB}{59, 130, 246}
+
+\\newcommand{\\margincomment}[1]{%
+  \\marginpar{\\raggedright\\scriptsize\\textcolor{commentcolor}{#1}}%
+}
+`;
+
+/**
+ * Options for converting comments to margin notes
+ */
+export interface CommentConversionOptions {
+  useTodonotes?: boolean;
+  stripResolved?: boolean;
+}
+
+/**
+ * Result of comment conversion
+ */
+export interface CommentConversionResult {
+  markdown: string;
+  commentCount: number;
+  preamble: string;
+}
+
+/**
+ * Convert CriticMarkup comments to LaTeX margin notes
+ * {>>Author: comment text<<} -> \margincomment{Author: comment text}
+ *
+ * @param markdown - Markdown with CriticMarkup comments
+ * @param options - { useTodonotes: boolean, stripResolved: boolean }
+ * @returns Converted markdown with comment count and preamble
+ */
+export function convertCommentsToMarginNotes(
+  markdown: string,
+  options: CommentConversionOptions = {}
+): CommentConversionResult {
+  const { useTodonotes = true, stripResolved = true } = options;
+
+  let commentCount = 0;
+
+  // Pattern for CriticMarkup comments: {>>author: text<<} or {>>text<<}
+  // Also handle resolved comments: {>>✓ author: text<<}
+  const commentPattern = /\{>>(✓\s*)?([^<]+)<<\}/g;
+
+  const converted = markdown.replace(commentPattern, (match, resolved, content) => {
+    // Skip resolved comments if requested
+    if (resolved && stripResolved) {
+      return '';
+    }
+
+    commentCount++;
+
+    // Escape LaTeX special characters
+    const escaped = escapeLatex(content.trim());
+
+    if (useTodonotes) {
+      // Check if content has author prefix (Author: text)
+      const authorMatch = escaped.match(/^([^:]+):\s*([\s\S]+)$/);
+      if (authorMatch) {
+        const [, author, text] = authorMatch;
+        return `\\reviewercomment{${author}}{${text}}`;
+      }
+      return `\\margincomment{${escaped}}`;
+    } else {
+      return `\\margincomment{${escaped}}`;
+    }
+  });
+
+  const preamble = useTodonotes ? MARGIN_NOTES_PREAMBLE : SIMPLE_MARGIN_PREAMBLE;
+
+  return {
+    markdown: converted,
+    commentCount,
+    preamble,
+  };
+}
+
+/**
+ * Result of track changes conversion
+ */
+export interface TrackChangesResult {
+  markdown: string;
+  preamble: string;
+}
+
+/**
+ * Convert track changes to visible LaTeX formatting
+ * {++inserted++} -> \textcolor{green}{inserted}
+ * {--deleted--} -> \textcolor{red}{\sout{deleted}}
+ * {~~old~>new~~} -> \textcolor{red}{\sout{old}}\textcolor{green}{new}
+ *
+ * @param markdown - Markdown with track changes
+ * @returns Converted markdown and preamble
+ */
+export function convertTrackChangesToLatex(markdown: string): TrackChangesResult {
+  let result = markdown;
+
+  // Insertions: {++text++} -> green text
+  result = result.replace(/\{\+\+([^+]+)\+\+\}/g, (match, text) => {
+    return `\\textcolor{green}{${escapeLatex(text)}}`;
+  });
+
+  // Deletions: {--text--} -> red strikethrough
+  result = result.replace(/\{--([^-]+)--\}/g, (match, text) => {
+    return `\\textcolor{red}{\\sout{${escapeLatex(text)}}}`;
+  });
+
+  // Substitutions: {~~old~>new~~} -> red strikethrough + green new
+  result = result.replace(/\{~~([^~]+)~>([^~]+)~~\}/g, (match, oldText, newText) => {
+    return `\\textcolor{red}{\\sout{${escapeLatex(oldText)}}}\\textcolor{green}{${escapeLatex(newText)}}`;
+  });
+
+  const preamble = `
+% Track changes visualization
+\\usepackage{xcolor}
+\\usepackage[normalem]{ulem}
+\\definecolor{green}{RGB}{34, 197, 94}
+\\definecolor{red}{RGB}{239, 68, 68}
+`;
+
+  return { markdown: result, preamble };
+}
+
+/**
+ * Options for combined preamble
+ */
+export interface PreambleOptions {
+  comments?: boolean;
+  trackChanges?: boolean;
+  useTodonotes?: boolean;
+}
+
+/**
+ * Get combined preamble for comments and track changes
+ * @param options - { comments: boolean, trackChanges: boolean, useTodonotes: boolean }
+ * @returns Combined LaTeX preamble
+ */
+export function getCombinedPreamble(options: PreambleOptions = {}): string {
+  const { comments = true, trackChanges = false, useTodonotes = true } = options;
+
+  let preamble = '';
+
+  if (comments) {
+    preamble += useTodonotes ? MARGIN_NOTES_PREAMBLE : SIMPLE_MARGIN_PREAMBLE;
+  }
+
+  if (trackChanges) {
+    preamble += `
+% Track changes visualization
+\\usepackage[normalem]{ulem}
+`;
+    if (!comments) {
+      preamble += `\\usepackage{xcolor}\n`;
+    }
+    preamble += `
+\\definecolor{insertgreen}{RGB}{34, 197, 94}
+\\definecolor{deletered}{RGB}{239, 68, 68}
+`;
+  }
+
+  return preamble;
+}
+
+/**
+ * Options for preparing markdown for annotated PDF
+ */
+export interface AnnotatedPdfOptions {
+  showTrackChanges?: boolean;
+  useTodonotes?: boolean;
+  stripResolved?: boolean;
+}
+
+/**
+ * Result of preparing markdown for annotated PDF
+ */
+export interface AnnotatedPdfResult {
+  markdown: string;
+  preamble: string;
+  commentCount: number;
+}
+
+/**
+ * Prepare markdown for PDF with visible comments
+ * Converts comments to margin notes and optionally shows track changes
+ *
+ * @param markdown - Markdown content
+ * @param options - { showTrackChanges: boolean, useTodonotes: boolean }
+ * @returns Converted markdown with preamble and comment count
+ */
+export function prepareMarkdownForAnnotatedPdf(
+  markdown: string,
+  options: AnnotatedPdfOptions = {}
+): AnnotatedPdfResult {
+  const { showTrackChanges = false, useTodonotes = true, stripResolved = true } = options;
+
+  let result = markdown;
+  let preamble = '';
+  let commentCount = 0;
+
+  // Convert comments to margin notes
+  const commentResult = convertCommentsToMarginNotes(result, { useTodonotes, stripResolved });
+  result = commentResult.markdown;
+  commentCount = commentResult.commentCount;
+  preamble += commentResult.preamble;
+
+  // Optionally show track changes
+  if (showTrackChanges) {
+    const trackResult = convertTrackChangesToLatex(result);
+    result = trackResult.markdown;
+    // Add ulem package if not already in todonotes preamble
+    if (!useTodonotes) {
+      preamble += trackResult.preamble;
+    } else {
+      preamble += `\\usepackage[normalem]{ulem}\n`;
+    }
+  }
+
+  return { markdown: result, preamble, commentCount };
+}