clap_schema 0.2.1

Deprecated in favor of `argx`. JSON Schema generation for Clap with typed Rust results.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

//! Builder-style Clap uses the same handler-derived output contract model.

use std::convert::Infallible;

use clap::{Arg, Command};
use clap_schema::{ContractBuilder, schema_handler};
use schemars::JsonSchema;
use serde::Serialize;

/// Widget returned by the create command.
#[derive(Debug, Serialize, JsonSchema)]
struct Widget {
    /// Stable widget identifier.
    id: u64,
    /// Human-readable widget name.
    name: String,
}

/// Rust identity of the builder-registered create command.
struct CreateCommand;

/// Creates the example widget.
#[schema_handler(CreateCommand)]
fn create(_command: CreateCommand) -> Result<Widget, Infallible> {
    Ok(Widget { id: 1, name: "example".to_owned() })
}

/// Builds the example Clap command tree.
fn cli() -> Command {
    Command::new("widgetctl").subcommand(
        Command::new("create")
            .about("Create a widget")
            .arg(Arg::new("name").long("name").required(true)),
    )
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let contract = ContractBuilder::new(cli()).command::<CreateCommand>(["create"]).build()?;

    let command = contract.command_for::<CreateCommand>().expect("create command is registered");

    println!("Builder-derived command contract:");
    println!("{}", serde_json::to_string_pretty(&command)?);

    let created = create(CreateCommand)?;
    println!("\nRuntime value from the same handler:");
    println!("{}", serde_json::to_string_pretty(&created)?);

    Ok(())
}