@dolphjs/cli 0.0.1-beta

package/new-app.mjs

@@ -0,0 +1,352 @@
+#!/usr/bin/env node
+import { Command } from "commander";
+import { exec, execSync } from "child_process";
+import { mkdirSync } from "fs";
+import inquirer from "inquirer";
+import chalk from "chalk";
+import ora from "ora";
+import writeTsFilePackage from "./utils/ts-oop/packageData.mjs";
+import writeTsFuncFilePackage from "./utils/ts-func/packageData.mjs";
+import writeJsFIlePackage from "./utils/js-func/packageData.mjs";
+import writeTsFileSwcrc from "./utils/ts-oop/swcrcData.mjs";
+import writeGitignoreFile from "./utils/ts-oop/gitignoreData.mjs";
+import writeTsNodemonFile from "./utils/ts-oop/nodemonData.mjs";
+import writeReadmeFile from "./utils/ts-oop/readmeData.mjs";
+import writeTsOopSubFile from "./utils/ts-oop/copySubFolder.mjs";
+import writeTsFuncSubFile from "./utils/ts-func/copySubFolder.mjs";
+import writeSubFileJsFunc from "./utils/js-func/writeSubFile.mjs";
+import writeSubFileJsOop from "./utils/js-oop/writeSubFileJsOop.mjs";
+import writeTsconfigFile from "./utils/ts-oop/tsconfigFile.mjs";
+import { jsFunc, jsOop, tsFunc, tsOop } from "./utils/constants/types.mjs";
+import { npm, pnpm, yarn } from "./utils/constants/packageManagers.mjs";
+import {
+  dependencies,
+  devDependencies,
+  tsDependencies,
+  tsDevDependencies,
+} from "./utils/dependencies.mjs";
+
+const program = new Command();
+
+program
+  .version("1.0.0")
+  .command("create-app <app-name>")
+  .description("Create a new dolphJs application")
+  .action(async (appName) => {
+    try {
+      console.log(
+        chalk.blueBright("Initializing your dolphJs application...") + "🐬"
+      );
+      const options = [tsOop, tsFunc, jsOop, jsFunc];
+      const { selectedOption } = await inquirer.prompt([
+        {
+          type: "list",
+          name: "selectedOption",
+          message: "How do you want to write your application ? 🤔:",
+          choices: options,
+        },
+      ]);
+
+      const packageManagerOptions = [npm, yarn, pnpm];
+      const { selectedPackageManagerOption } = await inquirer.prompt([
+        {
+          type: "list",
+          name: "selectedPackageManagerOption",
+          message: "Which is your preffered package manager ? :",
+          choices: packageManagerOptions,
+        },
+      ]);
+      console.info(chalk.green(`Using ${selectedPackageManagerOption}!`));
+      console.log(
+        chalk.green(`Getting your application ready for ${selectedOption}!`)
+      );
+      mkdirSync(appName);
+      process.chdir(appName);
+      if (selectedOption === tsOop) {
+        writeTsFilePackage(appName);
+        writeTsFileSwcrc();
+        writeGitignoreFile();
+        writeTsNodemonFile();
+        writeReadmeFile();
+        writeTsconfigFile();
+        mkdirSync("src");
+        mkdirSync("src/config");
+        mkdirSync("src/controllers");
+        mkdirSync("src/interfaces");
+        mkdirSync("src/routes");
+        writeTsOopSubFile();
+      }
+      if (selectedOption === tsFunc) {
+        writeTsFuncFilePackage(appName);
+        writeTsFileSwcrc();
+        writeGitignoreFile();
+        writeTsNodemonFile();
+        writeTsconfigFile();
+        writeReadmeFile();
+        mkdirSync("src");
+        mkdirSync("src/config");
+        mkdirSync("src/controllers");
+        mkdirSync("src/routes");
+        writeTsFuncSubFile();
+      }
+
+      if (selectedOption === jsFunc) {
+        writeJsFIlePackage(appName);
+        writeReadmeFile();
+        writeGitignoreFile();
+        mkdirSync("src");
+        mkdirSync("src/config");
+        mkdirSync("src/controllers");
+        mkdirSync("src/routes");
+        writeSubFileJsFunc();
+      }
+
+      if (selectedOption === jsOop) {
+        writeJsFIlePackage(appName);
+        writeReadmeFile();
+        writeGitignoreFile();
+        mkdirSync("src");
+        mkdirSync("src/config");
+        mkdirSync("src/controllers");
+        mkdirSync("src/routes");
+        writeSubFileJsOop();
+      }
+
+      // install dependencies using child process execSync
+      try {
+        const spinner = ora("Installing dependencies...").start();
+        let installCommand = "yarn add";
+        let runMsg = "yarn dev";
+
+        switch (selectedPackageManagerOption) {
+          case npm:
+            installCommand = "npm install";
+            runMsg = "npm run dev";
+            break;
+          case pnpm:
+            installCommand = "pnpm add";
+            runMsg = "pnpm dev";
+          case yarn:
+            installCommand = installCommand;
+          default:
+            break;
+        }
+
+        if (selectedOption === jsFunc || selectedOption === jsOop) {
+          execSync(`${installCommand} ${dependencies.join(" ")}`);
+        } else if (selectedOption === tsFunc || selectedOption === tsOop) {
+          execSync(`${installCommand} ${tsDependencies.join(" ")}`);
+        }
+        spinner.succeed("Dependencies installed!");
+
+        // prompt user to select an option
+
+        // create app directory and copy files
+
+        // update package.json file
+        console.log(chalk.yellow("Updating package.json..."));
+        // install dev dependencies
+        const spinner2 = ora("Installing dev dependencies...").start();
+
+        if (selectedOption === jsFunc || selectedOption === jsOop) {
+          exec(`${installCommand} ${devDependencies.join(" ")}`);
+        } else if (selectedOption === tsFunc || selectedOption === tsOop) {
+          exec(`${installCommand} ${tsDevDependencies.join(" ")}`);
+        }
+
+        spinner2.succeed("Dev dependencies installed!");
+
+        // show completion message
+        console.log(
+          chalk.green(
+            `Done! Your app has been created. Navigate to your app by running "cd ${appName}" and then run ${chalk.bgGreen(
+              runMsg
+            )}`
+          )
+        );
+      } catch (error) {
+        console.log(chalk.redBright("\nError creating your app", error));
+      }
+    } catch (error) {
+      console.log(chalk.redBright("Error creating your app", error));
+    }
+  });
+
+program
+  .version("1.0.0")
+  .command("create-app <app-name>")
+  .description("Create a new dolphJs application")
+  .action(async (appName) => {
+    try {
+      console.log(
+        chalk.blueBright("Initializing your dolphJs application...") + "🐬"
+      );
+      const options = [tsOop, tsFunc, jsOop, jsFunc];
+      const { selectedOption } = await inquirer.prompt([
+        {
+          type: "list",
+          name: "selectedOption",
+          message: "How do you want to write your application ? 🤔:",
+          choices: options,
+        },
+      ]);
+
+      const packageManagerOptions = [npm, yarn, pnpm];
+      const { selectedPackageManagerOption } = await inquirer.prompt([
+        {
+          type: "list",
+          name: "selectedPackageManagerOption",
+          message: "Which is your preffered package manager ? :",
+          choices: packageManagerOptions,
+        },
+      ]);
+      console.info(chalk.green(`Using ${selectedPackageManagerOption}!`));
+      console.log(
+        chalk.green(`Getting your application ready for ${selectedOption}!`)
+      );
+      mkdirSync(appName);
+      process.chdir(appName);
+      if (selectedOption === tsOop) {
+        writeTsFilePackage(appName);
+        writeTsFileSwcrc();
+        writeGitignoreFile();
+        writeTsNodemonFile();
+        writeReadmeFile();
+        writeTsconfigFile();
+        mkdirSync("src");
+        mkdirSync("src/config");
+        mkdirSync("src/controllers");
+        mkdirSync("src/interfaces");
+        mkdirSync("src/routes");
+        writeTsOopSubFile();
+      }
+      if (selectedOption === tsFunc) {
+        writeTsFuncFilePackage(appName);
+        writeTsFileSwcrc();
+        writeGitignoreFile();
+        writeTsNodemonFile();
+        writeTsconfigFile();
+        writeReadmeFile();
+        mkdirSync("src");
+        mkdirSync("src/config");
+        mkdirSync("src/controllers");
+        mkdirSync("src/routes");
+        writeTsFuncSubFile();
+      }
+
+      if (selectedOption === jsFunc) {
+        writeJsFIlePackage(appName);
+        writeReadmeFile();
+        writeGitignoreFile();
+        mkdirSync("src");
+        mkdirSync("src/config");
+        mkdirSync("src/controllers");
+        mkdirSync("src/routes");
+        writeSubFileJsFunc();
+      }
+
+      if (selectedOption === jsOop) {
+        writeJsFIlePackage(appName);
+        writeReadmeFile();
+        writeGitignoreFile();
+        mkdirSync("src");
+        mkdirSync("src/config");
+        mkdirSync("src/controllers");
+        mkdirSync("src/routes");
+        writeSubFileJsOop();
+      }
+
+      // install dependencies using child process execSync
+      try {
+        const spinner = ora("Installing dependencies...").start();
+        let installCommand = "yarn add";
+        let runMsg = "yarn dev";
+
+        switch (selectedPackageManagerOption) {
+          case npm:
+            installCommand = "npm install";
+            runMsg = "npm run dev";
+            break;
+          case pnpm:
+            installCommand = "pnpm add";
+            runMsg = "pnpm dev";
+          case yarn:
+            installCommand = installCommand;
+          default:
+            break;
+        }
+
+        if (selectedOption === jsFunc || selectedOption === jsOop) {
+          execSync(`${installCommand} ${dependencies.join(" ")}`);
+        } else if (selectedOption === tsFunc || selectedOption === tsOop) {
+          execSync(`${installCommand} ${tsDependencies.join(" ")}`);
+        }
+        spinner.succeed("Dependencies installed!");
+
+        // prompt user to select an option
+
+        // create app directory and copy files
+
+        // update package.json file
+        console.log(chalk.yellow("Updating package.json..."));
+        // install dev dependencies
+        const spinner2 = ora("Installing dev dependencies...").start();
+
+        if (selectedOption === jsFunc || selectedOption === jsOop) {
+          exec(`${installCommand} ${devDependencies.join(" ")}`);
+        } else if (selectedOption === tsFunc || selectedOption === tsOop) {
+          exec(`${installCommand} ${tsDevDependencies.join(" ")}`);
+        }
+
+        spinner2.succeed("Dev dependencies installed!");
+
+        // show completion message
+        console.log(
+          chalk.green(
+            `Done! Your app has been created. Navigate to your app by running "cd ${appName}" and then run ${chalk.bgGreen(
+              runMsg
+            )}`
+          )
+        );
+      } catch (error) {
+        console.log(chalk.redBright("\nError creating your app", error));
+      }
+    } catch (error) {
+      console.log(chalk.redBright("Error creating your app", error));
+    }
+  });
+
+program.command("help").action(() => {
+  console.info(
+    chalk.white(
+      "The `create-app` command would walk you through a few questions in order to create your app how you desire together with dolphjs' unique and scalable application structure."
+    )
+  );
+  console.info(chalk.blue("Options: "));
+  console.info(
+    chalk.white(
+      "-v, --version                                       output the verson number"
+    )
+  );
+  console.info(
+    chalk.white(
+      "-h, --version                                       display help for command"
+    )
+  );
+
+  console.info(chalk.blue("Commands: "));
+  console.info(
+    chalk.white(
+      "create-app, <app-name>                               Create a new dolphjs app"
+    )
+  );
+});
+
+program.command("*", { hidden: true }).action(() => {
+  console.log(
+    chalk.redBright(`Unknown command. See the list of available commands:`)
+  );
+  program.help();
+});
+
+program.parse(process.argv);

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@dolphjs/cli",
+  "version": "0.0.1beta",
+  "description": "DolphJs is an express.js library for making software development easier by taking care of all the unneccessary tasks developers have to worry about.",
+  "main": "new-app.mjs",
+  "bin": {
+    "dolph": "./new-app.mjs"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "node new-app.mjs",
+    "push": "npm publish"
+  },
+  "keywords": [
+    "Dolph-cli",
+    "DolphJs",
+    "ExpressJs",
+    "API",
+    "NodeJs",
+    "JavaScript",
+    "dolphjs",
+    "dolph-cli",
+    "dolphcli"
+  ],
+  "sponsor": {
+    "url": "https://questgig.com"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Ghostcod3r <https://github.com/chrisegbaaaibon>",
+  "maintainers": [
+    "Christopher Egbaaibon <https://github.com/chrisegbaaaibon>",
+    "Utibeabasi Ekong <https://github.com/Xlaez>"
+  ],
+  "contributors": [
+    "Utibeabasi Ekong <https://github.com/Xlaez>"
+  ],
+  "repository": "https://github.com/dolphjs/cli",
+  "license": "MIT",
+  "dependencies": {
+    "@types/handlebars": "^4.1.0",
+    "chalk": "^5.2.0",
+    "child_process": "^1.0.2",
+    "command-not-found": "^0.0.3",
+    "commander": "^10.0.0",
+    "inquirer": "^9.1.4",
+    "ora": "^6.1.2",
+    "typescript": "^4.9.5"
+  }
+}

