@twobrake/create-monorepo 0.1.0

package/README.md

@@ -0,0 +1,17 @@
+<div align="center">
+    <div>
+        <img src="https://raw.githubusercontent.com/TwoBrake/bun-monorepo/refs/heads/development/.github/images/logo.png" alt="Logo" width="50px" />
+        <h1>Bun Monorepo</h1>
+    </div>
+    <div>
+        <img src="https://img.shields.io/github/actions/workflow/status/twobrake/bun-monorepo/lint.yml?branch=main&label=CI&style=for-the-badge" alt="CI State" />
+        <img src="https://img.shields.io/github/license/twobrake/bun-monorepo?style=for-the-badge&label=License&color=white" alt="License" />
+        <img src="https://img.shields.io/github/last-commit/twobrake/bun-monorepo?style=for-the-badge&label=Committed&color=orange" alt="Committed" />
+        <img src="https://img.shields.io/github/issues/twobrake/bun-monorepo?style=for-the-badge&label=Issues&color=red" alt="Issues" />
+    </div>
+</div>
+<div align="start">
+    <h2>Getting Started</h2>
+    <p>An opinionated starter template for TypeScript using the Bun ecosystem. The primary reason for this template being developed was to enhance the time it took for me to startup new projects without having to worry about restructuring the setup.</p>
+    <p>Obviously the structure isn't ideal for every project, but for general TypeScript setups that require a multi-package/app monorepo structure, this may be what you've been looking for.</p>
+</div>

package/dist/index.mjs

