@wooksjs/event-cli 0.3.0 → 0.3.1

package/README.md

@@ -21,13 +21,13 @@ As a part of `wooks` event processing framework, `@wooksjs/event-cli` implements
 
 ```js
 import { useRouteParams } from 'wooks'
-import { createCliApp, useFlags } from '@wooksjs/event-cli'
+import { createCliApp, useCliOptions } from '@wooksjs/event-cli'
 
 const app = createCliApp()
 
 app.cli('test', () => {
-    console.log('flags:')
-    return useFlags()
+    console.log('options:')
+    return useCliOptions()
 })
 
 app.cli(':arg', () => {
@@ -43,4 +43,4 @@ app.run()
 
 ## Documentation
 
-To check out docs, visit [wooksjs.org](https://wooksjs.org/).
+To check out docs, visit [wooksjs.org](https://wooksjs.org/guide/cli/).

package/dist/index.cjs

@@ -11,6 +11,11 @@ function createCliContext(data, options) {
         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');
 }
@@ -251,6 +256,12 @@ class WooksCli extends wooks.WooksAdapterBase {
         }
     }
 }
+/**
+ * Factory for WooksCli App
+ * @param opts TWooksCliOptions
+ * @param wooks Wooks | WooksAdapterBase
+ * @returns WooksHttp
+ */
 function createCliApp(opts, wooks) {
     return new WooksCli(opts, wooks);
 }
@@ -304,7 +315,7 @@ function useCliHelp() {
  */
 function useAutoHelp(keys = ['help'], colors = true) {
     for (const option of keys) {
-        if (useFlag(option) === true) {
+        if (useCliOption(option) === true) {
             // try {
             useCliHelp().print(colors);
             return true;
@@ -391,7 +402,12 @@ function useCommandLookupHelp(lookupDepth = 3) {
     }
 }
 
-function useFlags() {
+/**
+ * Get CLI Options
+ *
+ * @returns an object with CLI options
+ */
+function useCliOptions() {
     const { store } = useCliContext();
     const flags = store('flags');
     if (!flags.value) {
@@ -399,15 +415,21 @@ function useFlags() {
     }
     return flags.value;
 }
-function useFlag(name) {
+/**
+ * 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 opt = options.find(o => o.keys.includes(name));
         if (opt) {
             for (const key of opt.keys) {
-                if (useFlags()[key]) {
-                    return useFlags()[key];
+                if (useCliOptions()[key]) {
+                    return useCliOptions()[key];
                 }
             }
         }
@@ -415,13 +437,7 @@ function useFlag(name) {
     catch (e) {
         //
     }
-    return useFlags()[name];
-}
-
-function usePathParams() {
-    const { store } = useCliContext();
-    const event = store('event');
-    return event.get('pathParams');
+    return useCliOptions()[name];
 }
 
 exports.WooksCli = WooksCli;
@@ -431,7 +447,6 @@ exports.createCliContext = createCliContext;
 exports.useAutoHelp = useAutoHelp;
 exports.useCliContext = useCliContext;
 exports.useCliHelp = useCliHelp;
+exports.useCliOption = useCliOption;
+exports.useCliOptions = useCliOptions;
 exports.useCommandLookupHelp = useCommandLookupHelp;
-exports.useFlag = useFlag;
-exports.useFlags = useFlags;
-exports.usePathParams = usePathParams;

package/dist/index.d.ts

@@ -15,6 +15,12 @@ export declare const cliShortcuts: {
     cli: string;
 };
 
+/**
+ * Factory for WooksCli App
+ * @param opts TWooksCliOptions
+ * @param wooks Wooks | WooksAdapterBase
+ * @returns WooksHttp
+ */
 export declare function createCliApp(opts?: TWooksCliOptions, wooks?: Wooks | WooksAdapterBase): WooksCli;
 
 export declare function createCliContext(data: Omit<TCliEventData, 'type'>, options: TEventOptions): {
@@ -105,6 +111,11 @@ export declare interface TWooksCliOptions {
  */
 export declare function useAutoHelp(keys?: string[], colors?: boolean): true | undefined;
 
+/**
+ * Wrapper on top of useEventContext that provides
+ * proper context types for CLI event
+ * @returns set of hooks { getCtx, restoreCtx, clearCtx, hookStore, getStore, setStore }
+ */
 export declare function useCliContext<T extends TEmpty>(): {
     getCtx: () => TCliContextStore & T & TGenericContextStore<TCliEventData>;
     restoreCtx: () => TGenericContextStore<TEmpty>;
@@ -147,6 +158,23 @@ export declare function useCliHelp(): {
     print: (withColors?: boolean) => void;
 };
 
+/**
+ * Getter for Cli Option value
+ *
+ * @param name name of the option
+ * @returns value of a CLI option
+ */
+export declare function useCliOption(name: string): string | boolean;
+
+/**
+ * Get CLI Options
+ *
+ * @returns an object with CLI options
+ */
+export declare function useCliOptions(): {
+    [name: string]: string | boolean;
+};
+
 /**
  * ##useCommandLookupHelp
  * ### Composable
@@ -182,14 +210,6 @@ export declare function useCliHelp(): {
  */
 export declare function useCommandLookupHelp(lookupDepth?: number): void;
 
-export declare function useFlag(name: string): string | boolean;
-
-export declare function useFlags(): {
-    [name: string]: string | boolean;
-};
-
-export declare function usePathParams(): string[];
-
 export declare class WooksCli extends WooksAdapterBase {
     protected opts?: TWooksCliOptions | undefined;
     protected logger: TConsoleBase;

package/dist/index.mjs

@@ -9,6 +9,11 @@ function createCliContext(data, options) {
         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 useEventContext('CLI');
 }
@@ -249,6 +254,12 @@ class WooksCli extends WooksAdapterBase {
         }
     }
 }
+/**
+ * Factory for WooksCli App
+ * @param opts TWooksCliOptions
+ * @param wooks Wooks | WooksAdapterBase
+ * @returns WooksHttp
+ */
 function createCliApp(opts, wooks) {
     return new WooksCli(opts, wooks);
 }
@@ -302,7 +313,7 @@ function useCliHelp() {
  */
 function useAutoHelp(keys = ['help'], colors = true) {
     for (const option of keys) {
-        if (useFlag(option) === true) {
+        if (useCliOption(option) === true) {
             // try {
             useCliHelp().print(colors);
             return true;
@@ -389,7 +400,12 @@ function useCommandLookupHelp(lookupDepth = 3) {
     }
 }
 
-function useFlags() {
+/**
+ * Get CLI Options
+ *
+ * @returns an object with CLI options
+ */
+function useCliOptions() {
     const { store } = useCliContext();
     const flags = store('flags');
     if (!flags.value) {
@@ -397,15 +413,21 @@ function useFlags() {
     }
     return flags.value;
 }
-function useFlag(name) {
+/**
+ * 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 opt = options.find(o => o.keys.includes(name));
         if (opt) {
             for (const key of opt.keys) {
-                if (useFlags()[key]) {
-                    return useFlags()[key];
+                if (useCliOptions()[key]) {
+                    return useCliOptions()[key];
                 }
             }
         }
@@ -413,13 +435,7 @@ function useFlag(name) {
     catch (e) {
         //
     }
-    return useFlags()[name];
-}
-
-function usePathParams() {
-    const { store } = useCliContext();
-    const event = store('event');
-    return event.get('pathParams');
+    return useCliOptions()[name];
 }
 
-export { WooksCli, cliShortcuts, createCliApp, createCliContext, useAutoHelp, useCliContext, useCliHelp, useCommandLookupHelp, useFlag, useFlags, usePathParams };
+export { WooksCli, cliShortcuts, createCliApp, createCliContext, useAutoHelp, useCliContext, useCliHelp, useCliOption, useCliOptions, useCommandLookupHelp };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wooksjs/event-cli",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "@wooksjs/event-cli",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
@@ -31,8 +31,8 @@
     "url": "https://github.com/wooksjs/wooksjs/issues"
   },
   "peerDependencies": {
-    "wooks": "0.3.0",
-    "@wooksjs/event-core": "0.3.0"
+    "wooks": "0.3.1",
+    "@wooksjs/event-core": "0.3.1"
   },
   "dependencies": {
     "minimist": "^1.2.6",