html-collab 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json ADDED
@@ -0,0 +1,61 @@
1
+ {
2
+ "name": "html-collab",
3
+ "version": "0.1.0",
4
+ "description": "Turn any single-file HTML report into a portable, reviewable document. Comments, suggested edits, and deterministic merge — all stored inside the HTML file itself.",
5
+ "type": "module",
6
+ "engines": {
7
+ "node": ">=18"
8
+ },
9
+ "bin": {
10
+ "html-collab": "dist/cli.js"
11
+ },
12
+ "scripts": {
13
+ "build": "bun build src/cli.ts --target=node --outfile=dist/cli.js && chmod +x dist/cli.js",
14
+ "build:examples": "bun run build:sample && bun run build:tour",
15
+ "build:sample": "bun examples/build-sample.ts",
16
+ "build:tour": "bun examples/build-tour.ts",
17
+ "prepack": "bun run build",
18
+ "prepublishOnly": "bun run verify",
19
+ "record:demo": "node examples/record-demo.mjs",
20
+ "test": "bun test",
21
+ "typecheck": "tsc --noEmit",
22
+ "verify": "bun run typecheck && bun test && bun run build && bun run build:examples"
23
+ },
24
+ "devDependencies": {
25
+ "@types/node": "^22.15.0",
26
+ "bun-types": "^1.3.0",
27
+ "playwright": "^1.60.0",
28
+ "typescript": "^5.8.3"
29
+ },
30
+ "files": [
31
+ "dist",
32
+ "README.md",
33
+ "LICENSE",
34
+ "skill"
35
+ ],
36
+ "keywords": [
37
+ "html",
38
+ "review",
39
+ "comments",
40
+ "annotations",
41
+ "collaboration",
42
+ "local-first",
43
+ "single-file",
44
+ "merge",
45
+ "crdt",
46
+ "ai-generated"
47
+ ],
48
+ "author": "Glen Maisey <glen.maisey@gmail.com>",
49
+ "license": "MIT",
50
+ "repository": {
51
+ "type": "git",
52
+ "url": "git+https://github.com/glendigity/html-collab.git"
53
+ },
54
+ "publishConfig": {
55
+ "access": "public"
56
+ },
57
+ "homepage": "https://glendigity.github.io/html-collab/examples/tour.review.html",
58
+ "bugs": {
59
+ "url": "https://github.com/glendigity/html-collab/issues"
60
+ }
61
+ }
package/skill/SKILL.md ADDED
@@ -0,0 +1,70 @@
1
+ ---
2
+ name: html-collab
3
+ description: Process review comments from portable html-collab files. Use when a user provides or mentions a `.review.html` file produced by `html-collab`, asks to summarize review feedback, revise the underlying report, merge reviewed copies, extract an agent brief, or unwrap final HTML.
4
+ ---
5
+
6
+ # html-collab
7
+
8
+ Use the `html-collab` CLI as the source of truth for parsing, merging,
9
+ extracting, wrapping, and unwrapping reviewable HTML files. Do not scrape the
10
+ browser UI or reimplement the embedded operation-log format.
11
+
12
+ ## Core Commands
13
+
14
+ ```sh
15
+ html-collab wrap report.html --out report.review.html
16
+ html-collab merge glen.review.html maya.review.html --out merged.review.html
17
+ html-collab extract merged.review.html --format agent --out agent-plan.md
18
+ html-collab extract merged.review.html --format markdown --out review-brief.md
19
+ html-collab extract merged.review.html --format json --out review-bundle.json
20
+ html-collab skill --out html-collab.SKILL.md
21
+ html-collab unwrap merged.review.html --out report.final.html
22
+ html-collab unwrap merged.review.html --apply-edits --out report.final.html
23
+ ```
24
+
25
+ ## Workflow
26
+
27
+ 1. If the user gives reviewed copies from multiple reviewers, run `merge` first.
28
+ 2. Run `extract --format agent` when the user wants you to revise or act on
29
+ the review.
30
+ 3. Run `extract --format json` when you need deterministic thread/message data.
31
+ 4. Run `extract --format markdown` for a human-readable brief.
32
+ 5. Summarize unresolved threads by section or anchor.
33
+ 6. Summarize suggested edits separately from comments, including edit IDs,
34
+ status, replacement text, and whether they are accepted, rejected, or deleted.
35
+ 7. Separate direct edits from questions that need author judgement.
36
+ 8. If asked to revise the report, unwrap or locate the source HTML, apply edits
37
+ to the clean report, then wrap the revised report for another review round.
38
+ 9. When the review cycle is finished, run `unwrap --apply-edits` if accepted
39
+ tracked edits should be applied to the final HTML, otherwise run `unwrap`
40
+ to recover the original clean HTML.
41
+
42
+ ## Semantics
43
+
44
+ Suggested edits are deterministic instructions. Open or accepted suggested
45
+ edits can be applied directly when the user asks for revision. Rejected or
46
+ deleted edits should not be applied unless the user explicitly asks.
47
+
48
+ Comments are reviewer intent. Treat comments as questions unless the anchor and
49
+ message make a simple edit obvious. For example, a comment anchored to `1` that
50
+ says `Make this 5` can be treated as an inferred replacement from `1` to `5`,
51
+ but report it as inferred and preserve the thread ID.
52
+
53
+ Resolved comments should not drive new edits unless the user explicitly asks to
54
+ revisit resolved feedback. Deleted comments/replies should be ignored except
55
+ when auditing review history.
56
+
57
+ ## Response Shape
58
+
59
+ When summarizing review feedback, report:
60
+
61
+ - Open thread count and resolved thread count.
62
+ - Suggested edit counts by status.
63
+ - Reviewers.
64
+ - Thread IDs, edit IDs, and any review-file links from the extracted brief.
65
+ - Direct revisions the agent can make.
66
+ - Author decisions that block revision.
67
+ - Any unanchored or invalid operations from the extracted bundle.
68
+
69
+ Keep comments as review state. Do not silently transform comments into document
70
+ edits unless the user asks you to revise the underlying report.