@chanom/cli 0.0.1 → 0.0.3

package/README.md

@@ -0,0 +1,62 @@
+# @chanom/cli
+
+Interactive CLI that brews dev tooling config into your project - oxlint, oxfmt, knip, and commit hooks, picked with a couple of prompts.
+
+## Install
+
+Run it directly, no install needed:
+
+```sh
+npx @chanom/cli brew
+# or
+pnpm dlx @chanom/cli brew
+```
+
+or if you want to install it within your project:
+
+```sh
+pnpm add -D @chanom/cli
+```
+
+## Usage
+
+```sh
+chanom brew
+```
+
+`brew` walks you through two prompts:
+
+1. **Toppings** - which tools to add, any combination of:
+   - `oxlint` - fast Rust-based linter
+   - `oxfmt` - fast Rust-based formatter
+   - `knip` - dead code remover
+2. **Sweetness** - how strict to be:
+   - `light` - warn only, no blocking
+   - `medium` - block on commit via husky + lint-staged + commitlint
+
+Based on your answers, `brew` will:
+
+- Initialize a git repo if one doesn't exist yet (with a `.gitignore`)
+- Detect your package manager (`pnpm`, `npm`, `yarn`, or `bun`) from `package.json`/`packageManager` or the invoking user agent
+- Install the packages needed for your selected toppings, skipping any already installed
+- Write config files (`oxlint.config.ts`, `oxfmt.config.ts`, `knip.config.ts`, `.commitlintrc.json`, `.lintstagedrc.json`) and wire up `package.json` scripts
+- If `medium` sweetness is selected, run `husky init` and add `pre-commit` / `commit-msg` hooks
+- Stage and commit the changes it made
+
+## What gets added
+
+| Topping  | Config file        | Scripts added            |
+| -------- | ------------------ | ------------------------ |
+| `oxlint` | `oxlint.config.ts` | `lint`, `lint:fix`       |
+| `oxfmt`  | `oxfmt.config.ts`  | `format`, `format:check` |
+| `knip`   | `knip.config.ts`   | `knip`                   |
+
+Config files re-export presets from [`@chanom/dev-config`](../dev-config).
+
+`medium` sweetness additionally adds:
+
+- `husky` - installed via `husky init`
+- `lint-staged` - `.lintstagedrc.json` running the selected linter/formatter on staged files
+- `commitlint` - `.commitlintrc.json` extending `@commitlint/config-conventional`, enforced in the `commit-msg` hook
+
+Existing scripts and config are never overwritten - if a script name already exists in `package.json`, `brew` logs a warning and leaves it alone.

package/dist/index.js

@@ -1,10 +1,21 @@
 #!/usr/bin/env node
 import { intro, log, multiselect, outro, select, spinner } from "@clack/prompts";
-import pc from "picocolors";
 import { existsSync, readFileSync, writeFileSync } from "node:fs";
-import { join } from "node:path";
+import { basename, join } from "node:path";
+import pc from "picocolors";
 import { spawnSync } from "node:child_process";
 //#region src/utils/detect-pm.ts
