mdat 2.0.0 → 2.1.0

package/dist/bin/cli.js

@@ -1,15 +1,15 @@
 #!/usr/bin/env node
 import picocolors from "picocolors";
 import prettyMilliseconds from "pretty-ms";
-import { getMdatReports, getSoleRule, mdatClean, mdatExpand, mdatSplit, reporterMdat, rulesSchema, setLogger } from "remark-mdat";
+import { getMdatReports, getSoleRule, mdatCollapse, mdatExpand, mdatSplit, mdatStrip, reporterMdat, rulesSchema, setLogger } from "remark-mdat";
 import { cosmiconfig, defaultLoaders } from "cosmiconfig";
 import { TypeScriptLoader } from "cosmiconfig-typescript-loader";
 import fs from "node:fs/promises";
 import path from "node:path";
 import plur from "plur";
-import { defineTemplate, getMetadata, helpers, setLogger as setLogger$1, templates } from "metascope";
 import { deepmerge } from "deepmerge-ts";
 import { createLogger, getChildLogger, injectionHelper } from "lognow";
+import { defineTemplate, getMetadata, helpers, setLogger as setLogger$1, templates } from "metascope";
 import { z } from "zod";
 import { globby } from "globby";
 import { isFile, isFileSync } from "path-type";
@@ -27,65 +27,6 @@ import { confirm, group, intro, note, outro, select } from "@clack/prompts";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 
-//#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.
-* @throws {Error} If no package.json is found
-*/
-async function getContextMetadata() {
-	if (metascopeMetadata !== void 0) return metascopeMetadata;
-	metascopeMetadata = await getMetadata({
-		absolute: false,
-		offline: true
-	});
-	return metascopeMetadata;
-}
-/**
-* Reset
-*/
-function resetContextMetadata() {
-	metascopeMetadata = void 0;
-}
-const readmeMetadataTemplate = defineTemplate((context) => {
-	const { githubActions, 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 repositoryOwner = codemeta.codeRepository ? new URL(codemeta.codeRepository).pathname.split("/")[1] : void 0;
-	return {
-		author: helpers.firstOf(helpers.mixedStringsToArray(helpers.toBasicNames(codemeta.author))),
-		ciActionFileName: ciActionFilePath ? path.basename(ciActionFilePath) : void 0,
-		description: codemeta.description,
-		isPublicNpmPackage: !nodePackage?.name.startsWith("@") || nodePackage.publishConfig?.access === "public",
-		issuesUrl: codemeta.issueTracker,
-		license: helpers.toBasicLicense(helpers.firstOf(helpers.ensureArray(codemeta.license))),
-		licenseFilePath: licenseFileData?.source,
-		name: codemeta.name,
-		projectDirectory: metascope?.data.options.path === void 0 ? void 0 : `file://${metascope.data.options.path}`,
-		repositoryOwner
-	};
-});
-let readmeMetadata;
-/**
-* Nice data for readme rules
-*/
-async function getReadmeMetadata() {
-	if (readmeMetadata !== void 0) return readmeMetadata;
-	readmeMetadata = readmeMetadataTemplate(await getContextMetadata(), {});
-	return readmeMetadata;
-}
-/**
-* Reset
-*/
-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);
@@ -101,7 +42,7 @@ function deepMergeDefined(...objects) {
 //#endregion
 //#region package.json
 var name = "mdat";
-var version = "2.0.0";
+var version = "2.1.0";
 
 //#endregion
 //#region src/lib/log.ts
@@ -146,6 +87,87 @@ function flattenJson(jsonObject, parentKey = "", result = {}) {
 	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.
+*
+* @throws {Error} If no package.json is found
+*/
+async function getContextMetadata() {
+	if (metascopeMetadata !== void 0) return metascopeMetadata;
+	metascopeMetadata = await getMetadata({
+		absolute: false,
+		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 = /\/$/;
+const readmeMetadataTemplate = defineTemplate((context) => {
+	const { githubActions, 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, "");
+	return {
+		author: helpers.firstOf(helpers.mixedStringsToArray(helpers.toBasicNames(codemeta.author))),
+		ciActionFileName: ciActionFilePath ? path.basename(ciActionFilePath) : void 0,
+		description: codemeta.description,
+		isPublicNpmPackage: !nodePackage?.name.startsWith("@") || nodePackage.publishConfig?.access === "public",
+		issuesUrl: codemeta.issueTracker,
+		license: helpers.toBasicLicense(helpers.firstOf(helpers.ensureArray(codemeta.license))),
+		licenseFilePath: licenseFileData?.source,
+		name: codemeta.name,
+		projectDirectory: metascope?.data.options.path === void 0 ? void 0 : `file://${metascope.data.options.path}`,
+		repositoryUrl
+	};
+});
+let readmeMetadata;
+/**
+* Nice data for readme rules
+*
+* @public
+*/
+async function getReadmeMetadata() {
+	if (readmeMetadata !== void 0) return readmeMetadata;
+	readmeMetadata = readmeMetadataTemplate(await getContextMetadata(), {});
+	return readmeMetadata;
+}
+
 //#endregion
 //#region src/lib/readme/rules/badges.ts
 var badges_default = { badges: { async content(options) {
@@ -157,13 +179,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");
 } } };
@@ -231,24 +253,21 @@ 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\`\`\``;
 } } };
@@ -309,8 +328,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
@@ -497,6 +517,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.
@@ -504,11 +537,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;
@@ -523,10 +554,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") {
@@ -535,7 +562,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}"`);
@@ -559,20 +586,26 @@ function validateConfig(value) {
 
 //#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"
@@ -614,12 +647,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}"`);
@@ -635,7 +669,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,
@@ -656,32 +692,47 @@ 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;
+	}));
 }
 function getExpandProcessor(config, ambientRemarkConfig) {
 	return remark().use({ settings: {
@@ -689,17 +740,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);
+		mdatCollapse(tree, file);
+	});
+}
+function getStripProcessor(_config, ambientRemarkConfig) {
 	return remark().use({ settings: {
 		bullet: "-",
 		emphasis: "_"
 	} }).use(remarkGfm).use(ambientRemarkConfig).use(() => function(tree, file) {
 		mdatSplit(tree, file);
-		mdatClean(tree, file);
+		mdatStrip(tree, file);
 	});
 }
 
