@h3ravel/musket 0.3.5 → 0.3.7

package/dist/index.cjs

@@ -638,7 +638,7 @@ var Musket = class Musket {
 		* CLI Commands auto registration
 		*/
 		for await (const pth of glob.glob.stream(paths)) {
-			const name = node_path.default.basename(pth).replace(".js", "").replace(".ts", "");
+			const name = node_path.default.basename(pth).replaceAll(/\.ts|\.js|\.mjs/g, "");
 			try {
 				const cmdClass = (await import(pth))[name];
 				commands.push(new cmdClass(this.app, this.kernel));

package/dist/{index.d.cts → index.d.ts}

@@ -1,7 +1,7 @@
 import * as commander0 from "commander";
 import { Argument, Command as Command$1 } from "commander";
 import { ChoiceOrSeparatorArray, Choices } from "@h3ravel/shared";
-import { Options } from "tsdown";
+import { UserConfig } from "tsdown";
 import { XGeneric } from "@h3ravel/support";
 
 //#region src/Contracts/ICommand.d.ts
@@ -79,7 +79,7 @@ interface InitConfig {
   /**
    * If we need to programmatically run the tsdown build command, we will use this config.
    */
-  tsDownConfig?: Options;
+  tsDownConfig?: UserConfig;
   /**
    * Packages that should show up up when the `-V` flag is passed
    */
@@ -182,7 +182,7 @@ declare class Command {
   option(key: string, def?: any): any;
   options(key?: string): any;
   argument(key: string, def?: any): any;
-  arguments(): any;
+  arguments(): Record<string, any>;
   loadBaseFlags(): void;
   /**
    * Check if the command is quiet
@@ -255,7 +255,7 @@ declare class Command {
   /**
    * The default value
    */
-  def?: string | undefined): any;
+  def?: string | undefined): Promise<string>;
   /**
    * Allows users to pick from a predefined set of choices when asked a question.
    */
@@ -271,7 +271,7 @@ declare class Command {
   /**
    * Item index front of which the cursor will initially appear
    */
-  defaultIndex?: number): any;
+  defaultIndex?: number): Promise<string>;
   /**
    * Ask the user for a simple "yes or no" confirmation. By default, this method returns `false`.
    * However, if the user enters y or yes in response to the prompt, the method would return `true`.
@@ -284,7 +284,7 @@ declare class Command {
   /**
    * The default value
    */
-  def?: boolean | undefined): any;
+  def?: boolean | undefined): Promise<boolean>;
   /**
    * Prompt the user with the given question, accept their input which will
    * not be visible to them as they type in the console, and then return the user's input back to your command.
@@ -299,7 +299,7 @@ declare class Command {
    *
    * @default true
    */
-  mask?: string | boolean): any;
+  mask?: string | boolean): Promise<string>;
   /**
    * Provide auto-completion for possible choices. The user can still provide any
    * answer, regardless of the auto-completion hints.
@@ -316,7 +316,7 @@ declare class Command {
   /**
    * Set a default value
    */
-  def?: string): any;
+  def?: string): Promise<any>;
 }
 //#endregion
 //#region src/Musket.d.ts