+/** How to run a locally installed binary with each package manager. */
+const PM_EXEC = {
+	pnpm: ["pnpm", "exec"],
+	npm: [
+		"npx",
+		"--no",
+		"--"
+	],
+	yarn: ["yarn"],
+	bun: ["bunx"]
+};
 const KNOWN_PMS = [
 	"pnpm",
 	"yarn",
@@ -92,14 +103,14 @@ function writeGitignore(cwd, contents = "node_modules\n") {
 //#endregion
 //#region src/utils/install.ts
 function installDev(pm, cwd, ...packages) {
-	spawnSync(pm, [
+	return spawnSync(pm, [
 		"add",
 		"-D",
 		...packages
 	], {
 		stdio: "inherit",
 		cwd
-	});
+	}).status === 0;
 }
 //#endregion
 //#region src/utils/pkg.ts
@@ -108,6 +119,7 @@ function isEsm(pkg) {
 }
 function readPkg(cwd) {
 	const pkgPath = join(cwd, "package.json");
+	if (!existsSync(pkgPath)) throw new Error(`No package.json found in ${cwd}`);
 	return {
 		pkg: JSON.parse(readFileSync(pkgPath, "utf-8")),
 		pkgPath
@@ -117,46 +129,90 @@ function isPackageInstalled(pkg, name) {
 	return name in (pkg.dependencies ?? {}) || name in (pkg.devDependencies ?? {});
 }
 //#endregion
+//#region src/utils/detect-setup.ts
+const CONFIG_FILES = {
+	oxlint: [
+		"oxlint.config.js",
+		"oxlint.config.cjs",
+		"oxlint.config.mjs",
+		"oxlint.config.ts",
+		"oxlint.config.cts",
+		"oxlint.config.mts",
+		".oxlintrc.json"
+	],
+	oxfmt: [
+		"oxfmt.config.js",
+		"oxfmt.config.cjs",
+		"oxfmt.config.mjs",
+		"oxfmt.config.ts",
+		"oxfmt.config.cts",
+		"oxfmt.config.mts",
+		".oxfmtrc.json"
+	],
+	knip: [
+		"knip.json",
+		"knip.ts",
+		"knip.config.ts",
+		"knip.config.mts",
+		".knip.json"
+	],
+	husky: [".husky"],
+	"lint-staged": [
+		".lintstagedrc.json",
+		".lintstagedrc.js",
+		"lint-staged.config.js"
+	],
+	commitlint: [
+		".commitlintrc.json",
+		".commitlintrc.js",
+		"commitlint.config.js"
+	],
+	vite: [
+		"vite.config.ts",
+		"vite.config.js",
+		"vite.config.mjs"
+	]
+};
+function detectSetupFile(type, cwd = process.cwd()) {
+	for (const filename of CONFIG_FILES[type]) {
+		const filepath = join(cwd, filename);
+		if (existsSync(filepath)) return filepath;
+	}
+	return null;
+}
+//#endregion
 //#region src/commands/add-commitlint/index.ts
-function getPackages$7(pkg) {
+function getPackages$5(pkg) {
 	const missing = [];
 	if (!isPackageInstalled(pkg, "@commitlint/cli")) missing.push("@commitlint/cli");
 	if (!isPackageInstalled(pkg, "@commitlint/config-conventional")) missing.push("@commitlint/config-conventional");
 	return missing;
 }
-function apply$7(cwd) {
-	writeFileSync(join(cwd, ".commitlintrc.json"), JSON.stringify({ extends: ["@commitlint/config-conventional"] }, null, 2) + "\n");
-	if (existsSync(join(cwd, ".husky"))) writeFileSync(join(cwd, ".husky", "commit-msg"), "npx --no -- commitlint --edit $1\n");
-}
-//#endregion
-//#region src/commands/add-eslint/index.ts
-function getPackages$6(pkg) {
-	return isPackageInstalled(pkg, "eslint") ? [] : ["eslint"];
-}
-function apply$6(cwd, esm) {
-	writeFileSync(join(cwd, `eslint.config.${esm ? "ts" : "mts"}`), `export { default } from '@chanom/dev-config/eslint/config';\n`);
-	const { pkg, pkgPath } = readPkg(cwd);
-	pkg.scripts ??= {};
-	const missing = {};
-	if (!pkg.scripts["lint"]) missing["lint"] = "eslint .";
-	if (!pkg.scripts["lint:fix"]) missing["lint:fix"] = "eslint . --fix";
-	for (const [key, value] of Object.entries(missing)) pkg.scripts[key] = value;
-	const skipped = ["lint", "lint:fix"].filter((k) => !(k in missing));
-	for (const key of skipped) log.warn(`\`${key}\` script already exists in package.json - skipping`);
-	if (Object.keys(missing).length > 0) writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + "\n");
+function apply$5(cwd, pm) {
+	const existing = detectSetupFile("commitlint", cwd);
+	if (existing) log.warn(`\`${basename(existing)}\` already exists - skipping commitlint config`);
+	else writeFileSync(join(cwd, ".commitlintrc.json"), JSON.stringify({ extends: ["@commitlint/config-conventional"] }, null, 2) + "\n");
+	if (existsSync(join(cwd, ".husky"))) {
+		const hookPath = join(cwd, ".husky", "commit-msg");
+		if (existsSync(hookPath)) log.warn("`.husky/commit-msg` already exists - skipping");
+		else writeFileSync(hookPath, [
+			...PM_EXEC[pm],
+			"commitlint",
+			"--edit",
+			"$1"
+		].join(" ") + "\n");
+	}
 }
 //#endregion
 //#region src/commands/add-husky/index.ts
-const PM_EXEC = {
-	pnpm: ["pnpm", "exec"],
-	npm: ["npx"],
-	yarn: ["yarn"],
-	bun: ["bunx"]
-};
-function getPackages$5(pkg) {
+function getPackages$4(pkg) {
 	return isPackageInstalled(pkg, "husky") ? [] : ["husky"];
 }
-function apply$5(cwd, pm) {
+function apply$4(cwd, pm) {
+	if (existsSync(join(cwd, ".husky"))) {
+		log.warn("`.husky` already exists - skipping husky init");
+		return;
+	}
 	const [cmd, ...args] = PM_EXEC[pm];
 	spawnSync(cmd, [
 		...args,
@@ -168,46 +224,55 @@ function apply$5(cwd, pm) {
 	});
 }
 //#endregion
+//#region src/commands/add-knip/logic.ts
+function getMissingScripts$2(scripts) {
+	const missing = {};
+	if (!scripts["knip"]) missing["knip"] = "knip";
+	return missing;
+}
+//#endregion
 //#region src/commands/add-knip/index.ts
-function getPackages$4(pkg) {
-	return isPackageInstalled(pkg, "knip") ? [] : ["knip"];
+function getPackages$3(pkg) {
+	return isPackageInstalled(pkg, "knip") ? [] : [`knip@6.23.0`, `@chanom/dev-config@0.0.3`];
 }
-function apply$4(cwd) {
-	writeFileSync(join(cwd, "knip.json"), JSON.stringify({ entry: ["src/index.ts"] }, null, 2) + "\n");
+function apply$3(cwd, esm) {
+	const existing = detectSetupFile("knip", cwd);
+	if (existing) log.warn(`\`${basename(existing)}\` already exists - skipping knip config`);
+	else writeFileSync(join(cwd, `knip.config.${esm ? "ts" : "mts"}`), `export { default } from '@chanom/dev-config/knip/config';\n`);
 	const { pkg, pkgPath } = readPkg(cwd);
 	pkg.scripts ??= {};
-	if (pkg.scripts["knip"]) log.warn("`knip` script already exists in package.json - skipping");
-	else {
-		pkg.scripts["knip"] = "knip";
-		writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + "\n");
-	}
+	const missing = getMissingScripts$2(pkg.scripts);
+	for (const [key, value] of Object.entries(missing)) pkg.scripts[key] = value;
+	const skipped = ["knip"].filter((k) => !(k in missing));
+	for (const key of skipped) log.warn(`\`${key}\` script already exists in package.json - skipping`);
+	if (Object.keys(missing).length > 0) writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + "\n");
 }
 //#endregion
 //#region src/commands/add-lint-staged/index.ts
-function getPackages$3(pkg) {
+function getPackages$2(pkg) {
 	return isPackageInstalled(pkg, "lint-staged") ? [] : ["lint-staged"];
 }
-function apply$3(cwd, linters = [], formatters = []) {
-	const config = {};
-	const jsGlob = "**/*.{js,jsx,ts,tsx,mjs,cjs,mts,cts}";
-	if (linters.includes("oxlint")) {
-		config[jsGlob] ??= [];
-		config[jsGlob].push("oxlint --fix");
-	}
-	if (linters.includes("eslint")) {
-		config[jsGlob] ??= [];
-		config[jsGlob].push("eslint --fix");
-	}
-	if (formatters.includes("oxfmt")) {
-		config["*"] ??= [];
-		config["*"].push("oxfmt");
+function apply$2(cwd, linters = [], formatters = [], overwritePreCommit = false) {
+	const existing = detectSetupFile("lint-staged", cwd);
+	if (existing) log.warn(`\`${basename(existing)}\` already exists - skipping lint-staged config`);
+	else {
+		const config = {};
+		const jsGlob = "**/*.{js,jsx,ts,tsx,mjs,cjs,mts,cts}";
+		if (linters.includes("oxlint")) {
+			config[jsGlob] ??= [];
+			config[jsGlob].push("oxlint --fix");
+		}
+		if (formatters.includes("oxfmt")) {
+			config["*"] ??= [];
+			config["*"].push("oxfmt");
+		}
+		writeFileSync(join(cwd, ".lintstagedrc.json"), JSON.stringify(config, null, 2) + "\n");
 	}
-	if (formatters.includes("prettier")) {
-		config["*"] ??= [];
-		config["*"].push("prettier --ignore-unknown --write");
+	if (existsSync(join(cwd, ".husky"))) {
+		const hookPath = join(cwd, ".husky", "pre-commit");
+		if (existsSync(hookPath) && !overwritePreCommit) log.warn("`.husky/pre-commit` already exists - skipping");
+		else writeFileSync(hookPath, "lint-staged\n");
 	}
-	writeFileSync(join(cwd, ".lintstagedrc.json"), JSON.stringify(config, null, 2) + "\n");
-	if (existsSync(join(cwd, ".husky"))) writeFileSync(join(cwd, ".husky", "pre-commit"), "lint-staged\n");
 }
 //#endregion
 //#region src/commands/add-oxfmt/logic.ts
@@ -219,11 +284,13 @@ function getMissingScripts$1(scripts) {
 }
 //#endregion
 //#region src/commands/add-oxfmt/index.ts
-function getPackages$2(pkg) {
-	return isPackageInstalled(pkg, "oxfmt") ? [] : [`oxfmt@0.56.0`, "@chanom/dev-config"];
+function getPackages$1(pkg) {
+	return isPackageInstalled(pkg, "oxfmt") ? [] : [`oxfmt@0.56.0`, `@chanom/dev-config@0.0.3`];
 }
-function apply$2(cwd, esm) {
-	writeFileSync(join(cwd, `oxfmt.config.${esm ? "ts" : "mts"}`), `export { default } from '@chanom/dev-config/oxfmt/config';\n`);
+function apply$1(cwd, esm) {
+	const existing = detectSetupFile("oxfmt", cwd);
+	if (existing) log.warn(`\`${basename(existing)}\` already exists - skipping oxfmt config`);
+	else writeFileSync(join(cwd, `oxfmt.config.${esm ? "ts" : "mts"}`), `export { default } from '@chanom/dev-config/oxfmt/config';\n`);
 	const { pkg, pkgPath } = readPkg(cwd);
 	pkg.scripts ??= {};
 	const missing = getMissingScripts$1(pkg.scripts);
@@ -242,11 +309,13 @@ function getMissingScripts(scripts) {
 }
 //#endregion
 //#region src/commands/add-oxlint/index.ts
-function getPackages$1(pkg) {
-	return isPackageInstalled(pkg, "oxlint") ? [] : [`oxlint@1.71.0`, "@chanom/dev-config"];
+function getPackages(pkg) {
+	return isPackageInstalled(pkg, "oxlint") ? [] : [`oxlint@1.71.0`, `@chanom/dev-config@0.0.3`];
 }
-function apply$1(cwd, esm) {
-	writeFileSync(join(cwd, `oxlint.config.${esm ? "ts" : "mts"}`), `export { default } from '@chanom/dev-config/oxlint/config';\n`);
+function apply(cwd, esm) {
+	const existing = detectSetupFile("oxlint", cwd);
+	if (existing) log.warn(`\`${basename(existing)}\` already exists - skipping oxlint config`);
+	else writeFileSync(join(cwd, `oxlint.config.${esm ? "ts" : "mts"}`), `export { default } from '@chanom/dev-config/oxlint/config';\n`);
 	const { pkg, pkgPath } = readPkg(cwd);
 	pkg.scripts ??= {};
 	const missing = getMissingScripts(pkg.scripts);
@@ -256,23 +325,6 @@ function apply$1(cwd, esm) {
 	if (Object.keys(missing).length > 0) writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + "\n");
 }
 //#endregion
-//#region src/commands/add-prettier/index.ts
-function getPackages(pkg) {
-	return isPackageInstalled(pkg, "prettier") ? [] : ["prettier"];
-}
-function apply(cwd) {
-	writeFileSync(join(cwd, ".prettierrc"), JSON.stringify({}, null, 2) + "\n");
-	const { pkg, pkgPath } = readPkg(cwd);
-	pkg.scripts ??= {};
-	const missing = {};
-	if (!pkg.scripts["format"]) missing["format"] = "prettier --write .";
-	if (!pkg.scripts["format:check"]) missing["format:check"] = "prettier --check .";
-	for (const [key, value] of Object.entries(missing)) pkg.scripts[key] = value;
-	const skipped = ["format", "format:check"].filter((k) => !(k in missing));
-	for (const key of skipped) log.warn(`\`${key}\` script already exists in package.json - skipping`);
-	if (Object.keys(missing).length > 0) writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + "\n");
-}
-//#endregion
 //#region src/commands/brew/index.ts
 async function brew(cwd = process.cwd()) {
 	intro(pc.magenta("🧋 Chanom - Let's brew your project!"));
@@ -284,6 +336,10 @@ async function brew(cwd = process.cwd()) {
 		s.stop("Git initialized");
 	}
 	const pm = detectPm(cwd);
+	if (!existsSync(join(cwd, "package.json"))) {
+		log.error(`No package.json found. Run \`${pm} init\` first, then re-run \`chanom brew\`.`);
+		process.exit(1);
+	}
 	const toppings = await multiselect({
 		message: "Which toppings would you like?",
 		options: [
@@ -297,20 +353,10 @@ async function brew(cwd = process.cwd()) {
 				label: "oxfmt",
 				hint: "fast Rust-based formatter"
 			},
-			{
-				value: "eslint",
-				label: "eslint",
-				hint: "stub config"
-			},
-			{
-				value: "prettier",
-				label: "prettier",
-				hint: "stub config"
-			},
 			{
 				value: "knip",
 				label: "knip",
-				hint: "stub config"
+				hint: "dead code remover"
 			}
 		],
 		required: false
@@ -332,28 +378,29 @@ async function brew(cwd = process.cwd()) {
 	const { pkg } = readPkg(cwd);
 	const esm = isEsm(pkg);
 	const packages = [];
-	if (toppings.includes("oxlint")) packages.push(...getPackages$1(pkg));
-	if (toppings.includes("oxfmt")) packages.push(...getPackages$2(pkg));
-	if (toppings.includes("eslint")) packages.push(...getPackages$6(pkg));
-	if (toppings.includes("prettier")) packages.push(...getPackages(pkg));
-	if (toppings.includes("knip")) packages.push(...getPackages$4(pkg));
-	if (sweetness === "medium") packages.push(...getPackages$5(pkg), ...getPackages$3(pkg), ...getPackages$7(pkg));
+	if (toppings.includes("oxlint")) packages.push(...getPackages(pkg));
+	if (toppings.includes("oxfmt")) packages.push(...getPackages$1(pkg));
+	if (toppings.includes("knip")) packages.push(...getPackages$3(pkg));
+	if (sweetness === "medium") packages.push(...getPackages$4(pkg), ...getPackages$2(pkg), ...getPackages$5(pkg));
 	if (packages.length > 0) {
 		const s = spinner();
 		const uniquePackages = Array.from(new Set(packages));
 		s.start(`Installing ${uniquePackages.join(", ")}...`);
-		installDev(pm, cwd, ...uniquePackages);
+		if (!installDev(pm, cwd, ...uniquePackages)) {
+			s.stop(pc.red("Package installation failed"));
+			log.error(`\`${pm} add -D\` failed. Fix the error above and re-run \`chanom brew\`.`);
+			process.exit(1);
+		}
 		s.stop("Packages installed");
 	}
-	if (toppings.includes("oxlint")) apply$1(cwd, esm);
-	if (toppings.includes("oxfmt")) apply$2(cwd, esm);
-	if (toppings.includes("eslint")) apply$6(cwd, esm);
-	if (toppings.includes("prettier")) apply(cwd);
-	if (toppings.includes("knip")) apply$4(cwd);
+	if (toppings.includes("oxlint")) apply(cwd, esm);
+	if (toppings.includes("oxfmt")) apply$1(cwd, esm);
+	if (toppings.includes("knip")) apply$3(cwd, esm);
 	if (sweetness === "medium") {
+		const huskyExisted = existsSync(join(cwd, ".husky"));
+		apply$4(cwd, pm);
+		apply$2(cwd, toppings.filter((t) => ["oxlint"].includes(t)), toppings.filter((t) => ["oxfmt"].includes(t)), !huskyExisted);
 		apply$5(cwd, pm);
-		apply$3(cwd, toppings.filter((t) => ["oxlint", "eslint"].includes(t)), toppings.filter((t) => ["oxfmt", "prettier"].includes(t)));
-		apply$7(cwd);
 	}
 	const s2 = spinner();
 	s2.start("Committing changes...");

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@chanom/cli",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "",
   "keywords": [],
-  "type": "module",
   "bin": {
     "chanom": "./dist/index.js"
   },
   "files": [
     "dist"
   ],
+  "type": "module",
   "dependencies": {
     "@clack/prompts": "1.6.0",
     "picocolors": "1.1.1"
@@ -20,7 +20,7 @@
     "@types/node": "26.0.1",
     "tsdown": "0.22.3",
     "typescript": "6.0.3",
-    "@chanom/dev-config": "0.0.2"
+    "@chanom/dev-config": "0.0.3"
   },
   "scripts": {
     "build": "tsdown",