package/readme.md

@@ -0,0 +1,25 @@
+<p align="center">
+  <a href="https://www.npmjs.com/package/dolphjs/core" target="blank"><img src="https://github.com/Chrisegbaaaibon/Media/blob/master/Images/DolphJS-logo-small.png?raw=true" width="120" alt="Dolph Logo" /></a>
+</p>
+
+# DolphJs-CLI
+
+The CLI application provides developers with an easy and fast way to generate a dolphjs application structure.
+It is advisable to always build your applications using the CLI tool so as to maintain the design and pattern dolphjs implements.
+
+## Installation
+
+To install the package, run:
+
+`npm install @dolphjs/cli -g`
+
+## START
+
+To run the CLI application, run:
+
+`dolph create-app "app-name"`
+
+## HELP
+
+For help run the :
+`dolph help` command

package/utils/constants/packageManagers.mjs

@@ -0,0 +1,3 @@
+export const npm = "npm"
+export const yarn = "yarn"
+export const pnpm = "pnpm"

package/utils/constants/types.mjs

@@ -0,0 +1,4 @@
+export const tsOop = 'TypeScript - Object Oriented Programming'
+export const tsFunc =  'TypeScript - Functional Programming'
+export const jsOop = 'Javascript - Object Oriented Programming'
+export const jsFunc=  'Javascript - Functional Programming'

