create-rigg 0.1.0 → 0.1.2

package/README.md

@@ -2,18 +2,28 @@
 
 <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>
 
 **Create Node.js projects with a modern toolchain**
 
 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.
 
+![Screenshot of the rigg CLI](./media/screenshot-cli.png)
+
 ## Create a new project with rigg
 
 ```bash
+# pnpm
 pnpm create rigg@latest
+
+# npm
 npm create rigg@latest
+
+# bun
+bun create rigg@latest
+
+# yarn
+yarn create rigg@latest
 ```
 
 ## What you get
@@ -44,6 +54,7 @@ Every generated project includes:
 ```bash
 pnpm dev        # Run with tsx (no build step)
 pnpm build      # Build with tsdown
+pnpm start      # Run compiled output
 pnpm test       # Run Vitest
 pnpm check      # Lint + format check + type check
 pnpm fmt        # Format

package/dist/index.mjs

@@ -243,6 +243,10 @@ async function scaffoldFiles(options, targetDir) {
 	const pkg = JSON.parse(fs.readFileSync(pkgJsonPath, "utf-8"));
 	pkg.name = options.projectName;
 	fs.writeFileSync(pkgJsonPath, JSON.stringify(pkg, null, 2) + "\n");
+	/** Replace the placeholder project name in README.md. */
+	const readmePath = path.join(targetDir, "README.md");
+	const readme = fs.readFileSync(readmePath, "utf-8");
+	fs.writeFileSync(readmePath, readme.replaceAll("{{project_name}}", options.projectName));
 	/** 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]);
@@ -285,6 +289,7 @@ async function installDependencies(options, targetDir) {
 }
 /** Prints the gradient intro. */
 function showIntro() {
+	console.log("");
 	p.intro(pc.bold(gradient("rigg - Node.js projects with a modern toolchain", [[
 		255,
 		255,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-rigg",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Create Node.js TypeScript projects using the Vite+ Toolchain - for everything outside the browser.",
   "keywords": [
     "backend",
@@ -65,6 +65,7 @@
     "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",
+    "start": "node dist/index.mjs"
   }
 }

package/template/README.md

@@ -0,0 +1,17 @@
+# {{project_name}}
+
+> Short description of your project.
+
+## Commands
+
+```bash
+pnpm dev          # Run with tsx (no compile step)
+pnpm build        # Compile to dist/
+pnpm start        # Run compiled output
+pnpm test         # Vitest
+pnpm check        # Lint + format check + type check
+```
+
+---
+
+Scaffolded with [rigg](https://github.com/ehs5/rigg).

package/template/package.json

@@ -1,7 +1,7 @@
 {
   "name": "rigg-project",
   "version": "0.0.0",
-  "description": "Create Node.js TypeScript projects with a Unified Toolchain",
+  "description": "",
   "keywords": [],
   "license": "",
   "author": "",
@@ -13,6 +13,7 @@
   "scripts": {
     "dev": "tsx src/index.ts",
     "build": "tsdown src/index.ts",
+    "start": "node dist/index.mjs",
     "test": "vitest",
     "lint": "oxlint",
     "lint:fix": "oxlint --fix",

package/template/test/index.test.ts

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

package/template/vitest.config.ts

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