feat: support pass help option for args (#41)

* feat: support pass help option for args

* chore: code lint

Author: fu050409

.changeset/selfish-avocados-peel.md

@@ -0,0 +1,5 @@
+---
+'archons': patch
+---
+
+Support pass help option for args

examples/simple.cts

@@ -28,6 +28,7 @@ const main = defineCommand({
     verbose: {
       type: 'flag',
       parser: 'boolean',
+      help: 'Enable verbose output',
     },
   },
   subcommands: {

index.d.ts

@@ -6,8 +6,25 @@
 export declare function defineCommand(options: Command): Command
 export declare function run(cmd: Command, args?: Array<string> | undefined | null): void
 export const VERSION: string
+/**
+ * Command context
+ *
+ * This is the context object that is passed to the command callback.
+ */
 export interface Context {
+  /**
+   * Parsed arguments
+   *
+   * This is a js object that contains the parsed arguments.
+   * The keys of the object are the names of the arguments and
+   * the values are the parsed values.
+   */
   args: object
+  /**
+   * Raw arguments
+   *
+   * The raw arguments parsed by command line or manually given.
+   */
   rawArgs: Array<string>
 }
 /** Command metadata */
@@ -57,10 +74,17 @@ export interface CommandOption {
   long?: string
   alias?: Array<string>
   hiddenAlias?: Array<string>
+  help?: string
   required?: boolean
   default?: string
   hidden?: boolean
 }
+/**
+ * Command definition
+ *
+ * This is the object that defines a command.
+ * It contains the metadata, options, and callback function.
+ */
 export interface Command {
   meta: CommandMeta
   options: Record<string, CommandOption>

src/command.rs

@@ -37,7 +37,10 @@ pub fn run(env: Env, cmd: Command, args: Option<Vec<String>>) -> Result<()> {
     if let Some(cb) = cmd.callback.as_ref() {
       cb.call1::<Context, JsNull>(context)?;
     } else {
-      env.throw_error("No callback function found for command", None)?;
+      env.throw_error(
+        "No callback function found for main command and no subcommand was provided.",
+        Some("E_NO_CALLBACK"),
+      )?;
     };
   }
   Ok(())

src/types.rs

@@ -6,9 +6,20 @@ use napi_derive::napi;
 #[napi]
 pub const VERSION: &str = env!("CARGO_PKG_VERSION");
 
+/// Command context
+///
+/// This is the context object that is passed to the command callback.
 #[napi(object)]
 pub struct Context {
+  /// Parsed arguments
+  ///
+  /// This is a js object that contains the parsed arguments.
+  /// The keys of the object are the names of the arguments and
+  /// the values are the parsed values.
   pub args: JsObject,
+  /// Raw arguments
+  ///
+  /// The raw arguments parsed by command line or manually given.
   pub raw_args: Vec<String>,
 }
 
@@ -58,11 +69,16 @@ pub struct CommandOption {
   pub long: Option<String>,
   pub alias: Option<Vec<String>>,
   pub hidden_alias: Option<Vec<String>>,
+  pub help: Option<String>,
   pub required: Option<bool>,
   pub default: Option<String>,
   pub hidden: Option<bool>,
 }
 
+/// Command definition
+///
+/// This is the object that defines a command.
+/// It contains the metadata, options, and callback function.
 #[napi(object)]
 pub struct Command {
   pub meta: CommandMeta,

src/utils.rs

@@ -101,6 +101,9 @@ pub(crate) fn resolve_command_options(
             .collect::<Vec<&str>>();
           arg = arg.aliases(hidden_alias);
         }
+        if let Some(help) = &opt.help {
+          arg = arg.help(leak_borrowed_str(help));
+        }
         if let Some(required) = opt.required {
           arg = arg.required(required);
         }