mdat 2.0.0 → 2.1.0

package/dist/lib/index.js

@@ -4,10 +4,10 @@ import fs from "node:fs/promises";
 import path from "node:path";
 import picocolors from "picocolors";
 import plur from "plur";
-import { getSoleRule, mdatClean, mdatExpand, mdatSplit, rulesSchema, setLogger as setLogger$1 } from "remark-mdat";
-import { defineTemplate, getMetadata, helpers, setLogger as setLogger$2, templates } from "metascope";
+import { getSoleRule, mdatCollapse, mdatExpand, mdatSplit, mdatStrip, rulesSchema, setLogger as setLogger$1 } from "remark-mdat";
 import { deepmerge } from "deepmerge-ts";
 import { createLogger, getChildLogger, injectionHelper } from "lognow";
+import { defineTemplate, getMetadata, helpers, setLogger as setLogger$2, templates } from "metascope";
 import { z } from "zod";
 import { globby } from "globby";
 import { isFile, isFileSync } from "path-type";
@@ -22,24 +22,111 @@ import { VFile } from "vfile";
 import { Configuration } from "unified-engine";
 import untildify from "untildify";
 import { confirm, group, intro, note, outro, select } from "@clack/prompts";
+//#region src/lib/deep-merge-defined.ts
+function stripUndefinedDeep(object) {
+	if (Array.isArray(object)) return object.map((v) => v && typeof v === "object" ? stripUndefinedDeep(v) : v).filter((v) => v !== void 0);
+	return Object.entries(object).map(([k, v]) => [k, v && typeof v === "object" ? stripUndefinedDeep(v) : v]).reduce((acc, [k, v]) => v === void 0 ? acc : {
+		...acc,
+		[k]: v
+	}, {});
+}
+function deepMergeDefined(...objects) {
+	return deepmerge(...objects.map((v, i) => i === 0 ? v : stripUndefinedDeep(v)));
+}
+//#endregion
+//#region src/lib/log.ts
+/**
+* The default logger instance for the library.
+*/
+let log = createLogger({
+	logToConsole: { showTime: false },
+	name: "mdat"
+});
+setLogger$1(getChildLogger(log, "remark-mdat"));
+setLogger$2(getChildLogger(log, "metascope"));
+/**
+* Set the logger instance for the module.
+* Export this for library consumers to inject their own logger.
+* @param logger - Accepts either a LogLayer instance or a Console- or Stream-like log target
+*/
+function setLogger(logger) {
+	log = injectionHelper(logger);
+	setLogger$1(getChildLogger(log, "remark-mdat"));
+	setLogger$2(getChildLogger(log, "metascope"));
+}
+//#endregion
+//#region src/lib/mdat-json-loader.ts
+/**
+* Lets arbitrary JSON objects (like from package.json) become reasonably good mdat rule sets
+* HOWEVER cosmiconfig treats package.json as a special case and will always load only specific keys from it
+* So we have to intercept and load them manually in config.ts
+*/
+function mdatJsonLoader(filePath, content) {
+	const defaultJsonLoader = defaultLoaders[".json"];
+	return flattenJson(defaultJsonLoader(filePath, content));
+}
+function flattenJson(jsonObject, parentKey = "", result = {}) {
+	for (const [key, value] of Object.entries(jsonObject)) {
+		const fullPath = parentKey ? `${parentKey}.${key}` : key;
+		if (typeof value === "object" && value !== null && !Array.isArray(value)) flattenJson(value, fullPath, result);
+		else if (value === null) result[fullPath] = "null";
+		else result[fullPath] = value.toString();
+	}
+	return result;
+}
+//#endregion
 //#region src/lib/context.ts
 let metascopeMetadata;
 /**
 * Get a bunch of platform-agnostic local metadata via metascope, exposed
-* primarily for plugin developers.
-* Result is memoized the result.
+* primarily for plugin developers. Result is memoized the result.
+*
 * @throws {Error} If no package.json is found
 */
 async function getContextMetadata() {
 	if (metascopeMetadata !== void 0) return metascopeMetadata;
 	metascopeMetadata = await getMetadata({
 		absolute: false,
-		offline: true
+		offline: true,
+		sources: [
+			"arduinoLibraryProperties",
+			"cinderCinderblockXml",
+			"codemetaJson",
+			"gitConfig",
+			"githubActions",
+			"goGoMod",
+			"goGoreleaserYaml",
+			"javaPomXml",
+			"licenseFile",
+			"metadataFile",
+			"metascope",
+			"nodePackageJson",
+			"obsidianPluginManifestJson",
+			"openframeworksAddonConfigMk",
+			"openframeworksInstallXml",
+			"processingLibraryProperties",
+			"processingSketchProperties",
+			"publiccodeYaml",
+			"pythonPkgInfo",
+			"pythonPyprojectToml",
+			"pythonSetupCfg",
+			"pythonSetupPy",
+			"readmeFile",
+			"rubyGemspec",
+			"rustCargoToml",
+			"xcodeInfoPlist",
+			"xcodeProjectPbxproj"
+		]
 	});
 	return metascopeMetadata;
 }
