Validate derived command params later

[szszoke]

I am using #[derive(Parser)] and #[derive(Subcommand)]:

#[derive(Parser)]
#[command(version, about, long_about = None)]
pub struct Cli {
  #[command(subcommand)]
  pub command: Commands,
}

#[derive(Subcommand)]
pub enum Commands {
  MyCommand {
    #[arg(short, long)]
    param: usize
  }
}

fn main() {
  let args = Cli::parse();
  ...
}

I want to validate the value of MyCommand.param against a value that is only known during runtime. I can of course do that without blending in clap but it would be nice to get consistent error messages for invalid arguments.

The closest I got so far is the code below, but the error message that is printed doesn't have any context about which command was specified and which command parameter had an invalid value.

Cli::command()
  .error(ErrorKind::ValueValidation, "invalid param value")
  .exit();

[szszoke]

There is a secondary use case that is somewhat similar.

I want to collect key-value pairs from the CLI with the use of two parameters that could be provided multiple times:

#[derive(Parser)]
#[command(version, about, long_about = None)]
pub struct Cli {
  #[command(subcommand)]
  pub command: Commands,
}

#[derive(Subcommand)]
pub enum Commands {
  MyCommand {
    #[arg(short, long)]
    key: usize,
    #[arg(short, long)]
    value: usize
  }
}

fn main() {
  let args = Cli::parse();
  ...
}

The program could be called like this:

$ program -k 1 -v 2 -k 2 -v 4

This however requires that for every -k/--key parameter there is a -v/--value parameter.

[epage]

People have requested a native way of doing this in the past though I can't find the issue atm. If you combine command-chaining (#2222) with pacman-style subcommands, we could support this.

[szszoke]

I will look into that. Thanks!

[epage]

Almost everything clap uses for writing its error messges is publicly exposed though not thoroughly documented. This is kind of a "left to the user" exercise than something I expect we'll invest a lot in documenting.

See https://docs.rs/clap/latest/clap/error/struct.Error.html

In particular, see the pub(crate) functions on Error for how clap creates the error messages.