@peaske7/readit 0.2.1 → 0.3.0-rc.1

package/src/lib/comment-storage.ts

@@ -1,222 +0,0 @@
-import * as crypto from "node:crypto";
-import * as os from "node:os";
-import * as path from "node:path";
-import type { Comment, CommentFile } from "../schema";
-
-const FORMAT_VERSION = 1;
-const HASH_LENGTH = 16;
-const MAX_SELECTION_LENGTH = 1000;
-const TRUNCATION_MARKER = "\n...\n";
-const ANCHOR_PREFIX_LENGTH = 200;
-
-export function truncateSelection(text: string): string {
-  if (text.length <= MAX_SELECTION_LENGTH) {
-    return text;
-  }
-  const half = Math.floor(
-    (MAX_SELECTION_LENGTH - TRUNCATION_MARKER.length) / 2,
-  );
-  return text.slice(0, half) + TRUNCATION_MARKER + text.slice(-half);
-}
-
-export function getCommentPath(sourcePath: string): string {
-  const absolute = path.resolve(sourcePath);
-  const normalized = absolute.replace(/^\//, "").replace(/^[A-Z]:[\\/]/, "");
-  const ext = path.extname(normalized);
-  const withoutExt = normalized.slice(0, -ext.length || undefined);
-
-  return path.join(
-    os.homedir(),
-    ".readit",
-    "comments",
-    `${withoutExt}.comments.md`,
-  );
-}
-
-export function computeHash(content: string): string {
-  return crypto
-    .createHash("sha256")
-    .update(content)
-    .digest("hex")
-    .slice(0, HASH_LENGTH);
-}
-
-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;
-}
-
-export function getLineHint(
-  content: string,
-  startOffset: number,
-  endOffset: number,
-): string {
-  const startLine = getLineNumber(content, startOffset);
-  const endLine = getLineNumber(content, endOffset);
-  return startLine === endLine ? `L${startLine}` : `L${startLine}-L${endLine}`;
-}
-
-export function parseCommentFile(content: string): CommentFile {
-  const result: CommentFile = {
-    source: "",
-    hash: "",
-    version: FORMAT_VERSION,
-    comments: [],
-  };
-
-  if (!content.trim()) {
-    return result;
-  }
-
-  const frontMatterMatch = content.match(/^---\n([\s\S]*?)\n---/);
-  if (frontMatterMatch) {
-    const frontMatter = frontMatterMatch[1];
-    const sourceMatch = frontMatter.match(/^source:\s*(.+)$/m);
-    const hashMatch = frontMatter.match(/^hash:\s*(.+)$/m);
-    const versionMatch = frontMatter.match(/^version:\s*(\d+)$/m);
-
-    if (sourceMatch) result.source = sourceMatch[1].trim();
-    if (hashMatch) result.hash = hashMatch[1].trim();
-    if (versionMatch) result.version = Number.parseInt(versionMatch[1], 10);
-
-    if (result.version > FORMAT_VERSION) {
-      throw new Error(
-        `Comment file requires readit v${result.version} or higher. ` +
-          `Current version supports format v${FORMAT_VERSION}.`,
-      );
-    }
-  }
-
-  const bodyContent = content.replace(/^---\n[\s\S]*?\n---\n*/, "");
-
-  const markerRe = /<!--\s*c:[^|]+\|[^|>\s]+(?:\|[^>]*)?\s*-->/g;
-  const markerStarts: number[] = [];
-  for (const m of bodyContent.matchAll(markerRe)) {
-    if (m.index !== undefined) markerStarts.push(m.index);
-  }
-
-  for (let i = 0; i < markerStarts.length; i++) {
-    const start = markerStarts[i];
-    const end =
-      i + 1 < markerStarts.length ? markerStarts[i + 1] : bodyContent.length;
-    const block = bodyContent
-      .slice(start, end)
-      .replace(/\n+---\s*$/, "")
-      .trim();
-    if (!block) continue;
-    const comment = parseCommentBlock(block);
-    if (comment) {
-      result.comments.push(comment);
-    }
-  }
-
-  return result;
-}
-
-function parseCommentBlock(block: string): Comment | undefined {
-  const metadataMatch = block.match(
-    /<!--\s*c:([^|]+)\|([^|>\s]+)(?:\|[^>]*)?\s*-->/,
-  );
-  if (!metadataMatch) {
-    return undefined;
-  }
-
-  const [, id, lineHint] = metadataMatch;
-
-  const anchorMatch = block.match(/<!--\s*anchor:(.+?)\s*-->/);
-  const anchorPrefix = anchorMatch ? anchorMatch[1] : undefined;
-
-  const blockquoteMatch = block.match(/^>\s*(.+(?:\n>\s*.+)*)$/m);
-  if (!blockquoteMatch) {
-    return undefined;
-  }
-
-  const selectedText = blockquoteMatch[1]
-    .split("\n")
-    .map((line) => line.replace(/^>\s*/, ""))
-    .join("\n");
-
-  const afterBlockquote = block.slice(
-    block.indexOf(blockquoteMatch[0]) + blockquoteMatch[0].length,
-  );
-  const commentBody = afterBlockquote.trim();
-
-  return {
-    id,
-    selectedText,
-    comment: commentBody,
-    lineHint,
-    anchorPrefix,
-    startOffset: 0,
-    endOffset: 0,
-  };
-}
-
-export function serializeComments(file: CommentFile): string {
-  const lines: string[] = [];
-
-  lines.push("---");
-  lines.push(`source: ${file.source}`);
-  lines.push(`hash: ${file.hash}`);
-  lines.push(`version: ${file.version}`);
-  lines.push("---");
-  lines.push("");
-
-  for (const comment of file.comments) {
-    lines.push(serializeComment(comment));
-    lines.push("");
-    lines.push("---");
-    lines.push("");
-  }
-
-  return lines.join("\n");
-}
-
-function serializeComment(comment: Comment): string {
-  const lines: string[] = [];
-
-  const lineHint = comment.lineHint || "L0";
-  lines.push(`<!-- c:${comment.id}|${lineHint} -->`);
-
-  if (comment.anchorPrefix) {
-    lines.push(`<!-- anchor:${comment.anchorPrefix} -->`);
-  }
-
-  const quotedLines = comment.selectedText
-    .split("\n")
-    .map((line) => `> ${line}`);
-  lines.push(...quotedLines);
-
-  if (comment.comment) {
-    lines.push("");
-    lines.push(comment.comment);
-  }
-
-  return lines.join("\n");
-}
-
-export function createComment(
-  selectedText: string,
-  commentText: string,
-  startOffset: number,
-  endOffset: number,
-  sourceContent: string,
-): Comment {
-  const id = crypto.randomUUID().slice(0, 8);
-  const lineHint = getLineHint(sourceContent, startOffset, endOffset);
-
-  const needsTruncation = selectedText.length > MAX_SELECTION_LENGTH;
-
-  return {
-    id,
-    selectedText: truncateSelection(selectedText),
-    comment: commentText,
-    startOffset,
-    endOffset,
-    lineHint,
-    anchorPrefix: needsTruncation
-      ? selectedText.slice(0, ANCHOR_PREFIX_LENGTH)
-      : undefined,
-  };
-}

