@h3ravel/musket 0.6.1 → 0.6.3

package/README.md

@@ -68,14 +68,14 @@ Musket allows passing a `config` object that alters it's behavior and provide so
 ```ts
 Kernel.init(app, {
   packages: ['@h3ravel/shared', '@h3ravel/support'],
-  cliName: 'musket-cli',
+  name: 'musket-cli',
   discoveryPaths: [path.join(process.cwd(), 'tests/Commands/*.ts')],
 });
 ```
 
 ### Advanced Initialization
 
-You can also initialize **Musket CLI** with precise controls
+If you need fine grained control with your initialization, `Musket CLI` exposes just the right methods to enable you do just that, when when initializing the CLI in this manner, the `packages` config property is completely ignored, as a work around, chain the `setPackages` method to the Kernel intance to achieve the same results.
 
 ```ts
 import { Kernel } from 'h3ravel/musket';
@@ -86,7 +86,7 @@ const app = new Application();
 const instance = new Kernel(app)
   .setCwd(process.cwd())
   .setConfig({
-    cliName: 'musket-cli',
+    name: 'musket-cli',
     discoveryPaths: [path.join(process.cwd(), 'tests/Commands/*.ts')],
   })
   .setPackages([
@@ -99,8 +99,6 @@ const instance = new Kernel(app)
 return await instance.run();
 ```
 
-> NB: Packages in the config will be ignored when initializing in this way, as a work around, chain the `setPackages` method to the Kernel intance and pass your options
-
 ## Creating Commands
 
 Commands in Musket extend the base `Command` class and define a **signature** and **handle()** method.

package/dist/index.cjs

