@moostjs/event-cli 0.2.28 → 0.2.29

package/dist/index.cjs

@@ -145,11 +145,22 @@ class MoostCli {
         });
     }
     onInit(moost) {
+        var _a;
         this.moost = moost;
+        for (const [alias, entry] of Object.entries(this.cliHelp.getComputedAliases())) {
+            if (entry.custom) {
+                const vars = Object.keys(entry.args || {}).map(k => ':' + k).join('/');
+                const path = '/' + alias.replace(/\s+/g, '/').replace(/:/g, '\\:') + (vars ? '/' + vars : '');
+                this.cliApp.cli(path, entry.custom.fn);
+                if ((_a = this.opts) === null || _a === void 0 ? void 0 : _a.debug) {
+                    entry.custom.log(`${''}(CLI-alias*)${''}${path}`);
+                }
+            }
+        }
         void this.cliApp.run();
     }
     bindHandler(opts) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d, _e, _f;
         let fn;
         for (const handler of opts.handlers) {
             if (handler.type !== 'CLI')
@@ -159,7 +170,7 @@ class MoostCli {
                 : typeof opts.method === 'string'
                     ? opts.method
                     : '';
-            const targetPath = `${opts.prefix.replace(/\s+/g, '/') || ''}/${path}`
+            const makePath = (p) => `${opts.prefix.replace(/\s+/g, '/') || ''}/${p}`
                 .replace(/\/\/+/g, '/')
                 // avoid interpreting "cmd:tail" as "cmd/:tail"
                 .replace(/\/\\:/g, '\\:');
@@ -178,8 +189,10 @@ class MoostCli {
                     },
                 });
             }
+            const targetPath = makePath(path);
             const { getArgs, getStaticPart } = this.cliApp.cli(targetPath, fn);
             const meta = getCliMate().read(opts.fakeInstance, opts.method);
+            const classMeta = getCliMate().read(opts.fakeInstance);
             const args = {};
             getArgs().forEach(a => {
                 var _a;
@@ -187,20 +200,39 @@ class MoostCli {
                 args[a] = (argParam === null || argParam === void 0 ? void 0 : argParam.description) || '';
             });
             cliCommand = getStaticPart().replace(/\//g, ' ').trim();
-            this.cliHelp.addEntry({
-                description: (meta === null || meta === void 0 ? void 0 : meta.description) || '',
-                command: cliCommand,
-                options: ((_b = meta === null || meta === void 0 ? void 0 : meta.params) === null || _b === void 0 ? void 0 : _b.filter(param => !!param.cliParamKeys && param.cliParamKeys.length > 0).map(param => ({
+            const cliOptions = new Map();
+            [
+                ...(((_c = (_b = this.opts) === null || _b === void 0 ? void 0 : _b.globalCliOptions) === null || _c === void 0 ? void 0 : _c.length) ? this.opts.globalCliOptions : []),
+                ...((classMeta === null || classMeta === void 0 ? void 0 : classMeta.cliOptions) || []),
+                ...(((_d = meta === null || meta === void 0 ? void 0 : meta.params) === null || _d === void 0 ? void 0 : _d.filter(param => !!param.cliParamKeys && param.cliParamKeys.length > 0).map(param => ({
                     keys: param.cliParamKeys,
                     value: typeof param.value === 'string' ? param.value : '',
                     description: param.description || '',
-                }))) || [],
-                args,
-                aliases: meta === null || meta === void 0 ? void 0 : meta.cliAliases,
-            });
-            if ((_c = this.opts) === null || _c === void 0 ? void 0 : _c.debug) {
+                }))) || []),
+            ].forEach(o => cliOptions.set(o.keys[0], o));
+            if ((_e = this.opts) === null || _e === void 0 ? void 0 : _e.debug) {
                 opts.logHandler(`${''}(CLI)${''}${targetPath}`);
             }
+            const aliases = [];
+            if (meta === null || meta === void 0 ? void 0 : meta.cliAliases) {
+                for (const alias of meta.cliAliases) {
+                    const targetPath = makePath(alias);
+                    const { getStaticPart } = this.cliApp.cli(targetPath, fn);
+                    aliases.push(getStaticPart().replace(/\//g, ' ').trim());
+                    if ((_f = this.opts) === null || _f === void 0 ? void 0 : _f.debug) {
+                        opts.logHandler(`${''}(CLI-alias)${''}${targetPath}`);
+                    }
+                }
+            }
+            this.cliHelp.addEntry({
+                description: (meta === null || meta === void 0 ? void 0 : meta.description) || '',
+                command: cliCommand,
+                options: Array.from(cliOptions.values()),
+                args,
+                aliases: aliases,
+                custom: { fn, log: opts.logHandler },
+                examples: (meta === null || meta === void 0 ? void 0 : meta.cliExamples) || [],
+            });
         }
     }
 }
@@ -248,6 +280,17 @@ function CliOption(...keys) {
         }
         return vals[0];
     }, formatParams(keys).join(', ')));