package/src/lib/export.bench.ts

@@ -1,21 +0,0 @@
-import { bench, describe } from "vitest";
-import { COMMENTS_10, COMMENTS_50 } from "./__fixtures__/bench-data";
-import { formatComment, generatePrompt } from "./export";
-
-describe("formatComment", () => {
-  const comment = COMMENTS_10[0];
-
-  bench("single comment", () => {
-    formatComment(comment);
-  });
-});
-
-describe("generatePrompt", () => {
-  bench("10 comments", () => {
-    generatePrompt(COMMENTS_10, "benchmark.md");
-  });
-
-  bench("50 comments", () => {
-    generatePrompt(COMMENTS_50, "benchmark.md");
-  });
-});

package/src/lib/export.ts

@@ -1,36 +0,0 @@
-import type { Comment, Document } from "../schema";
-
-export function formatComment(c: Comment): string {
-  const line = c.lineHint ? `[${c.lineHint}] ` : "";
-  return `${line}"${c.selectedText}"\n${c.comment}`;
-}
-
-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(
-  comments: Comment[],
-  document: Document,
-): void {
-  const data = {
-    filePath: document.filePath,
-    fileName: document.fileName,
-    exportedAt: new Date().toISOString(),
-    comments: comments.map((c) => ({
-      selectedText: c.selectedText,
-      comment: c.comment,
-      lineHint: c.lineHint,
-    })),
-  };
-
-  const blob = new Blob([JSON.stringify(data, null, 2)], {
-    type: "application/json",
-  });
-  const url = URL.createObjectURL(blob);
-  const a = window.document.createElement("a");
-  a.href = url;
-  a.download = `${document.fileName}-comments.json`;
-  a.click();
-  URL.revokeObjectURL(url);
-}

