remark-mdat 2.2.4 → 3.0.1

package/dist/index.d.ts

@@ -3,8 +3,8 @@ import { z } from "zod";
 import { Root } from "mdast";
 import { VFile } from "vfile";
 import { JsonValue, MergeDeep, Simplify } from "type-fest";
+import "unist";
 import { Plugin } from "unified";
-
 //#region src/lib/mdat/rules.d.ts
 /**
  * Recursively simplifies a type for cleaner IDE hover display. Approximation of
@@ -15,8 +15,11 @@ type SimplifyDeep<T> = Simplify<MergeDeep<T, T>>;
  * Context passed to rule content functions during expansion.
  */
 type RuleContext = {
-  /** File path of the source document, if known. */filePath: string | undefined; /** Parsed YAML frontmatter from the document, if present. */
-  frontmatter: Record<string, unknown> | undefined; /** The full mdast AST of the document. Do not mutate. */
+  /** File path of the source document, if known. */
+  filePath: string | undefined;
+  /** Parsed YAML frontmatter from the document, if present. */
+  frontmatter: Record<string, unknown> | undefined;
+  /** The full mdast AST of the document. Do not mutate. */
   tree: Root;
 };
 /**
@@ -41,21 +44,21 @@ type Rule =
 /**
  * Function that returns the Markdown string to expand at the comment site.
  */
-((options: JsonValue, context: RuleContext) => Promise<string> | string)
+((options: JsonValue, context: RuleContext) => Promise<string> | string) |
 /**
  * Compound rules may be defined an array of rules, without keywords. Can be
  * defined at the top level, if no validation metadata is required, or as the
  * 'content' value of a rule object with validation metadata.
  */
-| Rule[]
+Rule[] |
 /**
  * The Markdown string to expand at the comment site.
  */
-| string
+string |
 /**
  * Rule object with optional metadata.
  */
