@dolphjs/cli 0.1.1 → 1.0.0

package/package.json

@@ -1,54 +1,61 @@
 {
   "name": "@dolphjs/cli",
-  "version": "0.1.1",
-  "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"
-  },
+  "version": "1.0.0",
+  "description": "The dolphjs-cli is a tool for efficient intialization and management of a dolphjs project",
+  "main": "./dist/index.js",
+  "repository": "https://github.com/dolphjs/dolph-cli.git",
+  "author": "<https://github.com/Xlaez>",
+  "license": "MIT",
   "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"
+    "lint": "eslint .",
+    "check-lint": "eslint [0-9]*.ts",
+    "clean": "rimraf ./dist",
+    "build": "tsc ./lib/index.ts --esModuleInterop true --target ES2020 --module nodenext --moduleResolution nodenext --outDir dist",
+    "start": "npm run clean && npm run build  && node ./dist/index.js",
+    "dev": "ts-node ./lib/index.ts",
+    "dev:start": "node ./dist/index.js",
+    "pub": "npm run clean && npm run build"
   },
+  "type": "module",
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=18.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "author": "Ghostcod3r <https://github.com/chrisegbaaaibon>",
-  "maintainers": [
-    "Christopher Egbaaibon <https://github.com/chrisegbaaaibon>",
-    "Utibeabasi Ekong <https://github.com/Xlaez>"
+  "keywords": [
+    "Dolphjs-cli",
+    "Dolphjs-cli",
+    "Dolphjs",
+    "Dolph",
+    "NodeJs",
+    "cli"
   ],
-  "contributors": [
-    "Utibeabasi Ekong <https://github.com/Xlaez>"
+  "files": [
+    "dist/**/*"
   ],
-  "repository": "https://github.com/dolphjs/cli",
-  "license": "MIT",
+  "bin": {
+    "dolph-cli": "./dist/index.js",
+    "dc": "./dist/index.js"
+  },
   "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"
+    "chalk": "^5.3.0",
+    "commander": "^11.1.0",
+    "figlet": "^1.7.0",
+    "inquirer": "^9.2.12",
+    "js-yaml": "^4.1.0",
+    "rimraf": "^5.0.5"
+  },
+  "devDependencies": {
+    "@types/figlet": "^1.5.8",
+    "@types/inquirer": "^9.0.7",
+    "@types/node": "^20.9.1",
+    "dotenv": "^16.3.1",
+    "eslint": "^8.54.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.29.0",
+    "ts-node": "^10.9.1",
+    "tslint": "^6.1.3",
+    "typescript": "^5.2.2"
   }
 }

package/CODE_OF_CONDUCT.md

@@ -1,76 +0,0 @@
-# Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to make participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-- Using welcoming and inclusive language
-- Being respectful of differing viewpoints and experiences
-- Gracefully accepting constructive criticism
-- Focusing on what is best for the community
-- Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-- The use of sexualized language or imagery and unwelcome sexual attention or
-  advances
-- Trolling, insulting/derogatory comments, and personal or political attacks
-- Public or private harassment
-- Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-- Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies within all project spaces, and it also applies when
-an individual is representing the project or its community in public spaces.
-Examples of representing a project or community include using an official
-project e-mail address, posting via an official social media account, or acting
-as an appointed representative at an online or offline event. Representation of
-a project may be further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at <opensource-conduct@fb.com>. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see
-<https://www.contributor-covenant.org/faq>

package/CONTRIBUTING.md

@@ -1,91 +0,0 @@
-# Contributing
-
-Thank you for your interest in contributing to the DolphJs Docs!
-
-## Code of Conduct
-
-DolphJs has adopted a code of conduct that we expect contributors to adhere to.
-Please read the instructions in the [CODE_OF_CONDUCT](CODE_OF_CONDUCT) so
-you can understand our ethics.
-
-**Try to follow your own instructions.**
-
-When writing step-by-step instructions (e.g. how to install something), try to forget everything you know about the topic, and actually follow the instructions you wrote, a single step at time. Often you will discover that there is implicit knowledge that you forgot to mention, or that there are missing or out-of-order steps in the instructions. Bonus points for getting _somebody else_ to follow the steps and watching what they struggle with. Often it would be something very simple that you have not anticipated.
-
-## Guidelines for Code Examples
-
-### Syntax
-
-#### Prefer OOP to Functional Programming
-
-DolphJS is strictly built with the OOP approach.
-
-#### Use `const` where possible, otherwise `let`. Don't use `var`
-
-#### Don't use ES5 features when equivalent ES6 features have no downsides
-
-#### Don't forget to remove console.log's when finished with them
-
-#### Ensure that your code is scalable and uses the best implementation e.g prefer code with 0(n) to 0(logn)
-
-In particular, you should prefer arrow functions `const myFunction = () => ...` to named `functions` for top-level functions.
-
-### Style
-
-- Use semicolons.
-- No space between function names and parenthesis (`method() {}` not `method () {}`).
-- When in doubt, use the default style favored by [Prettier](https://prettier.io/playground/).
-
-### Highlighting
-
-Use `javascript` as the highlighting language in Markdown code blocks:
-
-````
-```javascript
-// code
-```
-````
-
-Sometimes you'll see blocks with numbers.  
-They tell the website to highlight specific lines.
-
-You can highlight a single line:
-
-````
-```javascipt {2}
-function hello() {
-  // this line will get highlighted
-}
-```
-````
-
-A range of lines:
-
-````
-```javascript {2-4}
-function hello() {
-  // these lines
-  // will get
-  // highlighted
-}
-```
-````
-
-Or even multiple ranges:
-
-````
-```javascript {2-4,6}
-function hello() {
-  // these lines
-  // will get
-  // highlighted
-  console.log('hello');
-  // also this one
-  console.log('there');
-}
-```
-````
-
-Be mindful that if you move some code in an example with highlighting, you also need to update the highlighting.
-
-Don't be afraid to often use highlighting! It is very valuable when you need to focus the reader's attention on a particular detail that's easy to miss.

package/new-app.mjs

@@ -1,209 +0,0 @@
-#!/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("0.1.1")
-  .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) {
-          execSync(`${installCommand} ${devDependencies.join(" ")} -D`);
-        } else if (selectedOption === tsFunc || selectedOption === tsOop) {
-          execSync(`${installCommand} ${tsDevDependencies.join(" ")} -D`);
-        }
-
-        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 ${runMsg}`
-          )
-        );
-        process.exit(1);
-      } catch (error) {
-        console.log(chalk.redBright("\nError creating your app", error));
-        process.exit(1);
-      }
-    } catch (error) {
-      console.log(chalk.redBright("Error creating your app", error));
-      process.exit(1);
-    }
-  });
-
-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/readme.md

@@ -1,25 +0,0 @@
-<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

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

package/utils/constants/types.mjs

@@ -1,4 +0,0 @@
-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

@@ -1,24 +0,0 @@
-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

@@ -1,20 +0,0 @@
-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

@@ -1,96 +0,0 @@
-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/core#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

@@ -1,19 +0,0 @@
-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));
-}