projview 0.8.1 → 0.8.3

package/docs/ai-tests/comments.md

@@ -0,0 +1,118 @@
+# comments - AI test
+
+An AI-driven test of projview's **comment machine interface** (`projview comment
+add` / `comments` / `comment resolve|rm`, JSON on stdout). The scenario: an agent
+reviews a doc set, leaves anchored review notes, and a second reader pulls them
+back - no browser involved.
+
+## experimental parameters
+
+| parameter | value |
+| --- | --- |
+| tool | `projview` (global install) |
+| version | `0.8.2` |
+| commands | `comment add`, `comments`, `comment resolve`, `comment rm`, `usage` |
+| dataset | the bundled demo docs (`--demo`) |
+| store | a persistent sqlite file (`--store-url sqlite://…`) - comments need a store |
+| output | JSON per comment: `{ id, file, anchor, body, author, createdAt, resolved }` |
+
+> Comments ride a **persistent store**. With the default ephemeral store the
+> agent is warned the note won't survive exit, so pass `--persist` or
+> `--store-url`.
+
+## method
+
+An agent leaves review notes targeting different anchor types, then the notes are
+listed, one resolved, and one deleted:
+
+| # | file | anchor | aspect under test |
+| --- | --- | --- | --- |
+| 1 | `README.md` | file | whole-file note + agent self-tag (`--author claude`) |
+| 2 | `getting-started.md` | heading | section anchor to a stable `pv-` heading id |
+| 3 | lifecycle | — | list → resolve → delete over the CLI |
+
+## results
+
+### 1. leave an anchored, agent-tagged comment
+
+```bash
+DB="sqlite:///tmp/review.sqlite"
+projview comment add README.md "clear intro - add a 'what it is NOT' line" \
+  --author claude --store-url "$DB" --demo
+```
+
+```jsonc
+{ "id": "be15fdb7-…", "file": "README.md",
+  "anchor": { "type": "file" },
+  "body": "clear intro - add a 'what it is NOT' line",
+  "author": "claude", "resolved": false }
+```
+
+✅ The agent self-tags via `--author claude`, so AI notes are distinguishable
+from human ones. Without `--author`, the author defaults to the git/OS user.
+
+### 2. anchor to a section (heading)
+
+```bash
+projview comment add getting-started.md "could link forward to the api reference" \
+  --heading pv-headings-h1-h6 --author claude --store-url "$DB" --demo
+```
+
+`anchor` becomes `{ "type": "heading", "id": "pv-headings-h1-h6" }`. Heading ids
+are the `pv-`-prefixed slugs projview renders, so a section note survives edits to
+the section body.
+
+✅ Three anchor flavours exist: `file`, `heading`, and `text` (a quote selector,
+created from the viewer - it re-anchors on edits and flags itself *orphaned* only
+if the quoted text truly disappears).
+
+### 3. read them back
+
+```bash
+projview comments --store-url "$DB" --demo            # all comments, as a JSON array
+projview comments README.md --store-url "$DB" --demo  # filtered to one file
+```
+
+An agent can diff, summarise, or act on the returned objects programmatically.
+
+### 4. resolve + delete
+
+```bash
+projview comment resolve <id> --store-url "$DB" --demo   # -> { …, "resolved": true }
+projview comment rm <id>      --store-url "$DB" --demo   # -> { "deleted": "<id>" }
+```
+
+✅ Full lifecycle over the CLI: create → list → resolve/reopen → delete. A
+missing id exits non-zero with a clear message.
+
+### 5. usage
+
+```bash
+projview usage --store-url "$DB" --demo
+# { "total": 0, "byType": {}, "topFiles": [], "recentSearches": [] }
+```
+
+`usage` is empty here because the **viewer** (not the CLI) records `view` /
+`search` events; run the server and browse, then `usage` aggregates what was
+looked at.
+
+## observations & limitations
+
+- **Authorship**: explicit `--author` wins; otherwise the git `user.name` (or the
+  OS username). UI-created comments default to the server's git/OS user.
+- **Persistence is required** for CLI comments to survive - the default store is
+  ephemeral and `comment add` warns when it isn't writable beyond the session.
+- **Anchors**: `file` and `heading` are creatable from the CLI; `text` quote
+  anchors come from the viewer (they need a live text selection).
+- **Writes are localhost-only** over HTTP - an exposed (`0.0.0.0`) instance is
+  read-only (`403` on write). The CLI writes the store directly, so it isn't gated.
+
+## reproduce
+
+```bash
+npm i -g projview@latest
+DB="sqlite:///tmp/review.sqlite"
+projview comment add README.md "a note" --author claude --store-url "$DB" --demo
+projview comments --store-url "$DB" --demo
+projview usage --store-url "$DB" --demo
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "projview",
-  "version": "0.8.1",
+  "version": "0.8.3",
   "description": "Ephemeral local previewer for markdown + mermaid files in any directory",
   "type": "module",
   "bin": {

package/public/anchor.js

@@ -0,0 +1,38 @@
+/* text-quote re-anchoring - the pure part.
+ *
+ * findQuote() locates a {exact, prefix, suffix} selector in a flat string and
+ * returns the best start offset, disambiguating repeated text by surrounding
+ * context. It touches no DOM, so it's unit-testable directly (no jsdom). The
+ * caller (comments.js) maps the offset back to a DOM Range. */
+
+export const commonPrefix = (a, b) => {
+  let i = 0;
+  while (i < a.length && i < b.length && a[i] === b[i]) i++;
+  return i;
+};
+export const commonSuffix = (a, b) => {
+  let i = 0;
+  while (i < a.length && i < b.length && a[a.length - 1 - i] === b[b.length - 1 - i]) i++;
+  return i;
+};
+
+// Best start offset of anchor.exact in `text`, or -1 if it isn't present.
+// When `exact` repeats, the candidate whose surrounding text best matches
+// prefix/suffix wins (ties -> earliest).
+export function findQuote(text, anchor) {
+  const exact = anchor.exact || '';
+  if (!exact) return -1;
+  const prefix = anchor.prefix || '';
+  const suffix = anchor.suffix || '';
+  let best = -1;
+  let bestScore = -1;
+  let idx = text.indexOf(exact);
+  while (idx !== -1) {
+    const before = text.slice(Math.max(0, idx - prefix.length), idx);
+    const after = text.slice(idx + exact.length, idx + exact.length + suffix.length);
+    const score = commonSuffix(before, prefix) + commonPrefix(after, suffix);
+    if (score > bestScore) { bestScore = score; best = idx; }
+    idx = text.indexOf(exact, idx + 1);
+  }
+  return best;
+}

package/public/comments.js

@@ -10,6 +10,7 @@
 import { $, esc } from './dom.js';
 import { state } from './store.js';
 import { toast } from './toast.js';
+import { findQuote } from './anchor.js';
 
 const contentEl = $('content');
 const viewerEl = $('viewer');
@@ -29,7 +30,14 @@ const cre = (tag, cls, html) => {
   return e;
 };
 
-const fab = cre('button', 'cmt-fab', '💬<span class="cmt-badge" hidden>0</span>');
+const FAB_ICON =
+  `<svg class="cmt-fab-ico" viewBox="0 0 24 24" width="23" height="23" fill="none" aria-hidden="true">
+     <path d="M21 15a2 2 0 0 1-2 2H7l-4 4V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2z" stroke="currentColor" stroke-width="1.9" stroke-linecap="round" stroke-linejoin="round"/>
+     <circle cx="8" cy="10" r="1.05" fill="currentColor"/>
+     <circle cx="12" cy="10" r="1.05" fill="currentColor"/>
+     <circle cx="16" cy="10" r="1.05" fill="currentColor"/>
+   </svg>`;
+const fab = cre('button', 'cmt-fab', `${FAB_ICON}<span class="cmt-badge" hidden>0</span>`);
 fab.title = 'comments';
 fab.hidden = true;
 
@@ -148,24 +156,11 @@ function pointAt(segs, offset) {
   return last ? { node: last.node, offset: last.node.nodeValue.length } : null;
 }
 
-const commonPrefix = (a, b) => { let i = 0; while (i < a.length && i < b.length && a[i] === b[i]) i++; return i; };
-const commonSuffix = (a, b) => { let i = 0; while (i < a.length && i < b.length && a[a.length - 1 - i] === b[b.length - 1 - i]) i++; return i; };
-
-// Resolve a {exact, prefix, suffix} quote selector to a Range, disambiguating
-// repeats by surrounding context. Returns null if `exact` isn't present.
+// Resolve a {exact, prefix, suffix} quote selector to a DOM Range (using the
+// pure finder in anchor.js). Returns null if `exact` isn't present (orphan).
 function resolveText(anchor, ctx) {
-  const { text } = ctx;
   const exact = anchor.exact || '';
-  if (!exact) return null;
-  let best = -1, bestScore = -1;
-  let idx = text.indexOf(exact);
-  while (idx !== -1) {
-    const before = text.slice(Math.max(0, idx - (anchor.prefix?.length || 0)), idx);
-    const after = text.slice(idx + exact.length, idx + exact.length + (anchor.suffix?.length || 0));
-    const score = commonSuffix(before, anchor.prefix || '') + commonPrefix(after, anchor.suffix || '');
-    if (score > bestScore) { bestScore = score; best = idx; }
-    idx = text.indexOf(exact, idx + 1);
-  }
+  const best = exact ? findQuote(ctx.text, anchor) : -1;
   if (best === -1) return null;
   const a = pointAt(ctx.segs, best);
   const b = pointAt(ctx.segs, best + exact.length);