@chanom/cli 0.4.0 → 0.4.1

package/README.md

@@ -72,6 +72,12 @@ installing anything. `light` sweetness works anywhere in the repo.
 
 \* `.mts` instead of `.ts` when your project is CommonJS (no `"type": "module"` in `package.json`).
 
+oxlint and oxfmt auto-discover `.js`, `.cjs`, `.mjs`, `.ts`, and the JSON rc files, but not
+`.mts` or `.cts`. When the config in play is one of those two, the generated `oxlint`/`oxfmt`
+scripts - and the lint-staged commands - name it with `-c`. This tracks the file that actually
+ends up on disk, so it applies to a config `brew` detected and skipped just as much as one it
+wrote itself.
+
 Config files re-export presets from [`@chanom/dev-config`](../dev-config).
 
 The `vscode` topping installs no packages and adds no scripts. It writes editor

package/dist/index.js

@@ -257,7 +257,7 @@ const SKILLS = [{
 		},
 		{
 			"path": "SKILL.md",
-			"contents": "---\nname: coding-standards\ndescription: Coding standards for this Vite + React + TypeScript app. Use when writing or changing components, hooks, utils, or tests, and before committing.\n---\n\n# Coding standards\n\nVite + React 19 + TypeScript, scaffolded with `create-chanom-app`. oxlint lints,\noxfmt formats, vitest tests. Read the reference for what you touch **before**\nwriting, so new code matches the code already here.\n\n## Which reference to load\n\n| You are writing…                             | Load                       |\n| -------------------------------------------- | -------------------------- |\n| Any `.ts` / `.tsx` file                      | `references/typescript.md` |\n| A component, hook, or anything rendering JSX | `references/react.md`      |\n| A `*.test.ts` / `*.test.tsx` file            | `references/vitest.md`     |\n\nThese layer: a new component with a test reads all three. Load every row that\napplies.\n\n## Universal rules\n\n- Filenames are kebab-case: `user-card.tsx`, `use-current-user.ts`, `format-date.ts`.\n- Before adding a file, open two neighbouring files of the same kind and match\n  their shape — import order, export style, test naming.\n- Source lives under `src/`. Colocate a test beside the code it covers:\n  `src/utils/format-date.ts` → `src/utils/format-date.test.ts`.\n\n## Verify\n\nAfter implementing, from the project root:\n\n```sh\npnpm lint\npnpm test\npnpm build\n```\n\nDone only when all three exit clean. On failure, fix and rerun until they do.\nRun `pnpm format` before committing. Comment- or doc-only changes may skip all\nfour.\n\n## Committing\n\nAsk before committing. Use conventional commits under 100 characters:\n`<type>(<scope>): <subject>`, e.g. `feat(auth): add sign-out button`. Scope is\nthe area you touched, not the repo name.\n"
+			"contents": "---\nname: coding-standards\ndescription: Coding standards for this Vite + React + TypeScript app. Use when writing or changing components, hooks, utils, or tests, and before committing.\n---\n\n# Coding standards\n\nVite + React 19 + TypeScript, scaffolded with `create-chanom-app`. oxlint lints,\noxfmt formats, vitest tests. Read the reference for what you touch **before**\nwriting, so new code matches the code already here.\n\n## Which reference to load\n\n| You are writing…                             | Load                       |\n| -------------------------------------------- | -------------------------- |\n| Any `.ts` / `.tsx` file                      | `references/typescript.md` |\n| A component, hook, or anything rendering JSX | `references/react.md`      |\n| A `*.test.ts` / `*.test.tsx` file            | `references/vitest.md`     |\n\nThese layer: a new component with a test reads all three. Load every row that\napplies.\n\n## Universal rules\n\n- Filenames are kebab-case: `user-card.tsx`, `use-current-user.ts`, `format-date.ts`.\n- Before adding a file, open two neighbouring files of the same kind and match\n  their shape — import order, export style, test naming.\n- Source lives under `src/`. Colocate a test beside the code it covers:\n  `src/utils/format-date.ts` → `src/utils/format-date.test.ts`.\n\n## Verify\n\nAfter implementing, from the project root:\n\n```sh\npnpm lint\npnpm test\npnpm build\npnpm typecheck\n```\n\nDone only when all four exit clean. On failure, fix and rerun until they do.\nRun `pnpm format` before committing. Comment- or doc-only changes may skip all\nfour.\n\n## Committing\n\nAsk before committing. Use conventional commits under 100 characters:\n`<type>(<scope>): <subject>`, e.g. `feat(auth): add sign-out button`. Scope is\nthe area you touched, not the repo name.\n"
 		}
 	]
 }];