@@ -838,10 +898,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();
@@ -850,31 +911,46 @@ async function expand(files, name, output, config, options) {
 	return results;
 }
 /**
-* 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;
 }
 /**
-* 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
+* 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;
+}
+/**
+* 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
 	}));
 }
@@ -961,7 +1037,11 @@ try {
 		setLogger$2(createLogger({
 			name,
 			verbose: argv.verbose ?? false,
-			logToConsole: { showTime: false }
+			logToConsole: {
+				showLevel: false,
+				showName: false,
+				showTime: false
+			}
 		}));
 	}).command(["$0 [files..] [options]", "expand [files..] [options]"], "Expand MDAT placeholder comments. If no files are provided, the closest readme.md is expanded.", (yargs) => yargs.positional(...filesPositional).option(configOption).option(outputOption).option(nameOption).option(printOption).option(formatOption), async ({ config, files, format, name, output, print }) => {
 		logConflicts({
@@ -987,14 +1067,26 @@ try {
 		reporterMdat(results);
 		log.debug(`Collapsed comments in ${prettyMilliseconds(performance.now() - startTime)}.`);
 		process.exitCode = getExitCode(results);
-	}).command("check [files..] [options]", "Check if MDAT placeholder comments are up to date. Exits with code 1 if any files are out of sync.", (yargs) => yargs.positional(...filesPositional).option(configOption).option(formatOption), async ({ config, files, format }) => {
+	}).command("strip [files..] [options]", "Strip MDAT comments while preserving expanded content. If no files are provided, the closest readme.md is stripped.", (yargs) => yargs.positional(...filesPositional).option(outputOption).option(nameOption).option(printOption).option(formatOption), async ({ files, format, name, output, print }) => {
+		logConflicts({
+			name,
+			output,
+			print
+		});
+		const results = await strip(files, name, output, void 0, { format });
+		for (const file of results) if (print) process.stdout.write(file.toString());
+		else await write(file);
+		reporterMdat(results);
+		log.debug(`Stripped comments in ${prettyMilliseconds(performance.now() - startTime)}.`);
+		process.exitCode = getExitCode(results);
+	}).command("check [files..] [options]", "Check if MDAT placeholder comments are up to date. Exits with code 1 if any files have stale or unexpanded content.", (yargs) => yargs.positional(...filesPositional).option(configOption).option(formatOption), async ({ config, files, format }) => {
 		const results = await check(files, collectConfig(config), { format });
 		let allInSync = true;
 		for (const { inSync, result } of results) {
 			const filePath = result.path || "unknown";
-			if (inSync) log.info(`${picocolors.green("in sync")}: ${filePath}`);
+			if (inSync) log.debug(`${picocolors.green("Up to date")}: ${filePath}`);
 			else {
-				log.info(`${picocolors.red("out of sync")}: ${filePath}`);
+				log.warn(`${picocolors.red("Stale content")}: ${filePath}`);
 				allInSync = false;
 			}
 		}

package/dist/lib/index.d.ts

@@ -1,7 +1,7 @@
 import { Rule, Rule as Rule$1 } from "remark-mdat";
+import { ILogBasic, ILogLayer } from "lognow";
 import * as _$metascope from "metascope";
 import { MetadataContext } from "metascope";
-import { ILogBasic, ILogLayer } from "lognow";
 import { VFile } from "vfile";
 
 //#region src/lib/config.d.ts
@@ -67,10 +67,11 @@ declare function createReadme(options?: Partial<MdatReadmeCreateOptions>): Promi
 //#endregion
 //#region src/lib/api.d.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
  */
 declare function expand(files?: string | string[], name?: string, output?: string, config?: ConfigToLoad, options?: {
   format?: boolean;
@@ -82,10 +83,11 @@ declare function expandString(markdown: string, config?: ConfigToLoad, options?:
   format?: boolean;
 }): Promise<VFile>;
 /**
- * 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
  */
 declare function collapse(files?: string | string[], name?: string, output?: string, config?: ConfigToLoad, options?: {
   format?: boolean;
@@ -97,9 +99,27 @@ declare function collapseString(markdown: string, config?: ConfigToLoad, options
   format?: boolean;
 }): Promise<VFile>;
 /**
- * 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
+ * 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
+ */
+declare function strip(files?: string | string[], name?: string, output?: string, config?: ConfigToLoad, options?: {
+  format?: boolean;
+}): Promise<VFile[]>;
+/**
+ * Strip MDAT comments from a Markdown string.
+ */
+declare function stripString(markdown: string, config?: ConfigToLoad, options?: {
+  format?: boolean;
+}): Promise<VFile>;
+/**
+ * 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
  */
 declare function check(files?: string | string[], config?: ConfigToLoad, options?: {
   format?: boolean;
@@ -111,8 +131,8 @@ declare function check(files?: string | string[], config?: ConfigToLoad, options
 //#region src/lib/context.d.ts
 /**
  * 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
  */
 declare function getContextMetadata(): Promise<MetadataContext>;
@@ -126,11 +146,13 @@ declare const readmeMetadataTemplate: _$metascope.Template<{
   licenseFilePath: string | undefined;
   name: string | undefined;
   projectDirectory: string | undefined;
-  repositoryOwner: string | undefined;
+  repositoryUrl: string | undefined;
 }>;
 type ReadmeMetadata = ReturnType<typeof readmeMetadataTemplate>;
 /**
  * Nice data for readme rules
+ *
+ * @public
  */
 declare function getReadmeMetadata(): Promise<{
   author: string | undefined;
@@ -142,8 +164,13 @@ declare function getReadmeMetadata(): Promise<{
   licenseFilePath: string | undefined;
   name: string | undefined;
   projectDirectory: string | undefined;
-  repositoryOwner: string | undefined;
+  repositoryUrl: string | undefined;
 }>;
+/**
+ * Reset all cached metadata. Call between tests or when the underlying project
+ * files may have changed on disk.
+ */
+declare function resetMetadataCaches(): void;
 //#endregion
 //#region src/lib/log.d.ts
 /**
@@ -153,4 +180,4 @@ declare function getReadmeMetadata(): Promise<{
  */
 declare function setLogger(logger?: ILogBasic | ILogLayer): void;
 //#endregion
-export { type Config, type ReadmeMetadata, type Rule, check, collapse, collapseString, createReadme as create, createReadmeInteractive as createInteractive, defineConfig, expand, expandString, getContextMetadata, getReadmeMetadata, loadConfig, mergeConfig, setLogger };
+export { type Config, type ReadmeMetadata, type Rule, check, collapse, collapseString, createReadme as create, createReadmeInteractive as createInteractive, defineConfig, expand, expandString, getContextMetadata, getReadmeMetadata, loadConfig, mergeConfig, resetMetadataCaches, setLogger, strip, stripString };