");
+ expect(html.match(/ {
+ // The NIP-09 case: a Tag Reference section that exists in one version only.
+ const base = "## Usage\n\nText.";
+ const other = "## Usage\n\nText.\n\n## Tag Reference\n\nThe `e` tag deletes by id.";
+ const { html, changed } = diffMarkdown(base, other);
+ expect(changed).toBe(true);
+ expect(html).toContain('");
+ });
+
+ it("shows a symmetric divergence with both marks", () => {
+ // The NIP-59 case: each branch holds a passage the other lacks.
+ const base = "Shared opening.\n\n## Spam Protection\n\nRelays may require auth.";
+ const other = "Shared opening.\n\nThe optional self tag SHOULD be included.";
+ const { html } = diffMarkdown(base, other);
+ expect(html).toContain('class="diff-del"');
+ expect(html).toContain('class="diff-ins"');
+ });
+
+ it("marks a reworked sentence in place, inside one paragraph", () => {
+ const base = "Relays SHOULD delete all versions of the replaceable event.";
+ const other = "Relays SHOULD delete all events matching the kind and pubkey.";
+ const { html } = diffMarkdown(base, other);
+ expect(html.match(//g)).toHaveLength(1);
+ expect(html).toContain("");
+ expect(html).toContain("");
+ expect(html).toContain("Relays SHOULD delete all");
+ });
+
+ it("keeps a table one table when the other version adds a row", () => {
+ // The trusted-assertions case: one row added to a shared table.
+ const row = (name: string, tag: string) => `| ${name} | ${tag} |`;
+ const table = (rows: string[]) => ["| Name | Tag |", "| --- | --- |", ...rows].join("\n");
+ const base = table([row("First Post Time", "first_created_at")]);
+ const other = table([
+ row("First Post Time", "first_created_at"),
+ row("First Seen Time", "first_seen_at"),
+ ]);
+ const { html } = diffMarkdown(base, other);
+ expect(html.match(//g)).toHaveLength(1);
+ expect(html).toContain("First Seen Time");
+ expect(html).not.toContain("");
+ });
+
+ it("emits a changed heading once, under its new identifier", () => {
+ const { html } = diffMarkdown("## Client\n\nText.", "## Client Usage\n\nText.");
+ expect(html.match(/ Usage");
+ });
+
+ it("shows two passages whole when they share too little to merge", () => {
+ const base = "The quick brown fox jumps over the lazy dog near the river bank.";
+ const other = "Completely different words describing another idea entirely, twice as long.";
+ const { html } = diffMarkdown(base, other);
+ expect(html).toContain('class="diff-del"');
+ expect(html).toContain('class="diff-ins"');
+ expect(html).not.toContain("");
+ });
+
+ it("keeps the sanitizer between authors and the page", () => {
+ const { html } = diffMarkdown("safe text", "safe text and more");
+ expect(html).not.toContain(" {
+ const base = "# Doc\n\n## Section\n\nText.";
+ const other = "## Section\n\nText.";
+ const { html } = diffMarkdown(base, other);
+ // Both copies of "Section" render at the same depth, so it does not read as
+ // a change; only the title heading itself is struck.
+ expect(html.match(/");
+ });
+});
+
+describe("compareMarkdown", () => {
+ const BASE = "# Doc\n\nOne.\n\nTwo.\n\nThree.";
+
+ it("finds nothing between identical documents", () => {
+ const { changed, changes } = compareMarkdown(BASE, BASE);
+ expect(changed).toBe(false);
+ expect(changes).toEqual([]);
+ });
+
+ it("anchors a reworked block at its base index", () => {
+ const reworked = BASE.replace("Two.", "Two holds a sentence.");
+ const { changes } = compareMarkdown(
+ reworked,
+ reworked.replace("a sentence", "a reworked sentence"),
+ );
+ expect(changes).toHaveLength(1);
+ expect(changes[0]).toMatchObject({ anchor: 2, placement: "at" });
+ expect(changes[0]?.html).toContain("");
+ });
+
+ it("anchors added blocks after the one they follow", () => {
+ const { changes } = compareMarkdown(BASE, "# Doc\n\nOne.\n\nBetween.\n\nTwo.\n\nThree.");
+ expect(changes).toHaveLength(1);
+ expect(changes[0]).toMatchObject({ anchor: 1, placement: "after" });
+ expect(changes[0]?.html).toContain('class="diff-ins"');
+ });
+
+ it("anchors blocks added before everything at minus one", () => {
+ const { changes } = compareMarkdown("One.", "Zero.\n\nOne.");
+ expect(changes).toHaveLength(1);
+ expect(changes[0]).toMatchObject({ anchor: -1, placement: "after" });
+ });
+
+ it("groups a run of contiguous additions into one change", () => {
+ // The NIP-09 case: a whole section is one spot in the margin, not five.
+ const { changes } = compareMarkdown(BASE, `${BASE}\n\n## Extra\n\nMore.\n\nStill more.`);
+ expect(changes).toHaveLength(1);
+ expect(changes[0]).toMatchObject({ anchor: 3, placement: "after" });
+ expect(changes[0]?.html.match(/diff-ins/g)).toHaveLength(3);
+ });
+
+ it("keeps two separated changes as two, each at its own anchor", () => {
+ const { changes } = compareMarkdown(BASE, "# Doc\n\nOne, changed.\n\nTwo.\n\nThree, changed.");
+ expect(changes).toHaveLength(2);
+ expect(changes[0]).toMatchObject({ anchor: 1, placement: "at" });
+ expect(changes[1]).toMatchObject({ anchor: 3, placement: "at" });
+ });
+
+ it("marks a block the other side lacks at the block itself", () => {
+ const { changes } = compareMarkdown(BASE, "# Doc\n\nOne.\n\nThree.");
+ expect(changes).toHaveLength(1);
+ expect(changes[0]).toMatchObject({ anchor: 2, placement: "at" });
+ expect(changes[0]?.html).toContain('class="diff-del"');
+ });
+});
+
+describe("blockAnchors", () => {
+ it("aligns with the diff's block indices and carries the text", () => {
+ const anchors = blockAnchors("One.\n\nTwo.");
+ expect(anchors).toHaveLength(2);
+ expect(anchors[0]).toEqual({ text: "One.", rendered: true });
+ });
+
+ it("marks a leading heading repeating the title as not rendered", () => {
+ const anchors = blockAnchors("# NIP-07\n\nText.", "nip-07");
+ expect(anchors[0]?.rendered).toBe(false);
+ expect(anchors[1]?.rendered).toBe(true);
+ });
+
+ it("keeps a leading heading that says something else", () => {
+ const anchors = blockAnchors("# Another Name\n\nText.", "NIP-07");
+ expect(anchors[0]?.rendered).toBe(true);
+ });
+
+ it("marks definitions and raw html as not rendered", () => {
+ const anchors = blockAnchors("[ref]: https://example.com\n\nx
\n\nText [ref].");
+ expect(anchors.map((anchor) => anchor.rendered)).toEqual([false, false, true]);
+ });
+});
+
+describe("compareMarkdown, invisible changes", () => {
+ it("marks nothing when only a link target changed", () => {
+ // The mirror rewrites links to nostr addresses; a fork keeps the .md ones.
+ const { changes, changed } = compareMarkdown(
+ "This NIP relies on [NIP-44](nostr:naddr1qvzqqqr)'s encryption.",
+ "This NIP relies on [NIP-44](./44.md)'s encryption.",
+ );
+ expect(changes).toEqual([]);
+ expect(changed).toBe(false);
+ });
+
+ it("still marks a change to the link's own text", () => {
+ const { changes } = compareMarkdown(
+ "This NIP relies on [NIP-44](./44.md) but its text says so.",
+ "This NIP relies on [NIP-44 encryption](./44.md) but its text says so.",
+ );
+ expect(changes).toHaveLength(1);
+ expect(changes[0]?.html).toContain("");
+ });
+});
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 400bf71..7a855de 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -118,6 +118,9 @@ importers:
packages/markdown:
dependencies:
+ diff:
+ specifier: ^9.0.0
+ version: 9.0.0
hast-util-to-string:
specifier: ^3.0.1
version: 3.0.1
@@ -1046,6 +1049,10 @@ packages:
devlop@1.1.0:
resolution: {integrity: sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==}
+ diff@9.0.0:
+ resolution: {integrity: sha512-svtcdpS8CgJyqAjEQIXdb3OjhFVVYjzGAPO8WGCmRbrml64SPw/jJD4GoE98aR7r25A0XcgrK3F02yw9R/vhQw==}
+ engines: {node: '>=0.3.1'}
+
dunder-proto@1.0.1:
resolution: {integrity: sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==}
engines: {node: '>= 0.4'}
@@ -2804,6 +2811,8 @@ snapshots:
dependencies:
dequal: 2.0.3
+ diff@9.0.0: {}
+
dunder-proto@1.0.1:
dependencies:
call-bind-apply-helpers: 1.0.2