@@ -334,7 +334,7 @@ declare class Musket {
   cliName: string;
   private config;
   private commands;
-  constructor(app: Application, kernel: Kernel, baseCommands?: Command[], resolver?: NonNullable<InitConfig["resolver"]> | undefined, tsDownConfig?: Options);
+  constructor(app: Application, kernel: Kernel, baseCommands?: Command[], resolver?: NonNullable<InitConfig["resolver"]> | undefined, tsDownConfig?: UserConfig);
   build(): Promise<Command$1>;
   private loadBaseCommands;
   /**

package/dist/{index.mjs → index.js}

@@ -614,7 +614,7 @@ var Musket = class Musket {
 		* CLI Commands auto registration
 		*/
 		for await (const pth of glob.stream(paths)) {
-			const name = path.basename(pth).replace(".js", "").replace(".ts", "");
+			const name = path.basename(pth).replaceAll(/\.ts|\.js|\.mjs/g, "");
 			try {
 				const cmdClass = (await import(pth))[name];
 				commands.push(new cmdClass(this.app, this.kernel));

package/package.json

@@ -1,18 +1,22 @@
 {
   "name": "@h3ravel/musket",
-  "version": "0.3.5",
+  "version": "0.3.7",
   "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",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/index.mjs",
+      "import": "./dist/index.js",
       "require": "./dist/index.cjs"
-    }
+    },
+    "./package.json": "./package.json"
   },
   "typesVersions": {
     "*": {
       "*": [
-        "dist/index.d.mts"
+        "dist/index.d.ts"
       ]
     }
   },
@@ -46,7 +50,7 @@
     "console"
   ],
   "peerDependencies": {
-    "@h3ravel/support": "^0.15.2"
+    "@h3ravel/support": "^0.15.4"
   },
   "devDependencies": {
     "@types/node": "^24.7.2",
@@ -62,7 +66,7 @@
     "vitest": "^3.2.4"
   },
   "dependencies": {
-    "@h3ravel/shared": "^0.27.2",
+    "@h3ravel/shared": "^0.27.4",
     "chalk": "^5.6.2",
     "commander": "^14.0.1",
     "dayjs": "^1.11.18",

package/dist/index.d.mts

@@ -1,398 +0,0 @@
-import { ChoiceOrSeparatorArray, Choices } from "@h3ravel/shared";
-import * as commander0 from "commander";
-import { Argument, Command as Command$1 } from "commander";
-import { Options } from "tsdown";
-import { XGeneric } from "@h3ravel/support";
-
-//#region src/Contracts/ICommand.d.ts
-type CommandOption = {
-  name: string;
-  shared?: boolean;
-  required?: boolean;
-  multiple?: boolean;
-  placeholder?: string;
-  description?: string;
-  defaultValue?: string | number | boolean | undefined | string[];
-  choices?: string[];
-  argParser?: (...args: []) => any;
-  /**
-   * for options like --Q|queue
-   */
-  flags?: string[];
-  /**
-   * true if it's a flag option
-   */
-  isFlag?: boolean;
-  /**
-   * true if name begins with '#' or '^'
-   */
-  isHidden?: boolean;
-  /**
-   * for nested options
-   */
-  nestedOptions?: CommandOption[];
-};
-type ParsedCommand = {
-  commandClass: Command;
-  baseCommand: string;
-  description?: string;
-  /**
-   * true if baseCommand begins with '#' or '^'
-   */
-  isHidden?: boolean;
-  /**
-   * true if baseCommand ends with ':'
-   */
-  isNamespaceCommand: boolean;
-  /**
-   * for colon-ended commands
-   */
-  subCommands?: CommandOption[];
-  /**
-   * for normal commands
-   */
-  options?: CommandOption[];
-};
-interface InitConfig {
-  /**
-   * ASCII Art style logo
-   */
-  logo?: string;
-  /**
-   * The name of the CLI app we're building
-   *
-   * @default musket
-   */
-  cliName?: string;
-  /**
-   * Don't parse the command, usefull for testing or manual control
-   */
-  skipParsing?: boolean;
-  /**
-   * A callback function that should resolve the handle method of every command
-   *
-   * @param cmd
-   * @param met
-   * @returns
-   */
-  resolver?: <X extends Command>(cmd: X, met: any) => Promise<X>;
-  /**
-   * If we need to programmatically run the tsdown build command, we will use this config.
-   */
-  tsDownConfig?: Options;
-  /**
-   * Packages that should show up up when the `-V` flag is passed
-   */
-  packages?: (string | {
-    name: string;
-    alias: string;
-  })[];
-  /**
-   * If set to true, information about musket CLI like name and
-   * version info will not be unexpectedly shown in console
-   */
-  hideMusketInfo?: boolean;
-  /**
-   * If enabled rebuilds will be triggered when code changes happen
-   */
-  allowRebuilds?: boolean;
-  /**
-   * 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
-   *
-   *
-   * @example 'Console/Commands/*.js'
-   * @example 'dist/app/Console/Commands/*.js'
-   * @example ['Console/Commands/*.js', 'src/app/Commands/*.js']
-   */
-  discoveryPaths?: string | string[];
-}
-//#endregion
-//#region src/Core/Kernel.d.ts
-declare class Kernel {
-  app: Application;
-  cwd: string;
-  output: "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";
-  modules: XGeneric<{
-    version: string;
-    name: string;
-  }>[];
-  basePath: string;
-  packages: NonNullable<InitConfig['packages']>;
-  config: InitConfig;
-  constructor(app: Application);
-  ensureDirectoryExists(dir: string): Promise<void>;
-  static init(app: Application, config?: InitConfig): Promise<commander0.Command>;
-  private run;
-  private loadRequirements;
-}
-//#endregion
-//#region src/Core/Command.d.ts
-declare class Command {
-  protected app: Application;
-  protected kernel: Kernel;
-  constructor(app: Application, kernel: Kernel);
-  /**
-   * The underlying commander instance.
-   *
-   * @var Command
-   */
-  program: Command$1;
-  /**
-   * The name and signature of the console command.
-   *
-   * @var string
-   */
-  protected signature: string;
-  /**
-   * A dictionary of signatures or what not.
-   *
-   * @var object
-   */
-  protected dictionary: Record<string, any>;
-  /**
-   * The console command description.
-   *
-   * @var string
-   */
-  protected description?: string;
-  /**
-   * The console command input.
-   *
-   * @var object
-   */
-  private input;
-  /**
-   * Execute the console command.
-   */
-  handle(..._args: any[]): Promise<void>;
-  setApplication(app: Application): void;
-  setInput(options: XGeneric, args: string[], regArgs: readonly Argument[], dictionary: Record<string, any>, program: Command$1): this;
-  setOption(key: string, value: unknown): this;
-  setProgram(program: Command$1): this;
-  getSignature(): string;
-  getDescription(): string | undefined;
-  option(key: string, def?: any): any;
-  options(key?: string): any;
-  argument(key: string, def?: any): any;
-  arguments(): any;
-  loadBaseFlags(): void;
-  /**
-   * Check if the command is quiet
-   *
-   * @returns
-   */
-  isQuiet(): any;
-  /**
-   * Check if the command is silent
-   *
-   * @returns
-   */
-  isSilent(): any;
-  /**
-   * Check if the command is non interactive
-   *
-   * @returns
-   */
-  isNonInteractive(): boolean;
-  /**
-   * Get the verbosity of the command
-   *
-   * @returns
-   */
-  getVerbosity(): number;
-  /**
-   * Log an info message
-   */
-  info(message: string): this;
-  /**
-   * Log a warning message
-   */
-  warn(message: string): this;
-  /**
-   * Log a line message
-   */
-  line(message: string): this;
-  /**
-   * Log a new line
-   */
-  newLine(count?: number): this;
-  /**
-   * Log a success message
-   */
-  success(message: string): this;
-  /**
-   * Log an error message
-   */
-  error(message: string): this;
-  /**
-   * Log an error message and terminate execution of the command
-   * return an exit code of 1
-   *
-   * This method is not chainable
-   */
-  fail(message: string): void;
-  /**
-   * Log a debug message
-   */
-  debug(message: string | string[]): this;
-  /**
-   * Prompt the user with the given question, accept their input, and
-   * then return the user's input back to your command.
-   */
-  ask(
-  /**
-   * Message to dislpay
-   */
-  message: string,
-  /**
-   * The default value
-   */
-  def?: string | undefined): any;
-  /**
-   * Allows users to pick from a predefined set of choices when asked a question.
-   */
-  choice(
-  /**
-   * Message to dislpay
-   */
-  message: string,
-  /**
-   * The choices available to the user
-   */
-  choices: Choices,
-  /**
-   * Item index front of which the cursor will initially appear
-   */
-  defaultIndex?: number): any;
-  /**
-   * Ask the user for a simple "yes or no" confirmation. By default, this method returns `false`.
-   * However, if the user enters y or yes in response to the prompt, the method would return `true`.
-   */
-  confirm(
-  /**
-   * Message to dislpay
-   */
-  message: string,
-  /**
-   * The default value
-   */
-  def?: boolean | undefined): any;
-  /**
-   * Prompt the user with the given question, accept their input which will
-   * not be visible to them as they type in the console, and then return the user's input back to your command.
-   */
-  secret(
-  /**
-  * Message to dislpay
-  */
-  message: string,
-  /**
-   * Mask the user input
-   *
-   * @default true
-   */
-  mask?: string | boolean): any;
-  /**
-   * Provide auto-completion for possible choices. The user can still provide any
-   * answer, regardless of the auto-completion hints.
-   */
-  anticipate(
-  /**
-   * Message to dislpay
-   */
-  message: string,
-  /**
-   * The source of completions
-   */
-  source: string[] | ((input?: string | undefined) => Promise<ChoiceOrSeparatorArray<any>>),
-  /**
-   * Set a default value
-   */
-  def?: string): any;
-}
-//#endregion
-//#region src/Musket.d.ts
-declare class Musket {
-  private app;
-  private kernel;
-  private baseCommands;
-  private resolver?;
-  private tsDownConfig;
-  /**
-   * The name of the CLI app we're building
-   *
-   * @default musket
-   */
-  cliName: string;
-  private config;
-  private commands;
-  constructor(app: Application, kernel: Kernel, baseCommands?: Command[], resolver?: NonNullable<InitConfig["resolver"]> | undefined, tsDownConfig?: Options);
-  build(): Promise<Command$1>;
-  private loadBaseCommands;
-  /**
-   * Provide the configuration to initialize the CLI with
-   *
-   * @param config
-   * @returns
-   */
-  configure(config: InitConfig): this;
-  /**
-   * Set the paths where the cli can search and auto discover commands
-   *
-   * @param paths
-   *
-   * @example instance.discoverCommandsFrom('Console/Commands/*.js')
-   * @example instance.discoverCommandsFrom(['Console/Commands/*.js', 'App/Commands/*.js'])
-   *
-   * @returns the current cli intance
-   */
-  discoverCommandsFrom(paths: string | string[]): this;
-  private loadDiscoveredCommands;
-  addCommand(command: Command): void;
-  private initialize;
-  rebuild(name: string): Promise<void>;
-  private makeOption;
-  private handle;
-  static parse(kernel: Kernel, config?: InitConfig): Promise<Command$1>;
-}
-//#endregion
-//#region src/Contracts/Application.d.ts
-declare class Application {
-  /**
-   * The current musket CLI Instance
-   */
-  musket?: Musket;
-  /**
-   * Registered commands will be preloaded
-   */
-  registeredCommands?: typeof Command[];
-}
-//#endregion
-//#region src/Signature.d.ts
-declare class Signature {
-  /**
-   * Helper to parse options inside a block of text
-   *
-   * @param block
-   * @returns
-   */
-  static parseOptions(block: string): CommandOption[];
-  /**
-   * Helper to parse a command's signature
-   *
-   * @param signature
-   * @param commandClass
-   * @returns
-   */
-  static parseSignature(signature: string, commandClass: Command): ParsedCommand;
-}
-//#endregion
-export { Application, Command, CommandOption, InitConfig, Kernel, Musket, ParsedCommand, Signature };