@savvy-web/cli 0.3.0 → 0.4.0

package/commands/lint/init.js

@@ -0,0 +1,221 @@
+import { Command, Options } from "@effect/cli";
+import { BiomeSchemaSync, Lint, ManagedSection, SavvyBaseSection, SavvyHooksSection, savvyBasePreamble, savvyHooksHygiene } from "@savvy-web/silk-effects";
+import { Effect } from "effect";
+import { dirname } from "node:path";
+import { applyEdits, modify, parse } from "jsonc-effect";
+import { FileSystem } from "@effect/platform";
+import { chmod } from "node:fs/promises";
+import { isDeepStrictEqual } from "node:util";
+
+//#region src/commands/lint/init.ts
+/**
+* Init command - bootstrap lint-staged configuration.
+*
+* @internal
+*/
+/** Unicode checkmark symbol. */
+const CHECK_MARK = "✓";
+/** Unicode warning symbol. */
+const WARNING = "⚠";
+/** Executable file permission mode. */
+const EXECUTABLE_MODE = 493;
+/** Formatting options for jsonc-effect surgical edits. */
+const JSONC_FORMAT = {
+	tabSize: 1,
+	insertSpaces: false
+};
+/** Header written when creating a fresh pre-commit hook. */
+const PRE_COMMIT_HEADER = "#!/usr/bin/env sh\n# Pre-commit hook with savvy managed sections\n# Custom hooks can go above, below, or between the managed sections\n\n";
+/** Header written when creating a fresh hygiene hook (post-checkout / post-merge). */
+const HYGIENE_HEADER = "#!/usr/bin/env sh\n# Managed by savvy-hooks\n# Custom hooks can go above or below the managed section\n\n";
+/**
+* Check if a preset includes the ShellScripts handler.
+*
+* @param preset - The preset to check
+* @returns True if the preset includes ShellScripts (standard and silk)
+*/
+function presetIncludesShellScripts(preset) {
+	return preset !== "minimal";
+}
+/**
+* Check if a preset includes markdown tooling.
+*
+* @param preset - The preset to check
+* @returns True if the preset includes Markdown (standard and silk)
+*/
+function presetIncludesMarkdown(preset) {
+	return preset !== "minimal";
+}
+/**
+* Generate the lint-staged config file content.
+*
+* @param preset - The preset to use
+* @returns Config file content
+*/
+function generateConfigContent(preset) {
+	return `/**
+ * lint-staged configuration
+ * Generated by savvy lint init
+ */
+import { Preset } from "@savvy-web/silk/lint";
+
+export default Preset.${preset}();
+`;
+}
+/**
+* Write or update the markdownlint-cli2 config file.
+*
+* @param fs - FileSystem service
+* @param preset - The active preset
+* @param force - Whether to overwrite the entire file
+* @returns Effect that manages the markdownlint config
+*/
+function writeMarkdownlintConfig(fs, preset, force) {
+	return Effect.gen(function* () {
+		const configExists = yield* fs.exists(Lint.MARKDOWNLINT_CONFIG_PATH);
+		const fullTemplate = JSON.stringify(Lint.MARKDOWNLINT_TEMPLATE, null, "	");
+		if (!configExists) {
+			yield* fs.makeDirectory("lib/configs", { recursive: true });
+			yield* fs.writeFileString(Lint.MARKDOWNLINT_CONFIG_PATH, `${fullTemplate}\n`);
+			yield* Effect.log(`${CHECK_MARK} Created ${Lint.MARKDOWNLINT_CONFIG_PATH}`);
+			return;
+		}
+		if (preset !== "silk") {
+			yield* Effect.log(`${CHECK_MARK} ${Lint.MARKDOWNLINT_CONFIG_PATH}: exists (not managed by ${preset} preset)`);
+			return;
+		}
+		if (force) {
+			yield* fs.writeFileString(Lint.MARKDOWNLINT_CONFIG_PATH, `${fullTemplate}\n`);
+			yield* Effect.log(`${CHECK_MARK} Replaced ${Lint.MARKDOWNLINT_CONFIG_PATH} (--force)`);
+			return;
+		}
+		const existingText = yield* fs.readFileString(Lint.MARKDOWNLINT_CONFIG_PATH);
+		const existingParsed = yield* parse(existingText);
+		let updatedText = existingText;
+		let schemaUpdated = false;
+		if (existingParsed.$schema !== Lint.MARKDOWNLINT_SCHEMA) {
+			const edits = yield* modify(updatedText, ["$schema"], Lint.MARKDOWNLINT_SCHEMA, { formattingOptions: JSONC_FORMAT });
+			updatedText = yield* applyEdits(updatedText, edits);
+			schemaUpdated = true;
+		}
+		const existingConfig = existingParsed.config;
+		if (!(existingConfig !== void 0 && isDeepStrictEqual(existingConfig, Lint.MARKDOWNLINT_CONFIG))) {
+			yield* Effect.log(`${WARNING} ${Lint.MARKDOWNLINT_CONFIG_PATH}: config rules differ from template (use --force to overwrite)`);
+			if (schemaUpdated) {
+				yield* fs.writeFileString(Lint.MARKDOWNLINT_CONFIG_PATH, updatedText);
+				yield* Effect.log(`${CHECK_MARK} Updated $schema in ${Lint.MARKDOWNLINT_CONFIG_PATH}`);
+			}
+			return;
+		}
+		if (schemaUpdated) {
+			yield* fs.writeFileString(Lint.MARKDOWNLINT_CONFIG_PATH, updatedText);
+			yield* Effect.log(`${CHECK_MARK} Updated $schema in ${Lint.MARKDOWNLINT_CONFIG_PATH}`);
+		} else yield* Effect.log(`${CHECK_MARK} ${Lint.MARKDOWNLINT_CONFIG_PATH}: up-to-date`);
+	});
+}
+/**
+* Find and sync biome config `$schema` URLs to match the peer dependency version.
+*
+* @returns Effect that syncs biome schemas and logs results
+*/
+function syncBiomeSchemas() {
+	return Effect.gen(function* () {
+		const version = process.env.__BIOME_PEER_VERSION__;
+		if (!version) return;
+		const result = yield* (yield* BiomeSchemaSync).sync(version);
+		for (const configPath of result.current) yield* Effect.log(`${CHECK_MARK} ${configPath}: biome $schema up-to-date`);
+		for (const configPath of result.updated) yield* Effect.log(`${CHECK_MARK} Updated $schema in ${configPath}`);
+	});
+}
+/* v8 ignore start -- CLI option definitions; handler tested individually */
+const forceOption = Options.boolean("force").pipe(Options.withAlias("f"), Options.withDescription("Overwrite the pre-commit hook and config file entirely (managed sections in post-checkout/post-merge are never force-reset)"), Options.withDefault(false));
+const configOption = Options.text("config").pipe(Options.withAlias("c"), Options.withDescription("Relative path for the lint-staged config file (from repo root)"), Options.withDefault(Lint.DEFAULT_CONFIG_PATH));
+const presetOption = Options.choice("preset", [
+	"minimal",
+	"standard",
+	"silk"
+]).pipe(Options.withAlias("p"), Options.withDescription("Preset to use: minimal, standard, or silk"), Options.withDefault("silk"));
+/* v8 ignore stop */
+/** Make a file executable. */
+function makeExecutable(path) {
+	return Effect.tryPromise({
+		try: () => chmod(path, EXECUTABLE_MODE),
+		catch: (e) => new Error(String(e))
+	});
+}
+/** Ensure a hook file exists, writing `header` if it does not. */
+function ensureHookFile(path, header) {
+	return Effect.gen(function* () {
+		const fs = yield* FileSystem.FileSystem;
+		if (!(yield* fs.exists(path))) yield* fs.writeFileString(path, header);
+	});
+}
+/**
+* Run the full lint init pipeline.
+*
+* Exported so Task B5's unified `savvy init` orchestrator can invoke the
+* lint-staged init step directly without going through the CLI command layer.
+*
+* @param opts - The same options the CLI command receives
+* @returns An Effect that performs initialization
+*
+* @internal
+*/
+function runLintInit(opts) {
+	const { force, config, preset } = opts;
+	return Effect.gen(function* () {
+		const fs = yield* FileSystem.FileSystem;
+		const ms = yield* ManagedSection;
+		if (config.startsWith("/")) yield* Effect.fail(/* @__PURE__ */ new Error("Config path must be relative to repository root, not absolute"));
+		yield* Effect.log("Initializing lint-staged configuration...\n");
+		yield* fs.makeDirectory(".husky", { recursive: true });
+		if (force) yield* fs.writeFileString(Lint.HUSKY_HOOK_PATH, PRE_COMMIT_HEADER);
+		else yield* ensureHookFile(Lint.HUSKY_HOOK_PATH, PRE_COMMIT_HEADER);
+		const preCommitResults = yield* ms.syncMany(Lint.HUSKY_HOOK_PATH, [SavvyBaseSection.block(savvyBasePreamble()), Lint.savvyLintBlock(config)]);
+		yield* makeExecutable(Lint.HUSKY_HOOK_PATH);
+		yield* Effect.log(`${CHECK_MARK} ${force ? "Replaced" : "Synced"} ${Lint.HUSKY_HOOK_PATH} (${preCommitResults.map((r) => r._tag).join(", ")})`);
+		if (presetIncludesShellScripts(preset)) for (const hookPath of [Lint.POST_CHECKOUT_HOOK_PATH, Lint.POST_MERGE_HOOK_PATH]) {
+			yield* ensureHookFile(hookPath, HYGIENE_HEADER);
+			yield* ms.remove(hookPath, Lint.LegacySavvyLintHygieneDef);
+			yield* ms.sync(hookPath, SavvyHooksSection.block(savvyHooksHygiene()));
+			yield* makeExecutable(hookPath);
+			yield* Effect.log(`${CHECK_MARK} Synced ${hookPath}`);
+		}
+		if (presetIncludesMarkdown(preset)) yield* writeMarkdownlintConfig(fs, preset, force);
+		yield* syncBiomeSchemas().pipe(Effect.catchTag("BiomeSyncError", (e) => Effect.log(`${WARNING} Could not sync biome $schema: ${e.message}`)));
+		if ((yield* fs.exists(config)) && !force) yield* Effect.log(`${WARNING} ${config} already exists (use --force to overwrite)`);
+		else {
+			const configDir = dirname(config);
+			if (configDir && configDir !== ".") yield* fs.makeDirectory(configDir, { recursive: true });
+			yield* fs.writeFileString(config, generateConfigContent(preset));
+			yield* Effect.log(`${CHECK_MARK} Created ${config} (preset: ${preset})`);
+		}
+		yield* Effect.log("\nDone! Lint-staged is ready to use.");
+	});
+}
+/**
+* Init command implementation.
+*
+* @remarks
+* Writes:
+* - `.husky/pre-commit` — `savvy-base` preamble + `savvy-lint` tool section, in order
+*   (via `ManagedSection.syncMany`).
+* - `.husky/post-checkout` and `.husky/post-merge` — co-owned `savvy-hooks` hygiene
+*   (idempotent, shared with `@savvy-web/commitlint`). Migrates legacy `SAVVY-LINT`
+*   hygiene blocks by removing them before writing the new section.
+* - `lib/configs/.markdownlint-cli2.jsonc` config (when preset includes Markdown).
+* - lint-staged config at the specified path.
+*
+* Users may add custom commands above, below, or between the managed sections.
+* `--force` resets only the pre-commit hook and the config file; the hygiene sections
+* are always reconciled with `sync`.
+*/
+/* v8 ignore next 3 -- CLI registration; handler tested via runLintInit */
+const initCommand = Command.make("init", {
+	force: forceOption,
+	config: configOption,
+	preset: presetOption
+}, (opts) => runLintInit(opts)).pipe(Command.withDescription("Initialize lint-staged configuration and husky hooks"));
+
+//#endregion
+export { runLintInit };