@twobrake/create-monorepo 0.1.2 → 0.1.3

package/README.md

@@ -4,14 +4,22 @@
         <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" />
+        <img src="https://img.shields.io/github/actions/workflow/status/twobrake/bun-monorepo/lint.yml?branch=main&label=CI&style=for-the-badge&logo=githubactions" alt="CI State" />
+        <img src="https://img.shields.io/github/license/twobrake/bun-monorepo?style=for-the-badge&label=License&color=white&logo=unlicense" alt="License" />
+        <img src="https://img.shields.io/github/last-commit/twobrake/bun-monorepo?style=for-the-badge&label=Committed&color=orange&logo=git" alt="Committed" />
+        <img src="https://img.shields.io/github/issues/twobrake/bun-monorepo?style=for-the-badge&label=Issues&color=red&logo=github" alt="Issues" />
+        <img src="https://img.shields.io/npm/v/%40twobrake%2Fcreate-monorepo?style=for-the-badge&label=Installer Version&logo=npm&color=red" />
     </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>
+    <p>A template/project can be created fairly easily due to our installation helper published on NPM. This is useable by running the following in your terminal.</p>
+    <pre><code>npx @twobrake/create-monorepo</code></pre>
+    <p>This will run the installation helper in your current directory and guide you through configuration steps to finalize the project. You will be asked to select a directory and it is important to prepare the directory <strong>before running the helper</strong>. Please ensure this directory is empty as an already populated directory could cause issues.</p>
+    <p>If you prefer Bun over NPM's CLI due to it's performance enhancements, feel free to use the following command instead of the one above.</p>
+    <pre><code>bunx @twobrake/create-monorepo</code></pre>
+    <h2>Contributions</h2>
+    <p>If you have a passionate interest in this project, feel free to make suggestions or direct contributions through <a href="https://github.com/TwoBrake/bun-monorepo/issues" target="_blank">GitHub issues</a>. You can also leave comments on other people's suggestions with more features you may want added. Please keep in mind, this project is not meant to be largely scaled as it is a starting point to <strong>your project</strong>.</p>
 </div>

package/dist/index.mjs

@@ -40,7 +40,11 @@ const EXCLUDED_PACKAGE_SCRIPTS = new Set(["installer:build", "installer:publish"
 const IGNORE_PATH_LIST = [
 	"packages/installer",
 	"packages/installer/**",
-	"README.md"
+	"README.md",
+	".github/images",
+	".github/images/**",
+	".github/workflows/publish-installer.yml",
+	".github/dependabot.yml"
 ];
 const replaceOccurrences = async (data) => {
 	const { cwd, extensions, queries } = data;
@@ -73,7 +77,7 @@ const createPrompt = async (prompt) => {
 const execute = promisify(exec);
 //#endregion
 //#region package.json
-var version = "0.1.2";
+var version = "0.1.3";
 //#endregion
 //#region src/index.ts
 const main = async () => {
@@ -167,6 +171,9 @@ const main = async () => {
 			},
 			title: "Installing dependencies."
 		});
+		log.info(`Overview:\n\nProject Name: ${projectName}\nAuthor Name: ${authorName}\nAuthor Email: ${authorEmail}\nPath: ${targetDirectory}\nFramework: ${frameworkType}\nInstall Dependencies: ${shouldInstallDependencies ? "Yes" : "No"}`);
+		log.warn("Proceeding to the next step will start the installation process. Cancelling during it may cause unintended side-effects.");
+		if (!await createPrompt(async () => confirm({ message: "Are you sure you want to finalize the installation?" }))) throw new ActionAbortedError("User cancelled.");
 		await tasks(installationTasks);
 		outro(`Your project was successfully created at: ${clonedDirectory}`);
 	} catch (error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@twobrake/create-monorepo",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "The installer for an opinionated monorepo starter for TypeScript built on the Bun ecosystem.",
   "keywords": [
     "bun",