Merge pull request #40 from Shivansh-Khunger/version-1

🍬 Enhancement: Multiple Package Manager

Author: Shivansh-Khunger

README.md

@@ -1,9 +1,13 @@
-# create-node-nitro <a href="https://www.npmjs.com/package/create-node-nitro"><img src="https://img.shields.io/npm/v/create-node-nitro" alt="npm package"></a>
+# create-nitro <a href="https://www.npmjs.com/package/create-node-nitro"><img src="https://img.shields.io/npm/v/create-nitro" alt="npm package"></a>
+
+<div align="center">
+<img src="https://i.ibb.co/YBfq0GH/nitro-logo.png" alt="nitro-logo" width="256" >
+</div>
 
 ## Scaffolding Your Node API's
 
 > **Compatibility Note:**
-> Vite requires [Node.js](https://nodejs.org/en/) version 18+, 20+. However, some templates require a higher Node.js version to work, please upgrade if your package manager warns about it.
+> Nitro requires [Node.js](https://nodejs.org/en/) version 18+, 20+. However, some templates require a higher Node.js version to work, please upgrade if your package manager warns about it.
 
 ### Features
 
@@ -15,7 +19,19 @@
 With NPM:
 
 ```bash
-$ npm create node-nitro@latest
+npm create nitro@latest
+```
+
+With Yarn:
+
+```bash
+yarn create nitro
+```
+
+With PNPM:
+
+```bash
+pnpm create nitro
 ```
 
 Then follow the prompts!
@@ -24,7 +40,13 @@ You can also directly specify the project name and the template you want to use
 
 ```bash
 # npm 7+, extra double-dash is needed:
-npm create node-nitro@latest -- -t <template name> -d <directory name>
+npm create nitro@latest -- -t <template name> -d <directory name>
+
+# yarn
+yarn create nitro -t <template name> -d <directory name>
+
+# pnpm
+pnpm create nitro -t <template name> -d <directory name>
 ```
 
 Currently supported template presets include:

package.json

@@ -1,17 +1,17 @@
 {
-    "name": "create-node-nitro",
-    "version": "0.1.0-beta.7",
+    "name": "create-nitro",
+    "version": "1.0.0",
     "description": "",
     "main": "index.js",
+    "license": "MIT",
     "scripts": {
         "build": "tspc",
         "dev": "tspc --watch",
         "test": "echo \"Error: no test specified\" && exit 1",
-        "start": "node ./index.js",
         "pub": "npm run build && npm publish"
     },
     "bin": {
-        "create-node-nitro": "index.js"
+        "create-nitro": "index.js"
     },
     "files": [
         "dist/**",

src/helpers/handleOptions.ts

@@ -1,6 +1,3 @@
-// Import necessary external Module(s)
-import { bgCyan, yellow } from "kolorist";
-
 // Import necessary Type(s)
 import type { T_UserInputCli } from "../types/prompt";
 
@@ -10,14 +7,14 @@ function handleAdditionalOptions(
     tempDevDependency: string,
 ) {
     let dependency = tempDependency;
-    let devDependency = `${tempDevDependency} prettier`;
+    let devDependency = tempDevDependency;
 
     if (userInput.formatterAndLinter === "biome-prettier") {
         devDependency = `${devDependency} @biomejs/biome`;
     } else {
         devDependency = `${devDependency} eslint`;
         if (userInput.template === "express/ts") {
-            devDependency = `${devDependency} @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-prettier`;
+            devDependency = `${devDependency} @eslint/js @types/eslint__js typescript typescript-eslint eslint-plugin-prettier`;
         }
     }
 
@@ -29,15 +26,10 @@ function handleAdditionalOptions(
         }
     }
 
-    const installCmd = `${dependency} && ${devDependency}`;
-
-    console.log(
-        `${yellow("Installling dependencies...\ncommand ->")} ${bgCyan(
-            ` ${installCmd} `,
-        )}`,
-    );
-
-    return installCmd;
+    return {
+        updtDependencyCmd: dependency,
+        updtDevDependencyCmd: devDependency,
+    };
 }
 
 export default handleAdditionalOptions;

src/helpers/pkgManager.ts

@@ -0,0 +1,49 @@
+function pkgFromUserAgent(userAgent: string | undefined) {
+    if (!userAgent) return undefined;
+    const pkgSpec = userAgent.split(" ")[0];
+    const pkgSpecArr = pkgSpec.split("/");
+    return {
+        name: pkgSpecArr[0],
+        version: pkgSpecArr[1],
+    };
+}
+
+export type T_PkgManagerInfo = {
+    pkgManager: string;
+    prefix: string;
+    devPrefix: string;
+};
+
+const pkgInfo = pkgFromUserAgent(process.env.npm_config_user_agent);
+const pkgManager = pkgInfo ? pkgInfo.name : "npm";
+
+function selectPkgManager(): T_PkgManagerInfo {
+    let pkgManagerInfo: T_PkgManagerInfo = {
+        pkgManager: pkgManager,
+        prefix: "npm i",
+        devPrefix: "npm i --save-dev",
+    };
+
+    if (pkgManager === "yarn") {
+        pkgManagerInfo = {
+            ...pkgManagerInfo,
+            prefix: "yarn add",
+            devPrefix: "yarn add --dev",
+        };
+
+        return pkgManagerInfo;
+    }
+    if (pkgManager === "pnpm") {
+        pkgManagerInfo = {
+            ...pkgManagerInfo,
+            prefix: "pnpm add",
+            devPrefix: "pnpm add --save-dev",
+        };
+
+        return pkgManagerInfo;
+    }
+
+    return pkgManagerInfo;
+}
+
+export default selectPkgManager;

src/helpers/printDependencies.ts

@@ -0,0 +1,43 @@
+import { gray } from "kolorist";
+
+import type { T_PkgManagerInfo } from "./pkgManager";
+
+function printDependencies(
+    dependencyCmd: string,
+    devDependencyCmd: string,
+    pkgManagerInfo: T_PkgManagerInfo,
+) {
+    if (pkgManagerInfo.pkgManager === "pnpm") {
+        // pnpm does this by default
+        return;
+    }
+
+    const dependencies = dependencyCmd.replace(pkgManagerInfo.prefix, "");
+    const devDependencies = devDependencyCmd.replace(
+        pkgManagerInfo.devPrefix,
+        "",
+    );
+
+    const dependenciesArr = dependencies.split(" ");
+    const devDependenciesArr = devDependencies.split(" ");
+
+    console.log(
+        `\nDownloading dependencies... (${pkgManagerInfo.pkgManager})\n`,
+    );
+
+    console.log("Dependencies -:");
+    dependenciesArr.map((d: string) => {
+        console.log(`${gray(d)}`);
+    });
+
+    console.log("\nDev-Dependencies -:");
+    devDependenciesArr.map((d: string) => {
+        console.log(`${gray(d)}`);
+    });
+
+    if (pkgManagerInfo.pkgManager !== "npm") {
+        console.log("\n");
+    }
+}
+
+export default printDependencies;

src/index.ts

@@ -7,29 +7,26 @@ import addDbAndOrm from "@helpers/db&Orms";
 import { makeDevEnv, makeProdEnv } from "@helpers/envMaker";
 import addFmtAndLinterConfig from "@helpers/fmt&Linters";
 import handleAdditionalOptions from "@helpers/handleOptions";
+import selectPkgManager from "@helpers/pkgManager";
+import printDependencies from "@helpers/printDependencies";
 import { parseArgs, startUserInteraction } from "@utils/cli";
 import handleError, { makeTargetPath } from "@utils/errorHandler";
-
 import { renameFile } from "@utils/fileSystem";
+
+// Import external Module(s)
+import { gray, lightBlue, red } from "kolorist";
+
 // Import necessary Type(s)
 import type {
     T_Arg_HandleArgs,
     T_Arg_HandleCli,
 } from "./types/dependencyInstallers";
 import type { T_UserInput } from "./types/prompt";
 
-let filePathArr: string[];
-export let projectDirPath: string;
-
-if (process.platform === "win32") {
-    filePathArr = __dirname.split("\\");
-    filePathArr.pop();
-    projectDirPath = filePathArr.join("\\");
-} else {
-    filePathArr = __dirname.split("/");
-    filePathArr.pop();
-    projectDirPath = filePathArr.join("/");
-}
+const sysPathDisapator = process.platform === "win32" ? "\\" : "/";
+const filePathArr = __dirname.split(sysPathDisapator);
+filePathArr.pop();
+export const projectDirPath = filePathArr.join(sysPathDisapator);
 
 (async () => {
     const parsedArgs = parseArgs();
@@ -46,6 +43,16 @@ if (process.platform === "win32") {
 function copyTemplate(targetPath: string, targetTemplate: string) {
     try {
         const templatePath = `${projectDirPath}/templates/${targetTemplate}`;
+        const exists = fs.existsSync(targetPath);
+
+        if (exists) {
+            console.log(
+                `\n${red(
+                    "Program stopped",
+                )}\nReason -: A directory with the same name exists.`,
+            );
+            process.exit(1);
+        }
 
         fs.cpSync(templatePath, targetPath, { recursive: true });
     } catch (err) {
@@ -74,18 +81,24 @@ function performRenames(targetPath: string) {
 }
 
 function installDependecies(targetPath: string, userInput: T_UserInput) {
-    const dependencyCmd = "npm i express pino pino-http pino-pretty";
-    let devDependencyCmd: string;
+    const pkgManagerInfo = selectPkgManager();
+
+    const dependencyCmd = `${pkgManagerInfo.prefix} express pino pino-http pino-pretty`;
+    let devDependencyCmd = "prettier";
 
     function handleArgs({
         dependencyCmd,
         devDependencyCmd,
         targetPath,
     }: T_Arg_HandleArgs) {
         const installCmd = `${dependencyCmd} && ${devDependencyCmd}`;
+
+        printDependencies(dependencyCmd, devDependencyCmd, pkgManagerInfo);
+
         try {
             execSync(installCmd, {
                 cwd: targetPath,
+                stdio: "inherit",
             });
         } catch (err) {
             handleError(err);
@@ -98,18 +111,24 @@ function installDependecies(targetPath: string, userInput: T_UserInput) {
         devDependencyCmd,
         targetPath,
     }: T_Arg_HandleCli) {
-        const installCmd = handleAdditionalOptions(
-            userInput,
-            dependencyCmd,
-            devDependencyCmd,
-        );
+        // these are updated dependency and devDependecy commands which include all the extra options
+        const { updtDependencyCmd, updtDevDependencyCmd } =
+            handleAdditionalOptions(userInput, dependencyCmd, devDependencyCmd);
 
         addFmtAndLinterConfig(
             userInput.formatterAndLinter,
             targetPath,
             projectDirPath,
         );
 
+        const installCmd = `${updtDependencyCmd} && ${updtDevDependencyCmd}`;
+
+        printDependencies(
+            updtDependencyCmd,
+            updtDevDependencyCmd,
+            pkgManagerInfo,
+        );
+
         try {
             execSync(installCmd, {
                 cwd: targetPath,
@@ -127,7 +146,7 @@ function installDependecies(targetPath: string, userInput: T_UserInput) {
     switch (userInput.template) {
         case "express/js":
             {
-                devDependencyCmd = "npm i --save-dev @dotenvx/dotenvx nodemon";
+                devDependencyCmd = `${pkgManagerInfo.devPrefix} ${devDependencyCmd} @dotenvx/dotenvx nodemon`;
 
                 if (userInput.type === "args") {
                     handleArgs({ dependencyCmd, devDependencyCmd, targetPath });
@@ -143,8 +162,7 @@ function installDependecies(targetPath: string, userInput: T_UserInput) {
             break;
         case "express/ts":
             {
-                devDependencyCmd =
-                    "npm i --save-dev tsx typescript @dotenvx/dotenvx @types/express @types/node";
+                devDependencyCmd = `${pkgManagerInfo.devPrefix} ${devDependencyCmd} tsx typescript @dotenvx/dotenvx @types/express @types/node`;
 
                 if (userInput.type === "args") {
                     handleArgs({ dependencyCmd, devDependencyCmd, targetPath });
@@ -174,4 +192,10 @@ function handleLogic(userInput: T_UserInput) {
     performRenames(targetPath);
     intialiseGitRepo(targetPath);
     installDependecies(targetPath, userInput);
+
+    console.log(
+        `\n${lightBlue("Project made at -:")} ${gray(
+            `${targetPath},`,
+        )} Hope you finish this one ;)`,
+    );
 }

src/utils/cli.ts

@@ -209,7 +209,7 @@ export async function startUserInteraction() {
         ],
         {
             onCancel() {
-                console.log(red("program stopped keyboard interupt"));
+                console.log(`\n${red("Program stopped")}\nReason -: Keyboard interupt.`);
                 process.exit(1);
             },
         },

src/utils/errorHandler.ts

@@ -6,7 +6,9 @@ import { bold, green, lightRed } from "kolorist";
 const cwd = process.cwd();
 let targetPath: string;
 export function makeTargetPath(userInputDirName: string) {
-    targetPath = `${cwd}/${userInputDirName}`;
+    targetPath = `${cwd}${
+        process.platform === "win32" ? "\\" : "/"
+    }${userInputDirName}`;
 
     return targetPath;
 }