+}
+/**
+ * ## Define Global CLI Option
+ * ### @ClassDecorator
+ * The option described here will appear in every command instructions
+ * @param option keys and description of CLI option
+ * @returns
+ */
+function CliGlobalOption(option) {
+    const mate = getCliMate();
+    return mate.decorate('cliOptions', option, true);
 }
 
 /**
@@ -278,6 +321,18 @@ function Cli(path) {
  */
 function CliAlias(alias) {
     return getCliMate().decorate('cliAliases', alias, true);
+}
+/**
+ * ## Define CLI Example
+ * ### @MethodDecorator
+ *
+ * Use it to define example for Cli Help display
+ *
+ * @param path - command alias path
+ * @returns
+ */
+function CliExample(cmd, description) {
+    return getCliMate().decorate('cliExamples', { cmd, description }, true);
 }
 
 /**
@@ -309,18 +364,22 @@ const cliHelpInterceptor = (opts) => {
         if ((opts === null || opts === void 0 ? void 0 : opts.helpWithArgs) || (opts === null || opts === void 0 ? void 0 : opts.helpWithIncompleteCmd)) {
             const { getMethod } = moost.useControllerContext();
             if (!getMethod()) {
-                const pathParams = eventCli.useCliContext().store('event').get('pathParams').join(' ');
+                const parts = eventCli.useCliContext().store('event').get('pathParams');
                 const cliHelp = useCliHelp().getCliHelp();
                 const cmd = cliHelp.getCliName();
                 let data;
-                try {
-                    data = cliHelp.match(pathParams);
-                }
-                catch (e) {
-                    if (opts === null || opts === void 0 ? void 0 : opts.helpWithIncompleteCmd) {
-                        const variants = cliHelp.lookup(pathParams);
-                        if (variants.length) {
-                            throw new Error(`Command is incomplete, did you mean:\n${variants.slice(0, 7).map(c => `  $ ${cmd} ${c.main.command}`).join('\n')}`);
+                for (let i = 0; i < Math.min(parts.length, 4); i++) {
+                    const pathParams = parts.slice(0, i ? -i : parts.length).join(' ');
+                    try {
+                        data = cliHelp.match(pathParams);
+                        break;
+                    }
+                    catch (e) {
+                        if (opts === null || opts === void 0 ? void 0 : opts.helpWithIncompleteCmd) {
+                            const variants = cliHelp.lookup(pathParams);
+                            if (variants.length) {
+                                throw new Error(`Wrong command, did you mean:\n${variants.slice(0, 7).map(c => `  $ ${cmd} ${c.main.command}`).join('\n')}`);
+                            }
                         }
                     }
                 }
@@ -329,8 +388,8 @@ const cliHelpInterceptor = (opts) => {
                     if ((opts === null || opts === void 0 ? void 0 : opts.helpWithArgs) && main.args && Object.keys(main.args).length) {
                         throw new Error(`Arguments expected: ${Object.keys(main.args).map(l => `<${l}>`).join(', ')}`);
                     }
-                    else if ((opts === null || opts === void 0 ? void 0 : opts.helpWithIncompleteCmd) && children) {
-                        throw new Error(`Command is incomplete, did you mean:\n${children.slice(0, 7).map(c => `  $ ${cmd} ${c.command}`).join('\n')}`);
+                    else if ((opts === null || opts === void 0 ? void 0 : opts.helpWithIncompleteCmd) && children && children.length) {
+                        throw new Error(`Wrong command, did you mean:\n${children.slice(0, 7).map(c => `  $ ${cmd} ${c.command}`).join('\n')}`);
                     }
                 }
             }
@@ -362,6 +421,8 @@ const CliHelpInterceptor = (...opts) => moost.Intercept(cliHelpInterceptor(...op
 
 exports.Cli = Cli;
 exports.CliAlias = CliAlias;
+exports.CliExample = CliExample;
+exports.CliGlobalOption = CliGlobalOption;
 exports.CliHelpInterceptor = CliHelpInterceptor;
 exports.CliOption = CliOption;
 exports.MoostCli = MoostCli;

package/dist/index.d.ts

@@ -5,6 +5,7 @@ import { TInterceptorFn } from 'moost';
 import { TMoostAdapter } from 'moost';
 import { TMoostAdapterOptions } from 'moost';
 import { TWooksCliOptions } from '@wooksjs/event-cli';
+import { TWooksHandler } from 'wooks';
 import { WooksCli } from '@wooksjs/event-cli';
 
 /**
@@ -34,6 +35,30 @@ export declare function Cli(path?: string): MethodDecorator;
  */
 export declare function CliAlias(alias: string): MethodDecorator;
 
