@moostjs/event-cli 0.2.32 → 0.2.34

package/README.md

@@ -1,7 +1,5 @@
 # @moostjs/event-cli
 
-**!!! This is work-in-progress library, breaking changes are expected !!!**
-
 <p align="center">
 <img src="../../moost-logo.png" width="450px"><br>
 <a  href="https://github.com/moostjs/moostjs/blob/main/LICENSE">
@@ -9,32 +7,51 @@
 </a>
 </p>
 
-`event-cli` is a moostjs wrapper of [@wooksjs/event-cli](https://github.com/wooksjs/wooksjs/tree/main/packages/event-cli) with corresponding decorators for composable functions.
+Welcome to `@moostjs/event-cli`, a Moostjs library designed to handle CLI events within your Moost application. This package provides decorators that simplify the creation of command line interface handlers in a structured and declarative manner.
+
+**Note:** As `@moostjs/event-cli` is under active development, breaking changes can be expected.
 
-## Quick Start
+## Overview
 
-```ts
-import { MoostCli, Flag, Cli } from '@moostjs/event-cli'
-import { Moost } from 'moost'
+The `@moostjs/event-cli` module is crucial for making Moost applications responsive to CLI events. By leveraging this module, you can create handlers for these events in a structured, and clear manner.
 
-class MyApp extends Moost {
-    @Cli('command')
-    command(@Flag('test') test: string | boolean) {
-        return `command run with flag test=${ test }`
-    }
-}
+## Getting Started
 
-const app = new MyApp()
+To start a new Moost CLI project, you can run the following command:
+
+```bash
+npm create moost -- --cli
+```
 
-const cli = new MoostCli()
-app.adapter(cli)
-app.init()
+You can also provide a name for your project:
 
-// Run compiled file as CLI with `command --test`
-// The output:
-// "command run with flag test=true"
+```bash
+npm create moost my-cli-app -- --cli
 ```
 
-## Install
+This command will initiate a setup tool that will guide you through the project initialization process. It will prompt you to make certain choices such as:
+
+- Whether you want to integrate eslint and prettier.
+- Which bundler you prefer to use: esbuild or rollup.
+
+## [Official Documentation](https://moost.org/cliapp/)
+
+## Contributing
+
+We are excited to welcome contributors who are passionate about improving Moostjs. No matter your level of experience, your unique perspective and skills can make valuable contributions to our growing community.
+
+Here are some basic steps to get you started:
+
+1. **Fork the Repo:** Navigate to [moostjs](https://github.com/moostjs/moostjs) and fork the repository to your own GitHub account.
+
+2. **Clone the Repo:** Clone the forked repository to your local machine.
+
+3. **Create a Branch:** Make a new branch for your feature or bug fix.
+
+4. **Make your Changes:** Implement your feature or fix the bug and commit the changes to your branch.
+
+5. **Make a Pull Request:** Navigate back to your forked repo and press the "New pull request" button.
+
+Don't hesitate to ask for help if you need it. We believe in fostering a friendly and respectful environment for all contributors.
 
-`npm install moost @moostjs/event-cli`
+Thank you for your interest in Moostjs. We look forward to building something amazing together!

package/dist/index.cjs

@@ -107,7 +107,7 @@ class MoostCli {
         void this.cliApp.run();
     }
     bindHandler(opts) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d;
         let fn;
         for (const handler of opts.handlers) {
             if (handler.type !== 'CLI')
@@ -141,11 +141,11 @@ class MoostCli {
             [
                 ...(((_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.cliOptionsKeys && param.cliOptionsKeys.length > 0).map(param => ({
+                ...((meta === null || meta === void 0 ? void 0 : meta.params) ? meta.params.filter((param) => { var _a; return ((_a = param.cliOptionsKeys) === null || _a === void 0 ? void 0 : _a.length) > 0; }).map((param) => ({
                     keys: param.cliOptionsKeys,
                     value: typeof param.value === 'string' ? param.value : '',
                     description: param.description || '',
-                }))) || []),
+                })) : []),
             ].forEach(o => cliOptions.set(o.keys[0], o));
             const aliases = [];
             if (meta === null || meta === void 0 ? void 0 : meta.cliAliases) {
@@ -155,8 +155,8 @@ class MoostCli {
                 }
             }
             const args = {};
-            (_e = meta === null || meta === void 0 ? void 0 : meta.params) === null || _e === void 0 ? void 0 : _e.filter(p => p.isRouteParam && p.description).forEach(p => args[p.isRouteParam] = p.description);
-            this.cliApp.cli(targetPath, {
+            (_d = meta === null || meta === void 0 ? void 0 : meta.params) === null || _d === void 0 ? void 0 : _d.filter(p => p.paramSource === 'ROUTE' && p.description).forEach(p => args[p.paramName] = p.description);
+            const routerBinding = this.cliApp.cli(targetPath, {
                 description: (meta === null || meta === void 0 ? void 0 : meta.description) || '',
                 options: Array.from(cliOptions.values()),
                 args,
@@ -165,11 +165,13 @@ class MoostCli {
                 handler: fn,
                 onRegister: (path, aliasType) => {
                     var _a;
+                    opts.register(handler, path, routerBinding.getArgs());
                     if ((_a = this.opts) === null || _a === void 0 ? void 0 : _a.debug) {
                         opts.logHandler(`${''}(${aliasTypes[aliasType]})${''}${path}`);
                     }
                 },
             });
+            opts.register(handler, targetPath, routerBinding.getArgs());
         }
     }
 }

package/dist/index.d.ts

@@ -185,7 +185,7 @@ export declare class MoostCli implements TMoostAdapter<TCliHandlerMeta> {
     onNotFound(): Promise<unknown>;
     protected moost?: Moost;
     onInit(moost: Moost): void;
-    bindHandler<T extends object = object>(opts: TMoostAdapterOptions<TCliHandlerMeta, T>): void | Promise<void>;
+    bindHandler<T extends object = object>(opts: TMoostAdapterOptions<TCliHandlerMeta, T>): void;
 }
 
 export declare interface TCliHandlerMeta {

package/dist/index.mjs

@@ -106,7 +106,7 @@ class MoostCli {
         void this.cliApp.run();
     }
     bindHandler(opts) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d;
         let fn;
         for (const handler of opts.handlers) {
             if (handler.type !== 'CLI')
@@ -140,11 +140,11 @@ class MoostCli {
             [
                 ...(((_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.cliOptionsKeys && param.cliOptionsKeys.length > 0).map(param => ({
+                ...((meta === null || meta === void 0 ? void 0 : meta.params) ? meta.params.filter((param) => { var _a; return ((_a = param.cliOptionsKeys) === null || _a === void 0 ? void 0 : _a.length) > 0; }).map((param) => ({
                     keys: param.cliOptionsKeys,
                     value: typeof param.value === 'string' ? param.value : '',
                     description: param.description || '',
-                }))) || []),
+                })) : []),
             ].forEach(o => cliOptions.set(o.keys[0], o));
             const aliases = [];
             if (meta === null || meta === void 0 ? void 0 : meta.cliAliases) {
@@ -154,8 +154,8 @@ class MoostCli {
                 }
             }
             const args = {};
-            (_e = meta === null || meta === void 0 ? void 0 : meta.params) === null || _e === void 0 ? void 0 : _e.filter(p => p.isRouteParam && p.description).forEach(p => args[p.isRouteParam] = p.description);
-            this.cliApp.cli(targetPath, {
+            (_d = meta === null || meta === void 0 ? void 0 : meta.params) === null || _d === void 0 ? void 0 : _d.filter(p => p.paramSource === 'ROUTE' && p.description).forEach(p => args[p.paramName] = p.description);
+            const routerBinding = this.cliApp.cli(targetPath, {
                 description: (meta === null || meta === void 0 ? void 0 : meta.description) || '',
                 options: Array.from(cliOptions.values()),
                 args,
@@ -164,11 +164,13 @@ class MoostCli {
                 handler: fn,
                 onRegister: (path, aliasType) => {
                     var _a;
+                    opts.register(handler, path, routerBinding.getArgs());
                     if ((_a = this.opts) === null || _a === void 0 ? void 0 : _a.debug) {
                         opts.logHandler(`${''}(${aliasTypes[aliasType]})${''}${path}`);
                     }
                 },
             });
+            opts.register(handler, targetPath, routerBinding.getArgs());
         }
     }
 }

package/package.json

@@ -1,10 +1,18 @@
 {
   "name": "@moostjs/event-cli",
-  "version": "0.2.32",
+  "version": "0.2.34",
   "description": "@moostjs/event-cli",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
   "files": [
     "dist"
   ],
@@ -28,11 +36,12 @@
   },
   "homepage": "https://github.com/moostjs/moostjs/tree/main/packages/event-cli#readme",
   "peerDependencies": {
-    "moost": "0.2.32",
-    "wooks": "^0.3.3",
-    "@wooksjs/event-core": "^0.3.3"
+    "moost": "0.2.34",
+    "wooks": "^0.3.11",
+    "@wooksjs/event-core": "^0.3.11"
   },
   "dependencies": {
-    "@wooksjs/event-cli": "^0.3.3"
+    "@wooksjs/event-cli": "^0.3.11",
+    "@prostojs/wf": "^0.0.3"
   }
 }