markdown-it-critic 1.0.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Márton Visnovitz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,43 @@
+# markdown-it-critic
+
+[![License][license-badge]][license-link]
+[![Version][version-badge]][version-link]
+[![Build][build-badge]][build-link]
+
+[CriticMarkup](http://criticmarkup.com/) syntax as a [markdown-it](https://github.com/markdown-it/markdown-it)
+plugin, implemented as genuine inline tokenizer rules — change-tracking spans become first-class
+tokens in markdown-it's own token stream.
+
+## Setup
+
+Install via `npm`:
+
+```bash
+npm install markdown-it-critic
+```
+
+## Usage
+
+Registers like any other `markdown-it` plugin via `.use()`, no special setup, and safe to
+combine with other plugins in a curated distribution (e.g. `extramark`) or a standalone
+`markdown-it` instance.
+
+```js
+import MarkdownIt from "markdown-it";
+import criticMarkup from "markdown-it-critic";
+
+const md = new MarkdownIt().use(criticMarkup);
+
+md.render("Lorem{-- ipsum--} dolor {++sit++} amet.");
+```
+
+## Contributing
+
+All ideas, recommendations, bug reports, pull requests are welcome. 😊
+
+[license-badge]: https://img.shields.io/npm/l/markdown-it-critic.svg
+[license-link]: https://github.com/vimtaai/markdown-it-critic/blob/master/LICENSE.md
+[version-badge]: https://img.shields.io/npm/v/markdown-it-critic.svg
+[version-link]: https://www.npmjs.com/package/markdown-it-critic
+[build-badge]: https://github.com/vimtaai/markdown-it-critic/actions/workflows/main.yaml/badge.svg
+[build-link]: https://github.com/vimtaai/markdown-it-critic/actions/workflows/main.yaml

package/lib/index.js

@@ -0,0 +1,12 @@
+import { addition } from "./rules/addition.js";
+import { comment } from "./rules/comment.js";
+import { deletion } from "./rules/deletion.js";
+import { highlight } from "./rules/highlight.js";
+import { paragraphBreak } from "./rules/paragraph-break.js";
+import { substitution } from "./rules/substitution.js";
+
+export function markdownItCriticMarkup(md) {
+  md.use(comment).use(highlight).use(addition).use(deletion).use(substitution).use(paragraphBreak);
+}
+
+export default markdownItCriticMarkup;

package/lib/rules/addition.js

@@ -0,0 +1,53 @@
+const OPEN = "{++";
+const CLOSE = "++}";
+
+export function additionRule(state, silent) {
+  const start = state.pos;
+
+  if (state.src.slice(start, start + OPEN.length) !== OPEN) return false;
+
+  const closeIndex = state.src.indexOf(CLOSE, start + OPEN.length);
+  if (closeIndex === -1) return false;
+
+  if (silent) return true;
+
+  pushInsOpen(state, start + OPEN.length, closeIndex);
+  state.pos = closeIndex + CLOSE.length;
+  pushInsClose(state, start + OPEN.length, closeIndex);
+
+  return true;
+}
+
+export function pushInsOpen(state, contentStart, contentEnd) {
+  const isEmpty = state.src.slice(contentStart, contentEnd).trim() === "";
+  const token = state.push("critic_ins_open", "ins", 1);
+  token.meta = { empty: isEmpty };
+
+  if (!isEmpty) {
+    const maxPos = state.posMax;
+    state.pos = contentStart;
+    state.posMax = contentEnd;
+    state.md.inline.tokenize(state);
+    state.posMax = maxPos;
+  }
+}
+
+export function pushInsClose(state, contentStart, contentEnd) {
+  const isEmpty = state.src.slice(contentStart, contentEnd).trim() === "";
+  const token = state.push("critic_ins_close", "ins", -1);
+  token.meta = { empty: isEmpty };
+}
+
+export function renderInsOpen(tokens, idx) {
+  return tokens[idx].meta?.empty ? '<ins class="break">&nbsp;</ins>' : "<ins>";
+}
+
+export function renderInsClose(tokens, idx) {
+  return tokens[idx].meta?.empty ? "" : "</ins>";
+}
+
+export function addition(md) {
+  md.inline.ruler.push("critic_addition", additionRule);
+  md.renderer.rules.critic_ins_open = renderInsOpen;
+  md.renderer.rules.critic_ins_close = renderInsClose;
+}

package/lib/rules/comment.js

@@ -0,0 +1,42 @@
+const OPEN = "{>>";
+const CLOSE = "<<}";
+
+function commentRule(state, silent) {
+  const start = state.pos;
+
+  if (state.src.slice(start, start + OPEN.length) !== OPEN) return false;
+
+  const closeIndex = state.src.indexOf(CLOSE, start + OPEN.length);
+  if (closeIndex === -1) return false;
+
+  if (silent) return true;
+
+  const maxPos = state.posMax;
+
+  state.push("critic_comment_open", "span", 1);
+
+  state.pos = start + OPEN.length;
+  state.posMax = closeIndex;
+  state.md.inline.tokenize(state);
+
+  state.pos = closeIndex + CLOSE.length;
+  state.posMax = maxPos;
+
+  state.push("critic_comment_close", "span", -1);
+
+  return true;
+}
+
+function renderCommentOpen() {
+  return '<span class="critic comment">';
+}
+
+function renderCommentClose() {
+  return "</span>";
+}
+
+export function comment(md) {
+  md.inline.ruler.push("critic_comment", commentRule);
+  md.renderer.rules.critic_comment_open = renderCommentOpen;
+  md.renderer.rules.critic_comment_close = renderCommentClose;
+}

package/lib/rules/deletion.js

@@ -0,0 +1,53 @@
+const OPEN = "{--";
+const CLOSE = "--}";
+
+export function deletionRule(state, silent) {
+  const start = state.pos;
+
+  if (state.src.slice(start, start + OPEN.length) !== OPEN) return false;
+
+  const closeIndex = state.src.indexOf(CLOSE, start + OPEN.length);
+  if (closeIndex === -1) return false;
+
+  if (silent) return true;
+
+  pushDelOpen(state, start + OPEN.length, closeIndex);
+  state.pos = closeIndex + CLOSE.length;
+  pushDelClose(state, start + OPEN.length, closeIndex);
+
+  return true;
+}
+
+export function pushDelOpen(state, contentStart, contentEnd) {
+  const isEmpty = state.src.slice(contentStart, contentEnd).trim() === "";
+  const token = state.push("critic_del_open", "del", 1);
+  token.meta = { empty: isEmpty };
+
+  if (!isEmpty) {
+    const maxPos = state.posMax;
+    state.pos = contentStart;
+    state.posMax = contentEnd;
+    state.md.inline.tokenize(state);
+    state.posMax = maxPos;
+  }
+}
+
+export function pushDelClose(state, contentStart, contentEnd) {
+  const isEmpty = state.src.slice(contentStart, contentEnd).trim() === "";
+  const token = state.push("critic_del_close", "del", -1);
+  token.meta = { empty: isEmpty };
+}
+
+export function renderDelOpen(tokens, idx) {
+  return tokens[idx].meta?.empty ? "<del>&nbsp;</del> " : "<del>";
+}
+
+export function renderDelClose(tokens, idx) {
+  return tokens[idx].meta?.empty ? "" : "</del>";
+}
+
+export function deletion(md) {
+  md.inline.ruler.push("critic_deletion", deletionRule);
+  md.renderer.rules.critic_del_open = renderDelOpen;
+  md.renderer.rules.critic_del_close = renderDelClose;
+}

package/lib/rules/highlight.js

@@ -0,0 +1,42 @@
+const OPEN = "{==";
+const CLOSE = "==}";
+
+function highlightRule(state, silent) {
+  const start = state.pos;
+
+  if (state.src.slice(start, start + OPEN.length) !== OPEN) return false;
+
+  const closeIndex = state.src.indexOf(CLOSE, start + OPEN.length);
+  if (closeIndex === -1) return false;
+
+  if (silent) return true;
+
+  const maxPos = state.posMax;
+
+  state.push("critic_mark_open", "mark", 1);
+
+  state.pos = start + OPEN.length;
+  state.posMax = closeIndex;
+  state.md.inline.tokenize(state);
+
+  state.pos = closeIndex + CLOSE.length;
+  state.posMax = maxPos;
+
+  state.push("critic_mark_close", "mark", -1);
+
+  return true;
+}
+
+function renderMarkOpen() {
+  return "<mark>";
+}
+
+function renderMarkClose() {
+  return "</mark>";
+}
+
+export function highlight(md) {
+  md.inline.ruler.push("critic_highlight", highlightRule);
+  md.renderer.rules.critic_mark_open = renderMarkOpen;
+  md.renderer.rules.critic_mark_close = renderMarkClose;
+}

package/lib/rules/paragraph-break.js

@@ -0,0 +1,54 @@
+const ADDITION_OPEN = "{++";
+const ADDITION_CLOSE = "++}";
+const DELETION_OPEN = "{--";
+const DELETION_CLOSE = "--}";
+
+const ADDITION_BREAK_HTML = '<ins class="break">&nbsp;</ins>';
+const DELETION_BREAK_HTML = "<del>&nbsp;</del> ";
+
+function findDanglingSpan(tokens, i, openMarker, closeMarker) {
+  const isParagraphPair =
+    tokens[i]?.type === "paragraph_open" &&
+    tokens[i + 1]?.type === "inline" &&
+    tokens[i + 2]?.type === "paragraph_close" &&
+    tokens[i + 3]?.type === "paragraph_open" &&
+    tokens[i + 4]?.type === "inline" &&
+    tokens[i + 5]?.type === "paragraph_close";
+
+  if (!isParagraphPair) return null;
+
+  const before = tokens[i + 1].content.replace(/\s+$/, "");
+  const after = tokens[i + 4].content.replace(/^\s+/, "");
+
+  if (!before.endsWith(openMarker) || !after.startsWith(closeMarker)) return null;
+
+  return {
+    before: before.slice(0, -openMarker.length),
+    after: after.slice(closeMarker.length),
+  };
+}
+
+function unwrapParagraphBreaks(state) {
+  const tokens = state.tokens;
+
+  for (let i = 0; i < tokens.length - 5; i++) {
+    const addition = findDanglingSpan(tokens, i, ADDITION_OPEN, ADDITION_CLOSE);
+    const deletion = addition ? null : findDanglingSpan(tokens, i, DELETION_OPEN, DELETION_CLOSE);
+    const match = addition ?? deletion;
+
+    if (!match) continue;
+
+    tokens[i + 1].content = match.before;
+    tokens[i + 4].content = match.after;
+
+    const marker = new state.Token("html_block", "", 0);
+    marker.content = addition ? ADDITION_BREAK_HTML : DELETION_BREAK_HTML;
+    marker.block = true;
+
+    tokens.splice(i + 3, 0, marker);
+  }
+}
+
+export function paragraphBreak(md) {
+  md.core.ruler.after("block", "critic_paragraph_break", unwrapParagraphBreaks);
+}

package/lib/rules/substitution.js

@@ -0,0 +1,41 @@
+import { pushInsClose, pushInsOpen, renderInsClose, renderInsOpen } from "./addition.js";
+import { pushDelClose, pushDelOpen, renderDelClose, renderDelOpen } from "./deletion.js";
+
+const OPEN = "{~~";
+const MID = "~>";
+const CLOSE = "~~}";
+
+function substitutionRule(state, silent) {
+  const start = state.pos;
+
+  if (state.src.slice(start, start + OPEN.length) !== OPEN) return false;
+
+  const midIndex = state.src.indexOf(MID, start + OPEN.length);
+  if (midIndex === -1) return false;
+
+  const closeIndex = state.src.indexOf(CLOSE, midIndex + MID.length);
+  if (closeIndex === -1) return false;
+
+  if (silent) return true;
+
+  const delContentStart = start + OPEN.length;
+  const insContentStart = midIndex + MID.length;
+
+  pushDelOpen(state, delContentStart, midIndex);
+  state.pos = insContentStart;
+  pushDelClose(state, delContentStart, midIndex);
+
+  pushInsOpen(state, insContentStart, closeIndex);
+  state.pos = closeIndex + CLOSE.length;
+  pushInsClose(state, insContentStart, closeIndex);
+
+  return true;
+}
+
+export function substitution(md) {
+  md.inline.ruler.push("critic_substitution", substitutionRule);
+  md.renderer.rules.critic_del_open = renderDelOpen;
+  md.renderer.rules.critic_del_close = renderDelClose;
+  md.renderer.rules.critic_ins_open = renderInsOpen;
+  md.renderer.rules.critic_ins_close = renderInsClose;
+}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "markdown-it-critic",
+  "version": "1.0.0",
+  "description": "CriticMarkup syntax as a markdown-it plugin",
+  "author": "Márton Visnovitz <vimtaai@pm.me>",
+  "license": "MIT",
+  "repository": "github:vimtaai/markdown-it-critic",
+  "type": "module",
+  "main": "lib/index.js",
+  "files": [
+    "lib/**/*.js",
+    "!lib/**/*.test.js"
+  ],
+  "scripts": {
+    "test": "node --test",
+    "test:watch": "node --watch --test",
+    "check": "biome check",
+    "check:ci": "biome ci",
+    "check:fix": "biome check --write"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.1",
+    "markdown-it": "^14.1.0"
+  }
+}