@bensandee/tooling 0.2.0 → 0.4.0

package/dist/bin.mjs

@@ -48,18 +48,6 @@ const RenovateSchema = z.object({
 	$schema: z.string().optional(),
 	extends: z.array(z.string()).optional()
 }).loose();
-const KnipWorkspaceConfig = z.object({
-	entry: z.array(z.string()).optional(),
-	project: z.array(z.string()).optional(),
-	ignore: z.array(z.string()).optional()
-});
-const KnipSchema = z.object({
-	$schema: z.string().optional(),
-	entry: z.array(z.string()).optional(),
-	project: z.array(z.string()).optional(),
-	ignore: z.array(z.string()).optional(),
-	workspaces: z.record(z.string(), KnipWorkspaceConfig).optional()
-}).loose();
 /** Parse a JSONC string as a tsconfig.json. Returns a typed object with `{}` fallback on failure. */
 function parseTsconfig(raw) {
 	const result = TsconfigSchema.safeParse(parse(raw));
@@ -70,11 +58,6 @@ function parseRenovateJson(raw) {
 	const result = RenovateSchema.safeParse(parse(raw));
 	return result.success ? result.data : {};
 }
-/** Parse a JSONC string as a knip.json. Returns a typed object with `{}` fallback on failure. */
-function parseKnipJson(raw) {
-	const result = KnipSchema.safeParse(parse(raw));
-	return result.success ? result.data : {};
-}
 /** Parse a JSON string as a package.json. Returns `undefined` on failure. */
 function parsePackageJson(raw) {
 	try {
@@ -208,11 +191,11 @@ async function runInitPrompts(targetDir) {
 		p.cancel("Cancelled.");
 		process.exit(0);
 	}
-	const useLintRules = await p.confirm({
-		message: "Include @bensandee/lint-rules?",
+	const useEslintPlugin = await p.confirm({
+		message: "Include @bensandee/eslint-plugin?",
 		initialValue: true
 	});
-	if (isCancelled(useLintRules)) {
+	if (isCancelled(useEslintPlugin)) {
 		p.cancel("Cancelled.");
 		process.exit(0);
 	}
@@ -361,7 +344,7 @@ async function runInitPrompts(targetDir) {
 		name,
 		isNew: !isExisting,
 		structure,
-		useLintRules,
+		useEslintPlugin,
 		formatter,
 		setupVitest,
 		ci,
@@ -380,7 +363,7 @@ function buildDefaultConfig(targetDir, flags) {
 		name: existingPkg?.name ?? path.basename(targetDir),
 		isNew: !detected.hasPackageJson,
 		structure: detected.hasPnpmWorkspace ? "monorepo" : "single",
-		useLintRules: flags.lintRules ?? true,
+		useEslintPlugin: flags.eslintPlugin ?? true,
 		formatter: detected.legacyConfigs.some((l) => l.tool === "prettier") ? "prettier" : "oxfmt",
 		setupVitest: !detected.hasVitestConfig,
 		ci: flags.noCi ? "none" : DEFAULT_CI,
@@ -526,7 +509,7 @@ async function generatePackageJson(ctx) {
 	if (!isMonorepo) Object.assign(devDeps, PER_PACKAGE_DEV_DEPS);
 	devDeps["@bensandee/config"] = isWorkspacePackage(ctx, "@bensandee/config") ? "workspace:*" : "latest";
 	devDeps["@bensandee/tooling"] = isWorkspacePackage(ctx, "@bensandee/tooling") ? "workspace:*" : "latest";
-	if (ctx.config.useLintRules) devDeps["@bensandee/lint-rules"] = isWorkspacePackage(ctx, "@bensandee/lint-rules") ? "workspace:*" : "latest";
+	if (ctx.config.useEslintPlugin) devDeps["@bensandee/eslint-plugin"] = isWorkspacePackage(ctx, "@bensandee/eslint-plugin") ? "workspace:*" : "latest";
 	if (ctx.config.formatter === "oxfmt") devDeps["oxfmt"] = "0.35.0";
 	if (ctx.config.formatter === "prettier") devDeps["prettier"] = "3.8.1";
 	addReleaseDeps(devDeps, ctx.config);
@@ -709,7 +692,7 @@ function generateMigratePrompt(results, config, detected) {
 	sections.push("");
 	sections.push("- **Lint errors**: fix the code rather than adding disable comments or rule exceptions");
 	sections.push("- **Test failures**: update the test or fix the underlying bug rather than skipping or deleting the test");
-	sections.push("- **Knip findings**: remove genuinely unused code/exports/dependencies rather than adding ignores to `knip.json`");
+	sections.push("- **Knip findings**: remove genuinely unused code/exports/dependencies rather than adding ignores to `knip.config.ts`");
 	sections.push("- **Type errors**: add proper types rather than using `any` or `@ts-expect-error`");
 	sections.push("");
 	sections.push("Only suppress an issue if there is a clear, documented reason why the fix is not feasible (e.g. a third-party type mismatch). Leave a comment explaining why.");
@@ -941,7 +924,7 @@ export default defineConfig({
 `;
 async function generateOxlint(ctx) {
 	const filePath = "oxlint.config.ts";
-	const content = ctx.config.useLintRules ? CONFIG_WITH_LINT_RULES : CONFIG_PRESET_ONLY;
+	const content = ctx.config.useEslintPlugin ? CONFIG_WITH_LINT_RULES : CONFIG_PRESET_ONLY;
 	const existing = ctx.read(filePath);
 	if (existing) {
 		if (existing === content) return {
@@ -1051,12 +1034,19 @@ const STANDARD_ENTRIES = [
 	"!.env.example",
 	".tooling-migrate.md"
 ];
+/** Normalize a gitignore entry for comparison: strip leading `/` and trailing `/`. */
+function normalizeEntry(entry) {
+	let s = entry.trim();
+	if (s.startsWith("/")) s = s.slice(1);
+	if (s.endsWith("/")) s = s.slice(0, -1);
+	return s;
+}
 async function generateGitignore(ctx) {
 	const filePath = ".gitignore";
 	const existing = ctx.read(filePath);
 	if (existing) {
-		const existingLines = new Set(existing.split("\n").map((line) => line.trim()).filter((line) => line.length > 0));
-		const missing = STANDARD_ENTRIES.filter((entry) => !existingLines.has(entry));
+		const existingNormalized = new Set(existing.split("\n").map(normalizeEntry).filter((line) => line.length > 0));
+		const missing = STANDARD_ENTRIES.filter((entry) => !existingNormalized.has(normalizeEntry(entry)));
 		if (missing.length === 0) return {
 			filePath,
 			action: "skipped",
@@ -1138,71 +1128,71 @@ async function generateCi(ctx) {
 
 //#endregion
 //#region src/generators/knip.ts
-const KNIP_CONFIG_SINGLE = {
-	$schema: "https://unpkg.com/knip@latest/schema.json",
-	entry: ["src/index.ts"],
-	project: ["src/**/*.ts"],
-	ignore: ["dist/**"]
-};
-const KNIP_CONFIG_MONOREPO = {
-	$schema: "https://unpkg.com/knip@latest/schema.json",
-	workspaces: {
-		".": {
-			entry: [],
-			project: []
-		},
-		"packages/*": {
-			entry: ["src/index.ts", "src/bin.ts"],
-			project: ["src/**/*.ts"],
-			ignore: ["dist/**"]
-		}
-	}
-};
+const KNIP_CONFIG_SINGLE = `import type { KnipConfig } from "knip";
+
+export default {
+  entry: ["src/index.ts"],
+  project: ["src/**/*.ts"],
+  ignore: ["dist/**"],
+} satisfies KnipConfig;
+`;
+const KNIP_CONFIG_MONOREPO = `import type { KnipConfig } from "knip";
+
+export default {
+  workspaces: {
+    ".": {
+      entry: [],
+      project: [],
+    },
+    "packages/*": {
+      entry: ["src/index.ts", "src/bin.ts"],
+      project: ["src/**/*.ts"],
+      ignore: ["dist/**"],
+    },
+  },
+} satisfies KnipConfig;
+`;
+/** All known knip config file locations, in priority order. */
+const KNIP_CONFIG_PATHS = [
+	"knip.config.ts",
+	"knip.config.mts",
+	"knip.json",
+	"knip.jsonc",
+	"knip.ts",
+	"knip.mts"
+];
 async function generateKnip(ctx) {
-	const filePath = "knip.json";
-	const existing = ctx.read(filePath);
+	const filePath = "knip.config.ts";
 	const isMonorepo = ctx.config.structure === "monorepo";
-	if (existing) {
-		const parsed = parseKnipJson(existing);
-		const changes = [];
-		if (isMonorepo && !parsed.workspaces) {
-			parsed.workspaces = KNIP_CONFIG_MONOREPO.workspaces;
-			changes.push("added monorepo workspaces config");
-		}
-		if (!isMonorepo) {
-			if (!parsed.entry) {
-				parsed.entry = KNIP_CONFIG_SINGLE.entry;
-				changes.push("added entry patterns");
-			}
-			if (!parsed.project) {
-				parsed.project = KNIP_CONFIG_SINGLE.project;
-				changes.push("added project patterns");
-			}
-		}
-		if (changes.length === 0) return {
-			filePath,
-			action: "skipped",
-			description: "Already configured"
-		};
-		ctx.write(filePath, JSON.stringify(parsed, null, 2) + "\n");
-		return {
-			filePath,
-			action: "updated",
-			description: changes.join(", ")
-		};
-	}
+	const existingPath = KNIP_CONFIG_PATHS.find((p) => ctx.exists(p));
+	if (existingPath) return {
+		filePath: existingPath,
+		action: "skipped",
+		description: existingPath === filePath ? "Already configured" : `Existing config found at ${existingPath}`
+	};
 	const config = isMonorepo ? KNIP_CONFIG_MONOREPO : KNIP_CONFIG_SINGLE;
-	ctx.write(filePath, JSON.stringify(config, null, 2) + "\n");
+	ctx.write(filePath, config);
 	return {
 		filePath,
 		action: "created",
-		description: "Generated knip.json for dead code analysis"
+		description: "Generated knip.config.ts for dead code analysis"
 	};
 }
 
 //#endregion
 //#region src/generators/renovate.ts
-const SHARED_PRESET = "@bensandee/config";
+const SHARED_PRESET = "local>bensandee/tooling";
+/** Deprecated npm-based preset to migrate away from. */
+const LEGACY_PRESET = "@bensandee/config";
+/** All known renovate config file locations, in priority order. */
+const RENOVATE_CONFIG_PATHS = [
+	"renovate.json",
+	"renovate.json5",
+	".renovaterc",
+	".renovaterc.json",
+	".github/renovate.json",
+	".github/renovate.json5"
+];
 async function generateRenovate(ctx) {
 	const filePath = "renovate.json";
 	if (!ctx.config.setupRenovate) return {
@@ -1210,26 +1200,45 @@ async function generateRenovate(ctx) {
 		action: "skipped",
 		description: "Renovate not requested"
 	};
-	const existing = ctx.read(filePath);
-	if (existing) {
-		const parsed = parseRenovateJson(existing);
-		const existingExtends = parsed.extends ?? [];
-		if (!existingExtends.includes(SHARED_PRESET)) {
-			existingExtends.unshift(SHARED_PRESET);
-			parsed.extends = existingExtends;
-			ctx.write(filePath, JSON.stringify(parsed, null, 2) + "\n");
+	const existingPath = RENOVATE_CONFIG_PATHS.find((p) => ctx.exists(p));
+	if (existingPath === filePath) {
+		const existing = ctx.read(filePath);
+		if (existing) {
+			const parsed = parseRenovateJson(existing);
+			const existingExtends = parsed.extends ?? [];
+			const legacyIndex = existingExtends.indexOf(LEGACY_PRESET);
+			if (legacyIndex !== -1) {
+				existingExtends[legacyIndex] = SHARED_PRESET;
+				parsed.extends = existingExtends;
+				ctx.write(filePath, JSON.stringify(parsed, null, 2) + "\n");
+				return {
+					filePath,
+					action: "updated",
+					description: `Migrated extends: ${LEGACY_PRESET} → ${SHARED_PRESET}`
+				};
+			}
+			if (!existingExtends.includes(SHARED_PRESET)) {
+				existingExtends.unshift(SHARED_PRESET);
+				parsed.extends = existingExtends;
+				ctx.write(filePath, JSON.stringify(parsed, null, 2) + "\n");
+				return {
+					filePath,
+					action: "updated",
+					description: `Added extends: ${SHARED_PRESET}`
+				};
+			}
 			return {
 				filePath,
-				action: "updated",
-				description: `Added extends: ${SHARED_PRESET}`
+				action: "skipped",
+				description: "Already extends shared config"
 			};
 		}
-		return {
-			filePath,
-			action: "skipped",
-			description: "Already extends shared config"
-		};
 	}
+	if (existingPath) return {
+		filePath: existingPath,
+		action: "skipped",
+		description: `Existing config found at ${existingPath}`
+	};
 	const config = {
 		$schema: "https://docs.renovatebot.com/renovate-schema.json",
 		extends: [SHARED_PRESET]
@@ -1670,31 +1679,50 @@ async function generateReleaseCi(ctx) {
 //#endregion
 //#region src/generators/lint-staged.ts
 function buildConfig(formatter) {
-	return `export default {\n  "*": "${formatter === "prettier" ? "prettier --write" : "oxfmt"}",\n};\n`;
+	return `export default {\n  "*": "${formatter === "prettier" ? "prettier --write" : "oxfmt --no-error-on-unmatched-pattern"}",\n};\n`;
 }
 const HUSKY_PRE_COMMIT = "pnpm exec lint-staged\n";
+/** All known lint-staged config file locations, in priority order. */
+const LINT_STAGED_CONFIG_PATHS = [
+	"lint-staged.config.mjs",
+	"lint-staged.config.js",
+	"lint-staged.config.cjs",
+	".lintstagedrc",
+	".lintstagedrc.json",
+	".lintstagedrc.yaml",
+	".lintstagedrc.yml",
+	".lintstagedrc.mjs",
+	".lintstagedrc.cjs"
+];
 async function generateLintStaged(ctx) {
 	const filePath = "lint-staged.config.mjs";
 	const huskyPath = ".husky/pre-commit";
 	const content = buildConfig(ctx.config.formatter);
-	const existing = ctx.read(filePath);
 	if (ctx.read(huskyPath) !== HUSKY_PRE_COMMIT) ctx.write(huskyPath, HUSKY_PRE_COMMIT);
-	if (existing) {
-		if (existing === content) return {
-			filePath,
-			action: "skipped",
-			description: "Already configured"
-		};
-		if (await ctx.confirmOverwrite(filePath) === "skip") return {
-			filePath,
-			action: "skipped",
-			description: "Existing lint-staged config preserved"
-		};
-	}
+	const existingPath = LINT_STAGED_CONFIG_PATHS.find((p) => ctx.exists(p));
+	if (existingPath === filePath) {
+		const existing = ctx.read(filePath);
+		if (existing) {
+			if (existing === content) return {
+				filePath,
+				action: "skipped",
+				description: "Already configured"
+			};
+			if (await ctx.confirmOverwrite(filePath) === "skip") return {
+				filePath,
+				action: "skipped",
+				description: "Existing lint-staged config preserved"
+			};
+		}
+	} else if (existingPath) return {
+		filePath: existingPath,
+		action: "skipped",
+		description: `Existing config found at ${existingPath}`
+	};
 	ctx.write(filePath, content);
 	return {
 		filePath,
-		action: existing ? "updated" : "created",
+		action: existingPath === filePath ? "updated" : "created",
 		description: "Generated lint-staged config and husky pre-commit hook"
 	};
 }
@@ -1717,9 +1745,9 @@ const initCommand = defineCommand({
 			alias: "y",
 			description: "Accept all defaults (non-interactive)"
 		},
-		"lint-rules": {
+		"eslint-plugin": {
 			type: "boolean",
-			description: "Include @bensandee/lint-rules (default: true)"
+			description: "Include @bensandee/eslint-plugin (default: true)"
 		},
 		"no-ci": {
 			type: "boolean",
@@ -1733,7 +1761,7 @@ const initCommand = defineCommand({
 	async run({ args }) {
 		const targetDir = path.resolve(args.dir ?? ".");
 		await runInit(args.yes ? buildDefaultConfig(targetDir, {
-			lintRules: args["lint-rules"] === true ? true : void 0,
+			eslintPlugin: args["eslint-plugin"] === true ? true : void 0,
 			noCi: args["no-ci"] === true ? true : void 0
 		}) : await runInitPrompts(targetDir), args["no-prompt"] === true ? { noPrompt: true } : {});
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bensandee/tooling",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "CLI tool to bootstrap and maintain standardized TypeScript project tooling",
   "bin": {
     "tooling": "./dist/bin.mjs"
@@ -9,17 +9,13 @@
     "dist"
   ],
   "type": "module",
-  "main": "./dist/index.mjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.mts",
   "imports": {
     "#src/*": "./src/*.ts"
   },
   "exports": {
-    ".": {
-      "types": "./dist/index.d.mts",
-      "import": "./dist/index.mjs"
-    }
+    ".": "./dist/index.mjs",
+    "./bin": "./dist/bin.mjs",
+    "./package.json": "./package.json"
   },
   "publishConfig": {
     "access": "public"
@@ -35,7 +31,7 @@
     "tsdown": "0.20.3",
     "typescript": "5.9.3",
     "vitest": "4.0.18",
-    "@bensandee/config": "0.2.0"
+    "@bensandee/config": "0.4.0"
   },
   "scripts": {
     "build": "tsdown",

package/dist/bin.d.mts

@@ -1 +0,0 @@
-export { };

package/dist/index.d.mts

@@ -1,102 +0,0 @@
-import { z } from "zod";
-
-//#region src/utils/json.d.ts
-declare const PackageJsonSchema: z.ZodObject<{
-  name: z.ZodOptional<z.ZodString>;
-  version: z.ZodOptional<z.ZodString>;
-  private: z.ZodOptional<z.ZodBoolean>;
-  type: z.ZodOptional<z.ZodString>;
-  scripts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-  dependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-  devDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-  bin: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>>;
-  exports: z.ZodOptional<z.ZodUnknown>;
-  main: z.ZodOptional<z.ZodString>;
-  types: z.ZodOptional<z.ZodString>;
-  typings: z.ZodOptional<z.ZodString>;
-  engines: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-}, z.core.$loose>;
-type PackageJson = z.infer<typeof PackageJsonSchema>;
-//#endregion
-//#region src/types.d.ts
-type CiPlatform = "github" | "forgejo" | "none";
-type ReleaseStrategy = "release-it" | "commit-and-tag-version" | "changesets" | "none";
-/** User's answers from the interactive prompt or CLI flags. */
-interface ProjectConfig {
-  /** Project name (from package.json name or user input) */
-  name: string;
-  /** Whether this is a new project or existing */
-  isNew: boolean;
-  /** Project structure */
-  structure: "single" | "monorepo";
-  /** Include @bensandee/lint-rules oxlint plugin */
-  useLintRules: boolean;
-  /** Formatter choice */
-  formatter: "oxfmt" | "prettier";
-  /** Set up vitest with a starter test */
-  setupVitest: boolean;
-  /** CI platform choice */
-  ci: CiPlatform;
-  /** Set up Renovate for automated dependency updates */
-  setupRenovate: boolean;
-  /** Release management strategy */
-  releaseStrategy: ReleaseStrategy;
-  /** Project type determines tsconfig base configuration */
-  projectType: "default" | "node" | "react" | "library";
-  /** Auto-detect and configure tsconfig bases for monorepo packages */
-  detectPackageTypes: boolean;
-  /** Target directory (default: cwd) */
-  targetDir: string;
-}
-/** Result from a single generator: what file was written and how. */
-interface GeneratorResult {
-  filePath: string;
-  action: "created" | "updated" | "skipped";
-  /** Human-readable description of what changed */
-  description: string;
-}
-/** Context passed to each generator function. */
-interface GeneratorContext {
-  config: ProjectConfig;
-  /** Absolute path to target directory */
-  targetDir: string;
-  /** Pre-parsed package.json from the target directory, or undefined if missing/invalid */
-  packageJson: PackageJson | undefined;
-  /** Check whether a file exists in the target directory */
-  exists: (relativePath: string) => boolean;
-  /** Read an existing file from the target directory, returns undefined if not found */
-  read: (relativePath: string) => string | undefined;
-  /** Write a file to the target directory (creating directories as needed) */
-  write: (relativePath: string, content: string) => void;
-  /** Prompt user for conflict resolution on non-mergeable files */
-  confirmOverwrite: (relativePath: string) => Promise<"overwrite" | "skip">;
-}
-/** Generator function signature. */
-type Generator = (ctx: GeneratorContext) => Promise<GeneratorResult>;
-/** State detected from an existing project directory. */
-interface DetectedProjectState {
-  hasPackageJson: boolean;
-  hasTsconfig: boolean;
-  hasOxlintConfig: boolean;
-  /** Legacy .oxlintrc.json found (should be migrated to oxlint.config.ts) */
-  hasLegacyOxlintJson: boolean;
-  hasGitignore: boolean;
-  hasVitestConfig: boolean;
-  hasTsdownConfig: boolean;
-  hasPnpmWorkspace: boolean;
-  hasKnipConfig: boolean;
-  hasRenovateConfig: boolean;
-  hasReleaseItConfig: boolean;
-  hasCommitAndTagVersionConfig: boolean;
-  hasChangesetsConfig: boolean;
-  /** Legacy tooling configs found */
-  legacyConfigs: LegacyConfig[];
-}
-declare const LEGACY_TOOLS: readonly ["eslint", "prettier", "jest", "webpack", "rollup"];
-type LegacyTool = (typeof LEGACY_TOOLS)[number];
-interface LegacyConfig {
-  tool: LegacyTool;
-  files: string[];
-}
-//#endregion
-export { type DetectedProjectState, type Generator, type GeneratorContext, type GeneratorResult, type LegacyConfig, type ProjectConfig };