@@ -424,6 +424,32 @@ const SETUP_FILE_CANDIDATES = {
 		"vite.config.mjs"
 	]
 };
+/** Config file name a tool gets scaffolded with, matching the project's module system. */
+function configFileName(tool, esm) {
+	return `${tool}.config.${esm ? "ts" : "mts"}`;
+}
+/**
+* Extensions oxlint/oxfmt resolve on their own. `.mts`/`.cts` are absent
+* deliberately: the tools only auto-discover the plain `.ts` variant, so a
+* config using one of those has to be named explicitly on the command line.
+*/
+const AUTO_DISCOVERED = /* @__PURE__ */ new Set([
+	"js",
+	"cjs",
+	"mjs",
+	"ts",
+	"json"
+]);
+/**
+* `-c <config>` argument naming the config file, or an empty string when the
+* tool finds the file by itself. `configFile` is the config that will actually
+* be on disk - the one chanom is about to write, or an existing one it detected
+* and skipped - so the generated scripts never point at a path that isn't there.
+*/
+function configFlag(configFile) {
+	const extension = configFile.slice(configFile.lastIndexOf(".") + 1);
+	return AUTO_DISCOVERED.has(extension) ? "" : ` -c ${configFile}`;
+}
 //#endregion
 //#region src/utils/detect-setup.ts
 /** Finds an existing config file for the given tool, if any. */
@@ -523,7 +549,7 @@ function getPackages$3(pkg, versions) {
 }
 function configFile$2(esm) {
 	return {
-		fileName: `knip.config.${esm ? "ts" : "mts"}`,
+		fileName: configFileName("knip", esm),
 		contents: `export { default } from '@chanom/dev-config/knip/config';\n`
 	};
 }