package/src/lib/headings.test.ts

@@ -1,103 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { parseMarkdownHeadings } from "./headings";
-
-describe("parseMarkdownHeadings", () => {
-  it("extracts basic headings", () => {
-    const content = `# Heading 1
-## Heading 2
-### Heading 3`;
-
-    expect(parseMarkdownHeadings(content)).toEqual([
-      { id: "heading-1", text: "Heading 1", level: 1 },
-      { id: "heading-2", text: "Heading 2", level: 2 },
-      { id: "heading-3", text: "Heading 3", level: 3 },
-    ]);
-  });
-
-  it("handles duplicate headings", () => {
-    const content = `## Section
-## Section
-## Section`;
-
-    expect(parseMarkdownHeadings(content)).toEqual([
-      { id: "section", text: "Section", level: 2 },
-      { id: "section-1", text: "Section", level: 2 },
-      { id: "section-2", text: "Section", level: 2 },
-    ]);
-  });
-
-  it("ignores headings inside fenced code blocks", () => {
-    const content = `# Real Heading
-
-\`\`\`bash
-# This is a comment, not a heading
-echo "hello"
-\`\`\`
-
-## Another Real Heading`;
-
-    expect(parseMarkdownHeadings(content)).toEqual([
-      { id: "real-heading", text: "Real Heading", level: 1 },
-      { id: "another-real-heading", text: "Another Real Heading", level: 2 },
-    ]);
-  });
-
-  it("ignores headings inside triple-tilde code blocks", () => {
-    const content = `# Real Heading
-
-~~~python
-# Python comment
-def foo():
-    pass
-~~~
-
-## Another Real Heading`;
-
-    expect(parseMarkdownHeadings(content)).toEqual([
-      { id: "real-heading", text: "Real Heading", level: 1 },
-      { id: "another-real-heading", text: "Another Real Heading", level: 2 },
-    ]);
-  });
-
-  it("handles multiple code blocks", () => {
-    const content = `# Introduction
-
-\`\`\`bash
-# Comment 1
-\`\`\`
-
-## Methods
-
-\`\`\`python
-# Comment 2
-\`\`\`
-
-## Results`;
-
-    expect(parseMarkdownHeadings(content)).toEqual([
-      { id: "introduction", text: "Introduction", level: 1 },
-      { id: "methods", text: "Methods", level: 2 },
-      { id: "results", text: "Results", level: 2 },
-    ]);
-  });
-
-  it("handles code block with language specifier", () => {
-    const content = `# Setup
-
-\`\`\`bash
-# Use a custom port
-npx readit document.md --port 3000
-\`\`\`
-
-## Usage`;
-
-    expect(parseMarkdownHeadings(content)).toEqual([
-      { id: "setup", text: "Setup", level: 1 },
-      { id: "usage", text: "Usage", level: 2 },
-    ]);
-  });
-
-  it("returns empty array for empty content", () => {
-    expect(parseMarkdownHeadings("")).toEqual([]);
-  });
-});

package/src/lib/headings.ts

