@expressots/cli 1.2.1 → 1.3.0-rc-1

package/bin/generate/templates/controller-service.tpl

@@ -1,5 +1,6 @@
 import { BaseController, StatusCode } from "@expressots/core";
-import { controller, httpGet, response } from "inversify-express-utils";
+import { controller, {{method}}, response } from "inversify-express-utils";
+import { Response } from "express";
 import { {{className}}UseCase } from "./{{fileName}}.usecase";
 import { I{{className}}ResponseDTO } from "./{{fileName}}.dto";
 
@@ -10,13 +11,13 @@ class {{className}}Controller extends BaseController {
 		super("{{construct}}-controller")
 	}
 
-  @httpGet("/")
-  execute(@response() res: any): I{{className}}ResponseDTO {
+  @{{method}}("/")
+  execute(@response() res: Response): I{{className}}ResponseDTO {
     return this.callUseCase(
             this.{{useCase}}UseCase.execute(),
             res,
             StatusCode.OK,
-        );
+    );
   }
 }
 

package/bin/generate/templates/controller.tpl

@@ -1,5 +1,6 @@
 import { BaseController } from "@expressots/core";
-import { controller, httpGet, response } from "inversify-express-utils";
+import { controller, {{method}}, response } from "inversify-express-utils";
+import { Response } from "express";
 
 @controller("/{{{route}}}")
 class {{className}}Controller extends BaseController {
@@ -8,8 +9,8 @@ class {{className}}Controller extends BaseController {
 		super("{{construct}}-controller")
 	}
 
-  @httpGet("/")
-  execute(@response() res: any) {
+  @{{method}}("/")
+  execute(@response() res: Response) {
     return res.send("Hello Expresso TS");
   }
 }

package/bin/generate/templates/dto-op.tpl

@@ -0,0 +1,7 @@
+interface I{{className}}RequestDTO {
+    id: string;
+}
+
+interface I{{className}}ResponseDTO { }
+
+export { I{{className}}RequestDTO, I{{className}}ResponseDTO };

package/bin/generate/templates/entity.tpl

@@ -0,0 +1,13 @@
+import { provide } from "inversify-binding-decorators";
+import { randomUUID } from "node:crypto";
+
+@provide({{className}})
+class {{className}} {
+    public id: string;
+
+    constructor() {
+        this.id = randomUUID();
+    }
+}
+
+export { {{className}} };

package/bin/generate/templates/usecase-op.tpl

@@ -0,0 +1,14 @@
+import { provide } from "inversify-binding-decorators";
+import { I{{className}}RequestDTO, I{{className}}ResponseDTO } from "./{{fileName}}.dto";
+
+@provide({{className}}UseCase)
+class {{className}}UseCase {
+
+    constructor() {}
+
+    execute(id: string, payload: I{{className}}RequestDTO): I{{className}}ResponseDTO {
+        return "your use case";
+    }
+}
+
+export { {{className}}UseCase };

package/bin/generate/templates/usecase-post.tpl

@@ -0,0 +1,14 @@
+import { provide } from "inversify-binding-decorators";
+import { I{{className}}RequestDTO, I{{className}}ResponseDTO } from "./{{fileName}}.dto";
+
+@provide({{className}}UseCase)
+class {{className}}UseCase {
+
+    constructor() {}
+
+    execute(payload: I{{className}}RequestDTO): I{{className}}ResponseDTO {
+        return "your use case";
+    }
+}
+
+export { {{className}}UseCase };

package/bin/info/cli.d.ts

@@ -0,0 +1,4 @@
+import { CommandModule } from "yargs";
+type CommandModuleArgs = {};
+declare const infoProject: () => CommandModule<CommandModuleArgs, any>;
+export { infoProject };

package/bin/info/cli.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.infoProject = void 0;
+const form_1 = require("./form");
+const infoProject = () => {
+    return {
+        command: "info",
+        describe: "Displays project details",
+        aliases: ["i"],
+        handler: async () => {
+            await (0, form_1.infoForm)();
+        },
+    };
+};
+exports.infoProject = infoProject;

package/bin/info/form.d.ts

@@ -0,0 +1,2 @@
+declare const infoForm: () => Promise<void>;
+export { infoForm };

package/bin/info/form.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.infoForm = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const os_1 = __importDefault(require("os"));
+const cli_1 = require("../cli");
+const cli_ui_1 = require("../utils/cli-ui");
+function getInfosFromPackage() {
+    try {
+        // Get the absolute path of the input directory parameter
+        const absDirPath = path_1.default.resolve();
+        // Load the package.json file
+        const packageJsonPath = path_1.default.join(absDirPath, "package.json");
+        const fileContents = fs_1.default.readFileSync(packageJsonPath, "utf-8");
+        const packageJson = JSON.parse(fileContents);
+        console.log(chalk_1.default.green("ExpressoTS Project:"));
+        console.log(chalk_1.default.bold(`\tName: ${packageJson.name}`));
+        console.log(chalk_1.default.bold(`\tDescription: ${packageJson.description}`));
+        console.log(chalk_1.default.bold(`\tVersion: ${packageJson.version}`));
+        console.log(chalk_1.default.bold(`\tAuthor: ${packageJson.author}`));
+    }
+    catch (error) {
+        (0, cli_ui_1.printError)("No project information available.", "package.json not found!");
+    }
+}
+const infoForm = async () => {
+    console.log(chalk_1.default.green("System informations:"));
+    console.log(chalk_1.default.bold(`\tOS Version: ${os_1.default.version()}`));
+    console.log(chalk_1.default.bold(`\tNodeJS version: ${process.version}`));
+    console.log(chalk_1.default.green("CLI Version:"));
+    console.log(chalk_1.default.bold(`\tCurrent version: v${cli_1.CLI_VERSION}`));
+    getInfosFromPackage();
+};
+exports.infoForm = infoForm;

package/bin/info/index.d.ts

@@ -0,0 +1 @@
+export * from "./cli";

package/bin/info/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./cli"), exports);

package/bin/new/cli.js

@@ -4,8 +4,8 @@ exports.createProject = void 0;
 const form_1 = require("./form");
 const createProject = () => {
     return {
-        command: "new <project-name> [package-manager] [template]",
-        describe: "Create a new Expresso TS project",
+        command: "new <project-name> [package-manager] [template] [directory]",
+        describe: "Create a new project",
         builder: (yargs) => {
             yargs
                 .positional("project-name", {
@@ -23,11 +23,18 @@ const createProject = () => {
                 type: "string",
                 choices: ["npm", "yarn", "pnpm"],
                 alias: "p",
-            });
+            })
+                .option("directory", {
+                describe: "The directory for new project",
+                type: "string",
+                alias: "d",
+            })
+                .implies("package-manager", "template")
+                .implies("template", "package-manager");
             return yargs;
         },
-        handler: async ({ projectName, packageManager, template }) => {
-            return await (0, form_1.projectForm)(projectName, packageManager, template);
+        handler: async ({ projectName, packageManager, template, directory }) => {
+            return await (0, form_1.projectForm)(projectName, [packageManager, template, directory]);
         },
     };
 };

package/bin/new/form.d.ts

@@ -1,11 +1,2 @@
-declare enum Template {
-    "non-opinionated" = "Non-Opinionated :: A simple ExpressoTS project.",
-    opinionated = "Opinionated :: A complete ExpressoTS project with an opinionated structure and features."
-}
-declare const enum PackageManager {
-    npm = 0,
-    yarn = 1,
-    pnpm = 2
-}
-declare const projectForm: (projectName: string, packageManager: PackageManager, template: keyof typeof Template) => Promise<void>;
+declare const projectForm: (projectName: string, args: any[]) => Promise<void>;
 export { projectForm };

package/bin/new/form.js

@@ -4,13 +4,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.projectForm = void 0;
-const inquirer_1 = __importDefault(require("inquirer"));
 const chalk_1 = __importDefault(require("chalk"));
-const degit_1 = __importDefault(require("degit"));
 const child_process_1 = require("child_process");
 const cli_progress_1 = require("cli-progress");
+const degit_1 = __importDefault(require("degit"));
+const inquirer_1 = __importDefault(require("inquirer"));
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_path_1 = __importDefault(require("node:path"));
+const center_text_1 = require("../utils/center-text");
+const cli_ui_1 = require("../utils/cli-ui");
 async function packageManagerInstall({ packageManager, directory, progressBar, }) {
     return new Promise((resolve, reject) => {
         const isWindows = process.platform === "win32";
@@ -30,7 +32,7 @@ async function packageManagerInstall({ packageManager, directory, progressBar, }
                 resolve("Installation Done!");
             }
             else {
-                reject(new Error(`npm install exited with code ${code}`));
+                reject(new Error(`${packageManager} install exited with code ${code}`));
             }
         });
     });
