@stephansama/auto-readme 0.2.6 → 0.2.8

package/dist/{index.js → index.mjs}

@@ -1,8 +1,8 @@
 import { fromMarkdown } from "mdast-util-from-markdown";
 import * as cp from "node:child_process";
 import * as fsp from "node:fs/promises";
-import ora from "ora";
-import debug from "debug";
+import { Spinner } from "picospinner";
+import { createDebug, enable } from "obug";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 import * as z from "zod";
@@ -12,12 +12,11 @@ import { cosmiconfig, getDefaultSearchPlaces } from "cosmiconfig";
 import deepmerge from "deepmerge";
 import { getPackages } from "@manypkg/get-packages";
 import * as fs from "node:fs";
-import * as path$1 from "node:path";
 import path from "node:path";
 import { readPackageJSON } from "pkg-types";
 import * as yaml from "yaml";
 import { zod2md } from "zod2md";
-import glob from "fast-glob";
+import { glob } from "tinyglobby";
 import { remark } from "remark";
 import remarkCodeImport from "remark-code-import";
 import remarkCollapse from "remark-collapse";
@@ -27,7 +26,6 @@ import { VFile } from "vfile";
 import Handlebars from "handlebars";
 import { markdownTable } from "markdown-table";
 import { zone } from "mdast-zone";
