@wooksjs/event-cli 0.4.10 → 0.4.12

package/dist/index.cjs

@@ -7,113 +7,40 @@ var minimist = require('minimist');
 
 function createCliContext(data, options) {
     return eventCore.createEventContext({
-        event: Object.assign(Object.assign({}, data), { type: 'CLI' }),
+        event: {
+            ...data,
+            type: 'CLI',
+        },
         options,
     });
 }
-/**
- * Wrapper on top of useEventContext that provides
- * proper context types for CLI event
- * @returns set of hooks { getCtx, restoreCtx, clearCtx, hookStore, getStore, setStore }
- */
 function useCliContext() {
     return eventCore.useEventContext('CLI');
 }
 
-/******************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-/* global Reflect, Promise, SuppressedError, Symbol */
-
-
-function __awaiter(thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-}
-
-typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
-    var e = new Error(message);
-    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
-};
-
 const cliShortcuts = {
     cli: 'CLI',
 };
 class WooksCli extends wooks.WooksAdapterBase {
     constructor(opts, wooks) {
-        super(wooks, opts === null || opts === void 0 ? void 0 : opts.logger, opts === null || opts === void 0 ? void 0 : opts.router);
+        super(wooks, opts?.logger, opts?.router);
         this.opts = opts;
         this.alreadyComputedAliases = false;
-        this.logger = (opts === null || opts === void 0 ? void 0 : opts.logger) || this.getLogger('wooks-cli');
+        this.logger = opts?.logger || this.getLogger('wooks-cli');
         this.cliHelp =
-            (opts === null || opts === void 0 ? void 0 : opts.cliHelp) instanceof cliHelp.CliHelpRenderer
+            opts?.cliHelp instanceof cliHelp.CliHelpRenderer
                 ? opts.cliHelp
-                : new cliHelp.CliHelpRenderer(opts === null || opts === void 0 ? void 0 : opts.cliHelp);
+                : new cliHelp.CliHelpRenderer(opts?.cliHelp);
     }
-    /**
-     * ### Register CLI Command
-     * Command path segments may be separated by / or space.
-     *
-     * For example the folowing path are interpreted the same:
-     * - "command test use:dev :name"
-     * - "command/test/use:dev/:name"
-     *
-     * Where name will become an argument
-     *
-     * ```js
-     * // example without options
-     * app.cli('command/:arg', () => 'arg = ' + useRouteParams().params.arg )
-     *
-     * // example with options
-     * app.cli('command/:arg', {
-     *   description: 'Description of the command',
-     *   options: [{ keys: ['project', 'p'], description: 'Description of the option', value: 'myProject' }],
-     *   args: { arg: 'Description of the arg' },
-     *   aliases: ['cmd'],  // alias "cmd/:arg" will be registered
-     *   examples: [{
-     *      description: 'Example of usage with someProject',
-     *      cmd: 'argValue -p=someProject',
-     *      // will result in help display:
-     *      // "# Example of usage with someProject\n" +
-     *      // "$ myCli command argValue -p=someProject\n"
-     *   }],
-     *   handler: () => 'arg = ' + useRouteParams().params.arg
-     * })
-     * ```
-     *
-     * @param path command path
-     * @param _options handler or options
-     *
-     * @returns
-     */
     cli(path, _options) {
-        var _a;
         const options = typeof _options === 'function' ? { handler: _options } : _options;
         const handler = typeof _options === 'function' ? _options : _options.handler;
         const makePath = (s) => '/' + s.replace(/\s+/g, '/');
-        // register handler
         const targetPath = makePath(path);
         const routed = this.on('CLI', targetPath, handler);
         if (options.onRegister) {
             options.onRegister(targetPath, 0, routed);
         }
-        // register direct aliases
         for (const alias of options.aliases || []) {
             const vars = routed.getArgs().map((k) => ':' + k).join('/');
             const targetPath = makePath(alias) + (vars ? '/' + vars : '');
@@ -122,9 +49,10 @@ class WooksCli extends wooks.WooksAdapterBase {
                 options.onRegister(targetPath, 1, routed);
             }
         }
-        // register helpCli entry
         const command = routed.getStaticPart().replace(/\//g, ' ').trim();
-        const args = Object.assign({}, (options.args || {}));
+        const args = {
+            ...(options.args || {}),
+        };
         for (const arg of routed.getArgs()) {
             if (!args[arg]) {
                 args[arg] = '';
@@ -132,7 +60,7 @@ class WooksCli extends wooks.WooksAdapterBase {
         }
         this.cliHelp.addEntry({
             command,
-            aliases: (_a = options.aliases) === null || _a === void 0 ? void 0 : _a.map(alias => alias.replace(/\\:/g, ':')), // unescape ":" character
+            aliases: options.aliases?.map(alias => alias.replace(/\\:/g, ':')),
             args,
             description: options.description,
             examples: options.examples,
@@ -161,73 +89,57 @@ class WooksCli extends wooks.WooksAdapterBase {
             }
         }
     }
-    /**
-     * ## run
-     * ### Start command processing
-     * Triggers command processing
-     *
-     * By default takes `process.argv.slice(2)` as a command
-     *
-     * It's possible to replace the command by passing an argument
-     *
-     * @param _argv optionally overwrite `process.argv.slice(2)` with your `argv` array
-     */
-    run(_argv, _opts) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function* () {
-            const argv = _argv || process.argv.slice(2);
-            const parsedFlags = minimist(argv, _opts);
-            const pathParams = parsedFlags._;
-            const path = '/' +
-                pathParams.map((v) => encodeURI(v).replace(/\//g, '%2F')).join('/');
-            const { restoreCtx, clearCtx, store } = createCliContext({ opts: _opts, argv, pathParams, cliHelp: this.cliHelp, command: path.replace(/\//g, ' ').trim() }, this.mergeEventOptions((_a = this.opts) === null || _a === void 0 ? void 0 : _a.eventOptions));
-            store('flags').value = parsedFlags;
-            this.computeAliases();
-            const { handlers: foundHandlers, firstStatic } = this.wooks.lookup('CLI', path);
-            if (typeof firstStatic === 'string') {
-                // overwriting command with firstStatic to properly search for help
-                store('event').set('command', firstStatic.replace(/\//g, ' ').trim());
-            }
-            const handlers = foundHandlers ||
-                (((_b = this.opts) === null || _b === void 0 ? void 0 : _b.onNotFound) && [this.opts.onNotFound]) ||
-                null;
-            if (handlers) {
-                try {
-                    for (const handler of handlers) {
-                        restoreCtx();
-                        const response = yield handler();
-                        if (typeof response === 'string') {
-                            console.log(response);
-                        }
-                        else if (Array.isArray(response)) {
-                            response.forEach((r) => console.log(typeof r === 'string'
-                                ? r
-                                : JSON.stringify(r, null, '  ')));
-                        }
-                        else if (response instanceof Error) {
-                            this.onError(response);
-                        }
-                        else if (response) {
-                            if (response) {
-                                console.log(JSON.stringify(response, null, '  '));
-                            }
+    async run(_argv, _opts) {
+        const argv = _argv || process.argv.slice(2);
+        const parsedFlags = minimist(argv, _opts);
+        const pathParams = parsedFlags._;
+        const path = '/' +
+            pathParams.map((v) => encodeURI(v).replace(/\//g, '%2F')).join('/');
+        const { restoreCtx, clearCtx, store } = createCliContext({ opts: _opts, argv, pathParams, cliHelp: this.cliHelp, command: path.replace(/\//g, ' ').trim() }, this.mergeEventOptions(this.opts?.eventOptions));
+        store('flags').value = parsedFlags;
+        this.computeAliases();
+        const { handlers: foundHandlers, firstStatic } = this.wooks.lookup('CLI', path);
+        if (typeof firstStatic === 'string') {
+            store('event').set('command', firstStatic.replace(/\//g, ' ').trim());
+        }
+        const handlers = foundHandlers ||
+            (this.opts?.onNotFound && [this.opts.onNotFound]) ||
+            null;
+        if (handlers) {
+            try {
+                for (const handler of handlers) {
+                    restoreCtx();
+                    const response = await handler();
+                    if (typeof response === 'string') {
+                        console.log(response);
+                    }
+                    else if (Array.isArray(response)) {
+                        response.forEach((r) => console.log(typeof r === 'string'
+                            ? r
+                            : JSON.stringify(r, null, '  ')));
+                    }
+                    else if (response instanceof Error) {
+                        this.onError(response);
+                    }
+                    else if (response) {
+                        if (response) {
+                            console.log(JSON.stringify(response, null, '  '));
                         }
                     }
                 }
-                catch (e) {
-                    this.onError(e);
-                }
-                clearCtx();
             }
-            else {
-                this.onUnknownCommand(pathParams);
-                clearCtx();
+            catch (e) {
+                this.onError(e);
             }
-        });
+            clearCtx();
+        }
+        else {
+            this.onUnknownCommand(pathParams);
+            clearCtx();
+        }
     }
     onError(e) {
-        var _a;
-        if ((_a = this.opts) === null || _a === void 0 ? void 0 : _a.onError) {
+        if (this.opts?.onError) {
             this.opts.onError(e);
         }
         else {
@@ -235,17 +147,12 @@ class WooksCli extends wooks.WooksAdapterBase {
             process.exit(1);
         }
     }
-    /**
-     * Triggers `unknown command` processing and callbacks
-     * @param pathParams `string[]` containing command
-     */
     onUnknownCommand(pathParams) {
-        var _a;
         const raiseError = () => {
             this.error('' + 'Unknown command: ' + pathParams.join(' '));
             process.exit(1);
         };
-        if ((_a = this.opts) === null || _a === void 0 ? void 0 : _a.onUnknownCommand) {
+        if (this.opts?.onUnknownCommand) {
             this.opts.onUnknownCommand(pathParams, raiseError);
         }
         else {
@@ -261,33 +168,14 @@ class WooksCli extends wooks.WooksAdapterBase {
         }
     }
 }
-/**
- * Factory for WooksCli App
- * @param opts TWooksCliOptions
- * @param wooks Wooks | WooksAdapterBase
- * @returns WooksCli
- */
 function createCliApp(opts, wooks) {
     return new WooksCli(opts, wooks);
 }
 
-/**
- * ## useCliHelp
- * ### Composable
- * ```js
- * // example of printing cli instructions
- * const { print } = useCliHelp()
- * // print with colors
- * print(true)
- * // print with no colors
- * // print(false)
- * ```
- * @returns
- */
 function useCliHelp() {
     const event = useCliContext().store('event');
     const getCliHelp = () => event.get('cliHelp');
-    const getEntry = () => { var _a; return (_a = getCliHelp().match(event.get('command'))) === null || _a === void 0 ? void 0 : _a.main; };
+    const getEntry = () => getCliHelp().match(event.get('command'))?.main;
     return {
         getCliHelp,
         getEntry,
@@ -295,74 +183,14 @@ function useCliHelp() {
         print: (withColors) => getCliHelp().print(event.get('command'), withColors),
     };
 }
-/**
- * ## useAutoHelp
- * ### Composable
- *
- * Prints help if `--help` option provided.
- *
- * ```js
- *  // example of use: print help and exit
- *  app.cli('test', () => {
- *      useAutoHelp() && process.exit(0)
- *      return 'hit test command'
- *  })
- *
- *  // add option -h to print help, no colors
- *  app.cli('test/nocolors', () => {
- *      useAutoHelp(['help', 'h'], false) && process.exit(0)
- *      return 'hit test nocolors command'
- *  })
- * ```
- * @param keys default `['help']` - list of options to trigger help render
- * @param colors default `true`, prints with colors when true
- * @returns true when --help was provided. Otherwise returns false
- */
 function useAutoHelp(keys = ['help'], colors = true) {
     for (const option of keys) {
         if (useCliOption(option) === true) {
-            // try {
             useCliHelp().print(colors);
             return true;
-            // } catch (e) {
-            //     throw new 
-            // }
         }
     }
 }
-/**
- * ##useCommandLookupHelp
- * ### Composable
- *
- * Tries to find valid command based on provided command.
- *
- * If manages to find a valid command, throws an error
- * suggesting a list of valid commands
- *
- * Best to use in `onUnknownCommand` callback:
- *
- * ```js
- *  const app = createCliApp({
- *      onUnknownCommand: (path, raiseError) => {
- *          // will throw an error suggesting a list
- *          // of valid commands if could find some
- *          useCommandLookupHelp()
- *          // fallback to a regular error handler
- *          raiseError()
- *      },
- *  })
- * ```
- *
- * @param lookupDepth depth of search in backwards
- * @example
- *
- * For provided command `run test:drive dir`
- *  - lookup1: `run test:drive dir`  (deep = 0)
- *  - lookup2: `run test:drive`      (deep = 1)
- *  - lookup3: `run test`            (deep = 2)
- *  - lookup4: `run`                 (deep = 3)
- * ...
- */
 function useCommandLookupHelp(lookupDepth = 3) {
     const parts = useCliContext()
         .store('event')
@@ -407,11 +235,6 @@ function useCommandLookupHelp(lookupDepth = 3) {
     }
 }
 
-/**
- * Get CLI Options
- *
- * @returns an object with CLI options
- */
 function useCliOptions() {
     const { store } = useCliContext();
     const flags = store('flags');
@@ -421,16 +244,9 @@ function useCliOptions() {
     }
     return flags.value;
 }
-/**
- * Getter for Cli Option value
- *
- * @param name name of the option
- * @returns value of a CLI option
- */
 function useCliOption(name) {
-    var _a;
     try {
-        const options = ((_a = useCliHelp().getEntry()) === null || _a === void 0 ? void 0 : _a.options) || [];
+        const options = useCliHelp().getEntry()?.options || [];
         const opt = options.find(o => o.keys.includes(name));
         if (opt) {
             for (const key of opt.keys) {
@@ -441,7 +257,6 @@ function useCliOption(name) {
         }
     }
     catch (e) {
-        //
     }
     return useCliOptions()[name];
 }