@@ -590,7 +590,7 @@ var Musket = class Musket {
 	* 
 	* @default musket
 	*/
-	cliName = "musket";
+	name = "musket";
 	config = {};
 	commands = [];
 	program;
@@ -691,7 +691,7 @@ var Musket = class Musket {
  /** 
 		* Run the base Command if a root command was not defined
 		*/
-		this.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([
+		this.program.name(this.name).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",
 			"2",
 			"3",
@@ -845,21 +845,28 @@ var Musket = class Musket {
 		if (this.resolver) return await this.resolver(cmd, "handle");
 		await cmd.handle(this.app);
 	}
-	static async parse(kernel, config = {}, extraCommands = []) {
+	static async parse(kernel, config = {}, extraCommands = [], returnExit = false) {
+		let exitCode = 0;
+		if (typeof extraCommands === "boolean") {
+			returnExit = extraCommands;
+			extraCommands = [];
+		}
 		const commands = config.baseCommands?.concat(extraCommands)?.map((e) => new e(kernel.app, kernel));
 		const cli = new Musket(kernel.app, kernel, commands, config.resolver, config.tsDownConfig).configure(config);
-		if (config.cliName) cli.cliName = config.cliName;
+		if (config.name) cli.name = config.name;
 		const command = (await cli.build()).exitOverride((e) => {
+			exitCode = e.exitCode;
 			if (e.exitCode <= 0) return;
 			__h3ravel_shared.Logger.log("Unknown command or argument.", "white");
 			__h3ravel_shared.Logger.log([
 				["Run", "white"],
-				[`\`${config.cliName} --help\``, ["grey", "italic"]],
+				[`\`${config.name} --help\``, ["grey", "italic"]],
 				["to see available commands.", "white"]
 			], " ");
 		});
-		if (!config.skipParsing) await command.parseAsync(process.argv).catch((e) => e);
+		if (!config.skipParsing) await command.parseAsync(process.argv).catch((e) => void 0);
 		if (cli.app) cli.app.musket = cli;
+		if (returnExit === true) return exitCode;
 		return command;
 	}
 };
@@ -908,8 +915,8 @@ var Kernel = class Kernel {
 	/**
 	* Run the CLI IO
 	*/
-	async run() {
-		return await Musket.parse(this, this.config, this.getRegisteredCommands());
+	async run(returnExit) {
+		return await Musket.parse(this, this.config, this.getRegisteredCommands(), returnExit);
 	}
 	/**
 	* Set the configuration for the CLI
@@ -966,23 +973,27 @@ var Kernel = class Kernel {
 		return Array.from(this.commands);
 	}
 	/**
-	* Bootstrap the CLI
+	* Prepares the CLI for execution
 	*/
 	bootstrap() {
+		let version = this.config.version;
 		const require$1 = (0, node_module.createRequire)(require("url").pathToFileURL(__filename).href);
 		this.cwd ??= node_path.default.join(process.cwd(), this.basePath);
 		if (!this.config.hideMusketInfo) try {
 			const pkg = require$1(node_path.default.join(process.cwd(), "package.json"));
-			pkg.name = this.config.cliName ?? pkg.name;
+			pkg.name = this.config.name ?? pkg.name;
 			this.modules.push(pkg);
 		} catch {}
 		for (let i = 0; i < this.packages.length; i++) try {
 			const item = this.packages[i];
 			const name = typeof item === "string" ? item : item.name;
 			const alias = typeof item === "string" ? item : item.alias;
+			const base = typeof item === "string" ? false : item.base;
 			const modulePath = __h3ravel_shared.FileSystem.findModulePkg(name, this.cwd) ?? "";
 			const pkg = require$1(node_path.default.join(modulePath, "package.json"));
 			pkg.alias = alias;
+			pkg.base = base;
+			if (base === true && version) pkg.version = version;
 			this.modules.push(pkg);
 		} catch (e) {
 			this.modules.push({
@@ -990,6 +1001,13 @@ var Kernel = class Kernel {
 				name: "Unknown"
 			});
 		}
+		if (this.packages.length < 1) {
+			if (!version) version = typeof this.app.version === "function" ? this.app.version() : typeof this.app.getVersion === "function" ? this.app.getVersion() : this.app.version;
+			this.modules.push({
+				version: version ?? "N/A",
+				name: "Musket CLI"
+			});
+		}
 		return this;
 	}
 };

package/dist/index.d.ts

@@ -53,17 +53,29 @@ type ParsedCommand = {
    */
   options?: CommandOption[];
 };
-interface InitConfig {
+type PackageMeta = string | {
+  name: string;
+  alias: string;
+  base?: boolean;
+};
+type CommandMethodResolver = <X extends Command>(cmd: X, met: any) => Promise<X>;
+interface KernelConfig {
   /**
    * ASCII Art style logo
    */
   logo?: string;
   /**
-   * The name of the CLI app we're building
+   * The name of the CLI app we're running
    *
    * @default musket
    */
-  cliName?: string;
+  name?: string;
+  /**
+   * The version of the CLI app we're running (if provided, this will overwrite the value of resolved version from packages config marked as base)
+   *
+   * @default musket
+   */
+  version?: string;
   /**
    * Don't parse the command, usefull for testing or manual control
    */
@@ -75,7 +87,7 @@ interface InitConfig {
    * @param met
    * @returns
    */
-  resolver?: <X extends Command>(cmd: X, met: any) => Promise<X>;
+  resolver?: CommandMethodResolver;
   /**
    * If we need to programmatically run the tsdown build command, we will use this config.
    */
@@ -83,10 +95,7 @@ interface InitConfig {
   /**
    * Packages that should show up up when the `-V` flag is passed
    */
-  packages?: (string | {
-    name: string;
-    alias: string;
-  })[];
+  packages?: PackageMeta[];
   /**
    * If set to true, information about musket CLI like name and
    * version info will not be unexpectedly shown in console
@@ -126,6 +135,8 @@ declare class Kernel<A extends Application = Application> {
   modules: XGeneric<{
     version: string;
     name: string;
+    base?: boolean;
+    alias?: string;
   }>[];
   /**
    * The base path for the CLI app
@@ -152,19 +163,19 @@ declare class Kernel<A extends Application = Application> {
    * @param config
    * @returns
    */
-  static init<A extends Application>(app: A, config?: InitConfig): Promise<commander0.Command>;
+  static init<A extends Application>(app: A, config?: KernelConfig): Promise<commander0.Command>;
   /**
    * Run the CLI IO
    */
-  run(): Promise<commander0.Command>;
+  run<E extends boolean = false>(returnExit?: E): Promise<E extends true ? number : commander0.Command>;
   /**
    * Set the configuration for the CLI
    */
-  setConfig(config: InitConfig): this;
+  setConfig(config: KernelConfig): this;
   /**
    * Get the configuration for the CLI
    */
-  getConfig(): InitConfig;
+  getConfig(): KernelConfig;
   /**
    * Set the current working directory
    */
@@ -176,11 +187,11 @@ declare class Kernel<A extends Application = Application> {
   /**
    * Set the packages that should show up up when the -V flag is passed
    */
-  setPackages(packages: NonNullable<InitConfig['packages']>): this;
+  setPackages(packages: PackageMeta[]): this;
   /**
    * Get the packages that should show up up when the -V flag is passed
    */
-  getPackages(): NonNullable<InitConfig['packages']>;
+  getPackages(): PackageMeta[];
   /**
    * Push a list of new commands to commands stack
    *
@@ -192,7 +203,7 @@ declare class Kernel<A extends Application = Application> {
    */
   getRegisteredCommands(): typeof Command[];
   /**
-   * Bootstrap the CLI
+   * Prepares the CLI for execution
    */
   bootstrap(): this;
 }
@@ -394,11 +405,11 @@ declare class Musket {
    *
    * @default musket
    */
-  cliName: string;
+  name: string;
   private config;
   private commands;
   private program;
-  constructor(app: Application, kernel: Kernel, baseCommands?: Command[], resolver?: NonNullable<InitConfig["resolver"]> | undefined, tsDownConfig?: UserConfig);
+  constructor(app: Application, kernel: Kernel, baseCommands?: Command[], resolver?: CommandMethodResolver | undefined, tsDownConfig?: UserConfig);
   build(): Promise<Command$1>;
   private loadBaseCommands;
   /**
@@ -407,7 +418,7 @@ declare class Musket {
    * @param config
    * @returns
    */
-  configure(config: InitConfig): this;
+  configure(config: KernelConfig): this;
   /**
    * Set the paths where the cli can search and auto discover commands
    *
@@ -440,8 +451,8 @@ declare class Musket {
   rebuild(name: string): Promise<void>;
   private makeOption;
   private handle;
-  static parse(kernel: Kernel, config: InitConfig): Promise<Command$1>;
-  static parse(kernel: Kernel, config: InitConfig, commands: typeof Command[]): Promise<Command$1>;
+  static parse<E extends boolean = false>(kernel: Kernel, config: KernelConfig, returnExit?: E): Promise<E extends true ? number : Command$1>;
+  static parse<E extends boolean = false>(kernel: Kernel, config: KernelConfig, commands: typeof Command[], returnExit?: E): Promise<E extends true ? number : Command$1>;
 }
 //#endregion
 //#region src/Contracts/Application.d.ts
@@ -476,4 +487,4 @@ declare class Signature {
   static parseSignature(signature: string, commandClass: Command): ParsedCommand;
 }
 //#endregion
-export { Application, Command, CommandOption, InitConfig, Kernel, Musket, ParsedCommand, Signature };
+export { Application, Command, CommandMethodResolver, CommandOption, Kernel, KernelConfig, Musket, PackageMeta, ParsedCommand, Signature };

package/dist/index.js

@@ -566,7 +566,7 @@ var Musket = class Musket {
 	* 
 	* @default musket
 	*/
-	cliName = "musket";
+	name = "musket";
 	config = {};
 	commands = [];
 	program;
@@ -667,7 +667,7 @@ var Musket = class Musket {
  /** 
 		* Run the base Command if a root command was not defined
 		*/
-		this.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([
+		this.program.name(this.name).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",
 			"2",
 			"3",
@@ -821,21 +821,28 @@ var Musket = class Musket {
 		if (this.resolver) return await this.resolver(cmd, "handle");
 		await cmd.handle(this.app);
 	}
-	static async parse(kernel, config = {}, extraCommands = []) {
+	static async parse(kernel, config = {}, extraCommands = [], returnExit = false) {
+		let exitCode = 0;
+		if (typeof extraCommands === "boolean") {
+			returnExit = extraCommands;
+			extraCommands = [];
+		}
 		const commands = config.baseCommands?.concat(extraCommands)?.map((e) => new e(kernel.app, kernel));
 		const cli = new Musket(kernel.app, kernel, commands, config.resolver, config.tsDownConfig).configure(config);
-		if (config.cliName) cli.cliName = config.cliName;
+		if (config.name) cli.name = config.name;
 		const command = (await cli.build()).exitOverride((e) => {
+			exitCode = e.exitCode;
 			if (e.exitCode <= 0) return;
 			Logger.log("Unknown command or argument.", "white");
 			Logger.log([
 				["Run", "white"],
-				[`\`${config.cliName} --help\``, ["grey", "italic"]],
+				[`\`${config.name} --help\``, ["grey", "italic"]],
 				["to see available commands.", "white"]
 			], " ");
 		});
-		if (!config.skipParsing) await command.parseAsync(process.argv).catch((e) => e);
+		if (!config.skipParsing) await command.parseAsync(process.argv).catch((e) => void 0);
 		if (cli.app) cli.app.musket = cli;
+		if (returnExit === true) return exitCode;
 		return command;
 	}
 };
@@ -884,8 +891,8 @@ var Kernel = class Kernel {
 	/**
 	* Run the CLI IO
 	*/
-	async run() {
-		return await Musket.parse(this, this.config, this.getRegisteredCommands());
+	async run(returnExit) {
+		return await Musket.parse(this, this.config, this.getRegisteredCommands(), returnExit);
 	}
 	/**
 	* Set the configuration for the CLI
@@ -942,23 +949,27 @@ var Kernel = class Kernel {
 		return Array.from(this.commands);
 	}
 	/**
-	* Bootstrap the CLI
+	* Prepares the CLI for execution
 	*/
 	bootstrap() {
+		let version = this.config.version;
 		const require = createRequire(import.meta.url);
 		this.cwd ??= path.join(process.cwd(), this.basePath);
 		if (!this.config.hideMusketInfo) try {
 			const pkg = require(path.join(process.cwd(), "package.json"));
-			pkg.name = this.config.cliName ?? pkg.name;
+			pkg.name = this.config.name ?? pkg.name;
 			this.modules.push(pkg);
 		} catch {}
 		for (let i = 0; i < this.packages.length; i++) try {
 			const item = this.packages[i];
 			const name = typeof item === "string" ? item : item.name;
 			const alias = typeof item === "string" ? item : item.alias;
+			const base = typeof item === "string" ? false : item.base;
 			const modulePath = FileSystem.findModulePkg(name, this.cwd) ?? "";
 			const pkg = require(path.join(modulePath, "package.json"));
 			pkg.alias = alias;
+			pkg.base = base;
+			if (base === true && version) pkg.version = version;
 			this.modules.push(pkg);
 		} catch (e) {
 			this.modules.push({
@@ -966,6 +977,13 @@ var Kernel = class Kernel {
 				name: "Unknown"
 			});
 		}
+		if (this.packages.length < 1) {
+			if (!version) version = typeof this.app.version === "function" ? this.app.version() : typeof this.app.getVersion === "function" ? this.app.getVersion() : this.app.version;
+			this.modules.push({
+				version: version ?? "N/A",
+				name: "Musket CLI"
+			});
+		}
 		return this;
 	}
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@h3ravel/musket",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "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",
   "main": "./dist/index.cjs",