mdat 3.0.0 → 3.2.0

package/dist/bin/cli.js

@@ -29,7 +29,7 @@ import { confirm, group, intro, note, outro, select } from "@clack/prompts";
 
 //#region package.json
 var name = "mdat";
-var version = "3.0.0";
+var version = "3.2.0";
 
 //#endregion
 //#region src/lib/deep-merge-defined.ts
@@ -41,7 +41,8 @@ function stripUndefinedDeep(object) {
 	}, {});
 }
 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
@@ -111,6 +112,7 @@ async function getContextMetadata() {
 			"codemetaJson",
 			"gitConfig",
 			"githubActions",
+			"gitStats",
 			"goGoMod",
 			"goGoreleaserYaml",
 			"javaPomXml",
@@ -140,8 +142,9 @@ async function getContextMetadata() {
 const GIT_PREFIX_REGEX = /^git\+/v;
 const GIT_SUFFIX_REGEX = /\.git$/v;
 const TRAILING_SLASH_REGEX = /\/$/v;
+const PACKAGE_MANAGER_REGEX = /^(?<name>[^@]+)@(?<version>[^+]+)/v;
 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);
@@ -174,6 +177,27 @@ 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))),
@@ -181,6 +205,7 @@ const readmeMetadataTemplate = defineTemplate((context) => {
 		bin,
 		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,
@@ -193,6 +218,7 @@ const readmeMetadataTemplate = defineTemplate((context) => {
 		projectDirectory: metascope?.data.options.path === void 0 ? void 0 : `file://${metascope.data.options.path}`,
 		repositoryUrl: repoUrl,
 		runtimePlatform: codemeta.runtimePlatform,
+		usesGitLfs: helpers.firstOf(gitStats)?.data.hasLfs === true,
 		usesPnpm: helpers.usesPnpm(nodePackageJson)
 	};
 });
@@ -220,13 +246,14 @@ 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://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 (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");
 } } };
