mk-cli 0.4.1

Standalone CLI for mk1 (mnemonic-key) plate handling — encode, decode, inspect, verify, vectors, gui-schema.
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

//! `mk gui-schema` — emit a machine-readable JSON description of the CLI
//! surface for consumption by `mnemonic-gui`'s schema-mirror gate.
//!
//! Realizes Section C.2 of the `mnemonic-gui` v0.2 plan (per the cross-repo
//! `mnemonic-gui-schema-mirror` FOLLOWUPS entry). The JSON contract is the
//! SPEC §7 shape shared across all four sibling CLIs (`md`, `ms`, `mk`,
//! `mnemonic`):
//!
//! ```json
//! {
//!   "version": 1,
//!   "cli": "mk",
//!   "subcommands": [
//!     { "name": "encode",
//!       "flags": [ { "name": "--xpub", "required": true, "kind": "text", "choices": null }, ... ],
//!       "positionals": [ { "name": "...", "required": ..., "repeating": ... } ] },
//!     ...
//!   ]
//! }
//! ```
//!
//! `kind` is one of `"text"`, `"boolean"`, `"number"`, `"dropdown"`,
//! `"path"`. `choices` is non-null only for `"dropdown"`. Complex types map
//! to `"text"`. The `gui-schema` subcommand itself is excluded from the
//! emitted list (the GUI never invokes it as a user-facing form).

use clap::{Arg, ArgAction, Command, CommandFactory, ValueHint};
use serde::Serialize;
use serde_json::json;

use crate::error::{CliError, Result};

/// `mk gui-schema` arguments — zero-argument subcommand.
#[derive(clap::Args, Debug)]
pub struct GuiSchemaArgs {}

/// Run `mk gui-schema`.
pub fn run(_args: GuiSchemaArgs) -> Result<u8> {
    let cmd = crate::Cli::command();
    let schema = build_schema(&cmd);
    let s = serde_json::to_string(&schema)
        .map_err(|e| CliError::UsageError(format!("gui-schema serialize: {e}")))?;
    println!("{s}");
    Ok(0)
}

#[derive(Serialize)]
struct Subcommand {
    name: String,
    flags: Vec<Flag>,
    positionals: Vec<Positional>,
}

#[derive(Serialize)]
struct Flag {
    name: String,
    required: bool,
    kind: &'static str,
    choices: Option<Vec<String>>,
}

#[derive(Serialize)]
struct Positional {
    name: String,
    required: bool,
    repeating: bool,
}

fn build_schema(cmd: &Command) -> serde_json::Value {
    let mut subs: Vec<Subcommand> = Vec::new();
    for sub in cmd.get_subcommands() {
        let name = sub.get_name().to_string();
        // Skip auto-generated `help` and the `gui-schema` subcommand itself.
        if name == "help" || name == "gui-schema" {
            continue;
        }
        let mut flags: Vec<Flag> = Vec::new();
        let mut positionals: Vec<Positional> = Vec::new();
        for arg in sub.get_arguments() {
            if arg.is_positional() {
                positionals.push(positional_from_arg(arg));
            } else {
                // Skip help/version auto-flags.
                let id = arg.get_id().as_str();
                if id == "help" || id == "version" {
                    continue;
                }
                flags.push(flag_from_arg(arg));
            }
        }
        subs.push(Subcommand {
            name,
            flags,
            positionals,
        });
    }
    json!({
        "version": 1,
        "cli": "mk",
        "subcommands": subs,
    })
}

fn flag_from_arg(arg: &Arg) -> Flag {
    let long = arg
        .get_long()
        .map(|s| format!("--{s}"))
        .unwrap_or_else(|| format!("--{}", arg.get_id().as_str().replace('_', "-")));
    let required = arg.is_required_set();
    let (kind, choices) = classify(arg);
    Flag {
        name: long,
        required,
        kind,
        choices,
    }
}

fn positional_from_arg(arg: &Arg) -> Positional {
    let name = arg.get_id().as_str().to_string();
    let required = arg.is_required_set();
    let repeating = matches!(arg.get_action(), ArgAction::Append | ArgAction::Count)
        || arg.get_num_args().is_some_and(|n| n.max_values() > 1);
    Positional {
        name,
        required,
        repeating,
    }
}

/// Map a clap `Arg` to the SPEC §7 `kind` + optional `choices`.
///
/// Order of resolution:
/// 1. Boolean action (`SetTrue` / `SetFalse`) ⇒ `"boolean"`.
/// 2. `PossibleValuesParser`-derived choices ⇒ `"dropdown"`.
/// 3. `ValueHint` of `FilePath` / `DirPath` / `AnyPath` / `ExecutablePath` ⇒ `"path"`.
/// 4. Otherwise ⇒ `"text"`. Numeric flags (none in mk-cli today) would map here too;
///    callers needing `"number"` should add a `value_parser!(u32)` and we can extend.
fn classify(arg: &Arg) -> (&'static str, Option<Vec<String>>) {
    if matches!(arg.get_action(), ArgAction::SetTrue | ArgAction::SetFalse) {
        return ("boolean", None);
    }
    let choices: Vec<String> = arg
        .get_possible_values()
        .iter()
        .map(|pv| pv.get_name().to_string())
        .collect();
    if !choices.is_empty() {
        return ("dropdown", Some(choices));
    }
    match arg.get_value_hint() {
        ValueHint::FilePath
        | ValueHint::DirPath
        | ValueHint::AnyPath
        | ValueHint::ExecutablePath => return ("path", None),
        _ => {}
    }
    // `--out` on `vectors` is a `PathBuf` but lacks an explicit ValueHint.
    // Treat any arg whose value-parser type-id matches `PathBuf` as a path.
    if arg.get_value_parser().type_id() == std::any::TypeId::of::<std::path::PathBuf>() {
        return ("path", None);
    }
    ("text", None)
}