mdat 2.3.6 → 3.1.0

package/dist/lib/index.d.ts

@@ -2,7 +2,6 @@ import { Rule, Rule as Rule$1 } from "remark-mdat";
 import { ILogBasic, ILogLayer } from "lognow";
 import { MetadataContext } from "metascope";
 import { VFile } from "vfile";
-
 //#region src/lib/config.d.ts
 /**
  * An mdat configuration is a record of expansion rules. Keys become comment
@@ -157,6 +156,16 @@ declare const readmeMetadataTemplate: import("metascope").Template<{
   bin: string[] | undefined;
   ciActionFileName: string | undefined;
   description: string | undefined;
+  developmentDependencies: {
+    packageManagers: {
+      name: string;
+      version: string | undefined;
+    }[] | undefined;
+    runtimes: {
+      name: string;
+      version: string | undefined;
+    }[] | undefined;
+  } | undefined;
   engines: {
     [k: string]: string;
   } | undefined;
@@ -175,6 +184,7 @@ declare const readmeMetadataTemplate: import("metascope").Template<{
   projectDirectory: string | undefined;
   repositoryUrl: string | undefined;
   runtimePlatform: string[] | undefined;
+  usesGitLfs: boolean;
   usesPnpm: boolean;
 }>;
 type ReadmeMetadata = ReturnType<typeof readmeMetadataTemplate>;
@@ -189,6 +199,16 @@ declare function getReadmeMetadata(): Promise<{
   bin: string[] | undefined;
   ciActionFileName: string | undefined;
   description: string | undefined;
+  developmentDependencies: {
+    packageManagers: {
+      name: string;
+      version: string | undefined;
+    }[] | undefined;
+    runtimes: {
+      name: string;
+      version: string | undefined;
+    }[] | undefined;
+  } | undefined;
   engines: {
     [k: string]: string;
   } | undefined;
@@ -207,6 +227,7 @@ declare function getReadmeMetadata(): Promise<{
   projectDirectory: string | undefined;
   repositoryUrl: string | undefined;
   runtimePlatform: string[] | undefined;
+  usesGitLfs: boolean;
   usesPnpm: boolean;
 }>;
 /**

package/dist/lib/index.js

@@ -24,14 +24,15 @@ 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 : {
+	if (Array.isArray(object)) return object.map((v) => v !== null && typeof v === "object" ? stripUndefinedDeep(v) : v).filter((v) => v !== void 0);
+	return Object.entries(object).map(([k, v]) => [k, v !== null && 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)));
+	const stripped = objects.map((v, i) => i === 0 ? v : stripUndefinedDeep(v));
+	return deepmerge(...stripped);
 }
 //#endregion
 //#region src/lib/log.ts
@@ -70,7 +71,7 @@ function mdatJsonLoader(filePath, content) {
 }
 function flattenJson(jsonObject, parentKey = "", result = {}) {
 	for (const [key, value] of Object.entries(jsonObject)) {
-		const fullPath = parentKey ? `${parentKey}.${key}` : key;
+		const fullPath = parentKey === "" ? key : `${parentKey}.${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();
@@ -98,6 +99,7 @@ async function getContextMetadata() {
 			"codemetaJson",
 			"gitConfig",
 			"githubActions",
+			"gitStats",
 			"goGoMod",
 			"goGoreleaserYaml",
 			"javaPomXml",
@@ -124,9 +126,10 @@ async function getContextMetadata() {
 	});
 	return metascopeMetadata;
 }
-const GIT_PREFIX_REGEX = /^git\+/;
-const GIT_SUFFIX_REGEX = /\.git$/;
-const TRAILING_SLASH_REGEX = /\/$/;
+const GIT_PREFIX_REGEX = /^git\+/v;
+const GIT_SUFFIX_REGEX = /\.git$/v;
+const TRAILING_SLASH_REGEX = /\/$/v;
+const PACKAGE_MANAGER_REGEX = /^(?<name>[^@]+)@(?<version>[^+]+)/v;
 /**
 * Reset cached context metadata. Call between tests or when the underlying
 * project files may have changed on disk.
@@ -137,12 +140,12 @@ function resetContextMetadata() {
 	metascopeMetadata = void 0;
 }
 const readmeMetadataTemplate = defineTemplate((context) => {
-	const { githubActions, licenseFile, metascope, nodePackageJson } = context;
+	const { githubActions, gitStats, licenseFile, metascope, nodePackageJson } = context;
 	const codemeta = templates.codemetaJson(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 repositoryUrl = codemeta.codeRepository?.replace(GIT_PREFIX_REGEX, "").replace(GIT_SUFFIX_REGEX, "").replace(TRAILING_SLASH_REGEX, "");
+	const repoUrl = codemeta.codeRepository?.replace(GIT_PREFIX_REGEX, "").replace(GIT_SUFFIX_REGEX, "").replace(TRAILING_SLASH_REGEX, "");
 	const bin = (() => {
 		if (nodePackage === void 0) return;
 		const binField = nodePackage.bin;
@@ -170,13 +173,35 @@ const readmeMetadataTemplate = defineTemplate((context) => {
 			version
 		}));
 	})();
+	const developmentDependencies = (() => {
+		if (nodePackage === void 0) return;
+		const runtimes = helpers.ensureArray(nodePackage.devEngines?.runtime).map(({ name, version }) => ({
+			name,
+			version
+		}));
+		const packageManagers = helpers.ensureArray(nodePackage.devEngines?.packageManager).map(({ name, version }) => ({
+			name,
+			version
+		}));
+		const pinnedPackageManager = nodePackage.packageManager === void 0 ? void 0 : PACKAGE_MANAGER_REGEX.exec(nodePackage.packageManager)?.groups;
+		if (pinnedPackageManager?.name !== void 0 && pinnedPackageManager.version !== void 0 && packageManagers.every((entry) => entry.name !== pinnedPackageManager.name)) packageManagers.push({
+			name: pinnedPackageManager.name,
+			version: pinnedPackageManager.version
+		});
+		if (runtimes.length === 0 && packageManagers.length === 0) return;
+		return {
+			packageManagers: packageManagers.length > 0 ? packageManagers : void 0,
+			runtimes: runtimes.length > 0 ? runtimes : void 0
+		};
+	})();
 	const firstAuthor = helpers.firstOf(helpers.ensureArray(codemeta.author));
 	return {
 		author: helpers.firstOf(helpers.mixedStringsToArray(helpers.toBasicNames(codemeta.author))),
 		authorUrl: firstAuthor?.url,
 		bin,
-		ciActionFileName: ciActionFilePath ? path.basename(ciActionFilePath) : void 0,
+		ciActionFileName: ciActionFilePath === void 0 ? void 0 : path.basename(ciActionFilePath),
 		description: codemeta.description,
+		developmentDependencies,
 		engines,
 		isPublicNpmPackage: nodePackage?.private !== true && (nodePackage?.name.startsWith("@") && nodePackage.publishConfig?.access === "public" || true),
 		issuesUrl: codemeta.issueTracker,
@@ -187,8 +212,9 @@ const readmeMetadataTemplate = defineTemplate((context) => {
 		operatingSystem: codemeta.operatingSystem,
 		peerDependencies,
 		projectDirectory: metascope?.data.options.path === void 0 ? void 0 : `file://${metascope.data.options.path}`,
-		repositoryUrl,
+		repositoryUrl: repoUrl,
 		runtimePlatform: codemeta.runtimePlatform,
+		usesGitLfs: helpers.firstOf(gitStats)?.data.hasLfs === true,
 		usesPnpm: helpers.usesPnpm(nodePackageJson)
 	};
 });
@@ -200,7 +226,8 @@ let readmeMetadata;
 */
 async function getReadmeMetadata() {
 	if (readmeMetadata !== void 0) return readmeMetadata;
-	readmeMetadata = readmeMetadataTemplate(await getContextMetadata(), {});
+	const contextMetadata = await getContextMetadata();
+	readmeMetadata = readmeMetadataTemplate(contextMetadata, {});
 	return readmeMetadata;
 }
 /**
@@ -231,14 +258,15 @@ var badges_default = { badges: { async content(options) {
 		npm: z.array(z.string()).optional()
 	}).optional().parse(options);
 	const metadata = await getReadmeMetadata();
-	const { ciActionFileName, license, licenseUrl, name, repositoryUrl } = metadata;
+	const { ciActionFileName, license, licenseUrl, name, repositoryUrl, usesGitLfs } = 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 (metadata.isPublicNpmPackage) badges.push(`[![NPM Package ${name}](https://img.shields.io/npm/v/${name}.svg)](https://www.npmjs.com/package/${name})`);
+	} else for (const packageName of validOptions.npm) badges.push(`[![NPM Package ${packageName}](https://img.shields.io/npm/v/${packageName}.svg)](https://www.npmjs.com/package/${packageName})`);
 	if (license !== void 0 && licenseUrl !== void 0) badges.push(`[![License: ${license}](https://img.shields.io/badge/License-${license.replaceAll("-", "--")}-yellow.svg)](${licenseUrl})`);
 	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})`);
+	if (usesGitLfs) badges.push("![Git LFS](https://img.shields.io/badge/Git%20LFS-enabled-F64935?logo=gitlfs&logoColor=white)");
+	if (validOptions?.custom !== void 0) for (const [badgeName, { image, link }] of Object.entries(validOptions.custom)) badges.push(`[![${badgeName}](${image})](${link})`);
 	return badges.join("\n");
 } } };
 //#endregion
@@ -250,7 +278,7 @@ var banner_default = { banner: { async content(options) {
 	}).optional().parse(options);
 	const src = validOptions?.src ?? await getBannerSrc();
 	if (src === void 0) throw new Error("Banner image not found at any typical location, consider adding something at ./assets/banner.webp");
-	else if (!isUrl(src) && !await isFile(src)) throw new Error(`Banner image not found at "${src}"`);
+	if (!isUrl(src) && !await isFile(src)) throw new Error(`Banner image not found at "${src}"`);
 	let alt = validOptions?.alt;
 	if (alt === void 0) {
 		const { name: packageName } = await getReadmeMetadata();
@@ -262,7 +290,7 @@ var banner_default = { banner: { async content(options) {
 async function getBannerSrc() {
 	const { projectDirectory } = await getReadmeMetadata();
 	if (projectDirectory === void 0) throw new Error("No project directory found");
-	const paths = await globby([
+	const [firstPath] = await globby([
 		".",
 		"assets",
 		"media",
@@ -298,19 +326,18 @@ async function getBannerSrc() {
 			]
 		}
 	});
-	if (paths.length > 0) return path.relative(process.cwd(), paths[0]);
+	return firstPath === void 0 ? void 0 : path.relative(process.cwd(), firstPath);
 }
 function isUrl(text, lenient = true) {
 	if (typeof text !== "string") throw new TypeError("Expected a string");
 	text = text.trim();
 	if (text.includes(" ")) return false;
 	if (URL.canParse(text)) return true;
-	if (lenient) return isUrl(`https://${text}`, false);
-	return false;
+	return lenient && URL.canParse(`https://${text}`);
 }
 //#endregion
 //#region src/lib/readme/rules/code.ts
-const LEADING_DOT_REGEX = /^\./;
+const LEADING_DOT_REGEX = /^\./v;
 var code_default = { code: { async content(options) {
 	const validOptions = z.object({
 		file: z.string(),
@@ -357,7 +384,7 @@ const PLATFORM_INFO = {
 	},
 	node: {
 		display: "Node.js",
-		url: "https://nodejs.org/"
+		url: "https://nodejs.org/en"
 	},
 	python: {
 		display: "Python",
@@ -387,7 +414,7 @@ var dependencies_default = { dependencies: { async content() {
 		if (engines?.[platformKey] !== void 0) continue;
 		const info = PLATFORM_INFO[platformKey.toLowerCase()];
 		const display = info ? `[${info.display}](${info.url})` : platformKey;
-		platformItems.push(version ? `- ${display} ${version}` : `- ${display}`);
+		platformItems.push(version === void 0 || version === "" ? `- ${display}` : `- ${display} ${version}`);
 	}
 	if (operatingSystem !== void 0 && operatingSystem.length > 0) platformItems.push(`- Supported platforms: ${operatingSystem.join(", ")}`);
 	const peerItems = [];
@@ -416,6 +443,56 @@ var description_default = { description: { async content() {
 	return `**${description}**`;
 } } };
 //#endregion
+//#region src/lib/readme/rules/development-dependencies.ts
+const TOOL_INFO = {
+	bun: {
+		display: "Bun",
+		url: "https://bun.sh/"
+	},
+	deno: {
+		display: "Deno",
+		url: "https://deno.land/"
+	},
+	node: {
+		display: "Node.js",
+		url: "https://nodejs.org/en"
+	},
+	npm: {
+		display: "npm",
+		url: "https://www.npmjs.com/"
+	},
+	pnpm: {
+		display: "pnpm",
+		url: "https://pnpm.io/"
+	},
+	yarn: {
+		display: "Yarn",
+		url: "https://yarnpkg.com/"
+	}
+};
+var development_dependencies_default = { "development-dependencies": { async content() {
+	const { developmentDependencies } = await getReadmeMetadata();
+	if (developmentDependencies === void 0) return "";
+	const { packageManagers, runtimes } = developmentDependencies;
+	const items = [];
+	for (const { name, version } of [...runtimes ?? [], ...packageManagers ?? []]) {
+		const info = TOOL_INFO[name.toLowerCase()];
+		const display = info ? `[${info.display}](${info.url})` : name;
+		items.push(version === void 0 || version === "" ? `- ${display}` : `- ${display} ${version}`);
+	}
+	return [
+		"## Development Dependencies",
+		"",
+		...items
+	].join("\n");
+} } };
+//#endregion
+//#region src/lib/readme/rules/dev-dependencies.ts
+/**
+* Simple alias for `development-dependencies`
+*/
+var dev_dependencies_default = { "dev-dependencies": getSoleRule(development_dependencies_default) };
+//#endregion
 //#region src/lib/readme/rules/license.ts
 var license_default = { license: { async content() {
 	const { author, authorUrl, license, licenseFilePath } = await getReadmeMetadata();
@@ -449,7 +526,7 @@ var title_default = { title: {
 	},
 	order: 2
 } };
-const SPLIT_FOR_TITLE_CASE_REGEX = /[ _-]+/;
+const SPLIT_FOR_TITLE_CASE_REGEX = /[ _\-]+/v;
 function makeTitleCase(text) {
 	return text.split(SPLIT_FOR_TITLE_CASE_REGEX).filter(Boolean).map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join(" ");
 }
@@ -520,7 +597,7 @@ async function createSizeReport(filePath) {
 			original: createSizeInfo(originalSize, originalSize)
 		};
 	} catch (error) {
-		throw new Error(`Failed to analyze file: ${error instanceof Error ? error.message : "Unknown error"}`);
+		throw new Error(`Failed to analyze file: ${error instanceof Error ? error.message : "Unknown error"}`, { cause: error });
 	}
 }
 //#endregion
