@dolphjs/cli 1.0.2 → 1.0.4

package/README.md

@@ -0,0 +1,64 @@
+# dolphjs cli
+
+The dolphjs-cli is a tool used for efficient initialization and management of a dolphjs project.
+
+## Commands
+
+**new**: the alias for this command is `n`. This command is used to initialize / start a new project. It takes the name of the project as an option
+
+```bash
+dolph-cli new <project-name>
+```
+
+or use `' . '` in place of `<project-name>` to initialize the project in current directory.
+
+After this, you'll be prompted with few questions which would be used to configure your dolphjs project. Navigate to the project folder and run
+
+```bash
+yarn
+```
+
+to install all packages .
+
+**generate**: the alias for this command is `g` and is used to generate files and folders with setup code for :
+
+- controllers
+- services
+- models
+- routes
+
+It is recommended to make use of the `generate` command when one was to create these files because it generates code the dolphjs way. In a scenario when you want to create files for all of the above, let's say you want to write code for user logic and functionalities, use the `-a` flag, as in:
+
+```bash
+dolph-cli g -a user
+```
+
+the command above creates a service, controller, model and routes file for `user` and set's you up for writing business logic. Alternatively, you might want to create one of the files (controllers, models, services, routes) so you make use of their independent flags:
+
+- controller:
+
+  ```bash
+  dolph-cli g -c <name>
+  ```
+
+- service:
+
+  ```bash
+  dolph-cli g -s <name>
+  ```
+
+- model:
+
+  ```bash
+  dolph-cli g -m <name>
+  ```
+
+- route:
+
+  ```bash
+  dolph-cli g -r <name>
+  ```
+
+## Credit
+
+dolphjs-cli is inspired by methane-cli [https://github.com/adedoyin/methane-cli]

package/dist/daemon/watcher.js

@@ -0,0 +1,36 @@
+import { spawn } from "child_process";
+import { watch } from "fs";
+import chalk from "chalk";
+import { getRootDirectory } from "../utils/get_root_dir_path.js";
+import { readConfig } from "../utils/read_user_config_path.js";
+import { join } from "path";
+let fileExtension = "";
+let runtimeEngine = "ts-node";
+let indexFilePath = "";
+export const startApp = () => {
+    fileExtension = readConfig().language;
+    if (fileExtension === "js")
+        runtimeEngine = "node";
+    indexFilePath = join(getRootDirectory(), `index.${fileExtension}`);
+    const child = spawn(runtimeEngine, [indexFilePath], { stdio: "inherit" });
+    child.on("close", (code) => {
+        if (code === 1) {
+            console.log(chalk.bold(`${chalk.red("[DOLPH ERROR]: ")} ${chalk.redBright("exiting watch mode ...")}`));
+            process.exit(1);
+        }
+    });
+};
+export const watchFile = () => {
+    console.log(chalk.bold(`${chalk.green("[DOLPH INFO]: ")} ${chalk.greenBright("watching files for changes ...")}`));
+    fileExtension = readConfig().language;
+    if (fileExtension === "js")
+        runtimeEngine = "node";
+    watch(indexFilePath, { recursive: true }, (_event, filenamae) => {
+        if (filenamae && filenamae.endsWith(`.${fileExtension}`)) {
+            console.log(chalk.bold(`${chalk.green("[DOLPH INFO]: ")} ${chalk.greenBright("file changed" + `[${filenamae}]`)}`));
+            startApp();
+        }
+    });
+};
+// startApp();
+// watchFile();

package/dist/daemon/watcherConfig.js

@@ -0,0 +1,12 @@
+import { program } from "commander";
+import { startApp, watchFile } from "./watcher.js";
+export const watcherConfig = () => {
+    program
+        .command("start")
+        .description("starts the dolphjs application")
+        .action(() => startApp());
+    program
+        .command("watch")
+        .description("starts the dolphjs application in watch mode")
+        .action(() => watchFile());
+};

package/dist/generators/templates/controller_template.js

@@ -4,8 +4,7 @@ const generateOopTsTemplate = (controllerName) => {
         return str.charAt(0).toUpperCase() + str.slice(1);
     };
     const className = capitalizeFirstLetter(controllerName) + "Controller";
-    template = `
-import { DolphControllerHandler } from "@dolphjs/dolph/classes";
+    template = `import { DolphControllerHandler } from "@dolphjs/dolph/classes";
 import {
   Dolph,
   SuccessResponse,
@@ -33,8 +32,7 @@ const generateOopJsTemplate = (controllerName) => {
         return str.charAt(0).toUpperCase() + str.slice(1);
     };
     const className = capitalizeFirstLetter(controllerName) + "Controller";
-    template = `
-const { DolphControllerHandler } = require("@dolphjs/dolph/classes");
+    template = `const { DolphControllerHandler } = require("@dolphjs/dolph/classes");
 const {
   SuccessResponse,
   TryCatchAsyncFn,
@@ -56,8 +54,7 @@ module.exports = { ${className} }
 };
 const generateFnTsTemplate = (controllerName) => {
     let template;
-    template = `
-import { TryCatchAsyncFn, SuccessResponse, DRequest, DResponse } from "@dolphjs/dolph/common";
+    template = `import { TryCatchAsyncFn, SuccessResponse, DRequest, DResponse } from "@dolphjs/dolph/common";
 
 export const defaultFunc = TryCatchAsyncFn(async (req: DRequest, res: DResponse) => {
   SuccessResponse({ res, body: { message: "${controllerName} working!" } });
@@ -68,8 +65,7 @@ export const defaultFunc = TryCatchAsyncFn(async (req: DRequest, res: DResponse)
 };
 const generateFnJsTemplate = (controllerName) => {
     let template;
-    template = `
-const { TryCatchAsyncFn, SuccessResponse } = require("@dolphjs/dolph/common");
+    template = `const { TryCatchAsyncFn, SuccessResponse } = require("@dolphjs/dolph/common");
 
 const defaultFunc = TryCatchAsyncFn(async (req, res) => {
   SuccessResponse({ res, body: { message: "${controllerName} working!" } });

package/dist/generators/templates/model_template.js

@@ -20,8 +20,7 @@ export const ${capitalizeFirstLetter(modelName)}Model = model<I${capitalizeFirst
 `;
     }
     if (isMysql) {
-        template = `
-import { sequelizeInstance } from "@/configs/db.configs";
+        template = `import { sequelizeInstance } from "@/configs/db.configs";
 import { DataTypes } from "sequelize";
 
 export const ${capitalizeFirstLetter(modelName)} = sequelizeInstance.define("${modelName}", {
@@ -45,8 +44,7 @@ const generateOopJsTemplate = (modelName, isMongo, isMysql) => {
         return str.charAt(0).toUpperCase() + str.slice(1);
     };
     if (isMongo) {
-        template = `
-const { Schema, model } = require("mongoose");
+        template = `const { Schema, model } = require("mongoose");
 
 const ${capitalizeFirstLetter(modelName)}Schema = new Schema(
     {
@@ -60,8 +58,7 @@ module.exports = { ${capitalizeFirstLetter(modelName)}Model }
 `;
     }
     if (isMysql) {
-        template = `
-const { sequelizeInstance } = require("../../../configs/db.configs");
+        template = `const { sequelizeInstance } = require("../../../configs/db.configs");
 const { DataTypes } = require("sequelize");
 
 const User = sequelizeInstance.define("user", {
@@ -87,8 +84,7 @@ const generateFnTsTemplate = (modelName, isMongo, isMysql) => {
         return str.charAt(0).toUpperCase() + str.slice(1);
     };
     if (isMongo) {
-        template = `
-import { Schema, Document, model } from "mongoose";
+        template = `import { Schema, Document, model } from "mongoose";
 
 export interface I${capitalizeFirstLetter(modelName)} extends Document {
   
@@ -104,8 +100,7 @@ export const ${capitalizeFirstLetter(modelName)}Model = model<I${capitalizeFirst
 `;
     }
     if (isMysql) {
-        template = `
-import { sequelizeInstance } from "@/configs/db.configs";
+        template = `import { sequelizeInstance } from "@/configs/db.configs";
 import { DataTypes } from "sequelize";
 
 export const ${capitalizeFirstLetter(modelName)} = sequelizeInstance.define("${modelName}", {
@@ -129,8 +124,7 @@ const generateFnJsTemplate = (modelName, isMongo, isMysql) => {
         return str.charAt(0).toUpperCase() + str.slice(1);
     };
     if (isMongo) {
-        template = `
-const { Schema, model } = require("mongoose");
+        template = `const { Schema, model } = require("mongoose");
 
 const ${capitalizeFirstLetter(modelName)}Schema = new Schema(
     {
@@ -144,8 +138,7 @@ module.exports = { ${capitalizeFirstLetter(modelName)}Model };
 `;
     }
     if (isMysql) {
-        template = `
-const { sequelizeInstance } = require("../../../configs/db.configs");
+        template = `const { sequelizeInstance } = require("../../../configs/db.configs");
 const { DataTypes } = require("sequelize");
 
 const User = sequelizeInstance.define("user", {

package/dist/index.js

@@ -6,6 +6,7 @@ import { packageDescription } from "./utils/package_description.js";
 import { configurePackage } from "./utils/read_user_config.js";
 import { InitDolphCli } from "./utils/package_init.js";
 import { packageGenerator } from "./utils/package_generator.js";
+import { watcherConfig } from "./daemon/watcherConfig.js";
 figlet.text("dolphjs cli", {
     font: "Big",
     horizontalLayout: "default",
@@ -22,6 +23,7 @@ figlet.text("dolphjs cli", {
     packageDescription();
     configurePackage();
     packageGenerator();
+    watcherConfig();
     program.command("*", { hidden: true }).action(() => {
         console.log(`${chalk.red("[DOLPH ERROR]: ")} ${chalk.redBright("unknown command. See list of available commands: ")}`);
         program.help();

package/dist/utils/package_description.js

@@ -1,6 +1,7 @@
 import chalk from "chalk";
 import { program } from "commander";
-import { description, version } from "./read_package_json.js";
 export const packageDescription = () => {
-    program.version(version).description(chalk.cyan(description));
+    program
+        .version("1.0.3")
+        .description(chalk.cyan("The dolphjs-cli is a tool for efficient intialization and management of a dolphjs project"));
 };

package/dist/utils/write_gitignore.js

@@ -6,6 +6,7 @@ export function writeGitignore() {
 .env
 logs
 yarn-error.log
+app
 `;
     const filePath = join(getRootDirectory(), ".gitignore");
     fs.writeFileSync(filePath, gitignoreContent, { encoding: "utf-8" });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dolphjs/cli",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "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",

package/dist/utils/read_package_json.js

@@ -1,9 +0,0 @@
-import { readFileSync } from "fs";
-import path from "path";
-const packageJsonPath = path.join(process.cwd(), "package.json");
-const packageJsonContent = readFileSync(packageJsonPath, "utf8");
-const packageJson = JSON.parse(packageJsonContent);
-const version = packageJson.version;
-const name = packageJson.name;
-const description = packageJson.description;
-export { version, name, description };