remark-mdat 1.1.0 → 1.1.2

package/dist/index.d.ts

@@ -1,228 +1,10 @@
-import { z } from "zod";
-import { Plugin } from "unified";
-import { VFile } from "vfile";
-import { Root } from "mdast";
-import { JsonValue, Merge, MergeDeep, SetOptional, Simplify } from "type-fest";
-
-//#region src/lib/mdat/rules.d.ts
-type SimplifyDeep<T> = Simplify<MergeDeep<T, T>>;
-/**
- * Strict normalized rules used internally.
- * Rules normalized to a form with async content functions and other default metadata
- * Simplifies processing elsewhere, while retaining flexibility for rule authors
- */
-type NormalizedRule = {
-  /**
-   * The order in which the rule should be applied during processing
-   * Helpful if a rule depends on the presence of content generated by another rule
-   * Defaults to 0.
-   */
-  applicationOrder: number;
-  /**
-   * The function that generates the expanded Markdown string.
-   * For 'compound' rules, this can be an array of rules (without keywords).
-   */
-  content: ((options: JsonValue, tree: Root) => Promise<string>) | NormalizedRule[];
-  /**
-   * The expected order of the keyword in the document relative to other expander comments.
-   * Used for validation purposes.
-   * Leave undefined to order skip validation.
-   * Defaults to undefined, which means order is not enforced.
-   */
-  order: number | undefined;
-  /**
-   * Whether the presence of the keyword comment in the document is required.
-   * Used for validation purposes.
-   * Defaults to false.
-   */
-  required: boolean;
-};
-type Rule =
-/**
- * Function that returns the Markdown string to expand at the comment site.
- */
-((options: JsonValue, tree: Root) => 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[]
-/**
- * The Markdown string to expand at the comment site.
- */ | SetOptional<Merge<NormalizedRule, {
-  /**
-   * Gets content to expand into the comment.
-   * Can be a simple string for direct replacement, a function that returns a string, or an async function that returns a string.
-   *
-   * If a function is provided, it will be passed the following arguments:
-   * @param options
-   * JSON value of options parsed immediately after the comment keyword in the comment, e.g.:
-   * `<!-- keyword({something: true}) -->` or
-   * `<!-- keyword {something: true}-->`
-   * Sets options to {something: true}
-   * @param tree
-   * Markdown (mdast) abstract syntax tree containing the entire parsed document. Useful for expanders that need the entire document context, such as when generating a table of contents. Do not mutate the AST, instead return a new string.
-   * @returns A string with the generated content. The string will be parsed as Markdown and inserted into the document at the comment's location.
-   */
-  content: ((options: JsonValue, tree: Root) => Promise<string> | string) | Rule[] | string;
-}>, 'applicationOrder' | 'order' | 'required'> | string;
-/**
- * Rules are record objects whose keys match strings inside a Markdown comment, and values explain what should be expanded at the comment site.
- *
- * The record value may be a string, or an object containing additional metadata, possibly with a function to invoke to generate content.
- * @example
- * Most basic rule:
- * ```ts
- * { basic: 'content' }
- * ```
- *
- * Rule with dynamic content:
- * ```ts
- * { basic: () => `${new Date().toISOString()}` }
- * ```
- *
- * Rule with metadata:
- * ```ts
- * { basic-meta: { required: true, content: 'content'} }
- * ```
- *
- * Rule with dynamic content and metadata:
- * { basic-date: { required: true, content: () => `${new Date().toISOString()}` } }
- */
-type Rules = SimplifyDeep<Record<string, Rule>>;
-type NormalizedRules = SimplifyDeep<Record<string, NormalizedRule>>;
-declare const rulesSchema: z.ZodRecord<z.ZodString, z.ZodType<any, z.ZodTypeDef, any>>;
-/**
- * Returns the rule value from a single-rule record.
- * Useful when aliasing rules or invoking them programmatically.
- *
- * Throws if there are no entries or more than one entry.
- */
-declare function getSoleRule<T extends NormalizedRules | Rules>(rules: T): T[keyof T];
-/**
- * Returns the rule key from a single-rule record.
- * Useful for comment placeholder validation.
- *
- * Throws if there are no entries or more than one entry.
- */
-declare function getSoleRuleKey<T extends NormalizedRules | Rules>(rules: T): keyof T;
-//#endregion
-//#region src/lib/mdast-utils/mdast-util-mdat.d.ts
-type Options$3 = {
-  addMetaComment: boolean;
-  closingPrefix: string;
-  keywordPrefix: string;
-  metaCommentIdentifier: string;
-  rules: Rules;
-};
-declare function mdat(tree: Root, file: VFile, options: Options$3): Promise<void>;
-//#endregion
-//#region src/lib/mdast-utils/mdast-util-mdat-check.d.ts
-type Options = {
-  addMetaComment: boolean;
-  closingPrefix: string;
-  keywordPrefix: string;
-  metaCommentIdentifier: string;
-  /** Enable extra checks, too noisy for real life. */
-  paranoid: boolean;
-  rules: Rules;
-};
-/**
- * Mdast utility function to check mdat source document, and output.
- */
-declare function mdatCheck(tree: Root, file: VFile, options: Options): Promise<void>;
-//#endregion
-//#region src/lib/mdast-utils/mdast-util-mdat-clean.d.ts
-type Options$1 = {
-  closingPrefix: string;
-  keywordPrefix: string;
-  metaCommentIdentifier: string;
-};
-/**
- * Collapses any expanded mdat comments and removes meta comments,
- * effectively resetting the document to its pre-expansion state. No-op if no
- * mdat comments are found.
- */
-declare function mdatClean(tree: Root, file: VFile, options: Options$1): void;
-//#endregion
-//#region src/lib/mdast-utils/mdast-util-mdat-expand.d.ts
-type Options$2 = {
-  addMetaComment: boolean;
-  closingPrefix: string;
-  keywordPrefix: string;
-  metaCommentIdentifier: string;
-  rules: Rules;
-};
-declare function mdatExpand(tree: Root, file: VFile, options: Options$2): Promise<void>;
-//#endregion
-//#region src/lib/mdast-utils/mdast-util-mdat-split.d.ts
-/**
- * Mdast utility plugin to split any multi-comment nodes and their content into individual MDAST HTML
- * nodes. They're wrapped in a paragraph so as not to introduce new breaks.
- */
-declare function mdatSplit(tree: Root, file: VFile): void;
-//#endregion
-//#region src/lib/mdat/deep-merge-defined.d.ts
-declare function deepMergeDefined<T extends Record<string, unknown>>(...objects: T[]): T;
-//#endregion
-//#region src/lib/mdat/log.d.ts
-declare const log: {
-  verbose: boolean;
-  log(...data: unknown[]): void;
-  logPrefixed(prefix: string, ...data: unknown[]): void;
-  info(...data: unknown[]): void;
-  infoPrefixed(prefix: string, ...data: unknown[]): void;
-  warn(...data: unknown[]): void;
-  warnPrefixed(prefix: string, ...data: unknown[]): void;
-  error(...data: unknown[]): void;
-  errorPrefixed(prefix: string, ...data: unknown[]): void;
-};
-//#endregion
-//#region src/lib/mdat/mdat-log.d.ts
-/**
- * Tries to provide a simpler wrapper to vfile.message
- */
-type MdatMessage = {
-  column?: number;
-  level: 'error' | 'info' | 'warn';
-  line?: number;
-  message: string;
-  source?: string;
-};
-type MdatFileReport = {
-  destinationPath?: string;
-  errors: MdatMessage[];
-  infos: MdatMessage[];
-  sourcePath: string;
-  warnings: MdatMessage[];
-};
-declare function getMdatReports(files: VFile[]): MdatFileReport[];
-declare function reporterMdat(files: VFile[]): void;
-//#endregion
-//#region src/lib/remark-mdat.d.ts
-type Options$4 = Partial<Options$3>;
-declare const optionsSchema: z.ZodObject<{
-  addMetaComment: z.ZodOptional<z.ZodBoolean>;
-  closingPrefix: z.ZodOptional<z.ZodString>;
-  keywordPrefix: z.ZodOptional<z.ZodString>;
-  metaCommentIdentifier: z.ZodOptional<z.ZodString>;
-  rules: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodType<any, z.ZodTypeDef, any>>>;
-}, "strip", z.ZodTypeAny, {
-  addMetaComment?: boolean | undefined;
-  closingPrefix?: string | undefined;
-  keywordPrefix?: string | undefined;
-  metaCommentIdentifier?: string | undefined;
-  rules?: Record<string, any> | undefined;
-}, {
-  addMetaComment?: boolean | undefined;
-  closingPrefix?: string | undefined;
-  keywordPrefix?: string | undefined;
-  metaCommentIdentifier?: string | undefined;
-  rules?: Record<string, any> | undefined;
-}>;
-/**
- * A remark plugin that expands HTML comments in Markdown files.
- */
-declare const remarkMdat: Plugin<[Options$4], Root>;
-//#endregion
-export { type Options as MdatCheckOptions, type Options$1 as MdatCleanOptions, type Options$2 as MdatExpandOptions, type MdatFileReport, type MdatMessage, type Options$3 as MdatOptions, type NormalizedRule, type NormalizedRules, type Options$4 as Options, type Rule, type Rules, type SimplifyDeep, deepMergeDefined, remarkMdat as default, getMdatReports, getSoleRule, getSoleRuleKey, log, mdat, mdatCheck, mdatClean, mdatExpand, mdatSplit, optionsSchema, reporterMdat, rulesSchema };
+export { mdat, type Options as MdatOptions } from './lib/mdast-utils/mdast-util-mdat';
+export { mdatCheck, type Options as MdatCheckOptions, } from './lib/mdast-utils/mdast-util-mdat-check';
+export { mdatClean, type Options as MdatCleanOptions, } from './lib/mdast-utils/mdast-util-mdat-clean';
+export { mdatExpand, type Options as MdatExpandOptions, } from './lib/mdast-utils/mdast-util-mdat-expand';
+export { mdatSplit } from './lib/mdast-utils/mdast-util-mdat-split';
+export { deepMergeDefined } from './lib/mdat/deep-merge-defined';
+export { default as log } from './lib/mdat/log';
+export { getMdatReports, type MdatFileReport, type MdatMessage, reporterMdat, } from './lib/mdat/mdat-log';
+export { getSoleRule, getSoleRuleKey, type NormalizedRule, type NormalizedRules, type Rule, type Rules, rulesSchema, type SimplifyDeep, } from './lib/mdat/rules';
+export { default, type Options, optionsSchema } from './lib/remark-mdat';

package/dist/index.js

@@ -150,8 +150,7 @@ var require_utils = /* @__PURE__ */ __commonJS({ "node_modules/.pnpm/cli-table3@
 					break;
 				case "center": {
 					let right = Math.ceil(padlen / 2);
-					let left = padlen - right;
-					str = repeat(pad$1, left) + str + repeat(pad$1, right);
+					str = repeat(pad$1, padlen - right) + str + repeat(pad$1, right);
 					break;
 				}
 				default:
@@ -541,8 +540,7 @@ var require_supports_colors = /* @__PURE__ */ __commonJS({ "node_modules/.pnpm/@
 		return min;
 	}
 	function getSupportLevel(stream) {
-		var level$1 = supportsColor(stream);
-		return translateLevel(level$1);
+		return translateLevel(supportsColor(stream));
 	}
 	module.exports = {
 		supportsColor: getSupportLevel,
@@ -1451,13 +1449,12 @@ var require_layout_manager = /* @__PURE__ */ __commonJS({ "node_modules/.pnpm/cl
 			let yMin1 = cell1.y;
 			let yMax1 = cell1.y - 1 + (cell1.rowSpan || 1);
 			let yMin2 = cell2.y;
-			let yMax2 = cell2.y - 1 + (cell2.rowSpan || 1);
-			let yConflict = !(yMin1 > yMax2 || yMin2 > yMax1);
+			let yConflict = !(yMin1 > cell2.y - 1 + (cell2.rowSpan || 1) || yMin2 > yMax1);
 			let xMin1 = cell1.x;
 			let xMax1 = cell1.x - 1 + (cell1.colSpan || 1);
 			let xMin2 = cell2.x;
-			let xMax2 = cell2.x - 1 + (cell2.colSpan || 1);
-			return yConflict && !(xMin1 > xMax2 || xMin2 > xMax1);
+			let xConflict = !(xMin1 > cell2.x - 1 + (cell2.colSpan || 1) || xMin2 > xMax1);
+			return yConflict && xConflict;
 		}
 		function conflictExists(rows, x, y) {
 			let i_max = Math.min(rows.length - 1, y);
@@ -1702,7 +1699,7 @@ var require_cli_table3 = /* @__PURE__ */ __commonJS({ "node_modules/.pnpm/cli-ta
 }) });
 
 //#endregion
-//#region node_modules/.pnpm/unist-util-is@6.0.0/node_modules/unist-util-is/lib/index.js
+//#region node_modules/.pnpm/unist-util-is@6.0.1/node_modules/unist-util-is/lib/index.js
 /**
 * Generate an assertion from a test.
 *
@@ -1724,7 +1721,7 @@ var require_cli_table3 = /* @__PURE__ */ __commonJS({ "node_modules/.pnpm/cli-ta
 const convert = (function(test) {
 	if (test === null || test === void 0) return ok$1;
 	if (typeof test === "function") return castFactory(test);
-	if (typeof test === "object") return Array.isArray(test) ? anyFactory(test) : propsFactory(test);
+	if (typeof test === "object") return Array.isArray(test) ? anyFactory(test) : propertiesFactory(test);
 	if (typeof test === "string") return typeFactory(test);
 	throw new Error("Expected function, string, or object as test");
 });
@@ -1754,7 +1751,7 @@ function anyFactory(tests) {
 * @param {Props} check
 * @returns {Check}
 */
-function propsFactory(check) {
+function propertiesFactory(check) {
 	const checkAsRecord = check;
 	return castFactory(all$2);
 	/**
@@ -1812,7 +1809,7 @@ function looksLikeANode(value) {
 }
 
 //#endregion
-//#region node_modules/.pnpm/unist-util-visit-parents@6.0.1/node_modules/unist-util-visit-parents/lib/color.node.js
+//#region node_modules/.pnpm/unist-util-visit-parents@6.0.2/node_modules/unist-util-visit-parents/lib/color.node.js
 /**
 * @param {string} d
 * @returns {string}
@@ -1822,7 +1819,7 @@ function color(d) {
 }
 
 //#endregion
-//#region node_modules/.pnpm/unist-util-visit-parents@6.0.1/node_modules/unist-util-visit-parents/lib/index.js
+//#region node_modules/.pnpm/unist-util-visit-parents@6.0.2/node_modules/unist-util-visit-parents/lib/index.js
 /** @type {Readonly<ActionTuple>} */
 const empty = [];
 /**
@@ -2140,8 +2137,7 @@ function mdatMessageToLogString(sourcePath, mdatMessage) {
 	const { column: column$1, level: level$1, line: line$1, message, source: source$1 } = mdatMessage;
 	const resolvedSource = source$1 ? picocolors.gray(`[${source$1}] `) : "";
 	const lineColumn = line$1 && column$1 ? `:${line$1}:${column$1}` : "";
-	const highlightedMessage = highlightComments(message, level$1);
-	return `${resolvedSource}${highlightedMessage} ${picocolors.whiteBright(sourcePath + lineColumn)}`;
+	return `${resolvedSource}${highlightComments(message, level$1)} ${picocolors.whiteBright(sourcePath + lineColumn)}`;
 }
 function highlightComments(text$4, level$1) {
 	return text$4.replaceAll(/<!--.+-->/g, (match) => level$1 === "info" ? picocolors.green(match) : level$1 === "warn" ? picocolors.yellow(match) : picocolors.red(match));
@@ -2191,7 +2187,7 @@ var require_parse = /* @__PURE__ */ __commonJS({ "node_modules/.pnpm/json5@2.2.3
 	let token;
 	let key;
 	let root$1;
-	module.exports = function parse$5(text$4, reviver) {
+	module.exports = function parse$4(text$4, reviver) {
 		source = String(text$4);
 		parseState = "start";
 		stack = [];
@@ -2930,7 +2926,7 @@ var require_parse = /* @__PURE__ */ __commonJS({ "node_modules/.pnpm/json5@2.2.3
 //#region node_modules/.pnpm/json5@2.2.3/node_modules/json5/lib/stringify.js
 var require_stringify = /* @__PURE__ */ __commonJS({ "node_modules/.pnpm/json5@2.2.3/node_modules/json5/lib/stringify.js": ((exports, module) => {
 	const util = require_util();
-	module.exports = function stringify$1(value, replacer, space) {
+	module.exports = function stringify(value, replacer, space) {
 		const stack$1 = [];
 		let indent$1 = "";
 		let propertyList;
@@ -3096,11 +3092,9 @@ var require_stringify = /* @__PURE__ */ __commonJS({ "node_modules/.pnpm/json5@2
 //#endregion
 //#region node_modules/.pnpm/json5@2.2.3/node_modules/json5/lib/index.js
 var require_lib = /* @__PURE__ */ __commonJS({ "node_modules/.pnpm/json5@2.2.3/node_modules/json5/lib/index.js": ((exports, module) => {
-	const parse$4 = require_parse();
-	const stringify = require_stringify();
 	const JSON5 = {
-		parse: parse$4,
-		stringify
+		parse: require_parse(),
+		stringify: require_stringify()
 	};
 	module.exports = JSON5;
 }) });
@@ -3621,7 +3615,7 @@ function getSoleRuleKey(rules) {
 * that are only supposed to contain a single rule.
 * @param record The record to get the sole entry from
 * @returns The value of the sole entry in the record
-* @throws If there are no entries or more than one entry
+* @throws {Error} If there are no entries or more than one entry
 */
 function getSoleRecord(record) {
 	const recordValues = Object.values(record);
@@ -3825,9 +3819,7 @@ const emptyOptions$2 = {};
 */
 function toString(value, options) {
 	const settings = options || emptyOptions$2;
-	const includeImageAlt = typeof settings.includeImageAlt === "boolean" ? settings.includeImageAlt : true;
-	const includeHtml = typeof settings.includeHtml === "boolean" ? settings.includeHtml : true;
-	return one$1(value, includeImageAlt, includeHtml);
+	return one$1(value, typeof settings.includeImageAlt === "boolean" ? settings.includeImageAlt : true, typeof settings.includeHtml === "boolean" ? settings.includeHtml : true);
 }
 /**
 * One node or several nodes.
@@ -12739,8 +12731,7 @@ function createTokenizer(parser, initialize, from) {
 				function start(code$2) {
 					const left = code$2 !== null && map$4[code$2];
 					const all$2 = code$2 !== null && map$4.null;
-					const list$3 = [...Array.isArray(left) ? left : left ? [left] : [], ...Array.isArray(all$2) ? all$2 : all$2 ? [all$2] : []];
-					return handleListOfConstructs(list$3)(code$2);
+					return handleListOfConstructs([...Array.isArray(left) ? left : left ? [left] : [], ...Array.isArray(all$2) ? all$2 : all$2 ? [all$2] : []])(code$2);
 				}
 			}
 			/**
@@ -13288,10 +13279,7 @@ function compiler(options) {
 		const listStack = [];
 		let index$1 = -1;
 		while (++index$1 < events.length) if (events[index$1][1].type === "listOrdered" || events[index$1][1].type === "listUnordered") if (events[index$1][0] === "enter") listStack.push(index$1);
-		else {
-			const tail = listStack.pop();
-			index$1 = prepareList(events, tail, index$1);
-		}
+		else index$1 = prepareList(events, listStack.pop(), index$1);
 		index$1 = -1;
 		while (++index$1 < events.length) {
 			const handler = config[events[index$1][0]];
@@ -17257,8 +17245,7 @@ function gfmTableToMarkdown(options) {
 	* @param {TableRow} node
 	*/
 	function handleTableRow(node$1, _, state, info$1) {
-		const row = handleTableRowAsData(node$1, state, info$1);
-		const value = serializeData([row]);
+		const value = serializeData([handleTableRowAsData(node$1, state, info$1)]);
 		return value.slice(0, value.indexOf("\n"));
 	}
 	/**
@@ -19721,7 +19708,7 @@ async function mdatExpand(tree, file, options) {
 			keywordPrefix,
 			metaCommentIdentifier
 		});
-		if (commentMarker !== void 0 && commentMarker.type === "open" && rules[commentMarker.keyword] !== void 0) commentMarkers.push(commentMarker);
+		if (commentMarker?.type === "open" && rules[commentMarker.keyword] !== void 0) commentMarkers.push(commentMarker);
 	});
 	commentMarkers.sort((a, b) => rules[a.keyword].applicationOrder - rules[b.keyword].applicationOrder);
 	for (const comment of commentMarkers) {
@@ -26283,8 +26270,7 @@ var Parser = class {
 		}
 		if (!token$1.location) return;
 		const siblings = this.treeAdapter.getChildNodes(parent);
-		const textNodeIdx = beforeElement ? siblings.lastIndexOf(beforeElement) : siblings.length;
-		const textNode = siblings[textNodeIdx - 1];
+		const textNode = siblings[(beforeElement ? siblings.lastIndexOf(beforeElement) : siblings.length) - 1];
 		if (this.treeAdapter.getNodeSourceCodeLocation(textNode)) {
 			const { endLine, endCol, endOffset } = token$1.location;
 			this.treeAdapter.updateNodeSourceCodeLocation(textNode, {
@@ -26499,8 +26485,7 @@ var Parser = class {
 	}
 	/** @protected */
 	_isSpecialElement(element$1, id) {
-		const ns = this.treeAdapter.getNamespaceURI(element$1);
-		return SPECIAL_ELEMENTS[ns].has(id);
+		return SPECIAL_ELEMENTS[this.treeAdapter.getNamespaceURI(element$1)].has(id);
 	}
 	/** @internal */
 	onCharacter(token$1) {
@@ -26987,8 +26972,7 @@ function aaRecreateElementFromEntry(p, elementEntry) {
 	return newElement;
 }
 function aaInsertLastNodeInCommonAncestor(p, commonAncestor, lastElement) {
-	const tn = p.treeAdapter.getTagName(commonAncestor);
-	const tid = getTagID(tn);
+	const tid = getTagID(p.treeAdapter.getTagName(commonAncestor));
 	if (p._isElementCausesFosterParenting(tid)) p._fosterParentElement(lastElement);
 	else {
 		const ns = p.treeAdapter.getNamespaceURI(commonAncestor);
@@ -28868,12 +28852,11 @@ function fromHtml(value, options) {
 	const file = value instanceof VFile ? value : new VFile(value);
 	const parseFunction = settings.fragment ? parseFragment : parse;
 	const document$2 = String(file);
-	const p5Document = parseFunction(document$2, {
+	return fromParse5(parseFunction(document$2, {
 		sourceCodeLocationInfo: true,
 		onParseError: settings.onerror ? internalOnerror : null,
 		scriptingEnabled: false
-	});
-	return fromParse5(p5Document, {
+	}), {
 		file,
 		space: settings.space,
 		verbose: settings.verbose
@@ -28945,8 +28928,7 @@ function fromHtml(value, options) {
 			*/
 			function formatC(_, $1, $2) {
 				const offset = ($2 ? Number.parseInt($2, 10) : 0) * ($1 === "-" ? -1 : 1);
-				const char = document$2.charAt(error.startOffset + offset);
-				return visualizeCharacter(char);
+				return visualizeCharacter(document$2.charAt(error.startOffset + offset));
 			}
 			/**
 			* Format the character code.
@@ -29214,11 +29196,10 @@ function mergeRecords$1(values, utils$2, meta) {
 		const propValues = [];
 		for (const value of values) if (objectHasProperty(value, key$1)) propValues.push(value[key$1]);
 		if (propValues.length === 0) continue;
-		const updatedMeta = utils$2.metaDataUpdater(meta, {
+		const propertyResult = mergeUnknowns(propValues, utils$2, utils$2.metaDataUpdater(meta, {
 			key: key$1,
 			parents: values
-		});
-		const propertyResult = mergeUnknowns(propValues, utils$2, updatedMeta);
+		}));
 		if (propertyResult === actions.skip) continue;
 		if (key$1 === "__proto__") Object.defineProperty(result, key$1, {
 			value: propertyResult,
@@ -29390,8 +29371,7 @@ function stripUndefinedDeep(object) {
 	}, {});
 }
 function deepMergeDefined(...objects) {
-	const stripped = objects.map((v, i) => i === 0 ? v : stripUndefinedDeep(v));
-	return deepmerge(...stripped);
+	return deepmerge(...objects.map((v, i) => i === 0 ? v : stripUndefinedDeep(v)));
 }
 
 //#endregion

package/dist/lib/mdast-utils/mdast-util-mdat-check.d.ts

@@ -0,0 +1,16 @@
+import type { Root } from 'mdast';
+import type { VFile } from 'vfile';
+import type { Rules } from '../mdat/rules';
+export type Options = {
+    addMetaComment: boolean;
+    closingPrefix: string;
+    keywordPrefix: string;
+    metaCommentIdentifier: string;
+    /** Enable extra checks, too noisy for real life. */
+    paranoid: boolean;
+    rules: Rules;
+};
+/**
+ * Mdast utility function to check mdat source document, and output.
+ */
+export declare function mdatCheck(tree: Root, file: VFile, options: Options): Promise<void>;

package/dist/lib/mdast-utils/mdast-util-mdat-clean.d.ts

@@ -0,0 +1,13 @@
+import type { Root } from 'mdast';
+import type { VFile } from 'vfile';
+export type Options = {
+    closingPrefix: string;
+    keywordPrefix: string;
+    metaCommentIdentifier: string;
+};
+/**
+ * Collapses any expanded mdat comments and removes meta comments,
+ * effectively resetting the document to its pre-expansion state. No-op if no
+ * mdat comments are found.
+ */
+export declare function mdatClean(tree: Root, file: VFile, options: Options): void;

package/dist/lib/mdast-utils/mdast-util-mdat-expand.d.ts

@@ -0,0 +1,11 @@
+import type { Root } from 'mdast';
+import type { VFile } from 'vfile';
+import type { Rules } from '../mdat/rules';
+export type Options = {
+    addMetaComment: boolean;
+    closingPrefix: string;
+    keywordPrefix: string;
+    metaCommentIdentifier: string;
+    rules: Rules;
+};
+export declare function mdatExpand(tree: Root, file: VFile, options: Options): Promise<void>;

package/dist/lib/mdast-utils/mdast-util-mdat-split.d.ts

@@ -0,0 +1,8 @@
+import type { Html, Root, Text } from 'mdast';
+import type { VFile } from 'vfile';
+/**
+ * Mdast utility plugin to split any multi-comment nodes and their content into individual MDAST HTML
+ * nodes. They're wrapped in a paragraph so as not to introduce new breaks.
+ */
+export declare function mdatSplit(tree: Root, file: VFile): void;
+export declare function splitHtmlIntoMdastNodes(mdastNode: Html): Array<Html | Text>;

package/dist/lib/mdast-utils/mdast-util-mdat.d.ts

@@ -0,0 +1,11 @@
+import type { Root } from 'mdast';
+import type { VFile } from 'vfile';
+import type { Rules } from '../mdat/rules';
+export type Options = {
+    addMetaComment: boolean;
+    closingPrefix: string;
+    keywordPrefix: string;
+    metaCommentIdentifier: string;
+    rules: Rules;
+};
+export declare function mdat(tree: Root, file: VFile, options: Options): Promise<void>;

package/dist/lib/mdat/deep-merge-defined.d.ts

@@ -0,0 +1 @@
+export declare function deepMergeDefined<T extends Record<string, unknown>>(...objects: T[]): T;

package/dist/lib/mdat/log.d.ts

@@ -0,0 +1,12 @@
+declare const log: {
+    verbose: boolean;
+    log(...data: unknown[]): void;
+    logPrefixed(prefix: string, ...data: unknown[]): void;
+    info(...data: unknown[]): void;
+    infoPrefixed(prefix: string, ...data: unknown[]): void;
+    warn(...data: unknown[]): void;
+    warnPrefixed(prefix: string, ...data: unknown[]): void;
+    error(...data: unknown[]): void;
+    errorPrefixed(prefix: string, ...data: unknown[]): void;
+};
+export default log;

package/dist/lib/mdat/mdat-log.d.ts

@@ -0,0 +1,23 @@
+import type { Node } from 'unist';
+import type { VFile } from 'vfile';
+/**
+ * Tries to provide a simpler wrapper to vfile.message
+ */
+export type MdatMessage = {
+    column?: number;
+    level: 'error' | 'info' | 'warn';
+    line?: number;
+    message: string;
+    source?: string;
+};
+export type MdatFileReport = {
+    destinationPath?: string;
+    errors: MdatMessage[];
+    infos: MdatMessage[];
+    sourcePath: string;
+    warnings: MdatMessage[];
+};
+export declare function saveLog(file: VFile, level: 'error' | 'info' | 'warn', source: string, message: string, line?: number, column?: number): void;
+export declare function saveLog(file: VFile, level: 'error' | 'info' | 'warn', source: string, message: string, node?: Node): void;
+export declare function getMdatReports(files: VFile[]): MdatFileReport[];
+export declare function reporterMdat(files: VFile[]): void;

package/dist/lib/mdat/parse.d.ts

@@ -0,0 +1,62 @@
+import type { Html, Parent } from 'mdast';
+import type { JsonValue, Simplify } from 'type-fest';
+/**
+ * Structured data about a parsed comment.
+ * Note that this is a discriminated union based on the `type` field.
+ */
+type CommentMarker = Simplify<{
+    /** The complete original comment, e.g. `<!-- keyword -->`  */
+    html: string;
+} & ({
+    /** Character used to delimit closing tags, e.g. the `/` in `<!-- /keyword -->`  */
+    closingPrefix: string;
+    /** The first complete word in the comment  */
+    keyword: string;
+    /** The unique keyword prefix  */
+    keywordPrefix: string;
+    /** Parsed JSON object of argument string that followed the keyword, empty object if nothing passed  */
+    options: JsonValue;
+    /**
+     * `open`: A mdat-style opening comment tag, e.g. `<!-- keyword -->`  \
+     * `close`: A mdat-style closing comment tag, e.g. `<!-- /keyword -->`
+     */
+    type: 'close' | 'open';
+} | {
+    /** The original text inside the comment, e.g. `<!-- content -->`  */
+    content: string;
+    /**
+     * `meta`: A mdat-style generated meta comment tag  \
+     * `native`: A normal comment that does not match the the `keywordPrefix` (if specified)
+     */
+    type: 'meta' | 'native';
+})>;
+/**
+ * Parsed comment with additional information about the Mdast Node and its Parent.
+ */
+export type CommentMarkerNode = Simplify<CommentMarker & {
+    /** Original Mdast HTML Node where the comment was found. */
+    node: Html;
+    /** Parent of original Mdast HTML Node where the comment was found. */
+    parent: Parent;
+}>;
+type CommentMarkerParseOptions = {
+    /** Character to identify closing tags, e.g. the `/` in `<!-- /keyword -->`  */
+    closingPrefix: string;
+    /** Prefix to require on all mdat comments, e.g. `mm-`  */
+    keywordPrefix: string;
+    /** Means of identifying mdat generated meta comments, e.g. `+`  */
+    metaCommentIdentifier: string;
+};
+/**
+ * Parse an Mdast HTML comment node into structured data.
+ * @returns A discriminated union of CommentMarkerNode based on comment type, or
+ * undefined if the node is not a comment.
+ */
+export declare function parseCommentNode(node: Html, parent: Parent, options: CommentMarkerParseOptions): CommentMarkerNode | undefined;
+/**
+ * Parse any comment string into structured data.
+ * @returns A discriminated union of CommentMarker based on comment type, or
+ * undefined if the node is not a comment.
+ */
+export declare function parseComment(text: string, options: CommentMarkerParseOptions): CommentMarker | undefined;
+export {};

package/dist/lib/mdat/rules.d.ts

@@ -0,0 +1,112 @@
+import type { Root } from 'mdast';
+import type { JsonValue, Merge, MergeDeep, SetOptional, Simplify } from 'type-fest';
+import { z } from 'zod';
+export type SimplifyDeep<T> = Simplify<MergeDeep<T, T>>;
+/**
+ * Strict normalized rules used internally.
+ * Rules normalized to a form with async content functions and other default metadata
+ * Simplifies processing elsewhere, while retaining flexibility for rule authors
+ */
+export type NormalizedRule = {
+    /**
+     * The order in which the rule should be applied during processing
+     * Helpful if a rule depends on the presence of content generated by another rule
+     * Defaults to 0.
+     */
+    applicationOrder: number;
+    /**
+     * The function that generates the expanded Markdown string.
+     * For 'compound' rules, this can be an array of rules (without keywords).
+     */
+    content: ((options: JsonValue, tree: Root) => Promise<string>) | NormalizedRule[];
+    /**
+     * The expected order of the keyword in the document relative to other expander comments.
+     * Used for validation purposes.
+     * Leave undefined to order skip validation.
+     * Defaults to undefined, which means order is not enforced.
+     */
+    order: number | undefined;
+    /**
+     * Whether the presence of the keyword comment in the document is required.
+     * Used for validation purposes.
+     * Defaults to false.
+     */
+    required: boolean;
+};
+export type Rule = 
+/**
+ * Function that returns the Markdown string to expand at the comment site.
+ */
+((options: JsonValue, tree: Root) => 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[]
+/**
+ * The Markdown string to expand at the comment site.
+ */
+ | SetOptional<Merge<NormalizedRule, {
+    /**
+     * Gets content to expand into the comment.
+     * Can be a simple string for direct replacement, a function that returns a string, or an async function that returns a string.
+     *
+     * If a function is provided, it will be passed the following arguments:
+     * @param options
+     * JSON value of options parsed immediately after the comment keyword in the comment, e.g.:
+     * `<!-- keyword({something: true}) -->` or
+     * `<!-- keyword {something: true}-->`
+     * Sets options to {something: true}
+     * @param tree
+     * Markdown (mdast) abstract syntax tree containing the entire parsed document. Useful for expanders that need the entire document context, such as when generating a table of contents. Do not mutate the AST, instead return a new string.
+     * @returns A string with the generated content. The string will be parsed as Markdown and inserted into the document at the comment's location.
+     */
+    content: ((options: JsonValue, tree: Root) => Promise<string> | string) | Rule[] | string;
+}>, 'applicationOrder' | 'order' | 'required'> | string;
+/**
+ * Rules are record objects whose keys match strings inside a Markdown comment, and values explain what should be expanded at the comment site.
+ *
+ * The record value may be a string, or an object containing additional metadata, possibly with a function to invoke to generate content.
+ * @example
+ * Most basic rule:
+ * ```ts
+ * { basic: 'content' }
+ * ```
+ *
+ * Rule with dynamic content:
+ * ```ts
+ * { basic: () => `${new Date().toISOString()}` }
+ * ```
+ *
+ * Rule with metadata:
+ * ```ts
+ * { basic-meta: { required: true, content: 'content'} }
+ * ```
+ *
+ * Rule with dynamic content and metadata:
+ * { basic-date: { required: true, content: () => `${new Date().toISOString()}` } }
+ */
+export type Rules = SimplifyDeep<Record<string, Rule>>;
+export type NormalizedRules = SimplifyDeep<Record<string, NormalizedRule>>;
+export declare function normalizeRules(rules: Rules): NormalizedRules;
+export declare function validateRules(rules: Rules): void;
+export declare const rulesSchema: z.ZodRecord<z.ZodString, z.ZodType<any, z.ZodTypeDef, any>>;
+/**
+ * Compound rule helpers, used in both "expand" and "check" utilities
+ */
+export declare function getRuleContent(rule: NormalizedRule, options: JsonValue, tree: Root, check?: boolean): Promise<string>;
+/**
+ * Returns the rule value from a single-rule record.
+ * Useful when aliasing rules or invoking them programmatically.
+ *
+ * Throws if there are no entries or more than one entry.
+ */
+export declare function getSoleRule<T extends NormalizedRules | Rules>(rules: T): T[keyof T];
+/**
+ * Returns the rule key from a single-rule record.
+ * Useful for comment placeholder validation.
+ *
+ * Throws if there are no entries or more than one entry.
+ */
+export declare function getSoleRuleKey<T extends NormalizedRules | Rules>(rules: T): keyof T;

package/dist/lib/remark-mdat.d.ts

@@ -0,0 +1,29 @@
+import type { Root } from 'mdast';
+import type { Plugin } from 'unified';
+import { z } from 'zod';
+import type { Options as MdatOptions } from './mdast-utils/mdast-util-mdat';
+export type Options = Partial<MdatOptions>;
+export declare const optionsSchema: z.ZodObject<{
+    addMetaComment: z.ZodOptional<z.ZodBoolean>;
+    closingPrefix: z.ZodOptional<z.ZodString>;
+    keywordPrefix: z.ZodOptional<z.ZodString>;
+    metaCommentIdentifier: z.ZodOptional<z.ZodString>;
+    rules: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodType<any, z.ZodTypeDef, any>>>;
+}, "strip", z.ZodTypeAny, {
+    closingPrefix?: string | undefined;
+    keywordPrefix?: string | undefined;
+    metaCommentIdentifier?: string | undefined;
+    rules?: Record<string, any> | undefined;
+    addMetaComment?: boolean | undefined;
+}, {
+    closingPrefix?: string | undefined;
+    keywordPrefix?: string | undefined;
+    metaCommentIdentifier?: string | undefined;
+    rules?: Record<string, any> | undefined;
+    addMetaComment?: boolean | undefined;
+}>;
+/**
+ * A remark plugin that expands HTML comments in Markdown files.
+ */
+declare const remarkMdat: Plugin<[Options], Root>;
+export default remarkMdat;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remark-mdat",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "A remark plugin implementing the Markdown Autophagic Template (MDAT) system.",
   "keywords": [
     "mdat",
@@ -35,28 +35,28 @@
   ],
   "dependencies": {
     "@types/mdast": "^4.0.4",
-    "@types/node": "^20.19.17",
+    "@types/node": "^20.19.24",
     "@types/unist": "^3.0.3",
     "picocolors": "^1.1.1",
-    "type-fest": "^5.0.1",
+    "type-fest": "^5.2.0",
     "unified": "^11.0.5",
     "vfile": "^6.0.3",
     "zod": "^3.25.76"
   },
   "devDependencies": {
-    "@kitschpatrol/shared-config": "^5.7.0",
-    "bumpp": "^10.2.3",
+    "@kitschpatrol/shared-config": "^5.7.4",
+    "bumpp": "^10.3.1",
     "cli-table3": "^0.6.5",
     "deepmerge-ts": "^7.1.5",
     "hast-util-from-html": "^2.0.3",
     "json5": "^2.2.3",
     "remark": "^15.0.1",
     "remark-gfm": "^4.0.1",
-    "tsdown": "^0.15.5",
-    "typescript": "~5.9.2",
+    "tsdown": "^0.15.12",
+    "typescript": "~5.9.3",
     "unist-util-visit": "^5.0.0",
     "vfile-message": "^4.0.3",
-    "vitest": "^3.2.4"
+    "vitest": "^4.0.6"
   },
   "engines": {
     "node": ">=20.19.0"
@@ -65,12 +65,12 @@
     "access": "public"
   },
   "scripts": {
-    "build": "tsdown --tsconfig ./tsconfig.build.json",
+    "build": "tsdown --dts false && tsc -p tsconfig.build.json",
     "clean": "git rm -f pnpm-lock.yaml ; git clean -fdX",
     "dev": "pnpm run test",
     "fix": "ksc fix",
     "lint": "ksc lint",
-    "release": "bumpp --commit 'Release: %s' && pnpm run build && pnpm publish --otp $(op read 'op://Personal/Npmjs/one-time password?attribute=otp')",
+    "release": "bumpp --commit 'Release: %s' && pnpm run build && NPM_AUTH_TOKEN=$(op read 'op://Personal/npm/token') && pnpm publish",
     "test": "vitest"
   }
 }