@@ -555,22 +581,42 @@ const apply$5 = Effect.fn("add-knip.apply")(function* (cwd, esm, pkg) {
 function getPackages$2(pkg) {
 	return isPackageInstalled(pkg, "lint-staged") ? [] : ["lint-staged"];
 }
-function buildConfig(linters, formatters) {
+function buildConfig(linters, formatters, configFiles) {
 	const config = {};
 	const jsGlob = "**/*.{js,jsx,ts,tsx,mjs,cjs,mts,cts}";
 	if (linters.includes("oxlint")) {
 		config[jsGlob] ??= [];
-		config[jsGlob].push("oxlint --fix --no-error-on-unmatched-pattern");
+		config[jsGlob].push(`oxlint --fix${configFlag(configFiles.oxlint)} --no-error-on-unmatched-pattern`);
 	}
 	if (formatters.includes("oxfmt")) {
 		config["*"] ??= [];
-		config["*"].push("oxfmt --no-error-on-unmatched-pattern");
+		config["*"].push(`oxfmt${configFlag(configFiles.oxfmt)} --no-error-on-unmatched-pattern`);
 	}
 	return config;
 }
 //#endregion
 //#region src/commands/add-lint-staged/index.ts
-const apply$4 = Effect.fn("add-lint-staged.apply")(function* (cwd, linters = [], formatters = [], overwritePreCommit = false) {
+/**
+* Config file each tool will run against: an existing one when `add-oxlint` /
+* `add-oxfmt` skipped writing, otherwise the name they scaffold. lint-staged
+* invokes the same binaries as the package scripts, so it has to resolve the
+* config the same way.
+*/
+const resolveConfigFiles = Effect.fn("add-lint-staged.resolveConfigFiles")(function* (cwd, esm) {
+	const path = yield* Path.Path;
+	const resolve = Effect.fn(function* (tool) {
+		const existing = yield* detectSetupFile(tool, cwd);
+		return Option.match(existing, {
+			onNone: () => configFileName(tool, esm),
+			onSome: (file) => path.basename(file)
+		});
+	});
+	return {
+		oxlint: yield* resolve("oxlint"),
+		oxfmt: yield* resolve("oxfmt")
+	};
+});
+const apply$4 = Effect.fn("add-lint-staged.apply")(function* (cwd, esm, linters = [], formatters = [], overwritePreCommit = false) {
 	if (linters.length === 0 && formatters.length === 0) {
 		yield* Effect.logDebug("no linters or formatters selected - skipping lint-staged setup");
 		return;
@@ -580,7 +626,10 @@ const apply$4 = Effect.fn("add-lint-staged.apply")(function* (cwd, linters = [],
 	const prompter = yield* Prompter;
 	const existing = yield* detectSetupFile("lint-staged", cwd);
 	if (Option.isSome(existing)) yield* prompter.warn(`\`${path.basename(existing.value)}\` already exists - skipping lint-staged config`);
-	else yield* fs.writeFileString(path.join(cwd, ".lintstagedrc.json"), JSON.stringify(buildConfig(linters, formatters), null, 2) + "\n");
+	else {
+		const configFiles = yield* resolveConfigFiles(cwd, esm);
+		yield* fs.writeFileString(path.join(cwd, ".lintstagedrc.json"), JSON.stringify(buildConfig(linters, formatters, configFiles), null, 2) + "\n");
+	}
 	const huskyDir = path.join(cwd, ".husky");
 	if (yield* fs.exists(huskyDir)) {
 		const hookPath = path.join(huskyDir, "pre-commit");
@@ -595,14 +644,15 @@ function getPackages$1(pkg, versions) {
 }
 function configFile$1(esm) {
 	return {
-		fileName: `oxfmt.config.${esm ? "ts" : "mts"}`,
+		fileName: configFileName("oxfmt", esm),
 		contents: `export { default } from '@chanom/dev-config/oxfmt/config';\n`
 	};
 }
-function getScriptPlan$1(scripts) {
+function getScriptPlan$1(scripts, configFile) {
+	const config = configFlag(configFile);
 	return planScripts(scripts, {
-		format: "oxfmt",
-		"format:check": "oxfmt --check"
+		format: `oxfmt${config}`,
+		"format:check": `oxfmt --check${config}`
 	});
 }
 //#endregion
@@ -613,12 +663,16 @@ const apply$3 = Effect.fn("add-oxfmt.apply")(function* (cwd, esm, pkg) {
 	const path = yield* Path.Path;
 	const prompter = yield* Prompter;
 	const existing = yield* detectSetupFile("oxfmt", cwd);
-	if (Option.isSome(existing)) yield* prompter.warn(`\`${path.basename(existing.value)}\` already exists - skipping oxfmt config`);
-	else {
+	let configFileName;
+	if (Option.isSome(existing)) {
+		configFileName = path.basename(existing.value);
+		yield* prompter.warn(`\`${configFileName}\` already exists - skipping oxfmt config`);
+	} else {
 		const config = configFile$1(esm);
+		configFileName = config.fileName;
 		yield* fs.writeFileString(path.join(cwd, config.fileName), config.contents);
 	}
-	const plan = getScriptPlan$1(pkg.scripts);
+	const plan = getScriptPlan$1(pkg.scripts, configFileName);
 	for (const key of plan.skipped) yield* prompter.warn(`\`${key}\` script already exists in package.json - skipping`);
 	return {
 		...pkg,
@@ -636,14 +690,15 @@ function getPackages(pkg, versions) {
 }
 function configFile(esm) {
 	return {
-		fileName: `oxlint.config.${esm ? "ts" : "mts"}`,
+		fileName: configFileName("oxlint", esm),
 		contents: `export { default } from '@chanom/dev-config/oxlint/config';\n`
 	};
 }
-function getScriptPlan(scripts) {
+function getScriptPlan(scripts, configFile) {
+	const config = configFlag(configFile);
 	return planScripts(scripts, {
-		lint: "oxlint",
-		"lint:fix": "oxlint --fix"
+		lint: `oxlint${config}`,
+		"lint:fix": `oxlint --fix${config}`
 	});
 }
 //#endregion
@@ -654,12 +709,16 @@ const apply$2 = Effect.fn("add-oxlint.apply")(function* (cwd, esm, pkg) {
 	const path = yield* Path.Path;
 	const prompter = yield* Prompter;
 	const existing = yield* detectSetupFile("oxlint", cwd);
-	if (Option.isSome(existing)) yield* prompter.warn(`\`${path.basename(existing.value)}\` already exists - skipping oxlint config`);
-	else {
+	let configFileName;
+	if (Option.isSome(existing)) {
+		configFileName = path.basename(existing.value);
+		yield* prompter.warn(`\`${configFileName}\` already exists - skipping oxlint config`);
+	} else {
 		const config = configFile(esm);
+		configFileName = config.fileName;
 		yield* fs.writeFileString(path.join(cwd, config.fileName), config.contents);
 	}
-	const plan = getScriptPlan(pkg.scripts);
+	const plan = getScriptPlan(pkg.scripts, configFileName);
 	for (const key of plan.skipped) yield* prompter.warn(`\`${key}\` script already exists in package.json - skipping`);
 	return {
 		...pkg,
@@ -810,7 +869,7 @@ function planPackages(pkg, toppings, sweetness, versions) {
 * value for a config the user may add later.
 */
 function oxfmtConfigPath(esm) {
-	return `oxfmt.config.${esm ? "ts" : "mts"}`;
+	return configFileName("oxfmt", esm);
 }
 /** True when at least one topping gives lint-staged something to run. */
 function wantsLintStaged(toppings) {
@@ -953,14 +1012,14 @@ const ensureRepoRootForHooks = Effect.fn("brew.ensureRepoRootForHooks")(function
 		root: Option.getOrElse(root, () => cwd)
 	});
 });
-const setupCommitGate = Effect.fn("brew.setupCommitGate")(function* (cwd, pm, toppings, sweetness) {
+const setupCommitGate = Effect.fn("brew.setupCommitGate")(function* (cwd, pm, esm, toppings, sweetness) {
 	if (sweetness !== "medium") return;
 	const fs = yield* FileSystem.FileSystem;
 	const path = yield* Path.Path;
 	const prompter = yield* Prompter;
 	const huskyExisted = yield* fs.exists(path.join(cwd, ".husky"));
 	yield* apply$6(cwd, pm);
-	if (wantsLintStaged(toppings)) yield* apply$4(cwd, selectedLinters(toppings), selectedFormatters(toppings), !huskyExisted);
+	if (wantsLintStaged(toppings)) yield* apply$4(cwd, esm, selectedLinters(toppings), selectedFormatters(toppings), !huskyExisted);
 	else {
 		yield* prompter.warn("No linters or formatters selected - skipping lint-staged");
 		const seededHook = path.join(cwd, ".husky", "pre-commit");
@@ -1003,7 +1062,7 @@ const brew = (cwd = process.cwd()) => Effect.gen(function* () {
 	yield* installPackages(pm, cwd, packages);
 	const { pkg: installedPkg } = yield* readPkg(cwd);
 	yield* persistScripts(pkgPath, installedPkg, yield* applyToppings(cwd, isEsm(installedPkg), installedPkg, toppings));
-	yield* setupCommitGate(cwd, pm, toppings, sweetness);
+	yield* setupCommitGate(cwd, pm, isEsm(installedPkg), toppings, sweetness);
 	yield* commitChanges(cwd);
 	yield* prompter.outro(pc.green(`Your Chanom with ${toppings.join(", ")} toppings and ${sweetness} sweetness is ready! Enjoy! 🧋`));
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chanom/cli",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "",
   "keywords": [],
   "repository": {
@@ -40,6 +40,7 @@
     "dev": "tsdown --watch",
     "test": "vitest run",
     "test:coverage": "vitest run --coverage",
-    "test:watch": "vitest"
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit"
   }
 }