@@ -603,20 +680,21 @@ var size_table_default = { "size-table": { async content(options) {
 //#region src/lib/readme/rules/table-of-contents.ts
 var table_of_contents_default = { "table-of-contents": {
 	async content(options, { tree }) {
+		const validOptions = z.object({ depth: z.union([
+			z.literal(1),
+			z.literal(2),
+			z.literal(3),
+			z.literal(4),
+			z.literal(5),
+			z.literal(6)
+		]).optional() }).optional().parse(options);
 		const result = toc(tree, {
 			heading: null,
-			maxDepth: z.object({ depth: z.union([
-				z.literal(1),
-				z.literal(2),
-				z.literal(3),
-				z.literal(4),
-				z.literal(5),
-				z.literal(6)
-			]).optional() }).optional().parse(options)?.depth ?? 3,
+			maxDepth: validOptions?.depth ?? 3,
 			tight: true
 		});
-		const heading = `## Table of contents`;
 		if (result.map === void 0) throw new Error("Could not generate table of contents");
+		const heading = `## Table of contents`;
 		const rootWrapper = {
 			children: result.map.children,
 			type: "root"
@@ -640,6 +718,8 @@ var rules_default = {
 	...contributing_default,
 	...dependencies_default,
 	...description_default,
+	...dev_dependencies_default,
+	...development_dependencies_default,
 	...footer_default,
 	...header_default,
 	...install_default,
@@ -674,13 +754,13 @@ function getAdditionalConfigExplorer() {
 async function loadConfig(options) {
 	const { additionalConfig, defaults = rules_default, searchFrom } = options ?? {};
 	let finalConfig = { mdat: `Powered by the Markdown Autophagic Template system: [mdat](https://github.com/kitschpatrol/mdat).` };
-	if (defaults) finalConfig = deepMergeDefined(finalConfig, defaults);
+	finalConfig = deepMergeDefined(finalConfig, defaults);
 	const results = await getConfigExplorer().search(searchFrom);
 	if (results) {
 		const { config, filepath } = results;
 		let possibleRules = config;
 		log.debug(`Using config from "${filepath}"`);
-		if (filepath.endsWith("package.json") && typeof config === "string") {
+		if (typeof config === "string" && filepath.endsWith("package.json")) {
 			log.debug(`Detected shared config string: "${config}"`);
 			const { default: sharedConfig } = await import(config);
 			possibleRules = sharedConfig;
@@ -693,14 +773,14 @@ async function loadConfig(options) {
 		for (const configOrPath of additionalConfigArray) {
 			let loaded;
 			if (typeof configOrPath === "string") {
-				let results;
-				if (path.basename(configOrPath).endsWith("package.json")) results = {
+				let loadResults;
+				if (path.basename(configOrPath).endsWith("package.json")) loadResults = {
 					config: mdatJsonLoader(configOrPath, await fs.readFile(configOrPath, "utf8")),
 					filepath: configOrPath
 				};
-				else results = await getAdditionalConfigExplorer().load(configOrPath);
-				if (results === null || results === void 0) continue;
-				const { config: loadedConfig, filepath } = results;
+				else loadResults = await getAdditionalConfigExplorer().load(configOrPath);
+				if (loadResults === null || loadResults === void 0) continue;
+				const { config: loadedConfig, filepath } = loadResults;
 				log.debug(`Loaded additional config from "${filepath}"`);
 				loaded = loadedConfig;
 			} else loaded = configOrPath;
@@ -745,7 +825,7 @@ async function formatWithPrettier(content, filePath) {
 	} catch {
 		throw new Error("The --format flag requires `prettier` to be installed. Run: pnpm add -D prettier");
 	}
-	const configKey = filePath ? path.dirname(filePath) : process.cwd();
+	const configKey = filePath === void 0 || filePath === "" ? process.cwd() : path.dirname(filePath);
 	let config = configCache.get(configKey);
 	if (config === void 0 && !configCache.has(configKey)) {
 		config = await cachedPrettier.resolveConfig(filePath ?? process.cwd());
@@ -767,22 +847,22 @@ function zeroPad(n, nMax) {
 async function getInputOutputPaths(inputs, output, name, extension) {
 	const paths = [];
 	for (const [index, file] of inputs.entries()) {
-		const inputOutputPath = await getInputOutputPath(file, output, name, extension, name && inputs.length > 1 ? `-${zeroPad(index + 1, inputs.length)}` : "");
+		const inputOutputPath = await getInputOutputPath(file, output, name, extension, name !== void 0 && name !== "" && inputs.length > 1 ? `-${zeroPad(index + 1, inputs.length)}` : "");
 		paths.push(inputOutputPath);
 	}
 	return paths;
 }
 async function getInputOutputPath(input, output, name, extension, nameSuffix = "") {
 	const resolvedInput = expandPath(input);
-	const resolvedOutput = output ? expandPath(output) : void 0;
 	if (!isFileSync(resolvedInput)) throw new Error(`Input file not found: "${resolvedInput}"`);
-	if (resolvedOutput) {
+	const resolvedOutput = output === void 0 || output === "" ? void 0 : expandPath(output);
+	if (resolvedOutput !== void 0) {
 		if (isFileSync(resolvedOutput)) throw new Error(`Output path must be a directory, received a file path: "${resolvedOutput}"`);
 		await fs.mkdir(resolvedOutput, { recursive: true });
 	}
 	return {
 		input: resolvedInput,
-		name: `${name ? path.basename(name, path.extname(name)) : path.basename(resolvedInput, path.extname(resolvedInput))}${nameSuffix}${extension === void 0 ? name && path.extname(name) !== "" ? path.extname(name) : path.extname(input) : `.${extension}`}`,
+		name: `${name === void 0 || name === "" ? path.basename(resolvedInput, path.extname(resolvedInput)) : path.basename(name, path.extname(name))}${nameSuffix}${extension === void 0 ? name !== void 0 && path.extname(name) !== "" ? path.extname(name) : path.extname(input) : `.${extension}`}`,
 		output: resolvedOutput ?? path.dirname(resolvedInput)
 	};
 }
@@ -793,7 +873,7 @@ function ensureArray(value) {
 	if (value === void 0 || value === null) return [];
 	return Array.isArray(value) ? value : [value];
 }
-const README_SEARCH_REGEX = /^readme(?:\.\w+)?$/i;
+const README_SEARCH_REGEX = /^readme(?:\.\w+)?$/iv;
 /**
 * Finds a readme file in the current working directory (case-insensitive).
 */
@@ -869,20 +949,20 @@ function stripLintPlugins(config) {
 //#endregion
 //#region src/lib/processors.ts
 async function processFiles(files, loader, processorGetter, name, output, config) {
-	const [resolvedConfig, localRemarkConfiguration] = await Promise.all([loader({ additionalConfig: config }), loadAmbientRemarkConfig()]);
+	const [resolvedConfig, localRemarkConfig] = await Promise.all([loader({ additionalConfig: config }), loadAmbientRemarkConfig()]);
 	const inputOutputPaths = await getInputOutputPaths(ensureArray(files), output, name, "md");
-	const resolvedProcessor = processorGetter(resolvedConfig, localRemarkConfiguration);
-	return await Promise.all(inputOutputPaths.map(async ({ input, name, output }) => {
+	const resolvedProcessor = processorGetter(resolvedConfig, localRemarkConfig);
+	return await Promise.all(inputOutputPaths.map(async ({ input, name: outputName, output: outputDirectory }) => {
 		const inputFile = await read(input);
 		const result = await resolvedProcessor.process(inputFile);
-		result.dirname = output;
-		result.basename = name;
+		result.dirname = outputDirectory;
+		result.basename = outputName;
 		return result;
 	}));
 }
 async function processString(markdown, loader, processorGetter, config) {
-	const [resolvedConfig, localRemarkConfiguration] = await Promise.all([loader({ additionalConfig: config }), loadAmbientRemarkConfig()]);
-	return processorGetter(resolvedConfig, localRemarkConfiguration).process(new VFile(markdown));
+	const [resolvedConfig, localRemarkConfig] = await Promise.all([loader({ additionalConfig: config }), loadAmbientRemarkConfig()]);
+	return processorGetter(resolvedConfig, localRemarkConfig).process(new VFile(markdown));
 }
 function getExpandProcessor(config, ambientRemarkConfig) {
 	return remark().use({ settings: {
@@ -951,13 +1031,15 @@ async function createReadmeInteractive() {
 	const readmePath = await findReadme();
 	intro(`Running ${picocolors.bold("mdat create")} interactively`);
 	const newReadmePath = await createReadme(await group({
-		overwrite: async () => readmePath === void 0 ? true : await confirm({
-			message: `Found an existing readme at "${picocolors.blue(readmePath)}". Do you want to overwrite it?`,
-			active: "Overwrite",
-			inactive: "Exit"
-		}) ? true : (() => {
-			throw new Error("`mdat create` was cancelled to avoid an overwrite - no changes were made");
-		})(),
+		async overwrite() {
+			if (readmePath === void 0) return true;
+			if (await confirm({
+				message: `Found an existing readme at "${picocolors.blue(readmePath)}". Do you want to overwrite it?`,
+				active: "Overwrite",
+				inactive: "Exit"
+			}) === false) throw new Error("`mdat create` was cancelled to avoid an overwrite - no changes were made");
+			return true;
+		},
 		template: async () => select({
 			message: "Which template would you like to use?",
 			options: getTemplateOptions()
@@ -999,17 +1081,24 @@ async function createReadme(options) {
 	const templateString = getTemplateForConfig(resolvedOptions.template, resolvedOptions.compound);
 	const readmePath = path.join(resolvedOptions.output, "readme.md");
 	if (!resolvedOptions.overwrite) {
-		if (await fs.access(readmePath).then(() => true, () => false)) throw new Error(`Readme already exists at "${readmePath}". Use the overwrite option to replace it.`);
+		let exists = true;
+		try {
+			await fs.access(readmePath);
+		} catch {
+			exists = false;
+		}
+		if (exists) throw new Error(`Readme already exists at "${readmePath}". Use the overwrite option to replace it.`);
 	}
 	await fs.writeFile(readmePath, templateString, "utf8");
 	if (resolvedOptions.expand) {
 		const [result] = await expand(readmePath);
+		if (result === void 0) throw new Error(`Failed to expand readme at "${readmePath}"`);
 		await write(result);
 	}
 	return readmePath;
 }
 function getTemplateForConfig(templateKey, compound) {
-	if (!(templateKey in templates_default)) throw new Error(`Unknown template "${templateKey}". Available templates: ${Object.keys(templates_default).join(", ")}`);
+	if (!Object.hasOwn(templates_default, templateKey)) throw new Error(`Unknown template "${templateKey}". Available templates: ${Object.keys(templates_default).join(", ")}`);
 	return templates_default[templateKey].content[compound ? "compound" : "explicit"];
 }
 function getTemplateOptions() {
@@ -1097,7 +1186,11 @@ async function check(files, config, options) {
 	const resolvedFiles = Array.isArray(files) ? files : [files];
 	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) => compareWithDiff(originals[i], result, options));
+	return results.map((result, i) => {
+		const original = originals[i];
+		if (original === void 0) throw new Error(`Missing original file for comparison at index ${i}`);
+		return compareWithDiff(original, result, options);
+	});
 }
 /**
 * Check if MDAT comments in a Markdown string are up to date by expanding and
@@ -1130,7 +1223,7 @@ function compareWithDiff(original, result, options) {
 	};
 }
 async function formatResults(results) {
-	for (const file of results) file.value = await formatWithPrettier(file.toString(), file.path || void 0);
+	for (const file of results) file.value = await formatWithPrettier(file.toString(), file.path === "" ? void 0 : file.path);
 }
 //#endregion
 export { check, checkString, 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.3.6",
+  "version": "3.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",
@@ -43,51 +43,51 @@
     "dist/*"
   ],
   "dependencies": {
-    "@clack/prompts": "^1.5.1",
-    "cosmiconfig": "^9.0.1",
+    "@clack/prompts": "^1.7.0",
+    "cosmiconfig": "^10.0.0",
     "cosmiconfig-typescript-loader": "^6.3.0",
     "deepmerge-ts": "^7.1.5",
-    "globby": "^16.2.0",
-    "lognow": "^0.6.2",
+    "globby": "^16.2.2",
+    "lognow": "^0.8.0",
     "mdast-util-toc": "^7.1.0",
-    "metascope": "^0.8.1",
+    "metascope": "^0.10.0",
     "path-type": "^6.0.0",
     "picocolors": "^1.1.1",
     "plur": "^6.0.0",
-    "pretty-bytes": "^7.1.0",
+    "pretty-bytes": "^7.1.1",
     "pretty-ms": "^9.3.0",
     "remark": "^15.0.1",
     "remark-gfm": "^4.0.1",
-    "remark-mdat": "^2.2.4",
+    "remark-mdat": "^3.0.1",
     "to-vfile": "^8.0.0",
-    "type-fest": "^5.7.0",
+    "type-fest": "^5.8.0",
     "unified-engine": "^11.2.2",
     "untildify": "^6.0.0",
     "vfile": "^6.0.3",
-    "yargs": "^18.0.0",
+    "yargs": "^18.1.0",
     "zod": "^4.4.3"
   },
   "devDependencies": {
-    "@arethetypeswrong/core": "^0.18.3",
-    "@kitschpatrol/shared-config": "^7.6.3",
+    "@arethetypeswrong/core": "^0.18.5",
+    "@kitschpatrol/shared-config": "^8.6.0",
     "@types/mdast": "^4.0.4",
-    "@types/node": "~22.19.19",
+    "@types/node": "~24.13.3",
     "@types/unist": "^3.0.3",
     "@types/yargs": "^17.0.35",
-    "@vitest/coverage-v8": "^4.1.8",
-    "bumpp": "^11.1.0",
-    "execa": "^9.6.1",
-    "mdat-plugin-cli-help": "^3.0.1",
-    "mdat-plugin-example": "^2.0.1",
-    "mdat-plugin-tldraw": "^2.0.2",
-    "nanoid": "^5.1.11",
-    "prettier": "^3.8.3",
-    "publint": "^0.3.21",
+    "@vitest/coverage-v8": "^4.1.10",
+    "bumpp": "^12.1.1",
+    "execa": "^10.0.1",
+    "mdat-plugin-cli-help": "^3.1.0",
+    "mdat-plugin-example": "^3.0.0",
+    "mdat-plugin-tldraw": "^3.0.0",
+    "nanoid": "^6.0.1",
+    "prettier": "^3.9.6",
+    "publint": "^0.3.22",
     "shx": "^0.4.0",
-    "tsdown": "^0.22.2",
-    "typescript": "~5.9.3",
+    "tsdown": "^0.22.14",
+    "typescript": "~6.0.3",
     "unplugin-raw": "^0.7.0",
-    "vitest": "^4.1.8"
+    "vitest": "^4.1.10"
   },
   "peerDependencies": {
     "prettier": "^3.0.0"
@@ -98,13 +98,7 @@
     }
   },
   "engines": {
-    "node": ">=22.17.0"
-  },
-  "devEngines": {
-    "runtime": {
-      "name": "node",
-      "version": ">=22.22.2"
-    }
+    "node": ">=24.16.0"
   },
   "scripts": {
     "bench": "vitest bench --run --compare test/benchmarks/baseline.json",