@@ -40,11 +42,11 @@ async function checkIfPackageManagerExists(packageManager) {
         (0, child_process_1.execSync)(`${packageManager} --version`);
         return true;
     }
-    catch (_) {
-        throw new Error(`Package manager ${packageManager} is not installed`);
+    catch (error) {
+        (0, cli_ui_1.printError)("Package manager not found!", packageManager);
+        process.exit(1);
     }
 }
-// Change the package.json name to the user's project name
 function changePackageName({ directory, name, }) {
     // Get the absolute path of the input directory parameter
     const absDirPath = node_path_1.default.resolve(directory);
@@ -62,8 +64,26 @@ var Template;
     Template["non-opinionated"] = "Non-Opinionated :: A simple ExpressoTS project.";
     Template["opinionated"] = "Opinionated :: A complete ExpressoTS project with an opinionated structure and features.";
 })(Template || (Template = {}));
-const projectForm = async (projectName, packageManager, template) => {
+const projectForm = async (projectName, args) => {
     let answer;
+    const projName = projectName;
+    let packageManager;
+    let template;
+    let directory;
+    // Resolving the argument order problem
+    for (const arg of args) {
+        if (args.length >= 3) {
+            if (arg === "npm" || arg === "yarn" || arg === "pnpm") {
+                packageManager = arg;
+            }
+            else if (arg === "non-opinionated" || arg === "opinionated") {
+                template = arg;
+            }
+            else {
+                directory = arg;
+            }
+        }
+    }
     if (packageManager && template) {
         answer = {
             name: projectName,
@@ -106,17 +126,23 @@ const projectForm = async (projectName, packageManager, template) => {
             },
         ]);
     }
+    if (directory) {
+        if (!node_fs_1.default.existsSync(node_path_1.default.join(directory, answer.name))) {
+            answer.name = node_path_1.default.join(directory, answer.name);
+        }
+        else {
+            (0, cli_ui_1.printError)("Directory already exists", directory);
+            process.exit(1);
+        }
+    }
     // Hashmap of templates and their directories
     const templates = {
         "Non-Opinionated": "non_opinionated",
         Opinionated: "opinionated",
     };
     if (answer.confirm) {
-        // Check if the package manager exists
-        await checkIfPackageManagerExists(answer.packageManager).catch((err) => {
-            console.log(chalk_1.default.red(err.message));
-            process.exit(1);
-        });
+        await checkIfPackageManagerExists(answer.packageManager);
+        console.log("\n");
         const progressBar = new cli_progress_1.SingleBar({
             format: "Progress |" + chalk_1.default.green("{bar}") + "| {percentage}% || {doing}",
             hideCursor: true,
@@ -125,12 +151,17 @@ const projectForm = async (projectName, packageManager, template) => {
             doing: "Cloning project",
         });
         const [_, template] = answer.template.match(/(.*) ::/);
-        const emitter = (0, degit_1.default)(`expressots/expressots/templates/${templates[template]}`);
-        await emitter.clone(answer.name);
+        try {
+            const emitter = (0, degit_1.default)(`expressots/expressots/templates/${templates[template]}`);
+            await emitter.clone(answer.name);
+        }
+        catch (err) {
+            (0, cli_ui_1.printError)("Project already exists or Folder is not empty", answer.name);
+            process.exit(1);
+        }
         progressBar.update(50, {
             doing: "Installing dependencies",
         });
-        // Run the package manager install in the directory
         await packageManagerInstall({
             packageManager: answer.packageManager,
             directory: answer.name,
@@ -139,14 +170,29 @@ const projectForm = async (projectName, packageManager, template) => {
         progressBar.update(90);
         changePackageName({
             directory: answer.name,
-            name: answer.name,
+            name: projName,
         });
         progressBar.update(100);
         progressBar.stop();
-        console.log(chalk_1.default.green("Project created successfully!"));
-        console.log("Run the following commands to start the project:");
-        console.log(chalk_1.default.bold(`cd ${answer.name}`));
-        console.log(chalk_1.default.bold(`${answer.packageManager} start`));
+        console.log("\n");
+        console.log("🐎 Project ", chalk_1.default.green(projName), "created successfully!");
+        console.log("🤙 Run the following commands to start the project:\n");
+        console.log(chalk_1.default.bold.gray(`$ cd ${answer.name}`));
+        switch (answer.packageManager) {
+            case "npm":
+                console.log(chalk_1.default.bold.gray("$ npm run dev"));
+                break;
+            case "yarn":
+                console.log(chalk_1.default.bold.gray("$ yarn dev"));
+                break;
+            case "pnpm":
+                console.log(chalk_1.default.bold.gray("$ pnpm run dev"));
+                break;
+        }
+        console.log("\n");
+        console.log(chalk_1.default.bold.green((0, center_text_1.centerText)("Happy coding!")));
+        console.log(chalk_1.default.bold.gray((0, center_text_1.centerText)("Please consider donating to support the project.\n")));
+        console.log(chalk_1.default.bold.white((0, center_text_1.centerText)("💖 Sponsor: https://github.com/sponsors/expressots")));
     }
 };
 exports.projectForm = projectForm;

package/bin/utils/add-controller-to-module.js

@@ -22,7 +22,7 @@ async function addControllerToModule(filePath, controllerName, controllerPath) {
         return;
     }
     imports.push(newImport);
-    const moduleDeclarationRegex = /CreateModule\(\[(.*)\]\);/s;
+    const moduleDeclarationRegex = /CreateModule\(\s*\[([\s\S]*?)]/;
     const moduleDeclarationMatch = fileContent.match(moduleDeclarationRegex);
     if (!moduleDeclarationMatch) {
         return;
@@ -33,7 +33,7 @@ async function addControllerToModule(filePath, controllerName, controllerPath) {
     }
     controllers.push(controllerName);
     const newControllers = controllers.join(', ');
-    const newModuleDeclaration = `CreateModule([${newControllers}]);`;
+    const newModuleDeclaration = `CreateModule([${newControllers}]`;
     const newFileContent = [...imports, ...notImports].join('\n').replace(moduleDeclarationRegex, newModuleDeclaration);
     await node_fs_1.default.promises.writeFile(filePath, newFileContent, 'utf8');
 }

package/bin/utils/add-module-to-container.d.ts

@@ -0,0 +1,2 @@
+declare function addModuleToContainer(name: string, modulePath?: string, path?: string): Promise<void>;
+export { addModuleToContainer };

package/bin/utils/add-module-to-container.js

@@ -0,0 +1,84 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addModuleToContainer = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const glob_1 = require("glob");
+const node_fs_1 = __importDefault(require("node:fs"));
+const cli_ui_1 = require("./cli-ui");
+const compiler_1 = __importDefault(require("./compiler"));
+const APP_CONTAINER = "app.container.ts";
+async function validateAppContainer() {
+    const { sourceRoot } = await compiler_1.default.loadConfig();
+    const imports = [];
+    const notImports = [];
+    const path = (0, glob_1.globSync)(`./${sourceRoot}/${APP_CONTAINER}`, { absolute: true, ignore: '**/node_modules/**' });
+    if (!path.length) {
+        (0, cli_ui_1.printError)('Module not added to Container. Container file not found!', APP_CONTAINER);
+        process.exit(1);
+    }
+    const fileContent = await node_fs_1.default.promises.readFile(path[0], 'utf8');
+    fileContent.split('\n').forEach((line) => {
+        if (line.startsWith('import')) {
+            imports.push(line);
+        }
+        else {
+            notImports.push(line);
+        }
+    });
+    // Validate the file content
+    const moduleDeclarationRegex = /.create\(\s*\[([\s\S]*?)]/;
+    const moduleDeclarationMatch = fileContent.match(moduleDeclarationRegex);
+    if (!moduleDeclarationMatch) {
+        (0, cli_ui_1.printError)('Container format incorrect!', APP_CONTAINER);
+        process.exit(1);
+    }
+    const modules = moduleDeclarationMatch[1].trim().split(',').filter((m) => m.trim() !== "").map((m) => m.trim());
+    return {
+        regex: moduleDeclarationRegex,
+        path: path[0],
+        content: moduleDeclarationMatch,
+        modules,
+        imports,
+        notImports
+    };
+}
+async function addModuleToContainer(name, modulePath, path) {
+    const containerData = await validateAppContainer();
+    const moduleName = (name[0].toUpperCase() + name.slice(1)).trimStart();
+    const { opinionated } = await compiler_1.default.loadConfig();
+    let usecaseDir;
+    if (opinionated) {
+        usecaseDir = `@useCases/`;
+    }
+    else {
+        usecaseDir = `./`;
+    }
+    let newImport = "";
+    const modulePathRegex = /^[^/]=$/;
+    if (!modulePathRegex.test(modulePath)) {
+        if (path.split('/').length > 1) {
+            newImport = `import { ${moduleName}Module } from "${usecaseDir}${modulePath}/${name}.module";`;
+        }
+        else {
+            newImport = `import { ${moduleName}Module } from "${usecaseDir}${name}.module";`;
+        }
+    }
+    else {
+        newImport = `import { ${moduleName}Module } from "${usecaseDir}${name}/${name}.module";`;
+    }
+    if (containerData.imports.includes(newImport) && containerData.modules.includes(`${moduleName}Module`)) {
+        return;
+    }
+    containerData.imports.push(newImport);
+    containerData.modules.push(`${moduleName}Module`);
+    const newModule = containerData.modules.join(', ');
+    const newModuleDeclaration = `.create([${newModule}]`;
+    const newFileContent = [...containerData.imports, ...containerData.notImports]
+        .join('\n').replace(containerData.regex, newModuleDeclaration);
+    console.log(" ", chalk_1.default.greenBright(`[container]`.padEnd(14)), chalk_1.default.bold.white(`${moduleName}Module added to ${APP_CONTAINER}! ✔️`));
+    await node_fs_1.default.promises.writeFile(containerData.path, newFileContent, 'utf8');
+}
+exports.addModuleToContainer = addModuleToContainer;

package/bin/utils/center-text.d.ts

@@ -0,0 +1,2 @@
+declare function centerText(text: string): string;
+export { centerText };

package/bin/utils/center-text.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.centerText = void 0;
+function centerText(text) {
+    const terminalWidth = process.stdout.columns;
+    const padding = Math.floor((terminalWidth - text.length) / 2);
+    const centeredText = ' '.repeat(padding) + text;
+    return centeredText;
+}
+exports.centerText = centerText;

package/bin/utils/cli-ui.d.ts

@@ -0,0 +1 @@
+export declare function printError(message: string, component: string): void;

package/bin/utils/cli-ui.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printError = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+function printError(message, component) {
+    console.error(chalk_1.default.red(`\n\n😞 ${message}:`, chalk_1.default.white(`[${component}]`)));
+}
+exports.printError = printError;

package/bin/utils/compiler.js

@@ -28,9 +28,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const node_fs_1 = require("node:fs");
 const path_1 = __importDefault(require("path"));
+const cli_ui_1 = require("./cli-ui");
 /**
  * The path to the expressots.config.ts file
  */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 const EXPRESSOTS_CONFIG = path_1.default.join(process.cwd(), "expressots.config.ts");
 /**
  * The config object
@@ -64,6 +66,7 @@ class Compiler {
         return compiler;
     }
     static interopRequireDefault(obj) {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
         const module = require(obj);
         return module && module.__esModule ? module : { default: module };
     }
@@ -73,8 +76,10 @@ class Compiler {
         if (exists)
             return configPath;
         const parentDir = path_1.default.join(dir, "..");
-        if (parentDir === dir)
-            throw new Error("No config file found");
+        if (parentDir === dir) {
+            (0, cli_ui_1.printError)("No config file found!", "expressots.config.ts");
+            process.exit(1);
+        }
         return Compiler.findConfig(parentDir);
     }
     static async loadConfig() {

package/bin/utils/verify-file-exists.js

@@ -4,9 +4,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.verifyIfFileExists = void 0;
-const chalk_1 = __importDefault(require("chalk"));
 const inquirer_1 = __importDefault(require("inquirer"));
 const node_fs_1 = __importDefault(require("node:fs"));
+const cli_ui_1 = require("./cli-ui");
 async function verifyIfFileExists(path) {
     const fileExists = node_fs_1.default.existsSync(path);
     if (fileExists) {
@@ -18,8 +18,9 @@ async function verifyIfFileExists(path) {
                 default: true,
             },
         ]);
+        const fileName = path.split('/').pop();
         if (!answer.confirm) {
-            console.log(chalk_1.default.green('> File not created!'));
+            (0, cli_ui_1.printError)('File not created!', fileName);
             process.exit(1);
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/cli",
-  "version": "1.2.1",
+  "version": "1.3.0-rc-1",
   "description": "Expressots CLI - modern, fast, lightweight nodejs web framework (@cli)",
   "author": "Richard Zampieri",
   "license": "MIT",
@@ -14,8 +14,8 @@
     "node": ">=18.10.0"
   },
   "funding": {
-    "type": "",
-    "url": ""
+    "type": "github",
+    "url": "https://github.com/sponsors/expressots"
   },
   "repository": {
     "type": "git",
@@ -46,6 +46,7 @@
     "chalk-animation": "^1",
     "cli-progress": "^3.11.2",
     "degit": "^2.8.4",
+    "glob": "^10.2.6",
     "inquirer": "^8.0.0",
     "mustache": "^4.2.0",
     "ts-node": "^10.9.1",