create-rigg 0.0.3 → 0.0.6

package/README.md

@@ -1,8 +1,13 @@
 # rigg
 
+<p>
+<a href="https://npmx.dev/package/create-rigg"><img src="https://npmx.dev/api/registry/badge/version/create-rigg" alt="Version"></a>
+<a href="https://www.npmjs.com/package/create-rigg"><img src="https://img.shields.io/npm/v/create-rigg.svg" alt="Version"></a>
+</p>
+
 **The Unified Toolchain Starter for Node.js**
 
-Creates a new Node.js TypeScript project using the same opinionated toolchain as [Vite+](https://github.com/voidzero-dev/vite-plus), but for backend and non-web projects.
+Creates a new Node.js TypeScript project using mostly the same toolchain as [Vite+](https://github.com/voidzero-dev/vite-plus), but for backend and non-web projects.
 
 ## Create a new project with rigg
 
@@ -20,17 +25,17 @@ The project follows most of the same toolchain as Vite+.
 | [Vitest](https://vitest.dev)                       | Testing            |
 | [Oxlint](https://oxc.rs/docs/guide/usage/linter)   | Linting            |
 | [Oxfmt](https://oxc.rs/docs/guide/usage/formatter) | Formatting         |
-| [tsdown](https://tsdown.dev)                       | Build & bundle     |
 | [tsx](https://tsx.is)                              | Dev-mode execution |
+| [tsdown](https://tsdown.dev)                       | Build              |
 
-## Backend framework
+### Backend framework
 
 You can also choose one of the following backend frameworks:
 
-- **None** — where you don't need a API framework, or you want to pick your own.
 - **Hono** — lightweight, modern API framework
 - **Fastify** — fast and low overhead
 - **Express** — familiar and widely supported
+- **None** — where you don't need a API framework, or you want to pick your own.
 
 ## Scripts
 
@@ -38,7 +43,7 @@ Every generated project includes:
 
 ```bash
 pnpm dev        # Run with tsx (no build step)
-pnpm build      # Bundle with tsdown
+pnpm build      # Build with tsdown
 pnpm test       # Run Vitest
 pnpm check      # Lint + format check + type check
 pnpm fmt        # Format
@@ -47,7 +52,7 @@ pnpm lint       # Lint
 pnpm lint:fix   # Lint with auto-fix
 ```
 
-The `pnpm` commands are just examples, you can also use `npm` or `yarn` or `bun` (depending on your package manager).
+You can also use `npm` or `yarn` or `bun`, depending on your package manager.
 
 ## License
 

package/dist/index.mjs

@@ -26,6 +26,12 @@ const FRAMEWORKS = [
 		label: "Express"
 	}
 ];
+const FRAMEWORK_LABELS = {
+	none: "None",
+	hono: "Hono",
+	fastify: "Fastify",
+	express: "Express"
+};
 const FRAMEWORK_DEPS = {
 	none: {
 		deps: [],
@@ -79,8 +85,15 @@ app.listen(3000, () => {
 `
 };
 //#endregion
+//#region src/pkg-managers.ts
+const PKG_MANAGERS = [
+	"npm",
+	"pnpm",
+	"yarn",
+	"bun"
+];
+//#endregion
 //#region src/index.ts
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
 /** Creates a colored gradient text effect */
 function gradient(text, stops, whiteRange) {
 	const chars = [...text];
@@ -97,9 +110,7 @@ function gradient(text, stops, whiteRange) {
 /** Detects the package manager used to invoke the CLI via npm_config_user_agent. */
 function detectPkgManager() {
 	const ua = process.env.npm_config_user_agent ?? "";
-	if (ua.startsWith("pnpm")) return "pnpm";
-	if (ua.startsWith("bun")) return "bun";
-	if (ua.startsWith("yarn")) return "yarn";
+	for (const pm of PKG_MANAGERS) if (ua.startsWith(pm)) return pm;
 	return "npm";
 }
 /** Builds the install/add command args for the given package manager. */
@@ -119,11 +130,14 @@ function addArgs(pkgManager, packages, dev) {
 /** Runs a command synchronously, exiting the process if it fails. */
 function run(cmd, args, opts) {
 	const result = spawn.sync(cmd, args, {
-		stdio: "inherit",
+		stdio: "ignore",
 		...opts
 	});
-	if (result.status != null && result.status !== 0) process.exit(result.status);
 	if (result.error) throw result.error;
+	if (result.status != null && result.status !== 0) {
+		p.cancel(`${cmd} ${args.join(" ")} failed with exit code ${result.status}`);
+		process.exit(result.status);
+	}
 }
 /** Recursively copies a directory, renaming _gitignore to .gitignore. */
 function copyDir(src, dest) {
@@ -141,9 +155,8 @@ function isEmpty(dir) {
 	const files = fs.readdirSync(dir);
 	return files.length === 0 || files.length === 1 && files[0] === ".git";
 }
-/** Prompts for a project name, or reads it from the first CLI argument. */
-async function promptProjectName(argv) {
-	const fromArg = argv._[0] ?? "";
+/** Resolves the project name from the CLI arg or prompts the user. */
+async function resolveProjectName(fromArg) {
 	if (fromArg) return fromArg;
 	const answer = await p.text({
 		message: "Project name:",
@@ -156,10 +169,9 @@ async function promptProjectName(argv) {
 	}
 	return answer || "rigg-project";
 }
-/** Prompts for a backend framework, or reads it from the --template flag. */
-async function promptFramework(argv) {
-	const templateArg = argv.template;
-	if (templateArg && FRAMEWORK_DEPS[templateArg]) return templateArg;
+/** Resolves the framework from the --framework flag or prompts the user. */
+async function resolveFramework(fromArg) {
+	if (fromArg && FRAMEWORK_DEPS[fromArg]) return fromArg;
 	const answer = await p.select({
 		message: "Backend framework:",
 		options: FRAMEWORKS,
@@ -174,7 +186,10 @@ async function promptFramework(argv) {
 /** Asks the user to confirm before wiping a non-empty target directory. */
 async function confirmOverwrite(projectName, targetDir) {
 	if (isEmpty(targetDir)) return;
-	const overwrite = await p.confirm({ message: `${pc.yellow(projectName)} is not empty. Remove existing files and continue?` });
+	const overwrite = await p.confirm({
+		message: `${pc.white(projectName)} is not empty. Remove existing files and continue?`,
+		initialValue: false
+	});
 	if (p.isCancel(overwrite) || !overwrite) {
 		p.cancel("Cancelled");
 		process.exit(0);
@@ -185,18 +200,29 @@ async function confirmOverwrite(projectName, targetDir) {
 	});
 }
 /** Copies the base template, sets the package name, and writes the framework starter code. */
-function scaffoldFiles(projectName, framework, targetDir) {
-	copyDir(path.join(__dirname, "..", "template"), targetDir);
+function scaffoldFiles(options, targetDir) {
+	const directory = path.dirname(fileURLToPath(import.meta.url));
+	copyDir(path.join(directory, "..", "template"), targetDir);
 	const pkgJsonPath = path.join(targetDir, "package.json");
 	const pkg = JSON.parse(fs.readFileSync(pkgJsonPath, "utf-8"));
-	pkg.name = projectName;
+	pkg.name = options.projectName;
 	fs.writeFileSync(pkgJsonPath, JSON.stringify(pkg, null, 2) + "\n");
 	fs.mkdirSync(path.join(targetDir, "src"), { recursive: true });
-	fs.writeFileSync(path.join(targetDir, "src", "index.ts"), FRAMEWORK_INDEX[framework]);
+	fs.writeFileSync(path.join(targetDir, "src", "index.ts"), FRAMEWORK_INDEX[options.framework]);
 }
 /** Installs shared dev dependencies and any framework-specific packages. */
-function installDependencies(pkgManager, framework, targetDir) {
-	p.log.step(`Installing dependencies with ${pkgManager}...`);
+function installDependencies(options, targetDir) {
+	const { pkgManager, framework, verbose } = options;
+	const stdio = verbose ? "inherit" : "ignore";
+	p.log.step(`Installing dependencies with ${gradient(pkgManager, [[
+		168,
+		85,
+		247
+	], [
+		99,
+		102,
+		241
+	]])}...`);
 	run(pkgManager, addArgs(pkgManager, [
 		"@types/node",
 		"oxfmt",
@@ -205,38 +231,33 @@ function installDependencies(pkgManager, framework, targetDir) {
 		"tsx",
 		"typescript",
 		"vitest"
-	], true), { cwd: targetDir });
-	/** Install framework dependencies */
+	], true), {
+		cwd: targetDir,
+		stdio
+	});
 	if (framework !== "none") {
-		p.log.step(`Installing ${framework}...`);
-		const frameworkDeps = FRAMEWORK_DEPS[framework];
-		if (frameworkDeps.deps.length > 0) run(pkgManager, addArgs(pkgManager, frameworkDeps.deps, false), { cwd: targetDir });
-		if (frameworkDeps.devDeps.length > 0) run(pkgManager, addArgs(pkgManager, frameworkDeps.devDeps, true), { cwd: targetDir });
+		p.log.step(`Installing ${gradient(FRAMEWORK_LABELS[framework], [[
+			168,
+			85,
+			247
+		], [
+			99,
+			102,
+			241
+		]])}...`);
+		const { deps, devDeps } = FRAMEWORK_DEPS[framework];
+		if (deps.length > 0) run(pkgManager, addArgs(pkgManager, deps, false), {
+			cwd: targetDir,
+			stdio
+		});
+		if (devDeps.length > 0) run(pkgManager, addArgs(pkgManager, devDeps, true), {
+			cwd: targetDir,
+			stdio
+		});
 	}
 }
-/** Prints the gradient outro with next steps. */
-function showOutro(projectName, framework, pkgManager) {
-	const frameworkLabel = FRAMEWORKS.find((f) => f.value === framework)?.label ?? framework;
-	const outroStops = [[
-		168,
-		85,
-		247
-	], [
-		99,
-		102,
-		241
-	]];
-	const outroText = frameworkLabel !== "None" ? `Created ${projectName} with ${frameworkLabel}` : `Created ${projectName}`;
-	const nameStart = 8;
-	const outro = gradient(outroText, outroStops, [nameStart, nameStart + projectName.length]);
-	const devCmd = pkgManager === "npm" ? "npm run dev" : `${pkgManager} dev`;
-	p.outro(`${outro}\n\n  ${pc.dim("Now run:")}\n  cd ${projectName}\n  ${devCmd}`);
-}
-async function main() {
-	const argv = mri(process.argv.slice(2), {
-		string: ["template"],
-		alias: { t: "template" }
-	});
+/** Prints the gradient intro. */
+function showIntro() {
 	p.intro(pc.bold(gradient("rigg - The Unified Toolchain Starter for Node.js", [
 		[
 			255,
@@ -254,46 +275,96 @@ async function main() {
 			241
 		]
 	], [0, 6])));
-	const projectName = await promptProjectName(argv);
-	const framework = await promptFramework(argv);
-	const targetDir = path.resolve(process.cwd(), projectName);
-	const pkgManager = detectPkgManager();
-	await confirmOverwrite(projectName, targetDir);
-	scaffoldFiles(projectName, framework, targetDir);
+}
+/** Prints the gradient outro with next steps. */
+function showOutro(options) {
+	const { projectName, framework, pkgManager } = options;
+	const frameworkLabel = FRAMEWORK_LABELS[framework];
+	const title = gradient(frameworkLabel !== "None" ? `Created ${projectName} with ${frameworkLabel}` : `Created ${projectName}`, [[
+		168,
+		85,
+		247
+	], [
+		99,
+		102,
+		241
+	]], [8, 8 + projectName.length]);
+	const devCmd = pkgManager === "npm" ? "npm run dev" : `${pkgManager} dev`;
+	p.outro(`${title}\n\n  ${pc.dim("Now run:")}\n  cd ${projectName}\n  ${devCmd}`);
+}
+/** Takes the CLI args and resolves all inputs into a single options object. */
+async function resolveOptions(argv) {
+	const projectName = await resolveProjectName(argv._[0]);
+	await confirmOverwrite(projectName, path.resolve(process.cwd(), projectName));
+	return {
+		projectName,
+		framework: await resolveFramework(argv.framework),
+		pkgManager: argv.pm || detectPkgManager(),
+		verbose: argv.verbose ?? false
+	};
+}
+function initializeGit(options, targetDir) {
+	p.log.step("Initializing git repository");
 	run("git", [
 		"init",
 		"-b",
 		"main"
 	], {
 		cwd: targetDir,
-		stdio: "ignore"
+		stdio: options.verbose ? "inherit" : "ignore"
 	});
-	p.log.step("Initializing git repository");
-	installDependencies(pkgManager, framework, targetDir);
+}
+function formatCode(options, targetDir) {
 	p.log.step("Formatting code");
+	const { pkgManager, verbose } = options;
+	const stdio = verbose ? "inherit" : "ignore";
+	const execCmd = pkgManager === "bun" ? "x" : "exec";
+	const sep = pkgManager === "npm" || pkgManager === "yarn" ? ["--"] : [];
 	run(pkgManager, [
-		"exec",
+		execCmd,
 		"oxlint",
-		"--",
+		...sep,
 		"--init"
 	], {
 		cwd: targetDir,
-		stdio: "ignore"
+		stdio
 	});
 	run(pkgManager, [
-		"exec",
+		execCmd,
 		"oxfmt",
-		"--",
+		...sep,
 		"--init"
 	], {
 		cwd: targetDir,
-		stdio: "ignore"
+		stdio
 	});
-	run(pkgManager, ["exec", "oxfmt"], {
+	run(pkgManager, [
+		execCmd,
+		"oxfmt",
+		...sep,
+		"."
+	], {
 		cwd: targetDir,
-		stdio: "ignore"
+		stdio
+	});
+}
+async function main() {
+	const argv = mri(process.argv.slice(2), {
+		string: ["framework", "pm"],
+		boolean: ["verbose"],
+		alias: {
+			f: "framework",
+			v: "verbose"
+		}
 	});
-	showOutro(projectName, framework, pkgManager);
+	showIntro();
+	const options = await resolveOptions(argv);
+	const targetDir = path.resolve(process.cwd(), options.projectName);
+	scaffoldFiles(options, targetDir);
+	initializeGit(options, targetDir);
+	installDependencies(options, targetDir);
+	formatCode(options, targetDir);
+	showOutro(options);
 }
 main().catch((err) => {
 	console.error(err);

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "create-rigg",
-  "version": "0.0.3",
+  "version": "0.0.6",
   "description": "The Unified Toolchain Starter for Node.js backend and non-web projects",
   "keywords": [
     "backend",
-    "node",
-    "nodejs",
     "create-rigg",
     "express",
     "fastify",
     "framework",
     "hono",
+    "node",
+    "nodejs",
     "oxfmt",
     "oxlint",
     "rigg",
@@ -42,7 +42,8 @@
     "fmt:check": "oxfmt --check",
     "check": "oxlint && oxfmt --check && tsc --noEmit",
     "dev": "tsx src/index.ts",
-    "build": "tsdown src/index.ts"
+    "build": "tsdown src/index.ts",
+    "prepublishOnly": "git diff --exit-code && git diff --cached --exit-code && oxlint && oxfmt && tsc --noEmit && vitest run && pnpm build"
   },
   "dependencies": {
     "@clack/prompts": "^1.1.0",

package/template/test/index.test.ts

@@ -0,0 +1,5 @@
+import { expect, test } from "vitest";
+
+test("example", () => {
+  expect(true).toBe(true);
+});

package/template/vitest.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    slowTestThreshold: 5_000,
+  },
+});