@bensandee/tooling 0.9.0 → 0.10.0

package/dist/bin.mjs

@@ -7,6 +7,7 @@ import { existsSync, mkdirSync, readFileSync, readdirSync, rmSync, writeFileSync
 import JSON5 from "json5";
 import { parse } from "jsonc-parser";
 import { z } from "zod";
+import { isMap, isSeq, parseDocument } from "yaml";
 import { FatalError, TransientError, UnexpectedError } from "@bensandee/common";
 //#region src/types.ts
 /** Default CI platform when not explicitly chosen. */
@@ -414,6 +415,19 @@ function buildDefaultConfig(targetDir, flags) {
 }
 //#endregion
 //#region src/utils/fs.ts
+/**
+* Compare file content, using parsed comparison for JSON files to ignore
+* formatting differences. Falls back to exact string comparison for JSONC
+* files (with comments/trailing commas) that fail JSON.parse.
+*/
+function contentEqual(relativePath, a, b) {
+	if (relativePath.endsWith(".json")) try {
+		return JSON.stringify(JSON.parse(a)) === JSON.stringify(JSON.parse(b));
+	} catch {
+		return a === b;
+	}
+	return a === b;
+}
 /** Check whether a file exists at the given path. */
 function fileExists(targetDir, relativePath) {
 	return existsSync(path.join(targetDir, relativePath));
@@ -446,7 +460,7 @@ function createContext(config, confirmOverwrite) {
 		write: (rel, content) => {
 			if (!rel.startsWith(".tooling-archived/")) {
 				const existing = readFile(config.targetDir, rel);
-				if (existing !== void 0 && existing !== content) {
+				if (existing !== void 0 && !contentEqual(rel, existing, content)) {
 					writeFile(config.targetDir, `.tooling-archived/${rel}`, existing);
 					archivedFiles.push(rel);
 				}
@@ -567,7 +581,7 @@ function getAddedDevDepNames(config) {
 	const deps = { ...ROOT_DEV_DEPS };
 	if (config.structure !== "monorepo") Object.assign(deps, PER_PACKAGE_DEV_DEPS);
 	deps["@bensandee/config"] = "0.7.1";
-	deps["@bensandee/tooling"] = "0.9.0";
+	deps["@bensandee/tooling"] = "0.10.0";
 	if (config.formatter === "oxfmt") deps["oxfmt"] = "0.35.0";
 	if (config.formatter === "prettier") deps["prettier"] = "3.8.1";
 	addReleaseDeps(deps, config);
@@ -588,7 +602,7 @@ async function generatePackageJson(ctx) {
 	const devDeps = { ...ROOT_DEV_DEPS };
 	if (!isMonorepo) Object.assign(devDeps, PER_PACKAGE_DEV_DEPS);
 	devDeps["@bensandee/config"] = isWorkspacePackage(ctx, "@bensandee/config") ? "workspace:*" : "0.7.1";
-	devDeps["@bensandee/tooling"] = isWorkspacePackage(ctx, "@bensandee/tooling") ? "workspace:*" : "0.9.0";
+	devDeps["@bensandee/tooling"] = isWorkspacePackage(ctx, "@bensandee/tooling") ? "workspace:*" : "0.10.0";
 	if (ctx.config.useEslintPlugin) devDeps["@bensandee/eslint-plugin"] = isWorkspacePackage(ctx, "@bensandee/eslint-plugin") ? "workspace:*" : "0.9.0";
 	if (ctx.config.formatter === "oxfmt") devDeps["oxfmt"] = "0.35.0";
 	if (ctx.config.formatter === "prettier") devDeps["prettier"] = "3.8.1";
@@ -1228,6 +1242,101 @@ async function generateGitignore(ctx) {
 	};
 }
 //#endregion
+//#region src/utils/yaml-merge.ts
+const IGNORE_PATTERN = "@bensandee/tooling:ignore";
+/** Check if a YAML file has an opt-out comment in the first 10 lines. */
+function isToolingIgnored(content) {
+	return content.split("\n", 10).some((line) => line.includes(IGNORE_PATTERN));
+}
+/**
+* Ensure required commands exist under `pre-commit.commands` in a lefthook config.
+* Only adds missing commands — never modifies existing ones.
+* Returns unchanged content if the file has an opt-out comment or can't be parsed.
+*/
+function mergeLefthookCommands(existing, requiredCommands) {
+	if (isToolingIgnored(existing)) return {
+		content: existing,
+		changed: false
+	};
+	try {
+		const doc = parseDocument(existing);
+		let changed = false;
+		if (!doc.hasIn(["pre-commit", "commands"])) {
+			doc.setIn(["pre-commit", "commands"], requiredCommands);
+			return {
+				content: doc.toString(),
+				changed: true
+			};
+		}
+		const commands = doc.getIn(["pre-commit", "commands"]);
+		if (!isMap(commands)) return {
+			content: existing,
+			changed: false
+		};
+		for (const [name, config] of Object.entries(requiredCommands)) if (!commands.has(name)) {
+			commands.set(name, config);
+			changed = true;
+		}
+		return {
+			content: changed ? doc.toString() : existing,
+			changed
+		};
+	} catch {
+		return {
+			content: existing,
+			changed: false
+		};
+	}
+}
+/**
+* Ensure required steps exist in a workflow job's steps array.
+* Only adds missing steps at the end — never modifies existing ones.
+* Returns unchanged content if the file has an opt-out comment or can't be parsed.
+*/
+function mergeWorkflowSteps(existing, jobName, requiredSteps) {
+	if (isToolingIgnored(existing)) return {
+		content: existing,
+		changed: false
+	};
+	try {
+		const doc = parseDocument(existing);
+		const steps = doc.getIn([
+			"jobs",
+			jobName,
+			"steps"
+		]);
+		if (!isSeq(steps)) return {
+			content: existing,
+			changed: false
+		};
+		let changed = false;
+		for (const { match, step } of requiredSteps) if (!steps.items.some((item) => {
+			if (!isMap(item)) return false;
+			if (match.run) {
+				const run = item.get("run");
+				return typeof run === "string" && run.includes(match.run);
+			}
+			if (match.uses) {
+				const uses = item.get("uses");
+				return typeof uses === "string" && uses.startsWith(match.uses);
+			}
+			return false;
+		})) {
+			steps.add(doc.createNode(step));
+			changed = true;
+		}
+		return {
+			content: changed ? doc.toString() : existing,
+			changed
+		};
+	} catch {
+		return {
+			content: existing,
+			changed: false
+		};
+	}
+}
+//#endregion
 //#region src/generators/ci.ts
 function hasEnginesNode$1(ctx) {
 	const raw = ctx.read("package.json");
@@ -1262,23 +1371,62 @@ jobs:
       - run: pnpm exec tooling repo:check
 `;
 }
-/**
-* Insert a step at the end of the `check` job's steps, even if other jobs
-* follow. Returns null if we can't find the right insertion point.
-*/
-function insertStepIntoCheckJob(yaml, step) {
-	const lines = yaml.split("\n");
-	const checkJobIdx = lines.findIndex((l) => /^ {2}check:\s*$/.test(l));
-	if (checkJobIdx === -1) return null;
-	let lastStepIdx = -1;
-	for (const [i, line] of lines.entries()) {
-		if (i <= checkJobIdx) continue;
-		if (/^ {2}\S/.test(line)) break;
-		if (/^ {6}/.test(line)) lastStepIdx = i;
-	}
-	if (lastStepIdx === -1) return null;
-	lines.splice(lastStepIdx + 1, 0, step.trimEnd());
-	return lines.join("\n");
+function requiredCheckSteps(isMonorepo, nodeVersionYaml) {
+	const buildCmd = isMonorepo ? "pnpm -r build" : "pnpm build";
+	const testCmd = isMonorepo ? "pnpm -r test" : "pnpm test";
+	const typecheckCmd = isMonorepo ? "pnpm -r --parallel run typecheck" : "pnpm typecheck";
+	return [
+		{
+			match: { uses: "actions/checkout" },
+			step: { uses: "actions/checkout@v4" }
+		},
+		{
+			match: { uses: "pnpm/action-setup" },
+			step: { uses: "pnpm/action-setup@v4" }
+		},
+		{
+			match: { uses: "actions/setup-node" },
+			step: {
+				uses: "actions/setup-node@v4",
+				with: {
+					...nodeVersionYaml.startsWith("node-version-file") ? { "node-version-file": "package.json" } : { "node-version": "24" },
+					cache: "pnpm"
+				}
+			}
+		},
+		{
+			match: { run: "pnpm install" },
+			step: { run: "pnpm install --frozen-lockfile" }
+		},
+		{
+			match: { run: "typecheck" },
+			step: { run: typecheckCmd }
+		},
+		{
+			match: { run: "lint" },
+			step: { run: "pnpm lint" }
+		},
+		{
+			match: { run: "build" },
+			step: { run: buildCmd }
+		},
+		{
+			match: { run: "test" },
+			step: { run: testCmd }
+		},
+		{
+			match: { run: "format" },
+			step: { run: "pnpm format --check" }
+		},
+		{
+			match: { run: "knip" },
+			step: { run: "pnpm knip" }
+		},
+		{
+			match: { run: "repo:check" },
+			step: { run: "pnpm exec tooling repo:check" }
+		}
+	];
 }
 async function generateCi(ctx) {
 	if (ctx.config.ci === "none") return {
@@ -1293,14 +1441,14 @@ async function generateCi(ctx) {
 	const content = ciWorkflow(isMonorepo, nodeVersionYaml, !isGitHub);
 	if (ctx.exists(filePath)) {
 		const existing = ctx.read(filePath);
-		if (existing && !existing.includes("repo:check")) {
-			const patched = insertStepIntoCheckJob(existing, "      - run: pnpm exec tooling repo:check\n");
-			if (patched) {
-				ctx.write(filePath, patched);
+		if (existing) {
+			const merged = mergeWorkflowSteps(existing, "check", requiredCheckSteps(isMonorepo, nodeVersionYaml));
+			if (merged.changed) {
+				ctx.write(filePath, merged.content);
 				return {
 					filePath,
 					action: "updated",
-					description: "Added `pnpm exec tooling repo:check` step to CI workflow"
+					description: "Added missing steps to CI workflow"
 				};
 			}
 		}
@@ -1706,7 +1854,7 @@ async function generateReleaseIt(ctx) {
 	const content = JSON.stringify(buildConfig$2(ctx.config.ci, ctx.config.structure === "monorepo"), null, 2) + "\n";
 	const existing = ctx.read(filePath);
 	if (existing) {
-		if (existing === content) return {
+		if (contentEqual(filePath, existing, content)) return {
 			filePath,
 			action: "skipped",
 			description: "Already configured"
@@ -1893,6 +2041,62 @@ ${commonSteps(nodeVersionYaml)}
         run: pnpm exec tooling release:changesets
 `;
 }
+function requiredReleaseSteps(strategy, nodeVersionYaml) {
+	const isNodeVersionFile = nodeVersionYaml.startsWith("node-version-file");
+	const steps = [
+		{
+			match: { uses: "actions/checkout" },
+			step: {
+				uses: "actions/checkout@v4",
+				with: { "fetch-depth": 0 }
+			}
+		},
+		{
+			match: { uses: "pnpm/action-setup" },
+			step: { uses: "pnpm/action-setup@v4" }
+		},
+		{
+			match: { uses: "actions/setup-node" },
+			step: {
+				uses: "actions/setup-node@v4",
+				with: {
+					...isNodeVersionFile ? { "node-version-file": "package.json" } : { "node-version": "24" },
+					cache: "pnpm",
+					"registry-url": "https://registry.npmjs.org"
+				}
+			}
+		},
+		{
+			match: { run: "pnpm install" },
+			step: { run: "pnpm install --frozen-lockfile" }
+		},
+		{
+			match: { run: "build" },
+			step: { run: "pnpm build" }
+		}
+	];
+	switch (strategy) {
+		case "release-it":
+			steps.push({
+				match: { run: "release-it" },
+				step: { run: "pnpm release-it --ci" }
+			});
+			break;
+		case "commit-and-tag-version":
+			steps.push({
+				match: { run: "commit-and-tag-version" },
+				step: { run: "pnpm exec commit-and-tag-version" }
+			});
+			break;
+		case "changesets":
+			steps.push({
+				match: { run: "changeset" },
+				step: { run: "pnpm exec tooling release:changesets" }
+			});
+			break;
+	}
+	return steps;
+}
 function buildWorkflow(strategy, ci, nodeVersionYaml) {
 	switch (strategy) {
 		case "release-it": return releaseItWorkflow(ci, nodeVersionYaml);
@@ -1917,11 +2121,25 @@ async function generateReleaseCi(ctx) {
 		action: "skipped",
 		description: "Release CI workflow not applicable"
 	};
-	if (ctx.exists(workflowPath)) return {
-		filePath: workflowPath,
-		action: "skipped",
-		description: "Existing release workflow preserved"
-	};
+	if (ctx.exists(workflowPath)) {
+		const existing = ctx.read(workflowPath);
+		if (existing) {
+			const merged = mergeWorkflowSteps(existing, "release", requiredReleaseSteps(ctx.config.releaseStrategy, nodeVersionYaml));
+			if (merged.changed) {
+				ctx.write(workflowPath, merged.content);
+				return {
+					filePath: workflowPath,
+					action: "updated",
+					description: "Added missing steps to release workflow"
+				};
+			}
+		}
+		return {
+			filePath: workflowPath,
+			action: "skipped",
+			description: "Release workflow already up to date"
+		};
+	}
 	ctx.write(workflowPath, content);
 	return {
 		filePath: workflowPath,
@@ -1931,6 +2149,15 @@ async function generateReleaseCi(ctx) {
 }
 //#endregion
 //#region src/generators/lefthook.ts
+function requiredCommands(formatter) {
+	return {
+		lint: { run: "pnpm exec oxlint {staged_files}" },
+		format: {
+			run: formatter === "prettier" ? "pnpm exec prettier --write {staged_files}" : "pnpm exec oxfmt --no-error-on-unmatched-pattern {staged_files}",
+			stage_fixed: true
+		}
+	};
+}
 function buildConfig(formatter) {
 	return [
 		"pre-commit:",
@@ -2042,10 +2269,25 @@ async function generateLefthook(ctx) {
 	cleanPackageJson(ctx, results);
 	const existingPath = LEFTHOOK_CONFIG_PATHS.find((p) => ctx.exists(p));
 	if (existingPath) {
-		results.push({
+		const existing = ctx.read(existingPath);
+		if (existing) {
+			const merged = mergeLefthookCommands(existing, requiredCommands(ctx.config.formatter));
+			if (merged.changed) {
+				ctx.write(existingPath, merged.content);
+				results.push({
+					filePath: existingPath,
+					action: "updated",
+					description: "Added missing pre-commit commands"
+				});
+			} else results.push({
+				filePath: existingPath,
+				action: "skipped",
+				description: "Lefthook config already up to date"
+			});
+		} else results.push({
 			filePath: existingPath,
 			action: "skipped",
-			description: "Existing lefthook config preserved"
+			description: "Could not read existing lefthook config"
 		});
 		return results;
 	}
@@ -2183,7 +2425,7 @@ async function generateVscodeSettings(ctx) {
 		return results;
 	}
 	const existingSchema = ctx.read(SCHEMA_LOCAL_PATH);
-	if (existingSchema === schemaContent) results.push({
+	if (existingSchema !== void 0 && contentEqual(SCHEMA_LOCAL_PATH, existingSchema, schemaContent)) results.push({
 		filePath: SCHEMA_LOCAL_PATH,
 		action: "skipped",
 		description: "Schema already up to date"
@@ -2279,7 +2521,7 @@ function saveToolingConfig(ctx, config) {
 	};
 	const content = JSON.stringify(saved, null, 2) + "\n";
 	const existing = ctx.exists(CONFIG_FILE) ? ctx.read(CONFIG_FILE) : void 0;
-	if (existing === content) return {
+	if (existing !== void 0 && contentEqual(CONFIG_FILE, existing, content)) return {
 		filePath: CONFIG_FILE,
 		action: "skipped",
 		description: "Already up to date"
@@ -2482,7 +2724,16 @@ async function runCheck(targetDir) {
 		return 1;
 	}
 	const { ctx, pendingWrites } = createDryRunContext(mergeWithSavedConfig(buildDefaultConfig(targetDir, {}), saved));
-	const actionable = (await runGenerators(ctx)).filter((r) => r.action === "created" || r.action === "updated");
+	const actionable = (await runGenerators(ctx)).filter((r) => {
+		if (r.action !== "created" && r.action !== "updated") return false;
+		const newContent = pendingWrites.get(r.filePath);
+		if (newContent && r.action === "updated") {
+			const existingPath = path.join(targetDir, r.filePath);
+			const existing = existsSync(existingPath) ? readFileSync(existingPath, "utf-8") : void 0;
+			if (existing && contentEqual(r.filePath, existing, newContent)) return false;
+		}
+		return true;
+	});
 	if (actionable.length === 0) {
 		p.log.success("Repository is up to date.");
 		return 0;
@@ -3207,7 +3458,7 @@ function mergeGitHub(dryRun) {
 const main = defineCommand({
 	meta: {
 		name: "tooling",
-		version: "0.9.0",
+		version: "0.10.0",
 		description: "Bootstrap and maintain standardized TypeScript project tooling"
 	},
 	subCommands: {
@@ -3220,7 +3471,7 @@ const main = defineCommand({
 		"release:merge": releaseMergeCommand
 	}
 });
-console.log(`@bensandee/tooling v0.9.0`);
+console.log(`@bensandee/tooling v0.10.0`);
 runMain(main);
 //#endregion
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bensandee/tooling",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "CLI tool to bootstrap and maintain standardized TypeScript project tooling",
   "bin": {
     "tooling": "./dist/bin.mjs"
@@ -25,6 +25,7 @@
     "citty": "^0.2.1",
     "json5": "^2.2.3",
     "jsonc-parser": "^3.3.1",
+    "yaml": "^2.8.2",
     "zod": "^4.3.6",
     "@bensandee/common": "0.1.0"
   },