@h3ravel/musket 0.2.3 → 0.3.0

package/README.md

@@ -156,10 +156,3 @@ The H3ravel framework is open-sourced software licensed under the [MIT license](
 [lini]: https://img.shields.io/github/license/h3ravel/framework
 [tel]: https://github.com/h3ravel/framework/actions/workflows/test.yml
 [tei]: https://github.com/h3ravel/framework/actions/workflows/test.yml/badge.svg
-
-````
-
-```
-
-```
-````

package/dist/index.cjs

@@ -224,6 +224,40 @@ var Command = class {
 		__h3ravel_shared.Logger.debug(message);
 		return this;
 	}
+	/**
+	* Prompt the user with the given question, accept their input, and 
+	* then return the user's input back to your command.
+	*/
+	ask(message, def) {
+		return __h3ravel_shared.Prompts.ask(message, def);
+	}
+	/**
+	* Allows users to pick from a predefined set of choices when asked a question.
+	*/
+	choice(message, choices, defaultIndex) {
+		return __h3ravel_shared.Prompts.choice(message, choices, defaultIndex);
+	}
+	/**
+	* 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, def) {
+		return __h3ravel_shared.Prompts.confirm(message, def);
+	}
+	/**
+	* 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, mask) {
+		return __h3ravel_shared.Prompts.secret(message, mask);
+	}
+	/**
+	* Provide auto-completion for possible choices. The user can still provide any 
+	* answer, regardless of the auto-completion hints.
+	*/
+	anticipate(message, source, def) {
+		return __h3ravel_shared.Prompts.anticipate(message, source, def);
+	}
 };
 
 //#endregion

package/dist/index.d.cts

@@ -1,5 +1,6 @@
 import * as commander0 from "commander";
 import { Argument, Command as Command$1 } from "commander";
+import { ChoiceOrSeparatorArray, Choices } from "@h3ravel/shared";
 import { Options } from "tsdown";
 import { XGeneric } from "@h3ravel/support";
 
@@ -242,6 +243,80 @@ declare class Command {
    * 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): Promise<string>;
+  /**
+   * 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): 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`.
+   */
+  confirm(
+  /**
+   * Message to dislpay
+   */
+  message: string,
+  /**
+   * The default value
+   */
+  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.
+   */
+  secret(
+  /**
+  * Message to dislpay
+  */
+  message: string,
+  /**
+   * Mask the user input
+   *
+   * @default true
+   */
+  mask?: string | boolean): Promise<string>;
+  /**
+   * 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): Promise<any>;
 }
 //#endregion
 //#region src/Musket.d.ts

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { ChoiceOrSeparatorArray, Choices } from "@h3ravel/shared";
 import * as commander0 from "commander";
 import { Argument, Command as Command$1 } from "commander";
 import { Options } from "tsdown";
@@ -242,6 +243,80 @@ declare class Command {
    * 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): Promise<string>;
+  /**
+   * 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): 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`.
+   */
+  confirm(
+  /**
+   * Message to dislpay
+   */
+  message: string,
+  /**
+   * The default value
+   */
+  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.
+   */
+  secret(
+  /**
+  * Message to dislpay
+  */
+  message: string,
+  /**
+   * Mask the user input
+   *
+   * @default true
+   */
+  mask?: string | boolean): Promise<string>;
+  /**
+   * 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): Promise<any>;
 }
 //#endregion
 //#region src/Musket.d.ts

package/dist/index.js

@@ -1,4 +1,4 @@
-import { FileSystem, Logger } from "@h3ravel/shared";
+import { FileSystem, Logger, Prompts } from "@h3ravel/shared";
 import { Argument, Option, program } from "commander";
 import { build } from "tsdown";
 import { glob } from "glob";
@@ -194,6 +194,40 @@ var Command = class {
 		Logger.debug(message);
 		return this;
 	}
+	/**
+	* Prompt the user with the given question, accept their input, and 
+	* then return the user's input back to your command.
+	*/
+	ask(message, def) {
+		return Prompts.ask(message, def);
+	}
+	/**
+	* Allows users to pick from a predefined set of choices when asked a question.
+	*/
+	choice(message, choices, defaultIndex) {
+		return Prompts.choice(message, choices, defaultIndex);
+	}
+	/**
+	* 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, def) {
+		return Prompts.confirm(message, def);
+	}
+	/**
+	* 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, mask) {
+		return Prompts.secret(message, mask);
+	}
+	/**
+	* Provide auto-completion for possible choices. The user can still provide any 
+	* answer, regardless of the auto-completion hints.
+	*/
+	anticipate(message, source, def) {
+		return Prompts.anticipate(message, source, def);
+	}
 };
 
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@h3ravel/musket",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "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": {
@@ -69,7 +69,7 @@
     "vitest": "^3.2.4"
   },
   "dependencies": {
-    "@h3ravel/shared": "^0.22.2",
+    "@h3ravel/shared": "^0.23.1",
     "chalk": "^5.6.2",
     "commander": "^14.0.1",
     "dayjs": "^1.11.18",