create-rigg 0.1.1 → 0.1.3

package/README.md

@@ -2,13 +2,14 @@
 
 <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
@@ -53,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

@@ -168,12 +168,13 @@ function run(cmd, args, opts) {
 		});
 	});
 }
-/** Recursively copies a directory, renaming _gitignore to .gitignore. */
+/** Recursively copies a directory, renaming _gitignore → .gitignore (npm strips dotfiles during publish). */
 function copyDir(src, dest) {
 	fs.mkdirSync(dest, { recursive: true });
 	for (const entry of fs.readdirSync(src)) {
 		const srcPath = path.join(src, entry);
-		const destPath = path.join(dest, entry === "_gitignore" ? ".gitignore" : entry);
+		const destName = entry === "_gitignore" ? ".gitignore" : entry;
+		const destPath = path.join(dest, destName);
 		if (fs.statSync(srcPath).isDirectory()) copyDir(srcPath, destPath);
 		else fs.copyFileSync(srcPath, destPath);
 	}
@@ -242,7 +243,13 @@ async function scaffoldFiles(options, targetDir) {
 	const pkgJsonPath = path.join(targetDir, "package.json");
 	const pkg = JSON.parse(fs.readFileSync(pkgJsonPath, "utf-8"));
 	pkg.name = options.projectName;
+	if (options.pkgManager === "npm") pkg.allowScripts = { esbuild: true };
 	fs.writeFileSync(pkgJsonPath, JSON.stringify(pkg, null, 2) + "\n");
+	if (options.pkgManager === "pnpm") fs.writeFileSync(path.join(targetDir, "pnpm-workspace.yaml"), "allowBuilds:\n  esbuild: true\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]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-rigg",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Create Node.js TypeScript projects using the Vite+ Toolchain - for everything outside the browser.",
   "keywords": [
     "backend",
@@ -38,6 +38,18 @@
     "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",
+    "start": "node dist/index.mjs",
+    "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",
@@ -57,14 +69,5 @@
   "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"
-  }
-}
+  "packageManager": "pnpm@10.30.3"
+}

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/_gitignore

@@ -0,0 +1,21 @@
+# macOS settings file
+.DS_Store
+
+# Contains all your dependencies
+node_modules
+
+/dist
+
+# Deal with environment files
+.env
+.env.*
+
+# We'll allow an example .env file which can be copied + schemas
+!.env.example
+!.env.schema
+
+# Coverage directory used by testing tools
+coverage
+
+# Visual Studio Code configuration
+.vscode/

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": "",
@@ -11,8 +11,9 @@
   },
   "type": "module",
   "scripts": {
-    "dev": "tsx src/index.ts",
+    "dev": "tsx watch src/index.ts",
     "build": "tsdown src/index.ts",
+    "start": "node dist/index.mjs",
     "test": "vitest",
     "lint": "oxlint",
     "lint:fix": "oxlint --fix",