+/**
+ * ## Define CLI Example
+ * ### @MethodDecorator
+ *
+ * Use it to define example for Cli Help display
+ *
+ * @param path - command alias path
+ * @returns
+ */
+export declare function CliExample(cmd: string, description?: string): MethodDecorator;
+
+/**
+ * ## Define Global CLI Option
+ * ### @ClassDecorator
+ * The option described here will appear in every command instructions
+ * @param option keys and description of CLI option
+ * @returns
+ */
+export declare function CliGlobalOption(option: {
+    keys: string[];
+    description?: string;
+    value?: string;
+}): ClassDecorator;
+
 /**
  * ## @Decorator
  * ### Interceptor Factory for CliHelpRenderer
@@ -113,6 +138,11 @@ export declare const cliHelpInterceptor: (opts?: {
     helpWithIncompleteCmd?: boolean;
 }) => TInterceptorFn;
 
+declare type CliHelpRendererWithFn = CliHelpRenderer<{
+    fn: TWooksHandler;
+    log: ((eventName: string) => void);
+}>;
+
 /**
  * ## Define CLI Option
  * ### @ParameterDecorator
@@ -167,7 +197,7 @@ export declare function CliOption(...keys: string[]): ParameterDecorator;
 export declare class MoostCli implements TMoostAdapter<TCliHandlerMeta> {
     protected opts?: TMoostCliOpts | undefined;
     protected cliApp: WooksCli;
-    protected cliHelp: CliHelpRenderer;
+    protected cliHelp: CliHelpRendererWithFn;
     constructor(opts?: TMoostCliOpts | undefined);
     onNotFound(): Promise<unknown>;
     protected moost?: Moost;
@@ -180,7 +210,7 @@ export declare class MoostCli implements TMoostAdapter<TCliHandlerMeta> {
  * Used internally to set CliHelpRenderer instance for an event state
  * @param cliHelp CliHelpRenderer
  */
-export declare function setCliHelpForEvent(cliHelp: CliHelpRenderer): void;
+export declare function setCliHelpForEvent(cliHelp: CliHelpRendererWithFn): void;
 
 export declare interface TCliHandlerMeta {
     path: string;
@@ -194,11 +224,18 @@ export declare interface TMoostCliOpts {
     /**
      * CliHelpRenderer options or instance
      */
-    cliHelp?: CliHelpRenderer | TCliHelpOptions;
+    cliHelp?: CliHelpRendererWithFn | TCliHelpOptions;
     /**
      * more internal logs are printed when true
      */
     debug?: boolean;
+    /**
+     * Array of cli options applicable to every cli command
+     */
+    globalCliOptions?: {
+        keys: string[];
+        description?: string;
+    }[];
 }
 
 /**
@@ -212,7 +249,7 @@ export declare interface TMoostCliOpts {
  * @returns
  */
 export declare function useCliHelp(): {
-    getCliHelp: () => CliHelpRenderer;
+    getCliHelp: () => CliHelpRendererWithFn;
     render: (width?: number, withColors?: boolean) => string[];
     print: (withColors?: boolean) => void;
 };

package/dist/index.mjs

@@ -143,11 +143,22 @@ class MoostCli {
         });
     }
     onInit(moost) {
+        var _a;
         this.moost = moost;
+        for (const [alias, entry] of Object.entries(this.cliHelp.getComputedAliases())) {
+            if (entry.custom) {
+                const vars = Object.keys(entry.args || {}).map(k => ':' + k).join('/');
+                const path = '/' + alias.replace(/\s+/g, '/').replace(/:/g, '\\:') + (vars ? '/' + vars : '');
+                this.cliApp.cli(path, entry.custom.fn);
+                if ((_a = this.opts) === null || _a === void 0 ? void 0 : _a.debug) {
+                    entry.custom.log(`${''}(CLI-alias*)${''}${path}`);
+                }
+            }
+        }
         void this.cliApp.run();
     }
     bindHandler(opts) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d, _e, _f;
         let fn;
         for (const handler of opts.handlers) {
             if (handler.type !== 'CLI')
@@ -157,7 +168,7 @@ class MoostCli {
                 : typeof opts.method === 'string'
                     ? opts.method
                     : '';
-            const targetPath = `${opts.prefix.replace(/\s+/g, '/') || ''}/${path}`
+            const makePath = (p) => `${opts.prefix.replace(/\s+/g, '/') || ''}/${p}`
                 .replace(/\/\/+/g, '/')
                 // avoid interpreting "cmd:tail" as "cmd/:tail"
                 .replace(/\/\\:/g, '\\:');
@@ -176,8 +187,10 @@ class MoostCli {
                     },
                 });
             }