@@ -0,0 +1,177 @@
+#!/usr/bin/env node
+import { readFile, readdir, writeFile } from "node:fs/promises";
+import { exec } from "node:child_process";
+import { confirm, intro, isCancel, log, outro, path, select, tasks, text } from "@clack/prompts";
+import path$1 from "node:path";
+import { promisify } from "node:util";
+import { downloadTemplate } from "giget";
+import { z } from "zod";
+//#region ../utility/src/errors.ts
+var ApplicationError = class extends Error {
+	constructor(message) {
+		super(message);
+		this.name = "ApplicationError";
+	}
+};
+var InternalError = class extends ApplicationError {
+	code = "INTERNAL_ERROR";
+	constructor(note) {
+		super(`Something went wrong internally: ${note ?? "N/A"}`);
+		this.name = "InternalError";
+	}
+};
+var ActionAbortedError = class extends ApplicationError {
+	code = "ACTION_ABORTED";
+	constructor(action) {
+		super(`Action aborted: ${action}`);
+		this.name = "ActionAbortedError";
+	}
+};
+//#endregion
+//#region src/lib.ts
+const DEFAULT_PACKAGE = { version: "0.0.1" };
+const PACKAGE_NAME = "TwoBrake/bun-monorepo";
+const DEFAULT_INSTALL_COMMANDS = {
+	bun: "bun install",
+	npm: "npm install",
+	pnpm: "pnpm install"
+};
+const EXCLUDED_PACKAGE_SCRIPTS = new Set(["installer:build", "installer:publish"]);
+const IGNORE_PATH_LIST = ["packages/installer", "README.md"];
+const replaceOccurrences = async (data) => {
+	const { cwd, extensions, queries } = data;
+	const directory = await readdir(cwd, { withFileTypes: true });
+	await Promise.all(directory.map(async (file) => {
+		const filePath = path$1.join(cwd, file.name);
+		if (file.isDirectory()) {
+			await replaceOccurrences({
+				cwd: filePath,
+				extensions,
+				queries
+			});
+			return;
+		}
+		if (!extensions.includes(path$1.extname(file.name).slice(1))) return;
+		const raw = await readFile(filePath, "utf8");
+		let updated = raw;
+		for (const query of queries) updated = updated.replaceAll(query.query, query.replaceWith);
+		if (updated === raw) return;
+		await writeFile(filePath, updated, "utf8");
+	}));
+};
+const isValidPackage = (value) => typeof value === "object" && value !== null && "name" in value;
+const isCancelled = (prompt) => isCancel(prompt);
+const createPrompt = async (prompt) => {
+	const result = await prompt();
+	if (isCancelled(result)) throw new ActionAbortedError("PROMPT");
+	return result;
+};
+const execute = promisify(exec);
+//#endregion
+//#region package.json
+var version = "0.1.0";
+//#endregion
+//#region src/index.ts
+const main = async () => {
+	try {
+		intro(`bun-monorepo (${version})`);
+		const authorName = await createPrompt(async () => text({
+			message: "What is your name?",
+			placeholder: "Lucas Stranks",
+			validate: (name) => z.safeParse(z.string().min(3), name).success ? void 0 : "Must be at least 3 characters long."
+		}));
+		const authorEmail = await createPrompt(async () => text({
+			message: "What is your email address?",
+			placeholder: "name@domain.com",
+			validate: (email) => z.safeParse(z.email(), email).success ? void 0 : "Not a valid email address."
+		}));
+		const projectName = await createPrompt(async () => text({
+			message: "What would you like to call your project?",
+			placeholder: "cool-project",
+			validate: (name) => {
+				const result = z.safeParse(z.string().min(3, "Must be at least 3 characters long.").lowercase("Must be all lowercase.").refine((value) => !value.includes(" "), "Must not have any whitespace."), name);
+				return result.success ? void 0 : result.error.issues[0]?.message ?? "Unknown error.";
+			}
+		}));
+		const targetDirectory = await createPrompt(async () => path({
+			directory: true,
+			message: "Where do you want to create this project at?"
+		}));
+		const frameworkType = await createPrompt(async () => select({
+			message: "What framework would you like to use for the project?",
+			options: [
+				{
+					label: "Bun (Recommended)",
+					value: "bun"
+				},
+				{
+					label: "NPM",
+					value: "npm"
+				},
+				{
+					label: "PNPM",
+					value: "pnpm"
+				}
+			]
+		}));
+		const shouldInstallDependencies = await createPrompt(async () => confirm({ message: "Once the template is ready, would you like me to install my dependencies?" }));
+		let clonedDirectory = void 0;
+		const installationTasks = [{
+			task: async () => {
+				const { dir } = await downloadTemplate(`gh:${PACKAGE_NAME}`, {
+					dir: targetDirectory,
+					ignore: IGNORE_PATH_LIST
+				});
+				clonedDirectory = dir;
+			},
+			title: "Pulling most recent version from GitHub."
+		}, {
+			task: async () => {
+				if (clonedDirectory === void 0) throw new InternalError("Failed to clone.");
+				const clonedPackageContents = await readFile(`${clonedDirectory}/package.json`, "utf8");
+				const clonedPackage = JSON.parse(clonedPackageContents);
+				if (!isValidPackage(clonedPackage)) throw new InternalError("Invalid package.");
+				Object.assign(clonedPackage, DEFAULT_PACKAGE);
+				clonedPackage.author = {
+					email: authorEmail,
+					name: authorName
+				};
+				clonedPackage.name = projectName;
+				if (clonedPackage.scripts) clonedPackage.scripts = Object.fromEntries(Object.entries(clonedPackage.scripts).filter(([script]) => !EXCLUDED_PACKAGE_SCRIPTS.has(script)));
+				await writeFile(`${clonedDirectory}/package.json`, JSON.stringify(clonedPackage, void 0, 2));
+				await replaceOccurrences({
+					cwd: clonedDirectory,
+					extensions: [
+						"ts",
+						"tsx",
+						"json"
+					],
+					queries: [{
+						query: `"@repo/`,
+						replaceWith: `"@${projectName}/`
+					}, {
+						query: "'@repo/",
+						replaceWith: `'@${projectName}/`
+					}]
+				});
+			},
+			title: "Applying configured options to template."
+		}];
+		if (shouldInstallDependencies) installationTasks.push({
+			task: async () => {
+				await execute(DEFAULT_INSTALL_COMMANDS[frameworkType], { cwd: clonedDirectory });
+			},
+			title: "Installing dependencies."
+		});
+		await tasks(installationTasks);
+		outro(`Your project was successfully created at: ${clonedDirectory}`);
+	} catch (error) {
+		if (error instanceof ActionAbortedError) log.error("Installation was aborted.");
+		else if (error instanceof InternalError) log.error(error.message);
+		else log.error("Something went wrong, please try again.");
+		process.exitCode = 1;
+	}
+};
+await main();
+//#endregion
+export {};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@twobrake/create-monorepo",
+  "version": "0.1.0",
+  "description": "The installer for an opinionated monorepo starter for TypeScript built on the Bun ecosystem.",
+  "keywords": [
+    "bun",
+    "installer",
+    "monorepo",
+    "oxfmt",
+    "oxlint",
+    "template",
+    "typescript"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "Lucas Stranks"
+  },
+  "bin": {
+    "create-monorepo": "dist/index.mjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test-install": "bun run src/index.ts",
+    "build": "tsdown",
+    "build:watch": "tsdown --watch",
+    "release": "bun publish --access public",
+    "prepublishOnly": "bun run build"
+  },
+  "dependencies": {
+    "@clack/prompts": "^1.8.1",
+    "giget": "^3.3.1",
+    "zod": "^4.6.5"
+  },
+  "devDependencies": {
+    "@repo/utility": "0.0.0",
+    "tsdown": "^0.23.0",
+    "type-fest": "^5.10.0"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}