review-workspace 1.0.2 → 1.1.0

package/README.md

@@ -1,8 +1,9 @@
 # Review Workspace
 
 A local, offline decision surface for reviewing a code Comparison. See
-`docs/framework.md` for product rules, `CONTEXT.md` for the domain glossary,
-and `docs/spec.md` for the v1 spec.
+`docs/framework.md` for product rules, `docs/development.md` for code and
+testing conventions, `CONTEXT.md` for the domain glossary, and `docs/spec.md`
+for the v1 spec. AI agents: read `AGENTS.md` or `CLAUDE.md` first.
 
 ## Reviewing an MR/PR
 
@@ -35,11 +36,15 @@ Opens the UI at `http://127.0.0.1:4317` (prints a write token too — needed onl
 
 ```sh
 pnpm install
-pnpm test         # vitest
-pnpm typecheck    # tsc --noEmit, doubling as lint (ponytail: no separate linter yet)
-pnpm build:ui     # builds ui/ and copies it to ui-dist/ so `serve` hosts the UI itself
+pnpm test              # vitest — engine + ui unit tests
+pnpm test:e2e          # playwright — e2e + doc screenshots
+pnpm test:e2e:update   # refresh visual baselines after intentional UI changes
+pnpm typecheck         # tsc --noEmit, doubling as lint (ponytail: no separate linter yet)
+pnpm build:ui          # builds ui/ and copies it to ui-dist/ so `serve` hosts the UI itself
 ```
 
+Code style, architecture, and testing rules: [`docs/development.md`](docs/development.md).
+
 While developing the UI itself, run the two pieces separately instead — `node src/cli.ts serve .bundles/<name> --port 4317` for the API, and `cd ui && pnpm dev` for the UI with hot reload (its Vite dev server proxies `/api/*` to the port above).
 
 Add fixtures under `fixtures/` — see `fixtures/README.md`. Never commit a real

package/dist/renderer/render.js

@@ -166,5 +166,19 @@ export function render(document, patch, diagnostics, bundlePath) {
         diagnostics: bundleLevelDiagnostics,
         generatorPrompt: buildGeneratorPrompt(bundlePath),
         answers: document.answers ?? [],
+        summary: renderSummary(document, attachedPaths),
+    };
+}
+/** Dangling ids/paths are dropped rather than diagnosed — same treatment as evidence/verification targetIds. */
+function renderSummary(document, attachedPaths) {
+    if (!document.summary)
+        return undefined;
+    const annotationsById = new Map((document.annotations ?? []).map((a) => [a.id, a]));
+    return {
+        text: document.summary.text,
+        highlightAnnotations: (document.summary.highlightAnnotationIds ?? [])
+            .map((id) => annotationsById.get(id))
+            .filter((a) => a !== undefined),
+        highlightPaths: (document.summary.highlightPaths ?? []).filter((path) => attachedPaths.has(path)),
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "review-workspace",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "A local, offline decision surface for reviewing a code Comparison — evidence-linked map of intent, behavior, risk, and observable effects.",
   "license": "MIT",
   "author": "Salih Sayer",
@@ -38,17 +38,21 @@
   },
   "scripts": {
     "test": "vitest run",
+    "test:e2e": "playwright test",
+    "test:e2e:update": "playwright test --update-snapshots",
     "typecheck": "tsc --noEmit",
     "build": "tsc -p tsconfig.build.json",
     "build:ui": "cd ui && pnpm install && pnpm build && rm -rf ../ui-dist && mv dist ../ui-dist",
     "prepublishOnly": "pnpm test && pnpm typecheck && pnpm build && pnpm build:ui"
   },
   "devDependencies": {
+    "@playwright/test": "^1.55.0",
     "@semantic-release/changelog": "^7.0.0",
     "@semantic-release/git": "^11.0.1",
     "@semantic-release/github": "^12.0.9",
     "@semantic-release/npm": "^13.1.5",
     "@types/node": "^26.1.2",
+    "happy-dom": "^20.0.0",
     "semantic-release": "^25.0.8",
     "typescript": "^5.7.0",
     "vitest": "^3.0.0"

package/schemas/review-document.schema.json

@@ -43,9 +43,20 @@
     "answers": {
       "type": "array",
       "items": { "$ref": "#/$defs/answer" }
-    }
+    },
+    "summary": { "$ref": "#/$defs/summary" }
   },
   "$defs": {
+    "summary": {
+      "type": "object",
+      "required": ["text"],
+      "additionalProperties": false,
+      "properties": {
+        "text": { "type": "string", "minLength": 1 },
+        "highlightAnnotationIds": { "type": "array", "items": { "type": "string" } },
+        "highlightPaths": { "type": "array", "items": { "type": "string" } }
+      }
+    },
     "target": {
       "type": "object",
       "required": ["type", "path"],