@@ -1,44 +0,0 @@
-export interface Heading {
-  id: string;
-  text: string;
-  level: 1 | 2 | 3 | 4 | 5 | 6;
-}
-
-export function slugify(text: string): string {
-  return text
-    .toLowerCase()
-    .trim()
-    .replace(/[^\w\s-]/g, "")
-    .replace(/\s+/g, "-")
-    .replace(/-+/g, "-");
-}
-
-export function stripCodeBlocks(content: string): string {
-  let result = content.replace(/^(`{3,}|~{3,}).*$[\s\S]*?^\1\s*$/gm, "");
-  result = result.replace(/(?:^|\n\n)((?:(?:[ ]{4}|\t).+\n?)+)/g, "\n\n");
-
-  return result;
-}
-
-export function parseMarkdownHeadings(content: string): Heading[] {
-  const headings: Heading[] = [];
-  const seenIds = new Map<string, number>();
-  const contentWithoutCode = stripCodeBlocks(content);
-
-  const regex = /^(#{1,6})\s+(.+)$/gm;
-  let match = regex.exec(contentWithoutCode);
-
-  while (match !== null) {
-    const level = match[1].length as 1 | 2 | 3 | 4 | 5 | 6;
-    const text = match[2].trim();
-    const baseId = slugify(text);
-    const count = seenIds.get(baseId) ?? 0;
-    const id = count > 0 ? `${baseId}-${count}` : baseId;
-    seenIds.set(baseId, count + 1);
-
-    headings.push({ id, text, level });
-    match = regex.exec(contentWithoutCode);
-  }
-
-  return headings;
-}

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

@@ -1,93 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { findTextPosition } from "./resolver";
-
-describe("findTextPosition", () => {
-  it("finds single occurrence", () => {
-    const result = findTextPosition("hello world", "world");
-    expect(result).toEqual({ start: 6, end: 11 });
-  });
-
-  it("finds text at start", () => {
-    const result = findTextPosition("hello world", "hello");
-    expect(result).toEqual({ start: 0, end: 5 });
-  });
-
-  it("returns null for no match", () => {
-    expect(findTextPosition("hello", "xyz")).toBeUndefined();
-  });
-
-  it("returns null for empty selectedText", () => {
-    expect(findTextPosition("hello world", "")).toBeUndefined();
-  });
-
-  it("returns null for empty textContent", () => {
-    expect(findTextPosition("", "hello")).toBeUndefined();
-  });
-
-  it("returns null for both empty", () => {
-    expect(findTextPosition("", "")).toBeUndefined();
-  });
-
-  describe("multiple occurrences", () => {
-    it("finds closest occurrence to hint (before)", () => {
-      const text = "the cat and the dog and the bird";
-
-      const result = findTextPosition(text, "the", 10);
-      expect(result?.start).toBe(12);
-    });
-
-    it("finds closest occurrence to hint (after)", () => {
-      const text = "the cat and the dog and the bird";
-
-      const result = findTextPosition(text, "the", 30);
-      expect(result?.start).toBe(24);
-    });
-
-    it("finds first occurrence when hint is 0", () => {
-      const text = "the cat and the dog and the bird";
-      const result = findTextPosition(text, "the", 0);
-      expect(result?.start).toBe(0);
-    });
-
-    it("finds first occurrence when no hint provided", () => {
-      const text = "the cat and the dog and the bird";
-      const result = findTextPosition(text, "the");
-      expect(result?.start).toBe(0);
-    });
-
-    it("handles exact match at hint position", () => {
-      const text = "abc abc abc";
-      const result = findTextPosition(text, "abc", 4);
-      expect(result?.start).toBe(4);
-    });
-  });
-
-  describe("edge cases", () => {
-    it("handles single character search", () => {
-      const result = findTextPosition("hello", "l");
-      expect(result).toEqual({ start: 2, end: 3 });
-    });
-
-    it("handles overlapping matches (returns first)", () => {
-      const result = findTextPosition("aaa", "aa");
-      expect(result).toEqual({ start: 0, end: 2 });
-    });
-
-    it("handles multiline content", () => {
-      const text = "line one\nline two\nline three";
-      const result = findTextPosition(text, "two");
-      expect(result).toEqual({ start: 14, end: 17 });
-    });
-
-    it("handles unicode", () => {
-      const text = "こんにちは世界";
-      const result = findTextPosition(text, "世界");
-      expect(result).toEqual({ start: 5, end: 7 });
-    });
-
-    it("is case sensitive", () => {
-      const result = findTextPosition("Hello World", "hello");
-      expect(result).toBeUndefined();
-    });
-  });
-});

package/src/lib/highlight/dom.ts

@@ -1,187 +0,0 @@
-import type { TextNodeInfo } from "./types";
-
-const BLOCK_ELEMENTS = new Set([
-  "P",
-  "DIV",
-  "H1",
-  "H2",
-  "H3",
-  "H4",
-  "H5",
-  "H6",
-  "PRE",
-  "BLOCKQUOTE",
-  "LI",
-  "TR",
-  "BR",
-]);
-
-function findBlockParent(node: Node): Element | null {
-  let parent = node.parentElement;
-  while (parent && !BLOCK_ELEMENTS.has(parent.tagName)) {
-    parent = parent.parentElement;
-  }
-  return parent;
-}
-
-export function getTextOffset(
-  root: Node,
-  targetNode: Node,
-  targetOffset: number,
-): number {
-  let offset = 0;
-  let lastBlockParent: Element | null = null;
-  const walker = document.createTreeWalker(root, NodeFilter.SHOW_TEXT);
-
-  let node = walker.nextNode();
-  while (node) {
-    const blockParent = findBlockParent(node);
-
-    if (lastBlockParent && blockParent && lastBlockParent !== blockParent) {
-      if (
-        !lastBlockParent.contains(blockParent) &&
-        !blockParent.contains(lastBlockParent)
-      ) {
-        offset += 1;
-      }
-    }
-
-    if (node === targetNode) {
-      return offset + targetOffset;
-    }
-    offset += node.textContent?.length ?? 0;
-    lastBlockParent = blockParent;
-    node = walker.nextNode();
-  }
-
-  return offset;
-}
-
-export function getDOMTextContent(root: Node): string {
-  const walker = document.createTreeWalker(root, NodeFilter.SHOW_TEXT);
-  let text = "";
-  let lastBlockParent: Element | null = null;
-  let node = walker.nextNode();
-
-  while (node) {
-    const blockParent = findBlockParent(node);
-
-    if (lastBlockParent && blockParent && lastBlockParent !== blockParent) {
-      if (
-        !lastBlockParent.contains(blockParent) &&
-        !blockParent.contains(lastBlockParent)
-      ) {
-        text += "\n";
-      }
-    }
-
-    text += node.textContent ?? "";
-    lastBlockParent = blockParent;
-    node = walker.nextNode();
-  }
-
-  return text;
-}
-
-export function collectTextNodes(root: Node): TextNodeInfo[] {
-  const textNodes: TextNodeInfo[] = [];
-  let currentOffset = 0;
-  let lastBlockParent: Element | null = null;
-
-  const walker = document.createTreeWalker(root, NodeFilter.SHOW_TEXT);
-  let node = walker.nextNode();
-
-  while (node) {
-    const blockParent = findBlockParent(node);
-
-    if (lastBlockParent && blockParent && lastBlockParent !== blockParent) {
-      if (
-        !lastBlockParent.contains(blockParent) &&
-        !blockParent.contains(lastBlockParent)
-      ) {
-        currentOffset += 1;
-      }
-    }
-
-    const length = node.textContent?.length ?? 0;
-    textNodes.push({
-      node: node as Text,
-      start: currentOffset,
-      end: currentOffset + length,
-    });
-    currentOffset += length;
-    lastBlockParent = blockParent;
-    node = walker.nextNode();
-  }
-
-  return textNodes;
-}
-
-export function collectTextNodesWithContent(root: Node): {
-  text: string;
-  nodes: TextNodeInfo[];
-} {
-  const nodes: TextNodeInfo[] = [];
-  let text = "";
-  let currentOffset = 0;
-  let lastBlockParent: Element | null = null;
-
-  const walker = document.createTreeWalker(root, NodeFilter.SHOW_TEXT);
-  let node = walker.nextNode();
-
-  while (node) {
-    const blockParent = findBlockParent(node);
-
-    if (lastBlockParent && blockParent && lastBlockParent !== blockParent) {
-      if (
-        !lastBlockParent.contains(blockParent) &&
-        !blockParent.contains(lastBlockParent)
-      ) {
-        text += "\n";
-        currentOffset += 1;
-      }
-    }
-
-    const content = node.textContent ?? "";
-    text += content;
-    const length = content.length;
-    nodes.push({
-      node: node as Text,
-      start: currentOffset,
-      end: currentOffset + length,
-    });
-    currentOffset += length;
-    lastBlockParent = blockParent;
-    node = walker.nextNode();
-  }
-
-  return { text, nodes };
-}
-
-export function createRangesForHighlight(
-  root: Node,
-  startOffset: number,
-  endOffset: number,
-): Range[] {
-  const textNodes = collectTextNodes(root);
-  return createRangesFromNodes(textNodes, startOffset, endOffset);
-}
-
-export function createRangesFromNodes(
-  textNodes: TextNodeInfo[],
-  startOffset: number,
-  endOffset: number,
-): Range[] {
-  const ranges: Range[] = [];
-
-  for (const { node, start, end } of textNodes) {
-    if (end <= startOffset || start >= endOffset) continue;
-
-    const range = document.createRange();
-    range.setStart(node, Math.max(0, startOffset - start));
-    range.setEnd(node, Math.min(node.length, endOffset - start));
-    ranges.push(range);
-  }
-
-  return ranges;
-}