-
 //#region src/schema.ts
 const actionsSchema = z.enum([
 	"ACTION",
@@ -70,8 +68,8 @@ const tableHeadingsSchema = z.record(actionsSchema, headingsSchema.array().optio
 	ZOD: []
 }).meta({ description: "Table heading action configuration" });
 const templatesSchema = z.object({
-	downloadImage: z.string().default("https://img.shields.io/npm/dw/{{name}}?labelColor=211F1F"),
-	emojis: z.record(headingsSchema, z.string()).default({
+	downloadImage: z.string().trim().default("https://img.shields.io/npm/dw/{{name}}?labelColor=211F1F"),
+	emojis: z.record(headingsSchema, z.string().trim()).default({
 		default: "⚙️",
 		description: "📝",
 		devDependency: "💻",
@@ -81,14 +79,14 @@ const templatesSchema = z.object({
 		required: "",
 		version: ""
 	}).meta({ description: "Table heading emojis used when enabled" }),
-	registryUrl: z.string().default("https://www.npmjs.com/package/{{name}}"),
-	versionImage: z.string().default("https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F")
+	registryUrl: z.string().trim().default("https://www.npmjs.com/package/{{name}}"),
+	versionImage: z.string().trim().default("https://img.shields.io/npm/v/{{uri_name}}?logo=npm&logoColor=red&color=211F1F&labelColor=211F1F")
 });
 const defaultTemplates = templatesSchema.parse({});
-const defaultTableHeadings = tableHeadingsSchema.parse(void 0);
-const _configSchema = z.object({
-	affectedRegexes: z.array(z.string()),
-	collapseHeadings: z.array(z.string()),
+const defaultTableHeadings = tableHeadingsSchema.parse({});
+const configSchema = z.object({
+	affectedRegexes: z.array(z.string().trim()),
+	collapseHeadings: z.array(z.string().trim()),
 	defaultLanguage: languageSchema.meta({
 		alias: "l",
 		description: "Default language to infer projects from"
@@ -113,27 +111,25 @@ const _configSchema = z.object({
 		alias: "p",
 		description: "Only show public packages in workspaces"
 	}),
-	removeScope: z.string().default("").meta({ description: "Remove common workspace scope" }),
+	removeScope: z.string().trim().default("").meta({ description: "Remove common workspace scope" }),
 	templates: templatesSchema.optional().default(defaultTemplates).describe("Handlebars templates used to fuel list and table generation"),
-	tocHeading: z.string().default("Table of contents").meta({ description: "Markdown heading used to generate table of contents" }),
-	usageFile: z.string().default("").meta({ description: "Workspace level usage file" }),
-	usageHeading: z.string().default("Usage").meta({ description: "Markdown heading used to generate usage example" }),
+	tocHeading: z.string().trim().default("Table of contents").meta({ description: "Markdown heading used to generate table of contents" }),
+	usageFile: z.string().trim().default("").meta({ description: "Workspace level usage file" }),
+	usageHeading: z.string().trim().default("Usage").meta({ description: "Markdown heading used to generate usage example" }),
 	verbose: z.boolean().default(false).meta({
 		alias: "v",
 		description: "whether or not to display verbose logging"
 	})
-});
-const configSchema = _configSchema.optional();
-
+}).optional();
 //#endregion
-//#region src/args.ts
+//#region src/arguments.ts
 const complexOptions = [
 	"affectedRegexes",
 	"collapseHeadings",
 	"headings",
 	"templates"
 ];
-const args = {
+const arguments_ = {
 	...zodToYargs(),
 	changes: {
 		alias: "g",
@@ -153,10 +149,10 @@ const args = {
 		type: "string"
 	}
 };
-async function parseArgs() {
-	const yargsInstance = yargs(hideBin(process.argv)).options(args).help("h").alias("h", "help").epilogue(`--> @stephansama open-source ${(/* @__PURE__ */ new Date()).getFullYear()}`);
+async function parseArguments() {
+	const yargsInstance = yargs(hideBin(process.argv)).options(arguments_).help("h").alias("h", "help").epilogue(`--> @stephansama open-source ${(/* @__PURE__ */ new Date()).getFullYear()}`);
 	const parsed = await yargsInstance.wrap(yargsInstance.terminalWidth()).parse();
-	if (parsed.verbose) debug.enable("autoreadme*");
+	if (parsed.verbose) enable("autoreadme*");
 	return parsed;
 }
 function zodToYargs() {
@@ -179,25 +175,12 @@ function zodToYargs() {
 	});
 	return Object.fromEntries(entries);
 }
-
 //#endregion
 //#region src/log.ts
-const error = debug("autoreadme:error");
-const info = debug("autoreadme:info");
-const warn = debug("autoreadme:warn");
-function ERROR(...rest) {
-	const [first, ...remaining] = rest;
-	error(`${first} %O`, ...remaining);
-}
-function INFO(...rest) {
-	const [first, ...remaining] = rest;
-	info(`${first} %O`, ...remaining);
-}
-function WARN(...rest) {
-	const [first, ...remaining] = rest;
-	warn(`${first} %O`, ...remaining);
-}
-
+const debug = createDebug("autoreadme", { useColors: true });
+const ERROR = debug.extend("error");
+const INFO = debug.extend("info");
+const WARN = debug.extend("warn");
 //#endregion
 //#region src/comment.ts
 const SEPARATOR = "-";
@@ -214,7 +197,7 @@ function parseComment(comment) {
 	});
 	const languageInput = third ? first : void 0;
 	const actionInput = third ? second : first;
-	const formatInput = third ? third : second;
+	const formatInput = third || second;
 	const language = languageSchema.parse(languageInput);
 	const parsed = {
 		action: actionsSchema.parse(actionInput),
@@ -228,8 +211,9 @@ function parseComment(comment) {
 }
 const startComment = "<!--";
 const endComment = "-->";
+const commentRegex = /start|end/;
 function trimComment(comment) {
-	return comment.replace(startComment, "").replace(/start|end/, "").replace(endComment, "").trim();
+	return comment.replace(startComment, "").replace(commentRegex, "").replace(endComment, "").trim();
 }
 function getComment(comment) {
 	if (!isComment(comment.value)) return false;
@@ -239,29 +223,28 @@ function getComment(comment) {
 function isComment(comment) {
 	return comment.startsWith(startComment) && comment.endsWith(endComment);
 }
-
 //#endregion
 //#region src/config.ts
 const moduleName = "autoreadme";
 const searchPlaces = getSearchPlaces();
 const loaders = { [".toml"]: loadToml };
-async function loadConfig(args$1) {
-	const opts$1 = {
+async function loadConfig(arguments_) {
+	const options = {
 		loaders,
 		searchPlaces
 	};
-	if (args$1.config) opts$1.searchPlaces = [args$1.config];
-	const search = await cosmiconfig(moduleName, opts$1).search();
-	if (!search) {
-		WARN(`no config file found`, args$1.config ? " at location: " + args$1.config : "");
-		INFO("using default configuration");
-	} else {
+	if (arguments_.config) options.searchPlaces = [arguments_.config];
+	const search = await cosmiconfig(moduleName, options).search();
+	if (search) {
 		INFO("found configuration file at: ", search.filepath);
 		INFO("loaded cosmiconfig", search.config);
+	} else {
+		WARN(`no config file found`, arguments_.config ? " at location: " + arguments_.config : "");
+		INFO("using default configuration");
 	}
-	args$1 = removeFalsy(args$1);
-	INFO("merging config with args", args$1);
-	return configSchema.parse(deepmerge(search?.config || {}, args$1, { arrayMerge: (_, sourceArray) => sourceArray }));
+	arguments_ = removeFalsy(arguments_);
+	INFO("merging config with args", arguments_);
+	return configSchema.parse(deepmerge(search?.config || {}, arguments_, { arrayMerge: (_, sourceArray) => sourceArray }));
 }
 function loadToml(_filepath, content) {
 	return toml.parse(content);
@@ -278,14 +261,13 @@ function getSearchPlaces() {
 		`.config/.${moduleName}rc.yml`
 	];
 }
-function removeFalsy(obj) {
-	return Object.fromEntries(Object.entries(obj).map(([k, v]) => !v ? false : [k, v]).filter((e) => Boolean(e)));
+function removeFalsy(object) {
+	return Object.fromEntries(Object.entries(object).map(([k, v]) => v ? [k, v] : false).filter(Boolean));
 }
-
 //#endregion
-//#region src/utils.ts
+//#region src/utilities.ts
 const sh = String.raw;
-const opts = { encoding: "utf8" };
+const options = { encoding: "utf8" };
 const ignore = ["**/node_modules/**"];
 const matches = [
 	/.*README\.md$/gi,
@@ -298,21 +280,23 @@ async function fileExists(file) {
 	return await fsp.access(file).then(() => true).catch(() => false);
 }
 function findAffectedMarkdowns(root, config) {
-	const affected = cp.execSync(sh`git diff --cached --name-only --diff-filter=MACT`, opts).trim().split("\n").filter(Boolean);
-	if (!affected.length) ERROR("no staged files found");
+	const affected = cp.execSync(sh`git diff --cached --name-only --diff-filter=MACT`, options).trim().split("\n").filter((item) => !!item);
+	if (affected.length === 0) ERROR("no staged files found");
 	if (config.affectedRegexes?.length) INFO("adding the following expressions: ", config.affectedRegexes);
 	const allMatches = [...matches, ...config.affectedRegexes?.map((r) => new RegExp(r)) || []];
 	INFO("Checking affected files against regexes", affected, allMatches);
 	const eligible = affected.filter((a) => allMatches.some((m) => a.match(m)));
 	INFO("Found the following eligible affected files", eligible);
-	const md = eligible.map((e) => findNearestReadme(root, path$1.resolve(e)));
-	const rootMd = path$1.join(root, "README.md");
-	const dedupe = [...new Set(md), rootMd].filter((s) => Boolean(s));
+	const md = eligible.map((current) => {
+		return findNearestReadme(root, path.resolve(current));
+	});
+	const rootMd = path.join(root, "README.md");
+	const dedupe = [...new Set(md), rootMd].filter((item) => !!item);
 	INFO("Found the following readmes", dedupe);
 	return dedupe;
 }
 function getGitRoot() {
-	const root = cp.execSync(sh`git rev-parse --show-toplevel`, opts).trim();
+	const root = cp.execSync(sh`git rev-parse --show-toplevel`, options).trim();
 	if (!root) throw new Error("must be ran within a git directory.");
 	INFO("found git root at location: ", root);
 	return root;
@@ -321,33 +305,31 @@ async function getMarkdownPaths(cwd, config) {
 	return (await glob(`**/${config?.onlyReadmes ? "README" : "*"}.md`, {
 		cwd,
 		ignore
-	})).map((readme) => path$1.resolve(cwd, readme));
+	})).map((readme) => path.resolve(cwd, readme));
 }
 async function getPrettierPaths(paths) {
 	return await Promise.all(paths.map(async (file) => {
 		if (!(await fsp.lstat(file)).isSymbolicLink()) return file;
 		const symlink = await fsp.readlink(file);
-		return path$1.join(path$1.dirname(file), symlink);
+		return path.join(path.dirname(file), symlink);
 	}));
 }
 function findNearestReadme(gitRoot, inputFile, maxRotations = 15) {
-	let dir = path$1.dirname(inputFile);
+	let dirname = path.dirname(inputFile);
 	let rotations = 0;
 	while (true) {
-		const option = path$1.join(dir, "README.md");
+		const option = path.join(dirname, "README.md");
 		if (fs.existsSync(option)) return option;
-		const parent = path$1.dirname(dir);
-		if (parent === dir || dir === gitRoot || ++rotations > maxRotations) break;
-		dir = parent;
+		const parent = path.dirname(dirname);
+		if (parent === dirname || dirname === gitRoot || ++rotations > maxRotations) break;
+		dirname = parent;
 	}
-	return null;
 }
-
 //#endregion
 //#region src/data.ts
 function createFindParameter(parameterList) {
 	return function(parameterName) {
-		return parameterList?.find((p) => p.startsWith(parameterName))?.replace(parameterName + "=", "")?.replace(/"/gi, "")?.replace(/_/gi, " ");
+		return parameterList?.find((p) => p.startsWith(parameterName))?.replace(parameterName + "=", "")?.replaceAll("\"", "")?.replaceAll("_", " ");
 	};
 }
 async function loadActionData(actions, file, root) {
@@ -356,7 +338,7 @@ async function loadActionData(actions, file, root) {
 		const find = createFindParameter(action.parameters);
 		switch (action.action) {
 			case "ACTION": {
-				const actionYaml = await loadActionYaml(path$1.dirname(file));
+				const actionYaml = await loadActionYaml(path.dirname(file));
 				return {
 					action: action.action,
 					actionYaml,
@@ -365,7 +347,7 @@ async function loadActionData(actions, file, root) {
 			}
 			case "PKG": {
 				const inputPath = find("path");
-				const pkgJson = await readPackageJSON(inputPath ? path$1.resolve(path$1.dirname(file), inputPath) : path$1.dirname(file));
+				const pkgJson = await readPackageJSON(inputPath ? path.resolve(path.dirname(file), inputPath) : path.dirname(file));
 				return {
 					action: action.action,
 					parameters: action.parameters,
@@ -378,7 +360,7 @@ async function loadActionData(actions, file, root) {
 			};
 			case "WORKSPACE": {
 				const workspaces = await getPackages(process.cwd());
-				const pnpmPath = path$1.resolve(root, "pnpm-workspace.yaml");
+				const pnpmPath = path.resolve(root, "pnpm-workspace.yaml");
 				const isPnpm = fs.existsSync(pnpmPath);
 				return {
 					action: action.action,
@@ -392,11 +374,11 @@ async function loadActionData(actions, file, root) {
 				if (action.format === "LIST") throw new Error("cannot display zod in list format");
 				const inputPath = find("path");
 				if (!inputPath) {
-					const error$1 = `no path found for zod table at markdown file ${file}`;
-					throw new Error(error$1);
+					const error = `no path found for zod table at markdown file ${file}`;
+					throw new Error(error);
 				}
 				const body = await zod2md({
-					entry: path$1.resolve(path$1.dirname(file), inputPath),
+					entry: path.resolve(path.dirname(file), inputPath),
 					title: find("title") || "Zod Schema"
 				});
 				return {
@@ -409,18 +391,17 @@ async function loadActionData(actions, file, root) {
 		}
 	}));
 }
-async function loadActionYaml(baseDir) {
-	const actionYmlPath = path$1.resolve(baseDir, "action.yml");
-	const actionYamlPath = path$1.resolve(baseDir, "action.yaml");
+async function loadActionYaml(baseDirectory) {
+	const actionYmlPath = path.resolve(baseDirectory, "action.yml");
+	const actionYamlPath = path.resolve(baseDirectory, "action.yaml");
 	const actualPath = await fileExists(actionYamlPath) && actionYamlPath || await fileExists(actionYmlPath) && actionYmlPath;
 	if (!actualPath) {
-		const error$1 = `no yaml file found at locations: ${[actionYmlPath, actionYamlPath]}`;
-		throw new Error(error$1);
+		const error = `no yaml file found at locations: ${[actionYmlPath, actionYamlPath].join(",")}`;
+		throw new Error(error);
 	}
 	const actionFile = await fsp.readFile(actualPath, { encoding: "utf8" });
 	return yaml.parse(actionFile);
 }
-
 //#endregion
 //#region src/plugin.ts
 function createHeading(headings, disableEmojis = false, emojis = defaultTemplates.emojis) {
@@ -448,8 +429,8 @@ const autoReadmeRemarkPlugin = (config, data) => (tree) => {
 		const heading = `### ${config.disableEmojis ? "" : "🧰"} actions`;
 		if (options.format === "LIST") return [
 			start,
-			fromMarkdown(`${heading}\n` + Object.entries(inputs).sort((a) => a[1].required ? -1 : 1).map(([key, value$1]) => {
-				return `- ${wrapRequired(value$1.required, key)}: (default: ${value$1.default})\n\n${value$1.description}`;
+			fromMarkdown(`${heading}\n` + Object.entries(inputs).toSorted((a) => a[1].required ? -1 : 1).map(([key, value]) => {
+				return `- ${wrapRequired(value.required, key)}: (default: ${value.default})\n\n${value.description}`;
 			}).join("\n")),
 			end
 		];
@@ -459,7 +440,7 @@ const autoReadmeRemarkPlugin = (config, data) => (tree) => {
 			fromMarkdown([
 				heading,
 				"",
-				markdownTable([createHeading(headings, config.disableEmojis, config.templates?.emojis), ...Object.entries(inputs).map(([k, v]) => headings.map((heading$1) => v[heading$1] || k).map(String))])
+				markdownTable([createHeading(headings, config.disableEmojis, config.templates?.emojis), ...Object.entries(inputs).map(([k, v]) => headings.map((heading) => v[heading] || k).map(String))])
 			].join("\n")),
 			end
 		];
@@ -470,11 +451,11 @@ const autoReadmeRemarkPlugin = (config, data) => (tree) => {
 		const workspace = data.find((d) => d?.action === "WORKSPACE");
 		const templates = loadTemplates(config.templates);
 		const packages = workspace?.workspaces?.packages || [];
-		const headings = config.headings?.WORKSPACE?.length && config.headings?.WORKSPACE || defaultTableHeadings.WORKSPACE;
+		const headings = config.headings?.WORKSPACE?.length && config.headings?.WORKSPACE || defaultTableHeadings.WORKSPACE || [];
 		if (comment && comment.format === "LIST") {}
-		const table = markdownTable([createHeading(headings, config.disableEmojis, config.templates?.emojis), ...packages.filter((pkg) => config.onlyShowPublicPackages ? !pkg.packageJson.private : true).map((pkg) => {
+		const table = markdownTable([createHeading(headings, config.disableEmojis, config.templates?.emojis) || [], ...packages.filter((pkg) => config.onlyShowPublicPackages ? !pkg.packageJson.private : true).map((pkg) => {
 			const { name } = pkg.packageJson;
-			return headings.map((heading) => {
+			return headings?.map((heading) => {
 				if (heading === "name") return `[${config.removeScope ? name.replace(config.removeScope, "") : name}](${path.relative(process.cwd(), path.resolve(pkg.dir, "README.md"))})`;
 				if (heading === "version") return `![npm version image](${templates.versionImage({ uri_name: encodeURIComponent(name) })})`;
 				if (heading === "downloads") return `![npm downloads](${templates.downloadImage({ name })})`;
@@ -503,13 +484,13 @@ const autoReadmeRemarkPlugin = (config, data) => (tree) => {
 			fromMarkdown(""),
 			end
 		];
-		function mapDependencies(isDev) {
+		function mapDependencies(isDevelopment) {
 			return function([name, version]) {
 				const url = templates.registryUrl({ name });
 				return headings.map((key) => {
 					if (key === "devDependency") {
-						if (config.disableEmojis) return `\`${isDev}\``;
-						return `${isDev ? "⌨️" : "👥"}`;
+						if (config.disableEmojis) return `\`${isDevelopment}\``;
+						return `${isDevelopment ? "⌨️" : "👥"}`;
 					}
 					if (key === "name") return `[${name}](${url})`;
 					if (key === "version") {
@@ -547,7 +528,6 @@ function loadTemplates(templates) {
 		return [key, Handlebars.compile(value)];
 	}));
 }
-
 //#endregion
 //#region src/pipeline.ts
 async function parse(file, filepath, root, config, data) {
@@ -555,10 +535,10 @@ async function parse(file, filepath, root, config, data) {
 	const usage = data.find((d) => d.action === "USAGE");
 	if (usage?.action === "USAGE" || config.enableUsage) {
 		const examplePath = createFindParameter(usage?.parameters || [])("path");
-		const dirname = path$1.dirname(filepath);
-		const resolvePath = examplePath && path$1.resolve(dirname, examplePath);
-		const relativeProjectPath = config.usageFile && path$1.relative(root, path$1.resolve(dirname, config.usageFile));
-		const example = examplePath && resolvePath && path$1.relative(root, resolvePath) || relativeProjectPath || void 0;
+		const dirname = path.dirname(filepath);
+		const resolvePath = examplePath && path.resolve(dirname, examplePath);
+		const relativeProjectPath = config.usageFile && path.relative(root, path.resolve(dirname, config.usageFile));
+		const example = examplePath && resolvePath && path.relative(root, resolvePath) || relativeProjectPath || void 0;
 		if (example && await fileExists(example)) {
 			INFO("generating usage section");
 			pipeline.use(remarkUsage, {
@@ -576,58 +556,57 @@ async function parse(file, filepath, root, config, data) {
 		pipeline.use(remarkCollapse, { test: {
 			ignoreFinalDefinitions: true,
 			test: (value, _) => {
-				return headings.some((i) => value.trim() === i?.trim());
+				return headings.some((item) => value.trim() === item?.trim());
 			}
 		} });
 	}
 	const vfile = new VFile({
-		path: path$1.resolve(filepath),
+		path: path.resolve(filepath),
 		value: file
 	});
 	return (await pipeline.process(vfile)).toString();
 }
-
 //#endregion
 //#region src/index.ts
 async function run() {
-	const args$1 = await parseArgs();
-	const config = await loadConfig(args$1) || {};
+	const arguments_ = await parseArguments();
+	const config = await loadConfig(arguments_) || {};
 	INFO("Loaded the following configuration:", config);
 	const root = getGitRoot();
-	const isAffected = args$1.changes && "affected";
-	INFO(`Loading ${!isAffected ? "all " : "affected "}files`);
+	const isAffected = arguments_.changes && "affected";
+	INFO(`Loading ${isAffected ? "affected " : "all "}files`);
 	const paths = isAffected ? findAffectedMarkdowns(root, config) : await getMarkdownPaths(root, config);
 	INFO("Loaded the following files:", paths.join("\n"));
-	const type = args$1.onlyReadmes ? "readmes" : "all markdown files";
-	if (!paths.length) return ERROR(`no ${isAffected} readmes found to update`);
-	const spinner = !args$1.verbose && ora(`Updating ${type}`).start();
-	await Promise.all(paths.map(async (path$2) => {
-		const file = await fsp.readFile(path$2, { encoding: "utf8" });
-		const actions = (() => {
-			return loadAstComments(fromMarkdown(file));
-		})();
-		if (!actions.length) {
-			WARN(`no action comments found in`, path$2);
+	if (paths.length === 0) return ERROR(`no ${isAffected} readmes found to update`);
+	const spinner = !arguments_.verbose && makeSpinner();
+	if (spinner) spinner.start();
+	await Promise.all(paths.filter((path) => !!path).map(async (path) => {
+		const file = await fsp.readFile(path, { encoding: "utf8" });
+		const actions = loadAstComments(fromMarkdown(file));
+		if (actions.length === 0) {
+			WARN(`no action comments found in`, path);
 			if (!config.enableUsage || !config.enableToc) return ERROR("no action or plugins found");
-			else INFO("plugins enabled. continuing parsing", path$2);
+			else INFO("plugins enabled. continuing parsing", path);
 		}
-		const data = await loadActionData(actions, path$2, root);
+		const data = await loadActionData(actions, path, root);
 		INFO("Loaded comment action data", data);
-		const content = await parse(file, path$2, root, config, data);
-		await fsp.writeFile(path$2, content);
+		const content = await parse(file, path, root, config, data);
+		await fsp.writeFile(path, content);
 	}));
-	const opts$1 = { stdio: "inherit" };
+	const options = { stdio: "inherit" };
 	if (config.enablePrettier) {
 		INFO("formatting with prettier");
 		const prettierPaths = await getPrettierPaths(paths);
-		cp.execFileSync("prettier", ["--write", ...prettierPaths], opts$1);
+		cp.execFileSync("prettier", ["--write", ...prettierPaths], options);
 	}
 	if (isAffected) {
 		INFO("adding affected files to git stage");
-		cp.execFileSync("git", ["add", ...paths], opts$1);
+		cp.execFileSync("git", ["add", ...paths], options);
 	}
 	if (spinner) spinner.stop();
 }
-
+function makeSpinner() {
+	return new Spinner("Updating readme...", { colors: { spinner: "red" } });
+}
 //#endregion
-export { run };
+export { run };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stephansama/auto-readme",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "description": "Generate lists and tables for your README automagically based on your repository and comments",
   "keywords": [
     "auto",
@@ -24,48 +24,41 @@
     "email": "stephanrandle.dev@gmail.com",
     "url": "https://stephansama.info"
   },
+  "sideEffects": false,
   "type": "module",
   "exports": {
     ".": {
-      "import": {
-        "types": "./config/schema.d.ts",
-        "default": "./config/schema.js"
-      },
-      "require": {
-        "types": "./config/schema.d.cts",
-        "default": "./config/schema.cjs"
-      }
+      "import": "./config/schema.mjs",
+      "require": "./config/schema.cjs"
     },
-    "./schema.json": "./config/schema.json",
     "./package.json": "./package.json"
   },
-  "main": "./config/schema.js",
-  "types": "./config/schema.d.ts",
+  "main": "./config/schema.cjs",
+  "types": "./config/schema.d.cts",
   "bin": "./cli.mjs",
   "files": [
     "./dist",
-    "./config",
-    "./cli.mjs"
+    "./config"
   ],
   "dependencies": {
-    "@iarna/toml": "^2.2.5",
-    "@manypkg/get-packages": "^3.1.0",
+    "@iarna/toml": "2.2.5",
+    "@manypkg/get-packages": "3.1.0",
     "cosmiconfig": "9.0.0",
-    "debug": "^4.4.3",
-    "deepmerge": "^4.3.1",
-    "fast-glob": "^3.3.3",
-    "handlebars": "4.7.8",
+    "deepmerge": "4.3.1",
+    "handlebars": "4.7.9",
     "markdown-table": "^3.0.4",
+    "mdast": "3.0.0",
     "mdast-comment-marker": "^3.0.0",
     "mdast-util-from-markdown": "^2.0.2",
     "mdast-zone": "github:stephansama/mdast-zone#1c5b08cd97240debeed4c9c6afad49df5877a132",
-    "ora": "^8.2.0",
+    "obug": "2.1.1",
     "pkg-types": "^2.3.0",
     "remark": "15.0.1",
     "remark-code-import": "^1.2.0",
     "remark-collapse": "^0.1.2",
     "remark-toc": "^9.0.0",
     "remark-usage": "^11.0.1",
+    "tinyglobby": "0.2.16",
     "vfile": "^6.0.3",
     "yaml": "^2.8.2",
     "yargs": "18.0.0",
@@ -73,22 +66,26 @@
     "zod2md": "^0.2.5"
   },
   "devDependencies": {
-    "@types/debug": "^4.1.12",
-    "@types/mdast": "^4.0.4",
-    "@types/vfile": "^4.0.0",
-    "@types/yargs": "^17.0.35",
-    "mdast": "^3.0.0",
-    "tsdown": "0.15.12",
-    "unified": "^11.0.5"
+    "@types/mdast": "4.0.4",
+    "@types/vfile": "4.0.0",
+    "@types/yargs": "17.0.35",
+    "picospinner": "3.0.0",
+    "tsdown": "0.21.10",
+    "unified": "11.0.5"
+  },
+  "engines": {
+    "node": ">=24"
   },
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
+  "module": "./config/schema.mjs",
   "scripts": {
     "build": "node build.mjs",
     "postbuild": "publint",
     "dev": "node --watch-path=./src build.mjs",
-    "lint": "eslint ./src/ --pass-on-no-patterns --no-error-on-unmatched-pattern"
+    "lint": "eslint ./src/ --pass-on-no-patterns --no-error-on-unmatched-pattern",
+    "lint:fix": "eslint ./src/ --pass-on-no-patterns --no-error-on-unmatched-pattern --fix"
   }
 }