@adaptivestone/framework 5.0.0-alpha.24 → 5.0.0-alpha.26

package/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 5.0.0-alpha.26
+
+[UPDATE] update deps
+[UPDATE] new commands view in CLI
+
 ### 5.0.0-alpha.24
 
 [UPDATE] update deps

package/commands/CreateUser.js

@@ -2,6 +2,10 @@ import AbstractCommand from '../modules/AbstractCommand.js';
 
 // Example: node src/cli createuser --email=somemail@gmail.com  --password=somePassword --roles=user,admin,someOtherRoles
 class CreateUser extends AbstractCommand {
+  static get description() {
+    return 'Create user in a database';
+  }
+
   async run() {
     const User = this.app.getModel('User');
     const { id, email, password, roles, update } = this.args;

package/commands/Documentation.js

@@ -2,6 +2,10 @@ import AbstractCommand from '../modules/AbstractCommand.js';
 import ControllerManager from '../controllers/index.js';
 
 class Documentation extends AbstractCommand {
+  static get description() {
+    return 'Generate documentation (internal)';
+  }
+
   async run() {
     const CM = new ControllerManager(this.app);
     this.app.documentation = [];

package/commands/GenerateRandomBytes.js

@@ -2,6 +2,10 @@ import { randomBytes } from 'node:crypto';
 import AbstractCommand from '../modules/AbstractCommand.js';
 
 class GenerateRandomBytes extends AbstractCommand {
+  static get description() {
+    return 'Generate random bytes ising randomBytes from  node:crypto';
+  }
+
   async run() {
     const sizes = [16, 32, 64, 128, 256];
     for (const size of sizes) {

package/commands/GetOpenApiJson.js

@@ -5,6 +5,10 @@ import AbstractCommand from '../modules/AbstractCommand.js';
  * Command for generate documentation json file openApi
  */
 class GetOpenApiJson extends AbstractCommand {
+  static get description() {
+    return 'Generate documentation (openApi) ';
+  }
+
   async run() {
     const { myDomain } = this.app.getConfig('http');
     let jsonFile = process.env.npm_package_json;

package/modules/AbstractCommand.js

@@ -8,7 +8,7 @@ class AbstractCommand extends Base {
   }
 
   static get description() {
-    return 'Command description';
+    return 'Command description. PLEASE PROVIDE IT';
   }
 
   /**

package/modules/BaseCli.js

@@ -29,24 +29,39 @@ class Cli extends Base {
     return true;
   }
 
+  async printComandTable() {
+    const commands = Object.keys(this.commands);
+    const maxLength = commands.reduce((max, c) => Math.max(max, c.length), 0);
+    console.log('Available commands:');
+    let commandsClasses = [];
+    for (const c of commands) {
+      // eslint-disable-next-line no-await-in-loop
+      commandsClasses.push(import(this.commands[c]));
+      // console.log(
+      //   ` \x1b[36m${c.padEnd(maxLength)}\x1b[0m - ${f.default.description}`,
+      // );
+    }
+    commandsClasses = await Promise.all(commandsClasses);
+    for (const [key, c] of Object.entries(commands)) {
+      // eslint-disable-next-line no-await-in-loop
+      console.log(
+        ` \x1b[36m${c.padEnd(maxLength)}\x1b[0m - ${commandsClasses[key].default.description}`,
+      );
+    }
+  }
+
   async run(command, args) {
     await this.loadCommands();
 
     if (!command) {
       console.log('Please provide command name');
-      console.log(
-        'Availalble commands:',
-        Object.keys(this.commands).join(', '),
-      );
+      await this.printComandTable();
       return false;
     }
 
     if (!this.commands[command]) {
       console.log(`Command ${command} not found `);
-      console.log(
-        'Availalble commands:',
-        Object.keys(this.commands).join(', '),
-      );
+      await this.printComandTable();
       return false;
     }
     const { default: Command } = await import(this.commands[command]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptivestone/framework",
-  "version": "5.0.0-alpha.24",
+  "version": "5.0.0-alpha.26",
   "description": "Adaptive stone node js framework",
   "main": "index.js",
   "type": "module",

package/commands/Generate.js

@@ -1,14 +0,0 @@
-import AbstractCommand from '../modules/AbstractCommand.js';
-
-class Generate extends AbstractCommand {
-  async run() {
-    if (!this.args.type) {
-      this.logger.error('Please provide type to generate "--type=model');
-
-      return false;
-    }
-    return true;
-  }
-}
-
-export default Generate;