+            const targetPath = makePath(path);
             const { getArgs, getStaticPart } = this.cliApp.cli(targetPath, fn);
             const meta = getCliMate().read(opts.fakeInstance, opts.method);
+            const classMeta = getCliMate().read(opts.fakeInstance);
             const args = {};
             getArgs().forEach(a => {
                 var _a;
@@ -185,20 +198,39 @@ class MoostCli {
                 args[a] = (argParam === null || argParam === void 0 ? void 0 : argParam.description) || '';
             });
             cliCommand = getStaticPart().replace(/\//g, ' ').trim();
-            this.cliHelp.addEntry({
-                description: (meta === null || meta === void 0 ? void 0 : meta.description) || '',
-                command: cliCommand,
-                options: ((_b = meta === null || meta === void 0 ? void 0 : meta.params) === null || _b === void 0 ? void 0 : _b.filter(param => !!param.cliParamKeys && param.cliParamKeys.length > 0).map(param => ({
+            const cliOptions = new Map();
+            [
+                ...(((_c = (_b = this.opts) === null || _b === void 0 ? void 0 : _b.globalCliOptions) === null || _c === void 0 ? void 0 : _c.length) ? this.opts.globalCliOptions : []),
+                ...((classMeta === null || classMeta === void 0 ? void 0 : classMeta.cliOptions) || []),
+                ...(((_d = meta === null || meta === void 0 ? void 0 : meta.params) === null || _d === void 0 ? void 0 : _d.filter(param => !!param.cliParamKeys && param.cliParamKeys.length > 0).map(param => ({
                     keys: param.cliParamKeys,
                     value: typeof param.value === 'string' ? param.value : '',
                     description: param.description || '',
-                }))) || [],
-                args,
-                aliases: meta === null || meta === void 0 ? void 0 : meta.cliAliases,
-            });
-            if ((_c = this.opts) === null || _c === void 0 ? void 0 : _c.debug) {
+                }))) || []),
+            ].forEach(o => cliOptions.set(o.keys[0], o));
+            if ((_e = this.opts) === null || _e === void 0 ? void 0 : _e.debug) {
                 opts.logHandler(`${''}(CLI)${''}${targetPath}`);
             }
+            const aliases = [];
+            if (meta === null || meta === void 0 ? void 0 : meta.cliAliases) {
+                for (const alias of meta.cliAliases) {
+                    const targetPath = makePath(alias);
+                    const { getStaticPart } = this.cliApp.cli(targetPath, fn);
+                    aliases.push(getStaticPart().replace(/\//g, ' ').trim());
+                    if ((_f = this.opts) === null || _f === void 0 ? void 0 : _f.debug) {
+                        opts.logHandler(`${''}(CLI-alias)${''}${targetPath}`);
+                    }
+                }
+            }
+            this.cliHelp.addEntry({
+                description: (meta === null || meta === void 0 ? void 0 : meta.description) || '',
+                command: cliCommand,
+                options: Array.from(cliOptions.values()),
+                args,
+                aliases: aliases,
+                custom: { fn, log: opts.logHandler },
+                examples: (meta === null || meta === void 0 ? void 0 : meta.cliExamples) || [],
+            });
         }
     }
 }
@@ -246,6 +278,17 @@ function CliOption(...keys) {
         }
         return vals[0];
     }, formatParams(keys).join(', ')));