package/utils/dependencies.mjs

@@ -0,0 +1,24 @@
+export const dependencies = [
+  "@dolphjs/core",
+  "cors",
+  "cross-env",
+  "dotenv",
+  "joi",
+];
+
+export const devDependencies = ["@types/express", "node-config", "nodemon"];
+
+export const tsDependencies = [...dependencies, "class-transformer"];
+export const tsDevDependencies = [
+  ...devDependencies,
+  "@swc/cli",
+  "@swc/core",
+  "@types/cors",
+  "@types/joi",
+  "@types/node",
+  "ts-node",
+  "tsc-alias",
+  "tsconfig-paths",
+  "typescript",
+  "nodemon",
+];

package/utils/js-func/packageData.mjs

@@ -0,0 +1,20 @@
+import { writeFileSync } from "fs";
+
+export default function writeFilePackage(appName) {
+  const packageJsonData = {
+    name: appName,
+    version: "1.0.0",
+    description: "",
+    main: "src/index.js",
+    scripts: {
+      dev: "cross-env NODE_ENV=development nodemon src/index.js",
+      start: "cross-env NODE_ENV=production node src/index.js",
+    },
+    keywords: [],
+    author: "",
+    license: "ISC",
+    dependencies: {},
+    devDependencies: {},
+  };
+  writeFileSync(`./package.json`, JSON.stringify(packageJsonData, null, 2));
+}