+const GIT_PREFIX_REGEX = /^git\+/;
+const GIT_SUFFIX_REGEX = /\.git$/;
+const TRAILING_SLASH_REGEX = /\/$/;
 /**
 * Reset
+*
+* @public
 */
 function resetContextMetadata() {
 	metascopeMetadata = void 0;
@@ -50,7 +137,7 @@ const readmeMetadataTemplate = defineTemplate((context) => {
 	const nodePackage = helpers.firstOf(nodePackageJson)?.data;
 	const licenseFileData = helpers.firstOf(licenseFile);
 	const ciActionFilePath = helpers.ensureArray(githubActions).find((entry) => entry.data.name.toLowerCase() === "ci")?.source;
-	const repositoryOwner = codemeta.codeRepository ? new URL(codemeta.codeRepository).pathname.split("/")[1] : void 0;
+	const repositoryUrl = codemeta.codeRepository?.replace(GIT_PREFIX_REGEX, "").replace(GIT_SUFFIX_REGEX, "").replace(TRAILING_SLASH_REGEX, "");
 	return {
 		author: helpers.firstOf(helpers.mixedStringsToArray(helpers.toBasicNames(codemeta.author))),
 		ciActionFileName: ciActionFilePath ? path.basename(ciActionFilePath) : void 0,
@@ -61,12 +148,14 @@ const readmeMetadataTemplate = defineTemplate((context) => {
 		licenseFilePath: licenseFileData?.source,
 		name: codemeta.name,
 		projectDirectory: metascope?.data.options.path === void 0 ? void 0 : `file://${metascope.data.options.path}`,
-		repositoryOwner
+		repositoryUrl
 	};
 });
 let readmeMetadata;
 /**
 * Nice data for readme rules
+*
+* @public
 */
 async function getReadmeMetadata() {
 	if (readmeMetadata !== void 0) return readmeMetadata;
@@ -75,62 +164,19 @@ async function getReadmeMetadata() {
 }
 /**
 * Reset
+*
+* @public
 */
 function resetReadmeMetadata() {
 	readmeMetadata = void 0;
 }
-//#endregion
-//#region src/lib/deep-merge-defined.ts
-function stripUndefinedDeep(object) {
-	if (Array.isArray(object)) return object.map((v) => v && typeof v === "object" ? stripUndefinedDeep(v) : v).filter((v) => v !== void 0);
-	return Object.entries(object).map(([k, v]) => [k, v && typeof v === "object" ? stripUndefinedDeep(v) : v]).reduce((acc, [k, v]) => v === void 0 ? acc : {
-		...acc,
-		[k]: v
-	}, {});
-}
-function deepMergeDefined(...objects) {
-	return deepmerge(...objects.map((v, i) => i === 0 ? v : stripUndefinedDeep(v)));
-}
-//#endregion
-//#region src/lib/log.ts
-/**
-* The default logger instance for the library.
-*/
-let log = createLogger({
-	logToConsole: { showTime: false },
-	name: "mdat"
-});
-setLogger$1(getChildLogger(log, "remark-mdat"));
-setLogger$2(getChildLogger(log, "metascope"));
-/**
-* Set the logger instance for the module.
-* Export this for library consumers to inject their own logger.
-* @param logger - Accepts either a LogLayer instance or a Console- or Stream-like log target
-*/
-function setLogger(logger) {
-	log = injectionHelper(logger);
-	setLogger$1(getChildLogger(log, "remark-mdat"));
-	setLogger$2(getChildLogger(log, "metascope"));
-}
-//#endregion
-//#region src/lib/mdat-json-loader.ts
 /**
-* Lets arbitrary JSON objects (like from package.json) become reasonably good mdat rule sets
-* HOWEVER cosmiconfig treats package.json as a special case and will always load only specific keys from it
-* So we have to intercept and load them manually in config.ts
+* Reset all cached metadata. Call between tests or when the underlying project
+* files may have changed on disk.
 */
-function mdatJsonLoader(filePath, content) {
-	const defaultJsonLoader = defaultLoaders[".json"];
-	return flattenJson(defaultJsonLoader(filePath, content));
-}
-function flattenJson(jsonObject, parentKey = "", result = {}) {
-	for (const [key, value] of Object.entries(jsonObject)) {
-		const fullPath = parentKey ? `${parentKey}.${key}` : key;
-		if (typeof value === "object" && value !== null && !Array.isArray(value)) flattenJson(value, fullPath, result);
-		else if (value === null) result[fullPath] = "null";
-		else result[fullPath] = value.toString();
-	}
-	return result;
+function resetMetadataCaches() {
+	resetContextMetadata();
+	resetReadmeMetadata();
 }
 //#endregion
 //#region src/lib/readme/rules/badges.ts
@@ -143,13 +189,13 @@ var badges_default = { badges: { async content(options) {
 		npm: z.array(z.string()).optional()
 	}).optional().parse(options);
 	const metadata = await getReadmeMetadata();
-	const { ciActionFileName, license, name, repositoryOwner } = metadata;
+	const { ciActionFileName, license, name, repositoryUrl } = metadata;
 	const badges = [];
 	if (validOptions?.npm === void 0) {
 		if (metadata.isPublicNpmPackage) badges.push(`[![NPM Package ${name}](https://img.shields.io/npm/v/${name}.svg)](https://npmjs.com/package/${name})`);
 	} else for (const name of validOptions.npm) badges.push(`[![NPM Package ${name}](https://img.shields.io/npm/v/${name}.svg)](https://npmjs.com/package/${name})`);
 	if (license !== void 0) badges.push(`[![License: ${license}](https://img.shields.io/badge/License-${license.replaceAll("-", "--")}-yellow.svg)](https://opensource.org/licenses/${license})`);
-	if (ciActionFileName !== void 0 && repositoryOwner !== void 0) badges.push(`[![CI](https://github.com/${repositoryOwner}/${name}/actions/workflows/${ciActionFileName}/badge.svg)](https://github.com/${repositoryOwner}/${name}/actions/workflows/${ciActionFileName})`);
+	if (ciActionFileName !== void 0 && repositoryUrl !== void 0) badges.push(`[![CI](${repositoryUrl}/actions/workflows/${ciActionFileName}/badge.svg)](${repositoryUrl}/actions/workflows/${ciActionFileName})`);
 	if (validOptions?.custom !== void 0) for (const [name, { image, link }] of Object.entries(validOptions.custom)) badges.push(`[![${name}](${image})](${link})`);
 	return badges.join("\n");
 } } };
@@ -216,23 +262,20 @@ function isUrl(text, lenient = true) {
 	if (typeof text !== "string") throw new TypeError("Expected a string");
 	text = text.trim();
 	if (text.includes(" ")) return false;
-	try {
-		new URL(text);
-		return true;
-	} catch {
-		if (lenient) return isUrl(`https://${text}`, false);
-		return false;
-	}
+	if (URL.canParse(text)) return true;
+	if (lenient) return isUrl(`https://${text}`, false);
+	return false;
 }
 //#endregion
 //#region src/lib/readme/rules/code.ts
+const LEADING_DOT_REGEX = /^\./;
 var code_default = { code: { async content(options) {
 	const validOptions = z.object({
 		file: z.string(),
 		language: z.string().optional(),
 		trim: z.boolean().default(true)
 	}).parse(options);
-	const lang = (path.extname(validOptions.file) ?? "").replace(/^\./, "");
+	const lang = (path.extname(validOptions.file) ?? "").replace(LEADING_DOT_REGEX, "");
 	const exampleCode = await fs.readFile(path.join(process.cwd(), validOptions.file), "utf8");
 	return `\`\`\`${lang}\n${validOptions.trim ? exampleCode.trim() : exampleCode}\n\`\`\``;
 } } };
@@ -287,8 +330,9 @@ var title_default = { title: {
 	},
 	order: 2
 } };
+const SPLIT_FOR_TITLE_CASE_REGEX = /[ _-]+/;
 function makeTitleCase(text) {
-	return text.split(/[ _-]+/).filter(Boolean).map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join(" ");
+	return text.split(SPLIT_FOR_TITLE_CASE_REGEX).filter(Boolean).map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join(" ");
 }
 //#endregion
 //#region src/lib/readme/rules/header.ts
@@ -467,6 +511,19 @@ var rules_default = {
 };
 //#endregion
 //#region src/lib/config.ts
+let _configExplorer;
+let _additionalConfigExplorer;
+function getConfigExplorer() {
+	_configExplorer ??= cosmiconfig("mdat", { loaders: { ".ts": TypeScriptLoader() } });
+	return _configExplorer;
+}
+function getAdditionalConfigExplorer() {
+	_additionalConfigExplorer ??= cosmiconfig("mdat", { loaders: {
+		".json": mdatJsonLoader,
+		".ts": TypeScriptLoader()
+	} });
+	return _additionalConfigExplorer;
+}
 /**
 * Load and validate mdat configuration.
 * Uses cosmiconfig to search in the usual places.
@@ -474,11 +531,9 @@ var rules_default = {
 */
 async function loadConfig(options) {
 	const { additionalConfig, defaults = rules_default, searchFrom } = options ?? {};
-	resetReadmeMetadata();
-	resetContextMetadata();
 	let finalConfig = { mdat: `Powered by the Markdown Autophagic Template system: [mdat](https://github.com/kitschpatrol/mdat).` };
 	if (defaults) finalConfig = deepMergeDefined(finalConfig, defaults);
-	const results = await cosmiconfig("mdat", { loaders: { ".ts": TypeScriptLoader() } }).search(searchFrom);
+	const results = await getConfigExplorer().search(searchFrom);
 	if (results) {
 		const { config, filepath } = results;
 		let possibleRules = config;
@@ -493,10 +548,6 @@ async function loadConfig(options) {
 	}
 	if (additionalConfig !== void 0) {
 		const additionalConfigArray = Array.isArray(additionalConfig) ? additionalConfig : [additionalConfig];
-		const configExplorer2 = cosmiconfig("mdat", { loaders: {
-			".json": mdatJsonLoader,
-			".ts": TypeScriptLoader()
-		} });
 		for (const configOrPath of additionalConfigArray) {
 			let loaded;
 			if (typeof configOrPath === "string") {
@@ -505,7 +556,7 @@ async function loadConfig(options) {
 					config: mdatJsonLoader(configOrPath, await fs.readFile(configOrPath, "utf8")),
 					filepath: configOrPath
 				};
-				else results = await configExplorer2.load(configOrPath);
+				else results = await getAdditionalConfigExplorer().load(configOrPath);
 				if (results === null || results === void 0) continue;
 				const { config: loadedConfig, filepath } = results;
 				log.debug(`Loaded additional config from "${filepath}"`);
@@ -541,20 +592,26 @@ function defineConfig(config) {
 }
 //#endregion
 //#region src/lib/format.ts
+let cachedPrettier;
+const configCache = /* @__PURE__ */ new Map();
 /**
 * Format a markdown string with Prettier, using config discovered from the file path.
 * Requires `prettier` to be installed as a peer dependency.
 */
 async function formatWithPrettier(content, filePath) {
-	let prettier;
-	try {
-		prettier = await import("prettier");
+	if (cachedPrettier === void 0) try {
+		cachedPrettier = await import("prettier");
 	} catch {
 		throw new Error("The --format flag requires `prettier` to be installed. Run: pnpm add -D prettier");
 	}
-	const config = await prettier.resolveConfig(filePath ?? process.cwd());
-	if (config) log.debug(`Using Prettier config from "${config.filepath}" for "${filePath ?? process.cwd()}"`);
-	return prettier.format(content, {
+	const configKey = filePath ? path.dirname(filePath) : process.cwd();
+	let config = configCache.get(configKey);
+	if (config === void 0 && !configCache.has(configKey)) {
+		config = await cachedPrettier.resolveConfig(filePath ?? process.cwd());
+		configCache.set(configKey, config);
+		if (config) log.debug(`Using Prettier config from "${config.filepath}" for "${filePath ?? process.cwd()}"`);
+	}
+	return cachedPrettier.format(content, {
 		...config,
 		filepath: filePath,
 		parser: "markdown"
@@ -595,12 +652,13 @@ function ensureArray(value) {
 	if (value === void 0 || value === null) return [];
 	return Array.isArray(value) ? value : [value];
 }
+const README_SEARCH_REGEX = /^readme(?:\.\w+)?$/i;
 /**
 * Finds a readme file in the current working directory (case-insensitive).
 */
 async function findReadme() {
 	log.debug("Searching for readme in current directory...");
-	const readme = (await fs.readdir(process.cwd())).find((entry) => /^readme(?:\.\w+)?$/i.test(entry));
+	const readme = (await fs.readdir(process.cwd())).find((entry) => README_SEARCH_REGEX.test(entry));
 	if (readme !== void 0) {
 		const absolutePath = path.resolve(readme);
 		log.debug(`Found readme at "${absolutePath}"`);
@@ -616,7 +674,9 @@ async function findReadmeThrows() {
 	if (readme === void 0) throw new Error("No readme found");
 	return readme;
 }
+let cachedAmbientRemarkConfig;
 async function loadAmbientRemarkConfig() {
+	if (cachedAmbientRemarkConfig !== void 0) return cachedAmbientRemarkConfig;
 	const ambientConfig = new Configuration({
 		cwd: process.cwd(),
 		detectConfig: true,
@@ -637,34 +697,50 @@ async function loadAmbientRemarkConfig() {
 		const { filePath } = configResult;
 		if (filePath === void 0) log.debug("No ambient Remark configuration file found");
 		else log.debug(`Found and loaded ambient Remark configuration from "${filePath}"`);
-		return configResult;
+		cachedAmbientRemarkConfig = stripLintPlugins(configResult);
+		return cachedAmbientRemarkConfig;
 	}
 	log.debug("No ambient Remark configuration found");
-	return {
+	cachedAmbientRemarkConfig = {
 		filePath: void 0,
 		plugins: [],
 		settings: {}
 	};
+	return cachedAmbientRemarkConfig;
+}
+/**
+* Strip remark-lint plugins from an ambient config. Lint plugins only produce
+* VFile warnings and never modify the AST or output — running them during
+* expansion is pure overhead.
+*/
+function stripLintPlugins(config) {
+	return {
+		...config,
+		plugins: config.plugins.filter((entry) => {
+			const plugin = Array.isArray(entry) ? entry[0] : entry;
+			if (typeof plugin !== "function") return true;
+			const { name } = plugin;
+			return name !== "remarkLint" && !name.startsWith("remark-lint:") && name !== "remarkValidateLinks";
+		})
+	};
 }
 //#endregion
 //#region src/lib/processors.ts
 async function processFiles(files, loader, processorGetter, name, output, config) {
-	const resolvedConfig = await loader({ additionalConfig: config });
-	const localRemarkConfiguration = await loadAmbientRemarkConfig();
+	const [resolvedConfig, localRemarkConfiguration] = await Promise.all([loader({ additionalConfig: config }), loadAmbientRemarkConfig()]);
 	const inputOutputPaths = await getInputOutputPaths(ensureArray(files), output, name, "md");
-	const results = [];
 	const resolvedProcessor = processorGetter(resolvedConfig, localRemarkConfiguration);
-	for (const { input, name, output } of inputOutputPaths) {
+	return await Promise.all(inputOutputPaths.map(async ({ input, name, output }) => {
 		const inputFile = await read(input);
 		const result = await resolvedProcessor.process(inputFile);
 		result.dirname = output;
 		result.basename = name;
-		results.push(result);
-	}
-	return results;
+		return result;
+	}));
 }
 async function processString(markdown, loader, processorGetter, config) {
-	return processorGetter(await loader({ additionalConfig: config }), await loadAmbientRemarkConfig()).process(new VFile(markdown));
+	const [resolvedConfig, localRemarkConfiguration] = await Promise.all([loader({ additionalConfig: config }), loadAmbientRemarkConfig()]);
+	return processorGetter(resolvedConfig, localRemarkConfiguration).process(new VFile(markdown));
 }
 function getExpandProcessor(config, ambientRemarkConfig) {
 	return remark().use({ settings: {
@@ -672,17 +748,26 @@ function getExpandProcessor(config, ambientRemarkConfig) {
 		emphasis: "_"
 	} }).use(remarkGfm).use(ambientRemarkConfig).use(() => async function(tree, file) {
 		mdatSplit(tree, file);
-		mdatClean(tree, file);
+		mdatCollapse(tree, file);
 		await mdatExpand(tree, file, config);
 	});
 }
-function getCleanProcessor(_config, ambientRemarkConfig) {
+function getCollapseProcessor(_config, ambientRemarkConfig) {
 	return remark().use({ settings: {
 		bullet: "-",
 		emphasis: "_"
 	} }).use(remarkGfm).use(ambientRemarkConfig).use(() => function(tree, file) {
 		mdatSplit(tree, file);
-		mdatClean(tree, file);
+		mdatCollapse(tree, file);
+	});
+}
+function getStripProcessor(_config, ambientRemarkConfig) {
+	return remark().use({ settings: {
+		bullet: "-",
+		emphasis: "_"
+	} }).use(remarkGfm).use(ambientRemarkConfig).use(() => function(tree, file) {
+		mdatSplit(tree, file);
+		mdatStrip(tree, file);
 	});
 }
 //#endregion
@@ -812,10 +897,11 @@ function getTemplateOptions() {
 //#endregion
 //#region src/lib/api.ts
 /**
-* Expand MDAT comments in one or more Markdown files.
-* If no files are provided, auto-finds the closest readme.md.
-* Writing is the responsibility of the caller (e.g. via `await write(result)`)
-* @returns an array of VFiles
+* Expand MDAT comments in one or more Markdown files. If no files are provided,
+* auto-finds the closest readme.md. Writing is the responsibility of the caller
+* (e.g. via `await write(result)`)
+*
+* @returns An array of VFiles
 */
 async function expand(files, name, output, config, options) {
 	files ??= await findReadmeThrows();
@@ -832,14 +918,15 @@ async function expandString(markdown, config, options) {
 	return result;
 }
 /**
-* Collapse MDAT comments in one or more Markdown files.
-* If no files are provided, auto-finds the closest readme.md.
-* Writing is the responsibility of the caller (e.g. via `await write(result)`)
-* @returns an array of VFiles
+* Collapse MDAT comments in one or more Markdown files. If no files are
+* provided, auto-finds the closest readme.md. Writing is the responsibility of
+* the caller (e.g. via `await write(result)`)
+*
+* @returns An array of VFiles
 */
 async function collapse(files, name, output, config, options) {
 	files ??= await findReadmeThrows();
-	const results = await processFiles(files, loadConfig, getCleanProcessor, name, output, config);
+	const results = await processFiles(files, loadConfig, getCollapseProcessor, name, output, config);
 	if (options?.format) await formatResults(results);
 	return results;
 }
@@ -847,24 +934,46 @@ async function collapse(files, name, output, config, options) {
 * Collapse MDAT comments in a Markdown string.
 */
 async function collapseString(markdown, config, options) {
-	const result = await processString(markdown, loadConfig, getCleanProcessor, config);
+	const result = await processString(markdown, loadConfig, getCollapseProcessor, config);
+	if (options?.format) await formatResults([result]);
+	return result;
+}
+/**
+* Strips MDAT comments in one or more Markdown files without touching other
+* content. Does _not_ automatically expand Mdat content before stripping the
+* tags. If no files are provided, auto-finds the closest readme.md. Writing is
+* the responsibility of the caller (e.g. via `await write(result)`)
+*
+* @returns An array of VFiles
+*/
+async function strip(files, name, output, config, options) {
+	files ??= await findReadmeThrows();
+	const results = await processFiles(files, loadConfig, getStripProcessor, name, output, config);
+	if (options?.format) await formatResults(results);
+	return results;
+}
+/**
+* Strip MDAT comments from a Markdown string.
+*/
+async function stripString(markdown, config, options) {
+	const result = await processString(markdown, loadConfig, getStripProcessor, config);
 	if (options?.format) await formatResults([result]);
 	return result;
 }
 /**
-* Dry-run expand and compare with file on disk.
-* If no files are provided, auto-finds the closest readme.md.
-* @returns per-file sync status and expanded VFiles
+* Dry-run expand and compare with file on disk. If no files are provided,
+* auto-finds the closest readme.md.
+*
+* @returns Per-file sync status and expanded VFiles
 */
 async function check(files, config, options) {
 	files ??= await findReadmeThrows();
 	const { read } = await import("to-vfile");
 	const resolvedFiles = Array.isArray(files) ? files : [files];
-	const originals = await Promise.all(resolvedFiles.map(async (f) => read(f)));
-	const results = await processFiles(files, loadConfig, getExpandProcessor, void 0, void 0, config);
+	const [originals, results] = await Promise.all([Promise.all(resolvedFiles.map(async (f) => read(f))), processFiles(files, loadConfig, getExpandProcessor, void 0, void 0, config)]);
 	if (options?.format) await formatResults(results);
 	return results.map((result, i) => ({
-		inSync: originals[i].toString() === result.toString(),
+		inSync: originals[i].toString().replaceAll("\r\n", "\n") === result.toString(),
 		result
 	}));
 }
@@ -872,4 +981,4 @@ async function formatResults(results) {
 	for (const file of results) file.value = await formatWithPrettier(file.toString(), file.path || void 0);
 }
 //#endregion
-export { check, collapse, collapseString, createReadme as create, createReadmeInteractive as createInteractive, defineConfig, expand, expandString, getContextMetadata, getReadmeMetadata, loadConfig, mergeConfig, setLogger };
+export { check, collapse, collapseString, createReadme as create, createReadmeInteractive as createInteractive, defineConfig, expand, expandString, getContextMetadata, getReadmeMetadata, loadConfig, mergeConfig, resetMetadataCaches, setLogger, strip, stripString };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mdat",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "CLI tool and TypeScript library implementing the Markdown Autophagic Template (MDAT) system. MDAT lets you use comments as dynamic content templates in Markdown files, making it easy to generate and update readme boilerplate.",
   "keywords": [
     "mdat",
@@ -48,9 +48,9 @@
     "cosmiconfig-typescript-loader": "^6.2.0",
     "deepmerge-ts": "^7.1.5",
     "globby": "^16.2.0",
-    "lognow": "^0.5.2",
+    "lognow": "^0.6.0",
     "mdast-util-toc": "^7.1.0",
-    "metascope": "^0.4.0",
+    "metascope": "^0.6.0",
     "path-type": "^6.0.0",
     "picocolors": "^1.1.1",
     "plur": "^6.0.0",
@@ -58,7 +58,7 @@
     "pretty-ms": "^9.3.0",
     "remark": "^15.0.1",
     "remark-gfm": "^4.0.1",
-    "remark-mdat": "^2.0.0",
+    "remark-mdat": "^2.1.0",
     "to-vfile": "^8.0.0",
     "type-fest": "^5.5.0",
     "unified-engine": "^11.2.2",
@@ -69,13 +69,16 @@
   },
   "devDependencies": {
     "@arethetypeswrong/core": "^0.18.2",
-    "@kitschpatrol/shared-config": "^6.2.0",
+    "@kitschpatrol/shared-config": "^7.0.1",
     "@types/mdast": "^4.0.4",
     "@types/node": "~22.17.2",
     "@types/unist": "^3.0.3",
     "@types/yargs": "^17.0.35",
     "bumpp": "^11.0.1",
     "execa": "^9.6.1",
+    "mdat-plugin-cli-help": "^2.0.2",
+    "mdat-plugin-example": "^2.0.0",
+    "mdat-plugin-tldraw": "^2.0.0",
     "nanoid": "^5.1.7",
     "prettier": "^3.8.1",
     "publint": "^0.3.18",
@@ -102,11 +105,13 @@
     }
   },
   "scripts": {
+    "bench": "vitest bench --run --compare test/benchmarks/baseline.json",
+    "bench:baseline": "vitest bench --run --outputJson test/benchmarks/baseline.json",
     "build": "tsdown",
     "clean": "git rm -f pnpm-lock.yaml ; git clean -fdX",
     "fix": "ksc fix",
     "lint": "ksc lint",
     "release": "bumpp --commit 'Release: %s' && pnpm run build && NPM_AUTH_TOKEN=$(op read 'op://Personal/npm/token') && pnpm publish",
-    "test": "vitest run --no-file-parallelism"
+    "test": "vitest run"
   }
 }