@h3ravel/musket 0.1.10 → 0.2.1

package/README.md

@@ -73,6 +73,60 @@ Kernel.init(app, {
 });
 ```
 
+## Creating Commands
+
+Commands in Musket extend the base `Command` class and define a **signature** and **handle()** method.
+
+Example:
+
+```ts
+import { Command } from '@h3ravel/musket';
+
+export default class GreetCommand extends Command {
+  protected signature = 'greet {name}';
+  protected description = 'Display a personalized greeting.';
+
+  async handle() {
+    const name = this.argument('name');
+
+    this.info(`Hello, ${name}!`);
+  }
+}
+```
+
+If your project uses discovery paths (via `discoveryPaths`),
+this command will be automatically registered.
+
+Otherwise, you can manually register it in your application:
+
+```ts
+class Application {
+  registeredCommands = [GreetCommand];
+}
+
+await Kernel.init(app);
+
+// OR
+
+await Kernel.init(app, {
+  baseCommands: [BuildCommand],
+});
+```
+
+## Running Commands
+
+Once your CLI is compiled or built, you can run commands via:
+
+```bash
+node dist/cli.js greet Legacy
+```
+
+Output:
+
+```
+Hello, Legacy!
+```
+
 ## Documentation
 
 The full musket documentation is available [Here](https://h3ravel.toneflix.net/musket)

package/dist/index.cjs

@@ -635,8 +635,9 @@ var Musket = class Musket {
 			verbose: ["-v, --verbose [level]", "Increase the verbosity of messages: 1 for normal output, 2 and v for more verbose output and 3 and vv for debug"],
 			noInteraction: ["-n, --no-interaction", "Do not ask any interactive question"]
 		};
-		/** 
-		* Init Commander
+		if (!this.config.rootCommand)
+ /** 
+		* Run the base Command if a root command was not defined
 		*/
 		commander.program.name(this.cliName).version(moduleVersions).description(this.config.logo ?? altLogo).configureHelp({ showGlobalOptions: true }).addOption(new commander.Option(additional.quiet[0], additional.quiet[1])).addOption(new commander.Option(additional.silent[0], additional.silent[1]).implies({ quiet: true })).addOption(new commander.Option(additional.verbose[0], additional.verbose[1]).choices([
 			"1",
@@ -649,6 +650,20 @@ var Musket = class Musket {
 			instance.setInput(commander.program.opts(), commander.program.args, commander.program.registeredArguments, {}, commander.program);
 			await this.handle(instance);
 		});
+		else {
+			/**
+			* Load the root command here
+			*/
+			const root = new this.config.rootCommand(this.app, this.kernel);
+			const sign = Signature.parseSignature(root.getSignature(), root);
+			const cmd = commander.program.name(sign.baseCommand).description(sign.description ?? sign.baseCommand).configureHelp({ showGlobalOptions: true }).action(async () => {
+				root.setInput(commander.program.opts(), commander.program.args, commander.program.registeredArguments, {}, commander.program);
+				await this.handle(root);
+			});
+			if ((sign.options?.length ?? 0) > 0) sign.options?.filter((v, i, a) => a.findIndex((t) => t.name === v.name) === i).forEach((opt) => {
+				this.makeOption(opt, cmd);
+			});
+		}
 		/**
 		* Format the help command display
 		*/

package/dist/index.d.cts

@@ -99,6 +99,10 @@ interface InitConfig {
    * Commands that should be autoloaded by default
    */
   baseCommands?: typeof Command[];
+  /**
+   * A command that will be run when the script is run without arguments
+   */
+  rootCommand?: typeof Command;
   /**
    * Paths where musket can search and auto discover commands
    *

package/dist/index.d.ts

@@ -99,6 +99,10 @@ interface InitConfig {
    * Commands that should be autoloaded by default
    */
   baseCommands?: typeof Command[];
+  /**
+   * A command that will be run when the script is run without arguments
+   */
+  rootCommand?: typeof Command;
   /**
    * Paths where musket can search and auto discover commands
    *

package/dist/index.js

@@ -605,8 +605,9 @@ var Musket = class Musket {
 			verbose: ["-v, --verbose [level]", "Increase the verbosity of messages: 1 for normal output, 2 and v for more verbose output and 3 and vv for debug"],
 			noInteraction: ["-n, --no-interaction", "Do not ask any interactive question"]
 		};
-		/** 
-		* Init Commander
+		if (!this.config.rootCommand)
+ /** 
+		* Run the base Command if a root command was not defined
 		*/
 		program.name(this.cliName).version(moduleVersions).description(this.config.logo ?? altLogo).configureHelp({ showGlobalOptions: true }).addOption(new Option(additional.quiet[0], additional.quiet[1])).addOption(new Option(additional.silent[0], additional.silent[1]).implies({ quiet: true })).addOption(new Option(additional.verbose[0], additional.verbose[1]).choices([
 			"1",
@@ -619,6 +620,20 @@ var Musket = class Musket {
 			instance.setInput(program.opts(), program.args, program.registeredArguments, {}, program);
 			await this.handle(instance);
 		});
+		else {
+			/**
+			* Load the root command here
+			*/
+			const root = new this.config.rootCommand(this.app, this.kernel);
+			const sign = Signature.parseSignature(root.getSignature(), root);
+			const cmd = program.name(sign.baseCommand).description(sign.description ?? sign.baseCommand).configureHelp({ showGlobalOptions: true }).action(async () => {
+				root.setInput(program.opts(), program.args, program.registeredArguments, {}, program);
+				await this.handle(root);
+			});
+			if ((sign.options?.length ?? 0) > 0) sign.options?.filter((v, i, a) => a.findIndex((t) => t.name === v.name) === i).forEach((opt) => {
+				this.makeOption(opt, cmd);
+			});
+		}
 		/**
 		* Format the help command display
 		*/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@h3ravel/musket",
-  "version": "0.1.10",
+  "version": "0.2.1",
   "description": "Musket CLI is a framework-agnostic CLI framework designed to allow you build artisan-like CLI apps and for use in the H3ravel framework.",
   "type": "module",
   "exports": {