package/utils/js-func/writeSubFile.mjs

@@ -0,0 +1,96 @@
+import { writeFileSync } from "fs";
+
+const indexRoute = `const { Router } = '@dolphjs/core';
+const demoRoute = require('./demo.route');
+
+const defaultRoutes = [
+\t{
+\t\tpath: '/',
+\t\trouter: demoRoute,
+\t},
+];
+
+module.exports = defaultRoutes;
+`;
+
+const demoRoutes =
+  "const { Router } = require('@dolphjs/core');\n\
+const { sendMsg } = require('@/controllers/demo.controller');\n\
+\
+const router = Router();\n\
+\
+const path = '/api/v1';\n\
+\
+router.get(`${path}`, sendMsg);\n\
+\
+module.exports = router;\n\
+";
+
+const indexData = `const Dolph = require('@dolphjs/core');
+const defaultRouter = require('./routes');
+const { env, port } = require('./config');
+const helmet = require('helmet');
+const cors = require('cors');
+
+const dolph = new Dolph(defaultRouter, port, env, null, [helmet(), cors()]);
+dolph.listen();
+`;
+
+const controllerDemo = `const { httpStatus, catchAsync } = require('@dolphjs/core');
+
+const sendMsg = catchAsync(async (req, res) => {
+\tconst message =
+\t'Welcome to the API end-point for the Dolph app. If you have problems getting started, visit https://github.com/dolphjs/\tcore#README.MD';
+\tres.status(httpStatus.OK).json({ message });
+});
+
+module.exports = { sendMsg };
+`;
+
+const configIndex =
+  "const dotenv = require('dotenv');\n\
+const path = require('path');\n\
+const Joi = require('joi');\n\
+\n\
+dotenv.config({});\n\
+\n\
+const envVarsSchema = Joi.object()\n\
+\t.keys({\n\
+\t\tNODE_ENV: Joi.string()\n\
+\t\t\t.valid('production', 'development', 'test')\n\
+\t\t\t.required(),\n\
+\t\tPORT: Joi.number().default(1919),\n\
+})\
+	.unknown();\n\
+\
+const { value: envVars, error } = envVarsSchema\n\
+\t.prefs({ errors: { label: 'key' } })\n\
+\t.validate(process.env);\n\
+\n\
+if (error) {\n\
+\tthrow new Error(`Config validation error: ${error.message}`);\n\
+}\n\
+\n\
+module.exports = {\n\
+\tenv: envVars.NODE_ENV,\n\
+\tport: envVars.PORT,\n\
+};\
+";
+
+const jsConfigFile = `{
+  "compilerOptions": {
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  }
+}
+`;
+
+export default function writeSubFileJsFunc() {
+  writeFileSync("src/index.js", indexData);
+  writeFileSync("src/config/index.js", configIndex);
+  writeFileSync("src/routes/demo.route.js", demoRoutes);
+  writeFileSync("src/routes/index.js", indexRoute);
+  writeFileSync("src/controllers/demo.controller.js", controllerDemo);
+  writeFileSync("jsConfig.json", jsConfigFile);
+}