-| {
+{
   /**
    * Gets content to expand into the comment. Can be a simple string for
    * direct replacement, a function that returns a string, or an async
@@ -152,8 +155,11 @@ declare const mdatClean: typeof mdatCollapse;
 //#region src/lib/mdast-utils/mdast-util-mdat-diff.d.ts
 /** Per-tag comparison result from {@link mdatDiff}. */
 type MdatDiffResult = {
-  /** The keyword for this tag. */keyword: string; /** 1-based line number of the opening comment in the expanded document. */
-  line: number; /** Comparison status. */
+  /** The keyword for this tag. */
+  keyword: string;
+  /** 1-based line number of the opening comment in the expanded document. */
+  line: number;
+  /** Comparison status. */
   status: 'added' | 'missing' | 'ok' | 'stale' | 'unexpanded';
 };
 /**
@@ -204,18 +210,28 @@ declare function setLogger(logger?: ILogBasic | ILogLayer<unknown>): void;
 //#region src/lib/mdat/mdat-log.d.ts
 /** A simplified representation of a {@link VFileMessage}. */
 type MdatMessage = {
-  /** Starting column of the message origin. */column?: number; /** Severity level. */
-  level: 'error' | 'info' | 'warn'; /** Starting line of the message origin. */
-  line?: number; /** Human-readable description of the issue. */
-  message: string; /** Namespace that produced the message (e.g. the rule name). */
+  /** Starting column of the message origin. */
+  column?: number;
+  /** Severity level. */
+  level: 'error' | 'info' | 'warn';
+  /** Starting line of the message origin. */
+  line?: number;
+  /** Human-readable description of the issue. */
+  message: string;
+  /** Namespace that produced the message (e.g. the rule name). */
   source?: string;
 };
 /** Aggregated processing report for a single file. */
 type MdatFileReport = {
-  /** Output path if the file was written to a different location. */destinationPath?: string; /** Fatal errors that prevented successful processing. */
-  errors: MdatMessage[]; /** Informational messages. */
-  infos: MdatMessage[]; /** Original input file path. */
-  sourcePath: string; /** Non-fatal warnings encountered during processing. */
+  /** Output path if the file was written to a different location. */
+  destinationPath?: string;
+  /** Fatal errors that prevented successful processing. */
+  errors: MdatMessage[];
+  /** Informational messages. */
+  infos: MdatMessage[];
+  /** Original input file path. */
+  sourcePath: string;
+  /** Non-fatal warnings encountered during processing. */
   warnings: MdatMessage[];
 };
 /** Converts an array of processed VFiles into {@link MdatFileReport} objects. */

package/dist/index.js

@@ -102,12 +102,12 @@ function reporterMdat(files) {
 }
 function mdatMessageToLogString(sourcePath, mdatMessage) {
 	const { column, level, line, message, source } = mdatMessage;
-	const resolvedSource = source ? picocolors.gray(`[${source}] `) : "";
-	const lineColumn = line && column ? `:${line}:${column}` : "";
+	const resolvedSource = source !== void 0 && source !== "" ? picocolors.gray(`[${source}] `) : "";
+	const lineColumn = line !== void 0 && line !== 0 && column !== void 0 && column !== 0 ? `:${line}:${column}` : "";
 	return `${resolvedSource}${highlightComments(message, level)} ${picocolors.whiteBright(sourcePath + lineColumn)}`;
 }
 function highlightComments(text, level) {
-	return text.replaceAll(/<!--.+-->/g, (match) => level === "info" ? picocolors.green(match) : level === "warn" ? picocolors.yellow(match) : picocolors.red(match));
+	return text.replaceAll(/<!--.+-->/gv, (match) => level === "info" ? picocolors.green(match) : level === "warn" ? picocolors.yellow(match) : picocolors.red(match));
 }
 //#endregion
 //#region src/lib/mdat/parse.ts
@@ -135,9 +135,9 @@ function parseCommentNode(node, parent) {
 		throw new VFileMessage("Unknown error", node);
 	}
 }
-const HTML_COMMENT_OPEN_REGEX = /^\s*<!-{2,}\s*/;
-const HTML_COMMENT_CLOSE_REGEX = /\s*-{2,}>\s*$/;
-const WHITESPACE_REGEX = /\s/;
+const HTML_COMMENT_OPEN_REGEX = /^\s*<!-{2,}\s*/v;
+const HTML_COMMENT_CLOSE_REGEX = /\s*-{2,}>\s*$/v;
+const WHITESPACE_REGEX = /\s/v;
 /**
 * Parse any comment string into structured data. Comments using code-style
 * notation (`//`, `#`, `/*`) are ignored and return `undefined`.
@@ -147,13 +147,12 @@ const WHITESPACE_REGEX = /\s/;
 */
 function parseComment(text) {
 	if (!isComment(text)) return;
-	const closingPrefix = "/";
 	const commentHtml = text.trim();
 	const commentBody = commentHtml.replace(HTML_COMMENT_OPEN_REGEX, "").replace(HTML_COMMENT_CLOSE_REGEX, "");
 	const parenIndex = commentBody.indexOf("(");
-	const rawKeyword = parenIndex === -1 ? commentBody.split(WHITESPACE_REGEX)[0] : commentBody.slice(0, parenIndex).trim();
+	const rawKeyword = parenIndex === -1 ? commentBody.split(WHITESPACE_REGEX)[0] ?? "" : commentBody.slice(0, parenIndex).trim();
 	if (rawKeyword.startsWith("//") || rawKeyword.startsWith("#") || rawKeyword.startsWith("/*")) return;
-	const type = rawKeyword.startsWith(closingPrefix) ? "close" : "open";
+	const type = rawKeyword.startsWith("/") ? "close" : "open";
 	let keyword = rawKeyword;
 	if (type === "close") keyword = keyword.slice(1);
 	let options = {};
@@ -221,7 +220,7 @@ function mdatCollapse(tree, file) {
 const NORMALIZED = Symbol("normalized");
 /** Check whether rules have already been normalized. */
 function isNormalized(rules) {
-	return NORMALIZED in rules;
+	return Object.hasOwn(rules, NORMALIZED);
 }
 /**
 * Converts flexible {@link Rules} into strict {@link NormalizedRules} for
@@ -267,7 +266,7 @@ function validateRules(rules) {
 	try {
 		rulesSchema.parse(rules);
 	} catch (error) {
-		if (error instanceof Error) throw new TypeError(`Error validating rules: ${error.message}`);
+		if (error instanceof Error) throw new TypeError(`Error validating rules: ${error.message}`, { cause: error });
 	}
 }
 const functionSchema = z.custom((value) => typeof value === "function");
@@ -284,7 +283,7 @@ const ruleSchema = z.lazy(() => z.union([
 		order: z.number().optional()
 	})
 ]));
-const COMMENT_PREFIX_REGEX = /^[/*#]/;
+const COMMENT_PREFIX_REGEX = /^[\/*#]/v;
 const keywordSchema = z.string().check(z.refine((key) => !COMMENT_PREFIX_REGEX.test(key), { message: "Rule keywords must not start with \"/\", \"*\", or \"#\" — these prefixes are reserved for comment syntax" }));
 /** Zod schema for validating {@link Rules} records. */
 const rulesSchema = z.record(keywordSchema, ruleSchema).describe("MDAT Rules");
@@ -333,8 +332,9 @@ function getSoleRule(rules) {
 */
 function getSoleRuleKey(rules) {
 	const keys = Object.keys(rules);
-	if (keys.length !== 1) throw new Error(`Expected exactly one rule, found ${keys.length}`);
-	return keys[0];
+	const [soleKey] = keys;
+	if (soleKey === void 0 || keys.length > 1) throw new Error(`Expected exactly one rule, found ${keys.length}`);
+	return soleKey;
 }
 /**
 * Get the sole entry in a record.
@@ -375,18 +375,22 @@ async function mdatExpand(tree, file, rules) {
 		if (parent === void 0 || index === void 0) return CONTINUE;
 		const commentMarker = parseCommentNode(node, parent);
 		if (commentMarker?.type !== "open") return CONTINUE;
-		if (normalizedRules[commentMarker.keyword] === void 0) {
+		const rule = normalizedRules[commentMarker.keyword];
+		if (rule === void 0) {
 			saveLog(file, "warn", "expand", `Missing rule for: ${commentMarker.html}`, node);
 			return CONTINUE;
 		}
-		commentMarkers.push(commentMarker);
+		commentMarkers.push({
+			marker: commentMarker,
+			rule
+		});
+		return CONTINUE;
 	});
-	commentMarkers.sort((a, b) => normalizedRules[a.keyword].order - normalizedRules[b.keyword].order);
+	commentMarkers.sort((a, b) => a.rule.order - b.rule.order);
 	const parser = remark().use(remarkGfm);
-	for (const comment of commentMarkers) {
-		const { html, keyword, node, options, parent } = comment;
-		const rule = normalizedRules[keyword];
-		let newMarkdownString = "";
+	for (const { marker, rule } of commentMarkers) {
+		const { html, keyword, node, options, parent } = marker;
+		let newMarkdownString;
 		try {
 			newMarkdownString = await getRuleContent(rule, options, context, (warning) => {
 				saveLog(file, "warn", "expand", `${html}: ${warning}`, node);
@@ -424,11 +428,12 @@ function mdatSplit(tree, file) {
 		const htmlNodes = splitHtmlIntoMdastNodes(node);
 		if (htmlNodes.length > 1) {
 			saveLog(file, "warn", "split", "Multiple comments in a single HTML node.", node);
-			parent.children.splice(index, 1, {
+			parent.children[index] = {
 				children: htmlNodes,
 				type: "paragraph"
-			});
+			};
 		}
+		return CONTINUE;
 	});
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remark-mdat",
-  "version": "2.2.4",
+  "version": "3.0.1",
   "description": "A remark plugin implementing the Markdown Autophagic Template (MDAT) system.",
   "keywords": [
     "mdat",
@@ -46,11 +46,11 @@
     "gray-matter-es": "^0.2.1",
     "hast-util-from-html": "^2.0.3",
     "json5": "^2.2.3",
-    "lognow": "^0.6.2",
+    "lognow": "^0.8.0",
     "picocolors": "^1.1.1",
     "remark": "^15.0.1",
     "remark-gfm": "^4.0.1",
-    "type-fest": "^5.7.0",
+    "type-fest": "^5.8.0",
     "unified": "^11.0.5",
     "unist-util-visit": "^5.1.0",
     "vfile": "^6.0.3",
@@ -58,25 +58,19 @@
     "zod": "^4.4.3"
   },
   "devDependencies": {
-    "@arethetypeswrong/core": "^0.18.3",
-    "@kitschpatrol/shared-config": "^7.6.3",
-    "@types/node": "~20.19.41",
-    "@vitest/coverage-v8": "^4.1.8",
-    "bumpp": "^11.1.0",
-    "publint": "^0.3.21",
+    "@arethetypeswrong/core": "^0.18.5",
+    "@kitschpatrol/shared-config": "^8.6.0",
+    "@types/node": "~24.13.3",
+    "@vitest/coverage-v8": "^4.1.10",
+    "bumpp": "^12.1.1",
+    "publint": "^0.3.22",
     "shx": "^0.4.0",
-    "tsdown": "^0.22.2",
-    "typescript": "~5.9.3",
-    "vitest": "^4.1.8"
+    "tsdown": "^0.22.14",
+    "typescript": "~6.0.3",
+    "vitest": "^4.1.10"
   },
   "engines": {
-    "node": ">=20.19.6"
-  },
-  "devEngines": {
-    "runtime": {
-      "name": "node",
-      "version": ">=22.22.2"
-    }
+    "node": ">=24.16.0"
   },
   "scripts": {
     "bench": "vitest bench --run --no-file-parallelism --compare test/benchmarks/baseline.json",

package/readme.md

@@ -6,8 +6,8 @@
 
 <!-- badges -->
 
-[![NPM Package remark-mdat](https://img.shields.io/npm/v/remark-mdat.svg)](https://npmjs.com/package/remark-mdat)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/mit/)
+[![NPM Package remark-mdat](https://img.shields.io/npm/v/remark-mdat.svg)](https://www.npmjs.com/package/remark-mdat)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/mit)
 [![CI](https://github.com/kitschpatrol/remark-mdat/actions/workflows/ci.yml/badge.svg)](https://github.com/kitschpatrol/remark-mdat/actions/workflows/ci.yml)
 
 <!-- /badges -->
@@ -81,7 +81,7 @@ This plugin powers the higher-level [`mdat` package](https://github.com/kitschpa
 
 ### Dependencies
 
-This library is ESM only and requires Node 20.19.6+. It's designed to work with Remark 15. `remark-mdat` is implemented in TypeScript and bundles a complete set of type definitions.
+This library is ESM only and requires Node 24.16.0+. It's designed to work with Remark 15. `remark-mdat` is implemented in TypeScript and bundles a complete set of type definitions.
 
 ### Installation