+}
+/**
+ * ## Define Global CLI Option
+ * ### @ClassDecorator
+ * The option described here will appear in every command instructions
+ * @param option keys and description of CLI option
+ * @returns
+ */
+function CliGlobalOption(option) {
+    const mate = getCliMate();
+    return mate.decorate('cliOptions', option, true);
 }
 
 /**
@@ -276,6 +319,18 @@ function Cli(path) {
  */
 function CliAlias(alias) {
     return getCliMate().decorate('cliAliases', alias, true);
+}
+/**
+ * ## Define CLI Example
+ * ### @MethodDecorator
+ *
+ * Use it to define example for Cli Help display
+ *
+ * @param path - command alias path
+ * @returns
+ */
+function CliExample(cmd, description) {
+    return getCliMate().decorate('cliExamples', { cmd, description }, true);
 }
 
 /**
@@ -307,18 +362,22 @@ const cliHelpInterceptor = (opts) => {
         if ((opts === null || opts === void 0 ? void 0 : opts.helpWithArgs) || (opts === null || opts === void 0 ? void 0 : opts.helpWithIncompleteCmd)) {
             const { getMethod } = useControllerContext();
             if (!getMethod()) {
-                const pathParams = useCliContext().store('event').get('pathParams').join(' ');
+                const parts = useCliContext().store('event').get('pathParams');
                 const cliHelp = useCliHelp().getCliHelp();
                 const cmd = cliHelp.getCliName();
                 let data;
-                try {
-                    data = cliHelp.match(pathParams);
-                }
-                catch (e) {
-                    if (opts === null || opts === void 0 ? void 0 : opts.helpWithIncompleteCmd) {
-                        const variants = cliHelp.lookup(pathParams);
-                        if (variants.length) {
-                            throw new Error(`Command is incomplete, did you mean:\n${variants.slice(0, 7).map(c => `  $ ${cmd} ${c.main.command}`).join('\n')}`);
+                for (let i = 0; i < Math.min(parts.length, 4); i++) {
+                    const pathParams = parts.slice(0, i ? -i : parts.length).join(' ');
+                    try {
+                        data = cliHelp.match(pathParams);
+                        break;
+                    }
+                    catch (e) {
+                        if (opts === null || opts === void 0 ? void 0 : opts.helpWithIncompleteCmd) {
+                            const variants = cliHelp.lookup(pathParams);
+                            if (variants.length) {
+                                throw new Error(`Wrong command, did you mean:\n${variants.slice(0, 7).map(c => `  $ ${cmd} ${c.main.command}`).join('\n')}`);
+                            }
                         }
                     }
                 }
@@ -327,8 +386,8 @@ const cliHelpInterceptor = (opts) => {
                     if ((opts === null || opts === void 0 ? void 0 : opts.helpWithArgs) && main.args && Object.keys(main.args).length) {
                         throw new Error(`Arguments expected: ${Object.keys(main.args).map(l => `<${l}>`).join(', ')}`);
                     }
-                    else if ((opts === null || opts === void 0 ? void 0 : opts.helpWithIncompleteCmd) && children) {
-                        throw new Error(`Command is incomplete, did you mean:\n${children.slice(0, 7).map(c => `  $ ${cmd} ${c.command}`).join('\n')}`);
+                    else if ((opts === null || opts === void 0 ? void 0 : opts.helpWithIncompleteCmd) && children && children.length) {
+                        throw new Error(`Wrong command, did you mean:\n${children.slice(0, 7).map(c => `  $ ${cmd} ${c.command}`).join('\n')}`);
                     }
                 }
             }
@@ -358,4 +417,4 @@ const cliHelpInterceptor = (opts) => {
  */
 const CliHelpInterceptor = (...opts) => Intercept(cliHelpInterceptor(...opts));
 
-export { Cli, CliAlias, CliHelpInterceptor, CliOption, MoostCli, cliHelpInterceptor, setCliHelpForEvent, useCliHelp };
+export { Cli, CliAlias, CliExample, CliGlobalOption, CliHelpInterceptor, CliOption, MoostCli, cliHelpInterceptor, setCliHelpForEvent, useCliHelp };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moostjs/event-cli",
-  "version": "0.2.28",
+  "version": "0.2.29",
   "description": "@moostjs/event-cli",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
@@ -28,12 +28,12 @@
   },
   "homepage": "https://github.com/moostjs/moostjs/tree/main/packages/event-cli#readme",
   "peerDependencies": {
-    "moost": "0.2.28",
-    "wooks": "^0.2.22",
-    "@wooksjs/event-core": "^0.2.22"
+    "moost": "0.2.29",
+    "wooks": "^0.2.23",
+    "@wooksjs/event-core": "^0.2.23"
   },
   "dependencies": {
-    "@wooksjs/event-cli": "^0.2.22",
-    "@prostojs/cli-help": "^0.0.7"
+    "@wooksjs/event-cli": "^0.2.23",
+    "@prostojs/cli-help": "^0.0.9"
   }
 }