@avleon/cli 0.0.46 → 0.0.47

package/dist/cli.js

@@ -42,6 +42,7 @@ exports.run = run;
 const cli_table3_1 = __importDefault(require("cli-table3"));
 const path_1 = __importDefault(require("path"));
 const promises_1 = __importDefault(require("fs/promises"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
 const fs_1 = require("fs");
 const prettier = __importStar(require("prettier"));
 const controller_1 = require("./controller");
@@ -49,6 +50,7 @@ const commands_1 = require("./commands");
 const child_process_1 = require("child_process");
 const create_1 = require("./create");
 const service_1 = require("./service");
+const path_helper_1 = require("./helpers/path-helper");
 const lodash_1 = require("lodash");
 function iqraCli() { }
 const listedCommands = commands_1.commandList
@@ -117,115 +119,88 @@ async function createModel(name, options = { force: false, orm: false }) {
         console.log("Model already exists!", "Use -f or --force to overwrite.\r");
         return;
     }
-    const basicModel = `
-      \t
-  export class ${modelName}{
-  id:number;
-  name: string;
-}
-  `;
-    const ormModel = `
-import {Entity, PrimaryGeneratedColumn, CreateDateColumn, UpdateDateColumn } from 'typeorm';
-\t
-  @Entity({name:'${modelName}'})
-  export class ${modelName}{
-
-  @PrimaryGeneratedColumn()
-  id:number;
-
-  @CreateDateColumn()
-  createdAt: Date;
-
-  @UpdateDateColumn()
-  updatedAt: Date;
-}
-`;
-    const formatModel = await prettier.format(options.orm ? ormModel : basicModel, {
+    const stubPath = path_helper_1.pathHelper.stubPath(options.orm ? "models/entity-model.stub" : "models/basic-model.stub");
+    const stub = await promises_1.default.readFile(stubPath, "utf8");
+    const model = stub
+        .replaceAll("{Model}", modelName)
+        .replaceAll("{model}", modelName.toLowerCase());
+    const formatModel = await prettier.format(model, {
         singleQuote: true,
         singleAttributePerLine: true,
         parser: "typescript",
     });
     await promises_1.default.writeFile(path_1.default.join(process.cwd(), "./src/models/" + modelName.toLowerCase() + ".ts"), formatModel);
-    console.log("Model created succssessfully!");
+    console.log("Model created successfully!");
 }
 async function createMiddleware(name, options = { force: false }) {
     if (!name) {
-        throw new Error("Model name not found . use --name or node artisan make:model ModelName");
+        throw new Error("Middleware name not found. Use npx avleon make:middleware MiddlewareName");
     }
-    const modelName = name.at(0).toUpperCase() + name.slice(1);
-    const modelExists = (0, fs_1.existsSync)(path_1.default.join(process.cwd(), `./src/middlewares/${modelName.toLowerCase()}.middleware.ts`));
-    if (modelExists && !options.force) {
+    const baseName = name.replace(/middleware$/i, "");
+    const className = baseName.at(0).toUpperCase() + baseName.slice(1) + "Middleware";
+    const fileName = `${baseName.toLowerCase()}.middleware.ts`;
+    const middlewareDir = path_1.default.join(process.cwd(), "./src/middlewares");
+    const filePath = path_1.default.join(middlewareDir, fileName);
+    if ((0, fs_1.existsSync)(filePath) && !options.force) {
         console.log("Middleware already exists!", "Use -f or --force to overwrite.\r");
         return;
     }
-    const modelFolderExists = (0, fs_1.existsSync)(path_1.default.join(process.cwd(), "./src/middlewares"));
-    if (!modelFolderExists) {
-        await promises_1.default.mkdir(path_1.default.join(process.cwd(), "./src/middleware"), {
-            recursive: true,
-        });
+    if (!(0, fs_1.existsSync)(middlewareDir)) {
+        await promises_1.default.mkdir(middlewareDir, { recursive: true });
     }
-    const basicMiddleware = `
-      \t
-import { Middleware, IMiddleware } from '@avleon/core';
-
-@Middleware
-export class ${modelName}Middleware implements IMiddleware{
-
-    invoke(req:IRequest){
-      // your logic goes here
-      return req;
-    }
- 
-}
+    const basicMiddleware = `
+import { AppMiddleware, AvleonMiddleware, IRequest, IResponse } from '@avleon/core';
+
+@AppMiddleware
+export class ${className} extends AvleonMiddleware {
+  async invoke(req: IRequest, res?: IResponse) {
+    // your logic goes here
+    return req;
+  }
+}
   `;
     const formatModel = await prettier.format(basicMiddleware, {
         singleQuote: true,
         singleAttributePerLine: true,
         parser: "typescript",
     });
-    await promises_1.default.writeFile(path_1.default.join(process.cwd(), "./src/middlewares/" + modelName.toLowerCase() + ".ts"), formatModel);
-    console.log("Middleware created succssessfully!");
+    await promises_1.default.writeFile(filePath, formatModel);
+    console.log("Middleware created successfully!");
 }
 async function createConfig(name, options = { force: false }) {
     if (!name) {
         throw new Error("Config name not found . use --name or node artisan make:config JwtConfig");
     }
-    const modelName = name.at(0).toUpperCase() + name.slice(1);
-    const modelClassName = (0, lodash_1.capitalize)(modelName).endsWith('Config') ? (0, lodash_1.capitalize)(modelName) : (0, lodash_1.capitalize)(modelName) + "Config";
-    const modelExists = (0, fs_1.existsSync)(path_1.default.join(process.cwd(), `./src/config/${modelName.toLowerCase()}.ts`));
-    if (modelExists && !options.force) {
+    const baseName = name.replace(/config$/i, "");
+    const modelClassName = (0, lodash_1.capitalize)(baseName) + "Config";
+    const fileName = `${baseName.toLowerCase()}.config.ts`;
+    const configDir = path_1.default.join(process.cwd(), "./src/config");
+    const filePath = path_1.default.join(configDir, fileName);
+    if ((0, fs_1.existsSync)(filePath) && !options.force) {
         console.log("Config already exists!", "Use -f or --force to overwrite.\r");
         return;
     }
-    const modelFolderExists = (0, fs_1.existsSync)(path_1.default.join(process.cwd(), "./src/config"));
-    if (!modelFolderExists) {
-        await promises_1.default.mkdir(path_1.default.join(process.cwd(), "./src/config"), {
-            recursive: true,
-        });
+    if (!(0, fs_1.existsSync)(configDir)) {
+        await promises_1.default.mkdir(configDir, { recursive: true });
     }
-    const basicMiddleware = `
-      \t
-import { AppConfig, IConfig } from '@avleon/core';
-
-@AppConfig
-export class ${modelClassName} implements IConfig<T>{
-
-    config(env: Environment){
-      // config must return config
-      return {
-      
-      };
-    }
- 
-}
+    const basicMiddleware = `
+import { AppConfig, AvleonConfig, Environment } from '@avleon/core';
+
+@AppConfig
+export class ${modelClassName} extends AvleonConfig {
+  config(env: Environment) {
+    // config must return the configuration object
+    return {};
+  }
+}
   `;
     const formatModel = await prettier.format(basicMiddleware, {
         singleQuote: true,
         singleAttributePerLine: true,
         parser: "typescript",
     });
-    await promises_1.default.writeFile(path_1.default.join(process.cwd(), "./src/config/" + modelName.toLowerCase() + ".ts"), formatModel);
-    console.log("Config created succssessfully!");
+    await promises_1.default.writeFile(filePath, formatModel);
+    console.log("Config created successfully!");
 }
 async function run() {
     try {
@@ -251,7 +226,7 @@ async function run() {
                 if (args.some((x) => x == "-f" || x == "--force")) {
                     force = true;
                 }
-                if (args.some((x) => x == "--mimimal")) {
+                if (args.some((x) => x == "--minimal" || x == "-m")) {
                     minimal = true;
                 }
                 const flags = { minimal, force };
@@ -264,19 +239,18 @@ async function run() {
                 }
                 if (args[0] == "build") {
                     process.env.NODE_ENV = "production";
-                    //const appPath =
-                    (0, child_process_1.execSync)("rm -r ./dist");
-                    (0, child_process_1.execSync)("npx tsc --project tsconfig.build.json");
+                    await fs_extra_1.default.remove(path_1.default.join(process.cwd(), "dist"));
+                    (0, child_process_1.execSync)("npx tsc --project tsconfig.build.json", { stdio: "inherit" });
                     console.log("Build successfully");
                 }
-                if (args[0] == "make:model") {
+                if (args[0] == "make:model" || args[0] == "m:m") {
                     const orm = args.some((x) => x == "--orm");
                     await createModel(args[1], { force, orm });
                 }
-                if (args[0] == "make:config" || args[0] == "m:cfg") {
+                if (args[0] == "make:config" || args[0] == "m:cnf" || args[0] == "m:cfg") {
                     await createConfig(args[1], { force });
                 }
-                if (args[0] == "make:middleware" || args[0] == "m:mdlr") {
+                if (args[0] == "make:middleware" || args[0] == "m:mlwr" || args[0] == "m:mdlr") {
                     await createMiddleware(args[1], { force });
                 }
                 if (args[0] == "make:controller" || args[0] == "m:c") {
@@ -284,10 +258,8 @@ async function run() {
                     let rest = false;
                     let prefix = true;
                     let root = null;
-                    if (args.some((x) => x == "-r" || x == "--resource")) {
+                    if (args.some((x) => x == "-r" || x == "--resource" || x == "--rest")) {
                         resource = true;
-                    }
-                    if (args.some((x) => x == "-r" || x == "--rest")) {
                         rest = true;
                     }
                     if (args.some((x) => x == "--base-path")) {
@@ -314,7 +286,8 @@ async function run() {
                         const rootPath = args[index + 1];
                         root = rootPath;
                     }
-                    await (0, controller_1.createController)(args[1], { force, resource, prefix, rest, model, root });
+                    const orm = args.some((x) => x == "--orm");
+                    await (0, controller_1.createController)(args[1], { force, resource, prefix, rest, model, root, orm });
                 }
                 if (args[0] == "make:service" || args[0] == "m:s") {
                     let resource = false;
@@ -346,7 +319,8 @@ async function run() {
                         const rootPath = args[index + 1];
                         root = rootPath;
                     }
-                    await (0, service_1.createService)(args[1], { force, resource, prefix, rest, model, root });
+                    const orm = args.some((x) => x == "--orm");
+                    await (0, service_1.createService)(args[1], { force, resource, prefix, rest, model, root, orm });
                 }
             }
         }

package/dist/commands.js

@@ -9,47 +9,55 @@ exports.commandList = [
     {
         Command: "new",
         Alias: "",
-        Options: "--minimal -m, -d --database",
-        Description: "Create a new application"
+        Options: "-m --minimal",
+        Description: "Create a new application",
+    },
+    {
+        Command: "serve",
+        Alias: "",
+        Options: "",
+        Description: "Start the development server. Compiles src/ on change and restarts the app.",
+    },
+    {
+        Command: "build",
+        Alias: "",
+        Options: "",
+        Description: "Compile the application using tsconfig.build.json",
     },
     {
         Command: "make:model",
         Alias: "m:m",
         Options: "-f --force, --orm",
-        Description: "Create a new model. Use -f or --froce to overwrite if any model exists with name",
+        Description: "Create a new model. Use -f or --force to overwrite an existing model. Pass --orm to generate a TypeORM entity.",
     },
     {
         Command: "make:controller",
         Alias: "m:c",
-        Options: `-f, --force for force create\n -r or --resource for resource controller`,
-        Description: `Create a new controller. Use -f or --force to overwrite existing controller. If you want to create a resource controller pass options -r or --resource. 
-You may also pass model by -m or --model.\n
-${chalk_1.default.blueBright("Note:")} when using a resource contorller iqra will automaticall check for dtos related to model name. If -m is user then
-it will check for dtos like UserCreateDto and UserUpdateDto. If dtos not found it will create automatically using 
-model properties.
-    `,
+        Options: "-f --force, -r --resource, -m --model, -rt --root, --orm, --base-path",
+        Description: `Create a new controller. Use -f or --force to overwrite an existing controller.
+Pass -r or --resource for a full REST skeleton, and -m or --model to bind it to a model.\n
+${chalk_1.default.blueBright("Note:")} with -m, the matching service is generated in src/services and the
+controller delegates to it. Add --orm to back that service with a TypeORM repository.`,
     },
     {
         Command: "make:service",
         Alias: "m:s",
-        Options: `-f, --force for force create\n -r or --resource for resource controller, --dtos`,
-        Description: `Create a new controller. Use -f or --force to overwrite existing controller. If you want to create a resource controller pass options -r or --resource. 
-You may also pass model by -m or --model.\n
-${chalk_1.default.blueBright("Note:")} when using a resource contorller iqra will automaticall check for dtos related to model name. If -m is user then
-it will check for dtos like UserCreateDto and UserUpdateDto. If dtos not found it will create automatically using 
-model properties.
-    `,
+        Options: "-f --force, -r --resource, -m --model, -rt --root, --orm",
+        Description: `Create a new service. Use -f or --force to overwrite an existing service.
+Pass -r or --resource together with -m or --model for a REST service.\n
+${chalk_1.default.blueBright("Note:")} a resource service uses an in-memory Collection by default.
+Add --orm to generate one backed by a TypeORM repository instead.`,
     },
     {
         Command: "make:config",
         Alias: "m:cnf",
         Options: "-f --force",
-        Description: "Create a new config. Use -f or --froce to overwrite if any config exists with name",
+        Description: "Create a new config class registered with @AppConfig. Use -f or --force to overwrite an existing config.",
     },
     {
         Command: "make:middleware",
         Alias: "m:mlwr",
         Options: "-f --force",
-        Description: "Create a new middleware. Use -f or --froce to overwrite if any config exists with name",
+        Description: "Create a new middleware extending AvleonMiddleware. Use -f or --force to overwrite an existing middleware.",
     },
 ];

package/dist/controller.js

@@ -32,35 +32,33 @@ function exportNamesAndPath(input) {
 }
 const controllersStubs = {
     basic: path_helper_1.pathHelper.stubPath('controllers/basic-controller.stub'),
-    rest: path_helper_1.pathHelper.stubPath('controllers/basic-controller.stub'),
+    rest: path_helper_1.pathHelper.stubPath('controllers/rest-controller.stub'),
     ormRest: path_helper_1.pathHelper.stubPath('controllers/orm-rest-controller.stub')
 };
-async function createController(name, options = { force: false, resource: false, prefix: true, rest: false, model: null, root: null }, p) {
+async function createController(name, options = { force: false, resource: false, prefix: true, rest: false, model: null, root: null, orm: false }, p) {
     if (!name) {
         throw new Error("Controller name not found. use --name or npx avleon make:controller HomeController");
     }
     // determine stub for generate
+    // A model means the controller can delegate to a generated service; without
+    // one there is nothing to call, so emit the unimplemented REST skeleton.
     let stubPath = controllersStubs.basic;
-    if (options.rest) {
-        stubPath = controllersStubs.rest;
-        if (options.model) {
-            stubPath = controllersStubs.ormRest;
-        }
+    if (options.rest || options.resource) {
+        stubPath = options.model ? controllersStubs.ormRest : controllersStubs.rest;
     }
     // determine root path for create controller file 
     const rootPath = options.root ? 'src/' + options.root + '/' : 'src/controllers/';
-    // ensure file create directory exits 
-    if (name.split("/").length > 1) {
-        if (!(0, fs_1.existsSync)(path_1.default.join(rootPath, name.split("/").splice(-1, 1).join("/")))) {
-            await promises_1.default.mkdir(path_1.default.join(rootPath, name.replace('/' + file_helper_1.fh.filenameFromPath(name), '')), { recursive: true });
-        }
+    // ensure the output directory exists
+    const outDir = path_1.default.join(rootPath, (0, file_helper_1.getFilePathWithoutName)(name));
+    if (!(0, fs_1.existsSync)(outDir)) {
+        await promises_1.default.mkdir(outDir, { recursive: true });
     }
     // read stub content from stub file
     const content = await promises_1.default.readFile(stubPath, 'utf8');
     const names = (0, file_helper_1.resolveNames)(file_helper_1.fh.filenameFromPath(name), 'Controller');
     const className = names.className.replace("Controller", '');
     if (options.model) {
-        await createRestService(className, options.model);
+        await createRestService(className, options.model, options.orm);
     }
     let replacedContent = content
         .replaceAll('{Controller}', className)
@@ -73,20 +71,26 @@ async function createController(name, options = { force: false, resource: false,
     if (!options.prefix) {
         replacedContent = replacedContent.replace(/@ApiController\s*\(([^)]*)\)/g, '@ApiController');
     }
-    await promises_1.default.writeFile(path_1.default.join(rootPath, (0, file_helper_1.getFilePathWithoutName)(name) + "/" + (0, lodash_1.kebabCase)(className) + '.controller.ts'), replacedContent, 'utf8');
-    console.log("Controller created succssessfully!");
+    await promises_1.default.writeFile(path_1.default.join(outDir, (0, lodash_1.kebabCase)(className) + '.controller.ts'), replacedContent, 'utf8');
+    console.log("Controller created successfully!");
 }
-async function createRestService(name, model) {
-    let stubPath = path_helper_1.pathHelper.stubPath('services/rest-service.stub');
+async function createRestService(name, model, orm = false) {
+    const stubPath = path_helper_1.pathHelper.stubPath(orm ? 'services/orm-rest-service.stub' : 'services/rest-service.stub');
     const content = await promises_1.default.readFile(stubPath, 'utf8');
-    const names = (0, file_helper_1.resolveNames)(file_helper_1.fh.filenameFromPath(name), 'Controller');
+    // The generated controller imports `{Model}Service` from
+    // `../services/{model}.service`, so the file must be named after the model.
+    const serviceName = model ? capitalize(model) : name;
     let replacedContent = content
-        .replaceAll('{Service}', name);
+        .replaceAll('{Service}', serviceName);
     if (model) {
         replacedContent = replacedContent
             .replaceAll('{Model}', capitalize(model))
             .replaceAll('{model}', lower(model));
     }
-    await promises_1.default.writeFile(path_1.default.join('src/services/', (0, lodash_1.kebabCase)(name) + '.service.ts'), replacedContent, 'utf8');
-    console.log("Service created succssessfully!");
+    const serviceDir = path_1.default.join('src', 'services');
+    if (!(0, fs_1.existsSync)(serviceDir)) {
+        await promises_1.default.mkdir(serviceDir, { recursive: true });
+    }
+    await promises_1.default.writeFile(path_1.default.join(serviceDir, lower(serviceName) + '.service.ts'), replacedContent, 'utf8');
+    console.log("Service created successfully!");
 }