standout-input 7.7.0

Declarative input collection for CLI applications
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
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

# standout-input

Declarative input collection for CLI applications.

## Overview

`standout-input` provides a unified way to acquire user input from multiple sources—CLI arguments, stdin, environment variables, editors, and interactive prompts—with automatic fallback chains.

```rust
use standout_input::{InputChain, ArgSource, StdinSource, EditorSource};

// Try argument first, then piped stdin, then open editor
let message = InputChain::<String>::new()
    .try_source(ArgSource::new("message"))
    .try_source(StdinSource::new())
    .try_source(EditorSource::new())
    .resolve(&matches)?;
```

## Features

- **Declarative chains** - Define fallback sequences without imperative logic
- **Pluggable sources** - Arg, stdin, env, clipboard, editor, prompts
- **Validation** - Chain-level and source-level validation with retry support
- **Testable** - All sources accept mock implementations for CI-safe testing
- **Minimal deps** - Core has ~2 dependencies; heavy features are opt-in

## Feature Flags

| Feature          | Default | Dependencies       | Provides                                  |
| ---------------- | ------- | ------------------ | ----------------------------------------- |
| `editor`         | Yes     | tempfile, which    | `EditorSource`                            |
| `simple-prompts` | Yes     | none               | `TextPromptSource`, `ConfirmPromptSource` |
| `inquire`        | No      | inquire (~29 deps) | Rich TUI prompts                          |

### Minimal Build

```toml
[dependencies]
standout-input = { version = "0.1", default-features = false }
```

### Full Feature Set

```toml
[dependencies]
standout-input = { version = "0.1", features = ["inquire"] }
```

## Usage

### Basic Chain

```rust
use standout_input::{InputChain, ArgSource, StdinSource, DefaultSource};

let chain = InputChain::<String>::new()
    .try_source(ArgSource::new("message"))
    .try_source(StdinSource::new())
    .default("default message".to_string());

let value = chain.resolve(&matches)?;
```

### With Validation

```rust
let chain = InputChain::<String>::new()
    .try_source(ArgSource::new("email"))
    .try_source(TextPromptSource::new("Email: "))
    .validate(|s| s.contains('@'), "Must be a valid email");
```

### Testing with Mocks

```rust
use standout_input::{StdinSource, MockStdin, EnvSource, MockEnv};

// Simulate piped input
let source = StdinSource::with_reader(MockStdin::piped("test content"));

// Simulate terminal (no piped input)
let source = StdinSource::with_reader(MockStdin::terminal());

// Simulate environment variable
let env = MockEnv::new().with_var("TOKEN", "secret");
let source = EnvSource::with_reader("TOKEN", env);
```

## Available Sources

### Non-Interactive (always available)

| Source             | Type     | Description                       |
| ------------------ | -------- | --------------------------------- |
| `ArgSource`        | `String` | CLI argument                      |
| `FlagSource`       | `bool`   | CLI flag                          |
| `StdinSource`      | `String` | Piped stdin (skipped if terminal) |
| `EnvSource`        | `String` | Environment variable              |
| `ClipboardSource`  | `String` | System clipboard                  |
| `DefaultSource<T>` | `T`      | Fallback value                    |

### Editor (`editor` feature, default)

| Source         | Type     | Description           |
| -------------- | -------- | --------------------- |
| `EditorSource` | `String` | Opens $VISUAL/$EDITOR |

### Simple Prompts (`simple-prompts` feature, default)

| Source                | Type     | Description      |
| --------------------- | -------- | ---------------- |
| `TextPromptSource`    | `String` | Basic text input |
| `ConfirmPromptSource` | `bool`   | Yes/no prompt    |

### Inquire (`inquire` feature)

| Source                  | Type     | Description            |
| ----------------------- | -------- | ---------------------- |
| `InquireText`           | `String` | Text with autocomplete |
| `InquireConfirm`        | `bool`   | Polished yes/no        |
| `InquireSelect<T>`      | `T`      | Single selection       |
| `InquireMultiSelect<T>` | `Vec<T>` | Multiple selection     |
| `InquirePassword`       | `String` | Masked input           |
| `InquireEditor`         | `String` | Editor with preview    |

## Documentation

- [Introduction to Input](docs/guides/intro-to-input.md) - Getting started guide
- [Backends](docs/topics/backends.md) - Detailed backend documentation and custom implementations

## License

MIT