package/utils/js-oop/packageData.mjs

@@ -0,0 +1,19 @@
+import { writeFileSync } from "fs";
+
+export default function writeFilePackageJs(appName) {
+  const packageJsonData = {
+    name: appName,
+    version: "1.0.0",
+    description: "",
+    main: "src/index.js",
+    scripts: {
+      dev: "cross-env NODE_ENV=development nodemon src/index.js",
+      start: "cross-env NODE_ENV=production node src/index.js",
+    },
+    keywords: [],
+    author: "",
+    license: "ISC",
+    dependencies: {},
+  };
+  writeFileSync(`./package.json`, JSON.stringify(packageJsonData, null, 2));
+}

package/utils/js-oop/writeSubFileJsOop.mjs

@@ -0,0 +1,94 @@
+import { writeFileSync } from "fs";
+
+const routeIndex =
+  "const { Router } = require('@dolphjs/core');\n\
+const DemoController = require('@/controllers/demo.controller');\n\
+\n\
+class DemoRouter {\n\
+\tpath = '/v1/api';\n\
+\tcontroller = new DemoController();\n\
+\trouter = Router();\
+\n\
+\n\
+\tconstructor() {\n\
+\t	this.Routes();\n\
+    }\n\
+\n\
+\tRoutes() {\n\
+\t\tthis.router.get(`${this.path}`, this.controller.sendMessage);\n\
+\t}\n\
+}\n\
+\n\
+module.exports = DemoRouter;\
+";
+
+const indexData = `const Dolph = require('@dolphjs/core');
+const { env, port } = require('./config');
+const DemoRouter = require('./routes/demo.route');
+const cors = require('cors');
+const helmet = require('helmet');
+
+const dolph = new Dolph([new DemoRouter()], port, env, null, [
+	helmet(),
+	cors({origin: '*'})
+]);
+dolph.listen();
+`;
+
+const controllerDemo = `const { httpStatus, catchAsync } = require('@dolphjs/core');
+
+class DemoController {
+	sendMessage = catchAsync(async (req, res) => {
+		const message =
+		'Welcome to the API end-point for the Dolph app. If you have problems getting started, visit https://github.com/dolphjs/core#README.MD';
+		res.status(httpStatus.OK).json({ message });
+	});
+}
+
+module.exports = DemoController;
+`;
+
+const configIndex =
+  "const dotenv = require('dotenv');\n\
+const Joi = require('joi');\n\
+\n\
+dotenv.config({});\n\
+\n\
+const envVarsSchema = Joi.object()\n\
+\t.keys({\n\
+\t\tNODE_ENV: Joi.string()\n\
+\t\t\t.valid('production', 'development', 'test'),\n\
+\t\tPORT: Joi.number().default(1919),\
+\t})\n\
+\t.unknown();\n\
+\n\
+const { value: envVars, error } = envVarsSchema\n\
+\t.prefs({ errors: { label: 'key' } })\n\
+\t.validate(process.env);\n\
+\n\
+if (error) {\n\
+\tthrow new Error(`Config validation error: ${error.message}`);\n\
+}\n\
+\n\
+module.exports = {\n\
+\t\tenv: envVars.NODE_ENV,\
+\t\tport: envVars.PORT,\n\
+};\
+";
+
+const jsConfigFile = `{
+  "compilerOptions": {
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  }
+}
+`;
+
+export default function writeSubFileJsOop() {
+  writeFileSync("src/index.js", indexData);
+  writeFileSync("src/config/index.js", configIndex);
+  writeFileSync("src/routes/demo.route.js", routeIndex);
+  writeFileSync("src/controllers/demo.controller.js", controllerDemo);
+  writeFileSync("jsConfig.json", jsConfigFile);
+}