create-rigg 0.0.7 → 0.1.0

package/README.md

@@ -5,9 +5,9 @@
 <a href="https://www.npmjs.com/package/create-rigg"><img src="https://img.shields.io/npm/v/create-rigg.svg" alt="Version"></a>
 </p>
 
-**Create Node.js projects with a Unified Toolchain**
+**Create Node.js projects with a modern toolchain**
 
-rigg sets up a Node.js TypeScript project with the same opinionated toolchain as [Vite+](https://github.com/voidzero-dev/vite-plus), just without the web parts. Use it for backend projects, CLIs, libraries, scripts. Whatever you're building.
+I really like what [VoidZero](https://voidzero.dev) and [Vite+](https://github.com/voidzero-dev/vite-plus) are doing for web development. **rigg** brings the same toolchain to every Node.js project outside the browser. Use it for backends, CLIs, libraries, scripts, whatever you're building.
 
 ## Create a new project with rigg
 
@@ -18,15 +18,15 @@ npm create rigg@latest
 
 ## What you get
 
-A project created with rigg gets most of the same tools from the Vite+ toolchain.
+A project created with rigg gets most of the same tools as in the Vite+ toolchain.
 
 | Tool                                               | Role               |
 | -------------------------------------------------- | ------------------ |
 | [Vitest](https://vitest.dev)                       | Testing            |
 | [Oxlint](https://oxc.rs/docs/guide/usage/linter)   | Linting            |
 | [Oxfmt](https://oxc.rs/docs/guide/usage/formatter) | Formatting         |
-| [tsx](https://tsx.is)                              | Dev-mode execution |
 | [tsdown](https://tsdown.dev)                       | Build              |
+| [tsx](https://tsx.is)                              | Dev-mode execution |
 
 ### Backend framework
 

package/dist/index.mjs

@@ -15,7 +15,7 @@ const FRAMEWORKS = [
 	{
 		value: "hono",
 		label: "Hono",
-		hint: "recommended"
+		hint: "recommended framework"
 	},
 	{
 		value: "fastify",
@@ -50,6 +50,7 @@ const FRAMEWORK_DEPS = {
 		devDeps: ["@types/express"]
 	}
 };
+/** Starter code (index.ts) for each framework. */
 const FRAMEWORK_INDEX = {
 	none: `console.log('Hello from rigg!')\n`,
 	hono: `import { Hono } from 'hono'
@@ -65,22 +66,36 @@ serve(app, (info) => {
 `,
 	fastify: `import Fastify from 'fastify'
 
-const fastify = Fastify({ logger: true })
+const fastify = Fastify({
+  logger: true,
+})
+
+fastify.get('/', async (request, reply) => {
+  return { hello: 'world' }
+})
 
-fastify.get('/', async () => ({ hello: 'world' }))
+const start = async () => {
+  try {
+    await fastify.listen({ port: 3000 })
+  } catch (err) {
+    fastify.log.error(err)
+    process.exit(1)
+  }
+}
 
-fastify.listen({ port: 3000 })
+start()
 `,
 	express: `import express from 'express'
 
 const app = express()
+const port = 3000
 
 app.get('/', (req, res) => {
   res.send('Hello World')
 })
 
-app.listen(3000, () => {
-  console.log('Server running on http://localhost:3000')
+app.listen(port, () => {
+  console.log(\`Server running on http://localhost:\${port}\`)
 })
 `
 };
@@ -94,6 +109,15 @@ const PKG_MANAGERS = [
 ];
 //#endregion
 //#region src/index.ts
+const THEME = [[
+	251,
+	146,
+	60
+], [
+	236,
+	72,
+	153
+]];
 /** Creates a colored gradient text effect */
 function gradient(text, stops, whiteRange) {
 	const chars = [...text];
@@ -127,17 +151,22 @@ function addArgs(pkgManager, packages, dev) {
 		...packages
 	] : [cmd, ...packages];
 }
-/** Runs a command synchronously, exiting the process if it fails. */
+/** Runs a command asynchronously, exiting the process if it fails. */
 function run(cmd, args, opts) {
-	const result = spawn.sync(cmd, args, {
-		stdio: "ignore",
-		...opts
+	return new Promise((resolve, reject) => {
+		const result = spawn(cmd, args, {
+			stdio: "ignore",
+			...opts
+		});
+		result.on("error", reject);
+		result.on("close", (code) => {
+			if (code !== 0) {
+				p.cancel(`${cmd} ${args.join(" ")} failed with exit code ${code}`);
+				process.exit(code ?? 1);
+			}
+			resolve();
+		});
 	});
-	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) {
@@ -194,36 +223,38 @@ async function confirmOverwrite(projectName, targetDir) {
 		p.cancel("Cancelled");
 		process.exit(0);
 	}
-	fs.rmSync(targetDir, {
+	const spin = p.spinner();
+	spin.start("Removing existing files...");
+	await fs.promises.rm(targetDir, {
 		recursive: true,
 		force: true
 	});
+	spin.stop("Removed existing files");
 }
 /** Copies the base template, sets the package name, and writes the framework starter code. */
-function scaffoldFiles(options, targetDir) {
+async function scaffoldFiles(options, targetDir) {
+	const spin = p.spinner();
+	spin.start("Generating project...");
+	/** Copy the base template to the target directory. */
 	const directory = path.dirname(fileURLToPath(import.meta.url));
 	copyDir(path.join(directory, "..", "template"), targetDir);
+	/** Set the package name in the package.json file. */
 	const pkgJsonPath = path.join(targetDir, "package.json");
 	const pkg = JSON.parse(fs.readFileSync(pkgJsonPath, "utf-8"));
 	pkg.name = options.projectName;
 	fs.writeFileSync(pkgJsonPath, JSON.stringify(pkg, null, 2) + "\n");
+	/** Create the src directory and write the framework starter code. */
 	fs.mkdirSync(path.join(targetDir, "src"), { recursive: true });
 	fs.writeFileSync(path.join(targetDir, "src", "index.ts"), FRAMEWORK_INDEX[options.framework]);
+	spin.stop("Project generated");
 }
 /** Installs shared dev dependencies and any framework-specific packages. */
-function installDependencies(options, targetDir) {
+async 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, [
+	const depSpin = p.spinner();
+	depSpin.start(`Installing dependencies with ${gradient(pkgManager, THEME)}...`);
+	await run(pkgManager, addArgs(pkgManager, [
 		"@types/node",
 		"oxfmt",
 		"oxlint",
@@ -235,64 +266,42 @@ function installDependencies(options, targetDir) {
 		cwd: targetDir,
 		stdio
 	});
+	depSpin.stop(`Dependencies installed with ${gradient(pkgManager, THEME)}`);
 	if (framework !== "none") {
-		p.log.step(`Installing ${gradient(FRAMEWORK_LABELS[framework], [[
-			168,
-			85,
-			247
-		], [
-			99,
-			102,
-			241
-		]])}...`);
+		const frameworkName = FRAMEWORK_LABELS[framework];
+		const frameworkSpin = p.spinner();
+		frameworkSpin.start(`Installing ${gradient(frameworkName, THEME)}...`);
 		const { deps, devDeps } = FRAMEWORK_DEPS[framework];
-		if (deps.length > 0) run(pkgManager, addArgs(pkgManager, deps, false), {
+		if (deps.length > 0) await run(pkgManager, addArgs(pkgManager, deps, false), {
 			cwd: targetDir,
 			stdio
 		});
-		if (devDeps.length > 0) run(pkgManager, addArgs(pkgManager, devDeps, true), {
+		if (devDeps.length > 0) await run(pkgManager, addArgs(pkgManager, devDeps, true), {
 			cwd: targetDir,
 			stdio
 		});
+		frameworkSpin.stop(`${gradient(frameworkName, THEME)} installed`);
 	}
 }
 /** Prints the gradient intro. */
 function showIntro() {
-	p.intro(pc.bold(gradient("rigg - The Unified Toolchain Starter for Node.js", [
-		[
-			255,
-			255,
-			255
-		],
-		[
-			168,
-			85,
-			247
-		],
-		[
-			99,
-			102,
-			241
-		]
-	], [0, 6])));
+	p.intro(pc.bold(gradient("rigg - Node.js projects with a modern toolchain", [[
+		255,
+		255,
+		255
+	], ...THEME], [0, 6])));
 }
 /** 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 title = gradient(frameworkLabel !== "None" ? `Created ${projectName} with ${frameworkLabel}` : `Created ${projectName}`, THEME, [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. */
+/**
+* Resolves options either from CLI args or user prompts.
+*/
 async function resolveOptions(argv) {
 	const projectName = await resolveProjectName(argv._[0]);
 	await confirmOverwrite(projectName, path.resolve(process.cwd(), projectName));
@@ -303,9 +312,15 @@ async function resolveOptions(argv) {
 		verbose: argv.verbose ?? false
 	};
 }
-function initializeGit(options, targetDir) {
-	p.log.step("Initializing git repository");
-	run("git", [
+async function initializeGit(options, targetDir) {
+	const git = spawn.sync("git", ["--version"], { stdio: "ignore" });
+	if (git.error || git.status !== 0) {
+		p.log.info("Git not found. Skipping repository initialization.");
+		return;
+	}
+	const spin = p.spinner();
+	spin.start("Initializing git repository...");
+	await run("git", [
 		"init",
 		"-b",
 		"main"
@@ -313,14 +328,19 @@ function initializeGit(options, targetDir) {
 		cwd: targetDir,
 		stdio: options.verbose ? "inherit" : "ignore"
 	});
+	spin.stop("Git repository initialized");
 }
-function formatCode(options, targetDir) {
-	p.log.step("Formatting code");
+/**
+* Creates oxlint+oxfmt configuration files and formats the code.
+*/
+async function formatCode(options, targetDir) {
 	const { pkgManager, verbose } = options;
 	const stdio = verbose ? "inherit" : "ignore";
 	const execCmd = pkgManager === "bun" ? "x" : "exec";
 	const sep = pkgManager === "npm" || pkgManager === "yarn" ? ["--"] : [];
-	run(pkgManager, [
+	const spin = p.spinner();
+	spin.start("Formatting code...");
+	await run(pkgManager, [
 		execCmd,
 		"oxlint",
 		...sep,
@@ -329,7 +349,7 @@ function formatCode(options, targetDir) {
 		cwd: targetDir,
 		stdio
 	});
-	run(pkgManager, [
+	await run(pkgManager, [
 		execCmd,
 		"oxfmt",
 		...sep,
@@ -338,7 +358,7 @@ function formatCode(options, targetDir) {
 		cwd: targetDir,
 		stdio
 	});
-	run(pkgManager, [
+	await run(pkgManager, [
 		execCmd,
 		"oxfmt",
 		...sep,
@@ -347,6 +367,7 @@ function formatCode(options, targetDir) {
 		cwd: targetDir,
 		stdio
 	});
+	spin.stop("Code formatted");
 }
 async function main() {
 	const argv = mri(process.argv.slice(2), {
@@ -360,10 +381,10 @@ async function main() {
 	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);
+	await scaffoldFiles(options, targetDir);
+	await initializeGit(options, targetDir);
+	await installDependencies(options, targetDir);
+	await formatCode(options, targetDir);
 	showOutro(options);
 }
 main().catch((err) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-rigg",
-  "version": "0.0.7",
-  "description": "Create Node.js TypeScript projects with a Unified Toolchain",
+  "version": "0.1.0",
+  "description": "Create Node.js TypeScript projects using the Vite+ Toolchain - for everything outside the browser.",
   "keywords": [
     "backend",
     "create-rigg",
@@ -38,17 +38,6 @@
     "template"
   ],
   "type": "module",
-  "scripts": {
-    "test": "vitest",
-    "lint": "oxlint",
-    "lint:fix": "oxlint --fix",
-    "fmt": "oxfmt",
-    "fmt:check": "oxfmt --check",
-    "check": "oxlint && oxfmt --check && tsc --noEmit",
-    "dev": "tsx 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",
     "cross-spawn": "^7.0.6",
@@ -65,5 +54,17 @@
     "typescript": "^6.0.2",
     "vitest": "^4.1.2"
   },
-  "packageManager": "pnpm@10.30.3"
-}
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "scripts": {
+    "test": "vitest",
+    "lint": "oxlint",
+    "lint:fix": "oxlint --fix",
+    "fmt": "oxfmt",
+    "fmt:check": "oxfmt --check",
+    "check": "oxlint && oxfmt --check && tsc --noEmit",
+    "dev": "tsx src/index.ts",
+    "build": "tsdown src/index.ts"
+  }
+}

package/template/package.json

@@ -1,6 +1,14 @@
 {
-  "name": "create-rigg",
+  "name": "rigg-project",
   "version": "0.0.0",
+  "description": "Create Node.js TypeScript projects with a Unified Toolchain",
+  "keywords": [],
+  "license": "",
+  "author": "",
+  "repository": {
+    "type": "",
+    "url": ""
+  },
   "type": "module",
   "scripts": {
     "dev": "tsx src/index.ts",