argot-cmd-derive 0.2.0

Derive macros for the argot command framework
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
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

# argot-cmd-derive

Derive macros for the [argot-cmd](https://crates.io/crates/argot-cmd) command interface framework.

This crate provides `#[derive(ArgotCommand)]`, which generates an `argot_cmd::Command`
definition from a plain Rust struct using `#[argot(...)]` attributes.

## Usage

Add both `argot-cmd` and this crate to your `Cargo.toml`:

```toml
[dependencies]
argot-cmd = { version = "0.1", features = ["derive"] }
```

The `derive` feature re-exports `#[derive(ArgotCommand)]` from `argot-cmd` directly,
so you do not need to depend on `argot-cmd-derive` explicitly.

## Example

```rust
use argot_cmd::ArgotCommand;

#[derive(ArgotCommand)]
#[argot(
    summary = "Deploy the application",
    alias = "d",
    best_practice = "always dry-run first",
    anti_pattern = "deploy directly to production"
)]
struct Deploy {
    #[argot(positional, required, description = "Target environment")]
    env: String,

    #[argot(flag, short = 'n', description = "Simulate without making changes")]
    dry_run: bool,
}

let cmd = Deploy::command();
assert_eq!(cmd.canonical, "deploy");
assert_eq!(cmd.summary, "Deploy the application");
assert_eq!(cmd.aliases, vec!["d"]);
```

## Struct-level attributes

| Attribute | Type | Description |
|-----------|------|-------------|
| `canonical = "name"` | string | Override the command name. Default: struct name in kebab-case (`DeployApp` → `deploy-app`). |
| `summary = "text"` | string | One-line summary shown in help and agent discovery. |
| `description = "text"` | string | Long prose description. |
| `alias = "a"` | string | Add an alias (repeat for multiple). |
| `best_practice = "text"` | string | Add a best-practice tip (repeat for multiple). |
| `anti_pattern = "text"` | string | Add an anti-pattern warning (repeat for multiple). |

## Field-level attributes

Fields without an `#[argot(...)]` attribute are ignored. Every annotated field
must declare either `positional` or `flag`.

| Attribute | Description |
|-----------|-------------|
| `positional` | Treat as a positional [`argot_cmd::Argument`]. |
| `flag` | Treat as a named [`argot_cmd::Flag`]. |
| `required` | Mark as required. |
| `short = 'c'` | Short flag character (e.g. `-n`). |
| `takes_value` | Flag consumes the next token as its value. |
| `description = "text"` | Human-readable description. |
| `default = "value"` | Default value string. |

## Name conventions

- Struct names are converted to kebab-case for the canonical command name:
  `DeployApp` → `deploy-app`
- Field names are converted to kebab-case for argument/flag names:
  `dry_run` → `dry-run`

## License

MIT