vld-clap 0.2.0

Clap integration for the vld validation library — validate CLI arguments after parsing
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
82
83
84
85
86
87
88
89
90

[![Crates.io](https://img.shields.io/crates/v/vld-clap?style=for-the-badge)](https://crates.io/crates/vld-clap)
[![docs.rs](https://img.shields.io/docsrs/vld-clap?style=for-the-badge)](https://docs.rs/vld-clap)
[![License](https://img.shields.io/badge/license-MIT-green?style=for-the-badge)](https://github.com/s00d/vld/blob/main/LICENSE)
[![Platform](https://img.shields.io/badge/platform-macOS%20%7C%20Windows%20%7C%20Linux-blue?style=for-the-badge)](https://github.com/s00d/vld)
[![GitHub issues](https://img.shields.io/badge/github-issues-orange?style=for-the-badge)](https://github.com/s00d/vld/issues)
[![GitHub stars](https://img.shields.io/badge/github-stars-yellow?style=for-the-badge)](https://github.com/s00d/vld/stargazers)

# vld-clap

[Clap](https://docs.rs/clap) integration for the **vld** validation library.

Validate CLI arguments **after** clap has parsed them — email format, URL, ranges, string lengths, regex patterns, and everything else `vld` supports. Validation rules go directly on the Cli struct via `#[derive(Validate)]`.

## Why

Clap handles argument parsing (types, defaults, required/optional), but doesn't validate semantic constraints like "must be a valid email" or "port must be 1–65535". `vld-clap` fills that gap — no separate schema struct needed.

## Installation

```toml
[dependencies]
vld-clap = "0.1"
vld = { version = "0.1", features = ["derive"] }
clap = { version = "4", features = ["derive"] }
serde = { version = "1", features = ["derive"] }
```

## Quick Start

```rust
use clap::Parser;
use vld::Validate;
use vld_clap::prelude::*;

#[derive(Parser, Debug, serde::Serialize, Validate)]
#[command(name = "myapp")]
struct Cli {
    #[arg(long)]
    #[vld(vld::string().email())]
    email: String,

    #[arg(long, default_value_t = 8080)]
    #[vld(vld::number().int().min(1).max(65535))]
    port: i64,

    #[arg(long)]
    #[vld(vld::string().min(2).max(50))]
    name: String,
}

fn main() {
    let cli = Cli::parse();
    validate_or_exit(&cli);
    println!("email={}, port={}", cli.email, cli.port);
}
```

## API

| Function | Description |
|----------|-------------|
| `validate(args)` | Validate a struct with `#[derive(Validate)]` + `Serialize` |
| `validate_or_exit(args)` | Validate; print error & exit(2) on failure |
| `validate_with_schema::<S, T>(args)` | Validate `T: Serialize` against a separate schema `S` |
| `validate_json::<S>(json)` | Validate raw JSON |

## Error Output

```
Invalid arguments:
       --email: Invalid email address
       --name: String must be at least 2 characters
       --port: Number must be at most 65535
```

## Examples

```bash
# Valid
cargo run -p vld-clap --example clap_basic -- \
  --email alice@example.com --name Alice --port 3000 --workers 8

# Invalid (exits with code 2)
cargo run -p vld-clap --example clap_basic -- \
  --email bad --name X --port 99999 --workers 0
```

## License

MIT