@kadal/prettier-plugin 0.0.0-stage → 0.4.0

package/dist/split.js

@@ -0,0 +1,151 @@
+//#region src/split.ts
+/**
+* ─────────────────────────────────────────────────────────────────────────────
+* CUTTING A DECK INTO PIECES, the engine's way
+* ─────────────────────────────────────────────────────────────────────────────
+*
+* The same reading of the text as `@kadal/deck`'s compiler (packages/deck/src/compiler/split.ts,
+* `cut`), kept here so the plugin installs without the engine: a `---` line starts a slide, a
+* `----` line starts one beneath the last, the block after a separator is that slide's YAML when
+* it reads as YAML and a `---` closes it, a bare ```yaml fence as the first thing in a body is
+* "block frontmatter", and the fenced YAML at the top of the file is the headmatter. Fenced code
+* is never cut. split.test.ts checks this file against the engine's on the showcase and on the
+* tricky fixtures, piece for piece.
+*
+* Unlike the engine's, a piece here keeps the lines as written — the separator, the fences, the
+* blank lines — because a formatter rebuilds the text from them.
+* ─────────────────────────────────────────────────────────────────────────────
+*/
+const HORIZONTAL = /^---\s*$/;
+const VERTICAL = /^----+\s*$/;
+const FRONTMATTER_LINE = /^\s*[A-Za-z_][\w.-]*\s*:(\s|$)/;
+/** True when every non-empty line could be a YAML mapping line or a continuation (split.ts). */
+function looksLikeYaml(lines) {
+	let any = false;
+	for (const line of lines) {
+		if (!line.trim()) continue;
+		if (/^\s+/.test(line) || /^\s*-\s/.test(line) || /^\s*#/.test(line)) continue;
+		if (!FRONTMATTER_LINE.test(line)) return false;
+		any = true;
+	}
+	return any;
+}
+/**
+* Cut the text at separators (the engine's `cut`, line for line). The head piece is always first,
+* possibly empty.
+*/
+function cutDeck(text) {
+	const lines = text.split(/\r?\n/);
+	const pieces = [];
+	const blockAt = (from) => {
+		let k = from;
+		while (k < lines.length && !lines[k].trim()) k++;
+		const open = /^\s*(`{3,}|~{3,})ya?ml\s*$/.exec(lines[k] ?? "");
+		if (!open) return null;
+		const mark = open[1];
+		for (let c = k + 1; c < lines.length; c++) {
+			const close = /^\s*(`{3,}|~{3,})\s*$/.exec(lines[c]);
+			if (close && close[1][0] === mark[0] && close[1].length >= mark.length) return {
+				yaml: lines.slice(k + 1, c).join("\n"),
+				open: k,
+				close: c
+			};
+		}
+		return null;
+	};
+	const frontmatterAt = (from) => {
+		let close = -1;
+		for (let k = from; k < lines.length; k++) {
+			const l = lines[k];
+			if (HORIZONTAL.test(l)) {
+				close = k;
+				break;
+			}
+			if (VERTICAL.test(l)) return null;
+		}
+		if (close === -1) return null;
+		const block = lines.slice(from, close);
+		if (!looksLikeYaml(block)) return null;
+		return {
+			yaml: block.join("\n"),
+			next: close + 1
+		};
+	};
+	let i = 0;
+	let firstContent = 0;
+	while (firstContent < lines.length && !lines[firstContent].trim()) firstContent++;
+	const head = {
+		separator: null,
+		vertical: false,
+		frontmatter: null,
+		body: [],
+		line: 0
+	};
+	if (firstContent < lines.length && HORIZONTAL.test(lines[firstContent])) {
+		const fm = frontmatterAt(firstContent + 1);
+		if (fm) {
+			head.frontmatter = {
+				kind: "fence",
+				yaml: fm.yaml,
+				open: "---",
+				close: "---"
+			};
+			i = fm.next;
+		}
+	}
+	pieces.push(head);
+	let inFence = false;
+	let fence = "";
+	for (; i < lines.length; i++) {
+		const line = lines[i];
+		const fenceMatch = /^\s*(`{3,}|~{3,})/.exec(line);
+		if (fenceMatch) {
+			const mark = fenceMatch[1];
+			if (!inFence) {
+				inFence = true;
+				fence = mark;
+			} else if (mark[0] === fence[0] && mark.length >= fence.length) inFence = false;
+		}
+		if (!inFence && (HORIZONTAL.test(line) || VERTICAL.test(line))) {
+			const vertical = VERTICAL.test(line);
+			const fm = frontmatterAt(i + 1);
+			const block = fm ? null : blockAt(i + 1);
+			const piece = {
+				separator: line,
+				vertical,
+				frontmatter: null,
+				body: [],
+				line: i
+			};
+			if (fm) {
+				piece.frontmatter = {
+					kind: "fence",
+					yaml: fm.yaml,
+					open: "---",
+					close: "---"
+				};
+				i = fm.next - 1;
+			} else if (block) {
+				piece.frontmatter = {
+					kind: "block",
+					yaml: block.yaml,
+					open: lines[block.open],
+					close: lines[block.close]
+				};
+				i = block.close;
+			}
+			pieces.push(piece);
+			continue;
+		}
+		pieces[pieces.length - 1].body.push(line);
+	}
+	return pieces;
+}
+/** Whether a piece becomes a slide in the engine (split.ts: an empty head is not; an empty
+* later piece is one only when it carries frontmatter). */
+function isSlide(piece, index, frontmatterKeys) {
+	if (!!piece.body.join("\n").trim()) return true;
+	return index > 0 && frontmatterKeys > 0;
+}
+//#endregion
+export { HORIZONTAL, VERTICAL, cutDeck, isSlide, looksLikeYaml };

package/package.json

@@ -1,6 +1,75 @@
 {
   "name": "@kadal/prettier-plugin",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.4.0",
+  "description": "Prettier for Kadal Deck decks (deck.mdx): separators and frontmatter normalised, YAML formatted with its comments, and every slide's Markdown formatted, with code, notes, magic-move and ::slot:: sugar left exactly as written.",
+  "keywords": [
+    "prettier",
+    "prettier-plugin",
+    "kadal-deck",
+    "presentation",
+    "slides",
+    "mdx"
+  ],
+  "homepage": "https://deck.kadal.cc/docs/",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/pmithunish"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kadalcc/deck.git",
+    "directory": "packages/prettier-plugin"
+  },
+  "bugs": {
+    "url": "https://github.com/kadalcc/deck/issues"
+  },
+  "license": "AGPL-3.0-or-later",
+  "author": "Mithunish Prabhakaran <pmithunish@gmail.com>",
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "engines": {
+    "node": ">=20.19"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "typecheck": "tsc --noEmit",
+    "lint": "oxlint src",
+    "test": "bun test",
+    "prepack": "tsdown"
+  },
+  "dependencies": {
+    "remark-gfm": "^4.0.1",
+    "remark-math": "^6.0.0",
+    "remark-mdx": "^3.1.1",
+    "remark-parse": "^11.0.0",
+    "unified": "^11.0.5",
+    "yaml": "^2.8.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.9.3",
+    "prettier": "^3.9.10",
+    "typescript": "^6.0.3"
+  },
+  "peerDependencies": {
+    "prettier": "^3.0.0"
+  }
+}