@peaske7/readit 0.1.7 → 0.2.0

package/src/lib/comment-storage.ts

@@ -1,7 +1,7 @@
 import * as crypto from "node:crypto";
 import * as os from "node:os";
 import * as path from "node:path";
-import type { Comment, CommentFile } from "../types";
+import type { Comment, CommentFile } from "../schema";
 
 const FORMAT_VERSION = 1;
 const HASH_LENGTH = 16;
@@ -9,9 +9,6 @@ const MAX_SELECTION_LENGTH = 1000;
 const TRUNCATION_MARKER = "\n...\n";
 const ANCHOR_PREFIX_LENGTH = 200; // chars stored for anchor matching when text is truncated
 
-/**
- * Truncate very long selections to first ~500 + ... + last ~500 chars.
- */
 export function truncateSelection(text: string): string {
   if (text.length <= MAX_SELECTION_LENGTH) {
     return text;
@@ -27,13 +24,9 @@ export function truncateSelection(text: string): string {
  * Comments are stored in ~/.readit/comments/{absolute-path-structure}/{filename}.comments.md
  */
 export function getCommentPath(sourcePath: string): string {
-  // Resolve to absolute path
   const absolute = path.resolve(sourcePath);
-
   // Remove leading slash and drive letter (Windows)
   const normalized = absolute.replace(/^\//, "").replace(/^[A-Z]:[\\/]/, "");
-
-  // Get filename without extension, add .comments.md
   const ext = path.extname(normalized);
   const withoutExt = normalized.slice(0, -ext.length || undefined);
 
@@ -45,9 +38,6 @@ export function getCommentPath(sourcePath: string): string {
   );
 }
 
-/**
- * Compute SHA-256 hash of content, returning first 16 characters.
- */
 export function computeHash(content: string): string {
   return crypto
     .createHash("sha256")
@@ -56,18 +46,12 @@ export function computeHash(content: string): string {
     .slice(0, HASH_LENGTH);
 }
 
-/**
- * Get line number (1-indexed) for a character offset in content.
- */
 export function getLineNumber(content: string, offset: number): number {
   if (offset <= 0 || content.length === 0) return 1;
   const clampedOffset = Math.min(offset, content.length);
   return content.slice(0, clampedOffset).split("\n").length;
 }
 
-/**
- * Get line range string for a selection (e.g., "L42" or "L42-45").
- */
 export function getLineHint(
   content: string,
   startOffset: number,
@@ -75,12 +59,9 @@ export function getLineHint(
 ): string {
   const startLine = getLineNumber(content, startOffset);
   const endLine = getLineNumber(content, endOffset);
-  return startLine === endLine ? `L${startLine}` : `L${startLine}-${endLine}`;
+  return startLine === endLine ? `L${startLine}` : `L${startLine}-L${endLine}`;
 }
 
-/**
- * Parse a comment file's markdown content into a CommentFile structure.
- */
 export function parseCommentFile(content: string): CommentFile {
   const result: CommentFile = {
     source: "",
@@ -93,7 +74,6 @@ export function parseCommentFile(content: string): CommentFile {
     return result;
   }
 
-  // Parse YAML front matter
   const frontMatterMatch = content.match(/^---\n([\s\S]*?)\n---/);
   if (frontMatterMatch) {
     const frontMatter = frontMatterMatch[1];
@@ -105,7 +85,6 @@ export function parseCommentFile(content: string): CommentFile {
     if (hashMatch) result.hash = hashMatch[1].trim();
     if (versionMatch) result.version = Number.parseInt(versionMatch[1], 10);
 
-    // Validate version compatibility
     if (result.version > FORMAT_VERSION) {
       throw new Error(
         `Comment file requires readit v${result.version} or higher. ` +
@@ -114,7 +93,6 @@ export function parseCommentFile(content: string): CommentFile {
     }
   }
 
-  // Remove front matter and split by separator
   const bodyContent = content.replace(/^---\n[\s\S]*?\n---\n*/, "");
   const blocks = bodyContent.split(/\n---\n/).filter((block) => block.trim());
 
@@ -128,9 +106,6 @@ export function parseCommentFile(content: string): CommentFile {
   return result;
 }
 
-/**
- * Parse a single comment block.
- */
 function parseCommentBlock(block: string): Comment | undefined {
   // Extract metadata from HTML comment: <!-- c:{id}|{lineHint}|{timestamp} -->
   const metadataMatch = block.match(/<!--\s*c:([^|]+)\|([^|]+)\|([^>]+)\s*-->/);
@@ -144,19 +119,16 @@ function parseCommentBlock(block: string): Comment | undefined {
   const anchorMatch = block.match(/<!--\s*anchor:(.+?)\s*-->/);
   const anchorPrefix = anchorMatch ? anchorMatch[1] : undefined;
 
-  // Extract selected text from blockquote
   const blockquoteMatch = block.match(/^>\s*(.+(?:\n>\s*.+)*)$/m);
   if (!blockquoteMatch) {
     return undefined;
   }
 
-  // Remove the "> " prefix from each line
   const selectedText = blockquoteMatch[1]
     .split("\n")
     .map((line) => line.replace(/^>\s*/, ""))
     .join("\n");
 
-  // Extract comment body (everything after blockquote)
   const afterBlockquote = block.slice(
     block.indexOf(blockquoteMatch[0]) + blockquoteMatch[0].length,
   );
@@ -175,13 +147,9 @@ function parseCommentBlock(block: string): Comment | undefined {
   };
 }
 
-/**
- * Serialize a CommentFile structure to markdown content.
- */
 export function serializeComments(file: CommentFile): string {
   const lines: string[] = [];
 
-  // YAML front matter
   lines.push("---");
   lines.push(`source: ${file.source}`);
   lines.push(`hash: ${file.hash}`);
@@ -189,7 +157,6 @@ export function serializeComments(file: CommentFile): string {
   lines.push("---");
   lines.push("");
 
-  // Comments
   for (const comment of file.comments) {
     lines.push(serializeComment(comment));
     lines.push("");
@@ -200,28 +167,21 @@ export function serializeComments(file: CommentFile): string {
   return lines.join("\n");
 }
 
-/**
- * Serialize a single comment to markdown block.
- */
 function serializeComment(comment: Comment): string {
   const lines: string[] = [];
 
-  // Metadata as HTML comment
   const lineHint = comment.lineHint || "L0";
   lines.push(`<!-- c:${comment.id}|${lineHint}|${comment.createdAt} -->`);
 
-  // Anchor prefix for long selections (used for anchor matching when text is truncated)
   if (comment.anchorPrefix) {
     lines.push(`<!-- anchor:${comment.anchorPrefix} -->`);
   }
 
-  // Selected text as blockquote
   const quotedLines = comment.selectedText
     .split("\n")
     .map((line) => `> ${line}`);
   lines.push(...quotedLines);
 
-  // Comment body
   if (comment.comment) {
     lines.push("");
     lines.push(comment.comment);
@@ -230,9 +190,6 @@ function serializeComment(comment: Comment): string {
   return lines.join("\n");
 }
 
-/**
- * Create a new comment with a generated ID and current timestamp.
- */
 export function createComment(
   selectedText: string,
   commentText: string,
@@ -255,7 +212,6 @@ export function createComment(
     startOffset,
     endOffset,
     lineHint,
-    // Store first N chars for anchor matching when text is truncated
     anchorPrefix: needsTruncation
       ? selectedText.slice(0, ANCHOR_PREFIX_LENGTH)
       : undefined,

package/src/lib/export.ts

@@ -1,19 +1,12 @@
-import type { Comment, Document } from "../types";
+import type { Comment, Document } from "../schema";
 
-export function generatePrompt(comments: Comment[], fileName: string): string {
-  const prompt = comments
-    .map((c) => {
-      return `---\nSelected text: "${c.selectedText}"\nComment: ${c.comment}`;
-    })
-    .join("\n\n");
-
-  return `# Review Comments for ${fileName}\n\n${prompt}`;
+export function formatComment(c: Comment): string {
+  const line = c.lineHint ? `[${c.lineHint}] ` : "";
+  return `${line}"${c.selectedText}"\n${c.comment}`;
 }
 
-export function generateRawText(comments: Comment[]): string {
-  return comments
-    .map((c) => `${c.selectedText}\n\n${c.comment}`)
-    .join("\n\n---\n\n");
+export function generatePrompt(comments: Comment[], fileName: string): string {
+  return `# Review Comments for ${fileName}\n\n${comments.map(formatComment).join("\n\n---\n\n")}`;
 }
 
 export function exportCommentsAsJson(
@@ -27,6 +20,7 @@ export function exportCommentsAsJson(
     comments: comments.map((c) => ({
       selectedText: c.selectedText,
       comment: c.comment,
+      lineHint: c.lineHint,
       createdAt: c.createdAt,
     })),
   };

package/src/lib/highlight/core.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from "vitest";
-import { findTextPosition } from "./core";
+import { findTextPosition } from "./resolver";
 
 describe("findTextPosition", () => {
   it("finds single occurrence", () => {

package/src/lib/highlight/dom.ts

@@ -1,9 +1,5 @@
-import type { HighlightPositions, HighlightStyle, TextNodeInfo } from "./types";
+import type { HighlightStyle, TextNodeInfo } from "./types";
 
-/**
- * Block-level elements that should have newlines between them.
- * Used to normalize whitespace in text extraction.
- */
 const BLOCK_ELEMENTS = new Set([
   "P",
   "DIV",
@@ -20,9 +16,6 @@ const BLOCK_ELEMENTS = new Set([
   "BR",
 ]);
 
-/**
- * Find the closest block-level ancestor of a node.
- */
 function findBlockParent(node: Node): Element | null {
   let parent = node.parentElement;
   while (parent && !BLOCK_ELEMENTS.has(parent.tagName)) {
@@ -31,10 +24,7 @@ function findBlockParent(node: Node): Element | null {
   return parent;
 }
 
-/**
- * Calculate text offset from root to a specific node position.
- * Accounts for newlines between block elements to match getDOMTextContent.
- */
+/** Accounts for newlines between block elements to match getDOMTextContent. */
 export function getTextOffset(
   root: Node,
   targetNode: Node,
@@ -48,13 +38,12 @@ export function getTextOffset(
   while (node) {
     const blockParent = findBlockParent(node);
 
-    // Add newline when transitioning between different block parents
     if (lastBlockParent && blockParent && lastBlockParent !== blockParent) {
       if (
         !lastBlockParent.contains(blockParent) &&
         !blockParent.contains(lastBlockParent)
       ) {
-        offset += 1; // Account for the newline
+        offset += 1;
       }
     }
 
@@ -69,10 +58,7 @@ export function getTextOffset(
   return offset;
 }
 
-/**
- * Extract all text content from a DOM tree.
- * Inserts newlines between block-level elements to match browser selection behavior.
- */
+/** Inserts newlines between block-level elements to match browser selection behavior. */
 export function getDOMTextContent(root: Node): string {
   const walker = document.createTreeWalker(root, NodeFilter.SHOW_TEXT);
   let text = "";
@@ -82,7 +68,6 @@ export function getDOMTextContent(root: Node): string {
   while (node) {
     const blockParent = findBlockParent(node);
 
-    // Insert newline when transitioning between different block parents
     if (lastBlockParent && blockParent && lastBlockParent !== blockParent) {
       // Only add newline if blocks are siblings (not nested)
       if (
@@ -101,10 +86,6 @@ export function getDOMTextContent(root: Node): string {
   return text;
 }
 
-/**
- * Collect all text nodes with their cumulative offset ranges.
- * Accounts for newlines between block elements to match getDOMTextContent.
- */
 export function collectTextNodes(root: Node): TextNodeInfo[] {
   const textNodes: TextNodeInfo[] = [];
   let currentOffset = 0;
@@ -116,14 +97,12 @@ export function collectTextNodes(root: Node): TextNodeInfo[] {
   while (node) {
     const blockParent = findBlockParent(node);
 
-    // Account for newline when transitioning between different block parents
-    // (same logic as getDOMTextContent)
     if (lastBlockParent && blockParent && lastBlockParent !== blockParent) {
       if (
         !lastBlockParent.contains(blockParent) &&
         !blockParent.contains(lastBlockParent)
       ) {
-        currentOffset += 1; // Account for the newline
+        currentOffset += 1;
       }
     }
 
@@ -141,9 +120,6 @@ export function collectTextNodes(root: Node): TextNodeInfo[] {
   return textNodes;
 }
 
-/**
- * Extended style configuration for highlight marks with color and bracket mode support.
- */
 export interface ExtendedHighlightStyle extends HighlightStyle {
   colorIndex?: number;
   isBracketMode?: boolean;
@@ -164,9 +140,6 @@ interface NodeSegment {
   order: number;
 }
 
-/**
- * Line threshold for bracket mode (selections spanning this many lines or more)
- */
 const BRACKET_MODE_LINE_THRESHOLD = 5;
 
 export function countLinesInRange(
@@ -183,9 +156,6 @@ export function countLinesInRange(
 // applyHighlightWithStyle adds color indices and bracket mode for saved comments.
 // Keeping them separate avoids unnecessary complexity in a shared abstraction.
 
-/**
- * Apply highlight mark elements to a text range (for pending selections).
- */
 export function applyHighlightToRange(
   root: HTMLElement,
   startOffset: number,
@@ -225,7 +195,6 @@ export function applyHighlightToRange(
         mark.appendChild(fragment);
         range.insertNode(mark);
       } catch (err) {
-        // Skip if fallback also fails, but log for debugging
         console.warn("[highlight] Failed to apply highlight to range:", err);
       }
     }
@@ -380,35 +349,3 @@ export function clearHighlights(
     }
   }
 }
-
-/**
- * Collect highlight positions relative to a container and document.
- */
-export function collectHighlightPositions(
-  root: HTMLElement,
-  containerRect: DOMRect,
-  scrollY = 0,
-): HighlightPositions {
-  const positions: Record<string, number> = {};
-  const documentPositions: Record<string, number> = {};
-
-  // Collect comment highlight positions
-  const marks = root.querySelectorAll("mark[data-comment-id]");
-  for (const mark of marks) {
-    const commentId = mark.getAttribute("data-comment-id");
-    if (!commentId) continue;
-
-    // Get position relative to container (for margin notes)
-    const markRect = mark.getBoundingClientRect();
-    const relativeTop = markRect.top - containerRect.top;
-
-    // Use first occurrence of each comment id
-    if (!(commentId in positions)) {
-      positions[commentId] = relativeTop;
-      // Document-absolute position (for minimap)
-      documentPositions[commentId] = markRect.top + scrollY;
-    }
-  }
-
-  return { positions, documentPositions };
-}