@@ -349,7 +376,7 @@ const PLATFORM_INFO = {
 	},
 	node: {
 		display: "Node.js",
-		url: "https://nodejs.org/"
+		url: "https://nodejs.org/en"
 	},
 	python: {
 		display: "Python",
@@ -409,6 +436,58 @@ 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() {
@@ -492,11 +571,11 @@ const gzipCompressAsync = promisify(gzip);
 * @param bytes - Size in bytes
 * @param originalSize - Original file size for percentage calculation
 */
-function createSizeInfo(bytes, originalSize) {
+function createSizeInfo(bytes, originalSize, precision) {
 	const percent = originalSize === 0 ? 0 : (originalSize - bytes) / originalSize * 100;
 	return {
 		bytes,
-		bytesPretty: prettyBytes(bytes, { maximumFractionDigits: 1 }),
+		bytesPretty: prettyBytes(bytes, { maximumFractionDigits: precision }),
 		percent,
 		percentPretty: `${Math.round(percent)}%`
 	};
@@ -505,19 +584,20 @@ function createSizeInfo(bytes, originalSize) {
 * Analyzes a file's size and its compressed sizes using Brotli and Gzip
 *
 * @param filePath - Path to the file to analyze
+* @param precision - Maximum number of decimal places in formatted byte sizes
 *
 * @returns Promise containing detailed size report
 * @throws {Error} If file cannot be read or compressed
 */
-async function createSizeReport(filePath) {
+async function createSizeReport(filePath, precision = 1) {
 	try {
 		const fileContent = await fs.readFile(filePath);
 		const originalSize = fileContent.length;
 		const [brotliCompressed, gzipCompressed] = await Promise.all([brotliCompressAsync(fileContent), gzipCompressAsync(fileContent)]);
 		return {
-			brotli: createSizeInfo(brotliCompressed.length, originalSize),
-			gzip: createSizeInfo(gzipCompressed.length, originalSize),
-			original: createSizeInfo(originalSize, originalSize)
+			brotli: createSizeInfo(brotliCompressed.length, originalSize, precision),
+			gzip: createSizeInfo(gzipCompressed.length, originalSize, precision),
+			original: createSizeInfo(originalSize, originalSize, precision)
 		};
 	} catch (error) {
 		throw new Error(`Failed to analyze file: ${error instanceof Error ? error.message : "Unknown error"}`, { cause: error });
@@ -543,7 +623,8 @@ function getSizeForCompression(report, compression) {
 }
 var size_default = { size: { async content(options) {
 	const validOptions = optionsSchema$1.parse(options);
-	return getSizeForCompression(await createSizeReport(path.join(process.cwd(), validOptions.file)), validOptions.compression);
+	const fullPath = path.join(process.cwd(), validOptions.file);
+	return getSizeForCompression(await createSizeReport(fullPath), validOptions.compression);
 } } };
 
 //#endregion
@@ -554,12 +635,14 @@ const optionsSchema = z.union([z.object({
 	file: fileSchema,
 	gzip: z.boolean().optional().default(true),
 	original: z.boolean().optional().default(true),
+	precision: z.number().int().min(0).max(100).optional().default(0),
 	showPercentage: z.boolean().optional().default(false)
 }), z.object({
 	brotli: z.boolean().optional().default(true),
 	files: fileSchema,
 	gzip: z.boolean().optional().default(true),
 	original: z.boolean().optional().default(true),
+	precision: z.number().int().min(0).max(100).optional().default(0),
 	showPercentage: z.boolean().optional().default(false)
 })]).transform((options) => {
 	if ("file" in options) {
@@ -593,7 +676,8 @@ function formatMarkdownTable(reports, options) {
 var size_table_default = { "size-table": { async content(options) {
 	const validOptions = optionsSchema.parse(options);
 	return formatMarkdownTable(await Promise.all(validOptions.files.map(async (file) => {
-		return [file, await createSizeReport(path.join(process.cwd(), file))];
+		const fullPath = path.join(process.cwd(), file);
+		return [file, await createSizeReport(fullPath, validOptions.precision)];
 	})), {
 		brotli: validOptions.brotli,
 		gzip: validOptions.gzip,
@@ -606,16 +690,17 @@ 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
 		});
 		if (result.map === void 0) throw new Error("Could not generate table of contents");
@@ -645,6 +730,8 @@ var rules_default = {
 	...contributing_default,
 	...dependencies_default,
 	...description_default,
+	...dev_dependencies_default,
+	...development_dependencies_default,
 	...footer_default,
 	...header_default,
 	...install_default,
@@ -700,11 +787,13 @@ async function loadConfig(options) {
 			let loaded;
 			if (typeof configOrPath === "string") {
 				let loadResults;
-				if (path.basename(configOrPath).endsWith("package.json")) loadResults = {
-					config: mdatJsonLoader(configOrPath, await fs.readFile(configOrPath, "utf8")),
-					filepath: configOrPath
-				};
-				else loadResults = await getAdditionalConfigExplorer().load(configOrPath);
+				if (path.basename(configOrPath).endsWith("package.json")) {
+					const packageJson = await fs.readFile(configOrPath, "utf8");
+					loadResults = {
+						config: mdatJsonLoader(configOrPath, packageJson),
+						filepath: configOrPath
+					};
+				} 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}"`);
@@ -867,7 +956,8 @@ function stripLintPlugins(config) {
 //#region src/lib/processors.ts
 async function processFiles(files, loader, processorGetter, name, output, config) {
 	const [resolvedConfig, localRemarkConfig] = await Promise.all([loader({ additionalConfig: config }), loadAmbientRemarkConfig()]);
-	const inputOutputPaths = await getInputOutputPaths(ensureArray(files), output, name, "md");
+	const resolvedFiles = ensureArray(files);
+	const inputOutputPaths = await getInputOutputPaths(resolvedFiles, output, name, "md");
 	const resolvedProcessor = processorGetter(resolvedConfig, localRemarkConfig);
 	return await Promise.all(inputOutputPaths.map(async ({ input, name: outputName, output: outputDirectory }) => {
 		const inputFile = await read(input);
@@ -1222,7 +1312,8 @@ try {
 			output,
 			print
 		});
-		const results = await expand(files, fileName, output, collectConfig(config), { format });
+		const mergedConfig = collectConfig(config);
+		const results = await expand(files, fileName, output, mergedConfig, { format });
 		for (const file of results) if (print) process.stdout.write(file.toString());
 		else await write(file);
 		reporterMdat(results);
@@ -1253,7 +1344,8 @@ try {
 		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.", (commandYargs) => commandYargs.positional(...filesPositional).option(configOption).option(formatOption), async ({ config, files, format }) => {
-		const results = await check(files, collectConfig(config), { format });
+		const mergedConfig = collectConfig(config);
+		const results = await check(files, mergedConfig, { format });
 		let allInSync = true;
 		for (const { inSync, result } of results) {
 			const filePath = result.path === "" ? "unknown" : result.path;

package/dist/lib/index.d.ts

@@ -156,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;
@@ -174,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>;
@@ -188,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;
@@ -206,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

@@ -31,7 +31,8 @@ function stripUndefinedDeep(object) {
 	}, {});
 }
 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
@@ -98,6 +99,7 @@ async function getContextMetadata() {
 			"codemetaJson",
 			"gitConfig",
 			"githubActions",
+			"gitStats",
 			"goGoMod",
 			"goGoreleaserYaml",
 			"javaPomXml",
@@ -127,6 +129,7 @@ async function getContextMetadata() {
 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,7 +140,7 @@ 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);
@@ -170,6 +173,27 @@ 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))),
@@ -177,6 +201,7 @@ const readmeMetadataTemplate = defineTemplate((context) => {
 		bin,
 		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,
@@ -189,6 +214,7 @@ const readmeMetadataTemplate = defineTemplate((context) => {
 		projectDirectory: metascope?.data.options.path === void 0 ? void 0 : `file://${metascope.data.options.path}`,
 		repositoryUrl: repoUrl,
 		runtimePlatform: codemeta.runtimePlatform,
+		usesGitLfs: helpers.firstOf(gitStats)?.data.hasLfs === true,
 		usesPnpm: helpers.usesPnpm(nodePackageJson)
 	};
 });
@@ -232,13 +258,14 @@ 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://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 (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");
 } } };
@@ -357,7 +384,7 @@ const PLATFORM_INFO = {
 	},
 	node: {
 		display: "Node.js",
-		url: "https://nodejs.org/"
+		url: "https://nodejs.org/en"
 	},
 	python: {
 		display: "Python",
@@ -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();
@@ -492,11 +569,11 @@ const gzipCompressAsync = promisify(gzip);
 * @param bytes - Size in bytes
 * @param originalSize - Original file size for percentage calculation
 */
-function createSizeInfo(bytes, originalSize) {
+function createSizeInfo(bytes, originalSize, precision) {
 	const percent = originalSize === 0 ? 0 : (originalSize - bytes) / originalSize * 100;
 	return {
 		bytes,
-		bytesPretty: prettyBytes(bytes, { maximumFractionDigits: 1 }),
+		bytesPretty: prettyBytes(bytes, { maximumFractionDigits: precision }),
 		percent,
 		percentPretty: `${Math.round(percent)}%`
 	};
@@ -505,19 +582,20 @@ function createSizeInfo(bytes, originalSize) {
 * Analyzes a file's size and its compressed sizes using Brotli and Gzip
 *
 * @param filePath - Path to the file to analyze
+* @param precision - Maximum number of decimal places in formatted byte sizes
 *
 * @returns Promise containing detailed size report
 * @throws {Error} If file cannot be read or compressed
 */
-async function createSizeReport(filePath) {
+async function createSizeReport(filePath, precision = 1) {
 	try {
 		const fileContent = await fs.readFile(filePath);
 		const originalSize = fileContent.length;
 		const [brotliCompressed, gzipCompressed] = await Promise.all([brotliCompressAsync(fileContent), gzipCompressAsync(fileContent)]);
 		return {
-			brotli: createSizeInfo(brotliCompressed.length, originalSize),
-			gzip: createSizeInfo(gzipCompressed.length, originalSize),
-			original: createSizeInfo(originalSize, originalSize)
+			brotli: createSizeInfo(brotliCompressed.length, originalSize, precision),
+			gzip: createSizeInfo(gzipCompressed.length, originalSize, precision),
+			original: createSizeInfo(originalSize, originalSize, precision)
 		};
 	} catch (error) {
 		throw new Error(`Failed to analyze file: ${error instanceof Error ? error.message : "Unknown error"}`, { cause: error });
@@ -552,12 +630,14 @@ const optionsSchema = z.union([z.object({
 	file: fileSchema,
 	gzip: z.boolean().optional().default(true),
 	original: z.boolean().optional().default(true),
+	precision: z.number().int().min(0).max(100).optional().default(0),
 	showPercentage: z.boolean().optional().default(false)
 }), z.object({
 	brotli: z.boolean().optional().default(true),
 	files: fileSchema,
 	gzip: z.boolean().optional().default(true),
 	original: z.boolean().optional().default(true),
+	precision: z.number().int().min(0).max(100).optional().default(0),
 	showPercentage: z.boolean().optional().default(false)
 })]).transform((options) => {
 	if ("file" in options) {
@@ -591,7 +671,7 @@ function formatMarkdownTable(reports, options) {
 var size_table_default = { "size-table": { async content(options) {
 	const validOptions = optionsSchema.parse(options);
 	return formatMarkdownTable(await Promise.all(validOptions.files.map(async (file) => {
-		return [file, await createSizeReport(path.join(process.cwd(), file))];
+		return [file, await createSizeReport(path.join(process.cwd(), file), validOptions.precision)];
 	})), {
 		brotli: validOptions.brotli,
 		gzip: validOptions.gzip,
@@ -603,16 +683,17 @@ 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
 		});
 		if (result.map === void 0) throw new Error("Could not generate table of contents");
@@ -640,6 +721,8 @@ var rules_default = {
 	...contributing_default,
 	...dependencies_default,
 	...description_default,
+	...dev_dependencies_default,
+	...development_dependencies_default,
 	...footer_default,
 	...header_default,
 	...install_default,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mdat",
-  "version": "3.0.0",
+  "version": "3.2.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",
@@ -44,50 +44,50 @@
   ],
   "dependencies": {
     "@clack/prompts": "^1.7.0",
-    "cosmiconfig": "^9.0.2",
+    "cosmiconfig": "^10.0.1",
     "cosmiconfig-typescript-loader": "^6.3.0",
-    "deepmerge-ts": "^7.1.5",
-    "globby": "^16.2.2",
-    "lognow": "^0.7.1",
+    "deepmerge-ts": "^8.0.2",
+    "globby": "^16.2.4",
+    "lognow": "^0.8.0",
     "mdast-util-toc": "^7.1.0",
-    "metascope": "^0.9.0",
+    "metascope": "^0.11.1",
     "path-type": "^6.0.0",
     "picocolors": "^1.1.1",
     "plur": "^6.0.0",
-    "pretty-bytes": "^7.1.1",
-    "pretty-ms": "^9.3.0",
+    "pretty-bytes": "^7.1.2",
+    "pretty-ms": "^9.3.1",
     "remark": "^15.0.1",
     "remark-gfm": "^4.0.1",
-    "remark-mdat": "^3.0.0",
+    "remark-mdat": "^3.0.1",
     "to-vfile": "^8.0.0",
-    "type-fest": "^5.8.0",
+    "type-fest": "^5.9.0",
     "unified-engine": "^11.2.2",
     "untildify": "^6.0.0",
     "vfile": "^6.0.3",
-    "yargs": "^18.0.0",
-    "zod": "^4.4.3"
+    "yargs": "^18.1.0",
+    "zod": "^4.5.4"
   },
   "devDependencies": {
     "@arethetypeswrong/core": "^0.18.5",
-    "@kitschpatrol/shared-config": "^8.4.0",
+    "@kitschpatrol/shared-config": "^8.7.0",
     "@types/mdast": "^4.0.4",
     "@types/node": "~24.13.3",
     "@types/unist": "^3.0.3",
     "@types/yargs": "^17.0.35",
-    "@vitest/coverage-v8": "^4.1.10",
-    "bumpp": "^12.0.0",
-    "execa": "^10.0.0",
-    "mdat-plugin-cli-help": "^3.0.2",
-    "mdat-plugin-example": "^2.0.1",
-    "mdat-plugin-tldraw": "^2.0.3",
-    "nanoid": "^6.0.0",
+    "@vitest/coverage-v8": "^4.1.11",
+    "bumpp": "^12.2.2",
+    "execa": "^10.0.1",
+    "mdat-plugin-cli-help": "^3.2.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",
+    "publint": "^0.3.24",
     "shx": "^0.4.0",
     "tsdown": "^0.22.14",
     "typescript": "~6.0.3",
-    "unplugin-raw": "^0.7.0",
-    "vitest": "^4.1.10"
+    "unplugin-raw": "^0.8.0",
+    "vitest": "^4.1.11"
   },
   "peerDependencies": {
     "prettier": "^3.0.0"
@@ -108,7 +108,7 @@
     "coverage": "vitest --coverage --run",
     "fix": "ksc fix",
     "lint": "ksc lint",
-    "release": "bumpp --commit 'Release: %s' && pnpm build && NPM_AUTH_TOKEN=$(op read 'op://Personal/npm/token') pnpm publish",
+    "release": "bumpp --commit 'Release: %s' && pnpm build && pnpm publish --otp $(op item get npm --otp)",
     "test": "vitest run"
   }
 }

package/readme.md

@@ -6,8 +6,8 @@
 
 <!-- badges -->
 
-[![NPM Package mdat](https://img.shields.io/npm/v/mdat.svg)](https://npmjs.com/package/mdat)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/mit/)
+[![NPM Package mdat](https://img.shields.io/npm/v/mdat.svg)](https://www.npmjs.com/package/mdat)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/mit)
 [![CI](https://github.com/kitschpatrol/mdat/actions/workflows/ci.yml/badge.svg)](https://github.com/kitschpatrol/mdat/actions/workflows/ci.yml)
 
 <!-- /badges -->
@@ -176,7 +176,7 @@ pnpm install --global mdat
    }
    ```
 
-   See the [bundled rules](src/lib/readme/rules) for more complex examples.
+   See the [bundled rules](./src/lib/readme/rules) for more complex examples.
 
    JSON files can also be used as rule sets. MDAT flattens them so any dot-notated key path becomes a comment keyword.
 
@@ -192,7 +192,7 @@ pnpm install --global mdat
 
    Compound rules combine several individual rules into a single comment keyword.
 
-   See [`<!-- header -->`](src/lib/readme/rules/header.ts) for an example.
+   See [`<!-- header -->`](./src/lib/readme/rules/header.ts) for an example.
 
 8. **Polyglot metadata**
 
@@ -548,7 +548,7 @@ When multiple config files are loaded, they are merged. CLI `--config` takes pre
 
 ### Creating custom rules
 
-See the [Examples section](https://github.com/kitschpatrol/remark-mdat#examples) of the `remark-mdat` readme, or look at the [bundled rules](src/lib/readme/rules) for complex examples.
+See the [Examples section](https://github.com/kitschpatrol/remark-mdat#examples) of the `remark-mdat` readme, or look at the [bundled rules](./src/lib/readme/rules) for complex examples.
 
 ### Bundled rules
 
@@ -564,7 +564,7 @@ See the [Examples section](https://github.com/kitschpatrol/remark-mdat#examples)
 
 - ##### `<!-- badges -->`
 
-  Generates badges based on project metadata. Supports NPM version, license, and CI status badges.
+  Generates badges based on project metadata. Supports NPM version, license, CI status, and Git LFS badges.
 
 - ##### `<!-- description -->`
 
@@ -578,6 +578,10 @@ See the [Examples section](https://github.com/kitschpatrol/remark-mdat#examples)
 
   Documents platform requirements and peer dependencies. Lists runtime platforms (Node, Python, Rust, Go, Ruby, etc.) with version constraints from `engines` or equivalent metadata, supported operating systems, and peer dependencies with links to npm.
 
+- ##### `<!-- development-dependencies -->`
+
+  Documents the tools needed to work on the project itself, derived from the `devEngines` and `packageManager` fields in `package.json`. Lists required runtimes and package managers with links and version constraints. Also aliased as `<!-- dev-dependencies -->`.
+
 - ##### `<!-- table-of-contents -->`
 
   Auto-generated via [mdast-util-toc](https://github.com/syntax-tree/mdast-util-toc). Also aliased as `<!-- toc -->`.
@@ -600,7 +604,7 @@ See the [Examples section](https://github.com/kitschpatrol/remark-mdat#examples)
 
 - ##### `<!-- size-table({ files: [".gitignore", "license.txt"] }) -->`
 
-  A table of files and their compressed sizes:
+  A table of files and their compressed sizes. The optional `precision` sets the maximum number of decimal places and defaults to `0`:
 
   <!-- size-table({ files: [".gitignore", "license.txt"] }) -->
 
@@ -792,7 +796,7 @@ There's quite a bit of prior art and similar explorations of this problem space:
 - lillallol's [md-in-place](https://www.npmjs.com/package/md-in-place)
 
 - [AutoMD](https://automd.unjs.io/)\
-  Extremely similar functionality to mdat. The project was initiated around the same time as MDAT, but I didn't find the project until a few years later. Ships in the night.
+  Extremely similar functionality to mdat. The project was initiated around the same time as MDAT, but I didn't find the project until a few years later. Ships passing in the night.
 
 - Franck Abgrall's [readme-md-generator](https://github.com/kefranabg/readme-md-generator)
 
@@ -802,7 +806,8 @@ There's quite a bit of prior art and similar explorations of this problem space:
 
 - Hiroki Osame's [comment-mark](https://github.com/privatenumber/comment-mark)
 
-- Hiroki Osame's [mdeval](https://github.com/privatenumber/mdeval)
+- Hiroki Osame's [mdeval](https://github.com/privatenumber/mdeval)\
+  The best name!
 
 ### Implementation notes