scriba 0.5.0

CLI text rendering, prompts, and terminal output utilities
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
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
use ::inquire::{
    ui::{Color, RenderConfig, StyleSheet, Styled},
    Confirm, MultiSelect, Select, Text,
};

use crate::{Config, Error, Result};
use super::theme::PromptTheme;

/// Parse a color string to inquire color.
///
/// Supports color names: cyan, white, gray, black, red, etc.
/// Maps to available inquire::ui::Color variants.
fn parse_color(color_str: &str) -> Color {
    match color_str.to_lowercase().as_str() {
        "black" => Color::Black,
        "red" | "bright_red" => Color::LightRed,
        "green" | "bright_green" => Color::LightGreen,
        "yellow" | "bright_yellow" => Color::LightYellow,
        "blue" | "bright_blue" => Color::LightBlue,
        "magenta" | "bright_magenta" => Color::LightMagenta,
        "cyan" | "bright_cyan" => Color::LightCyan,
        "white" | "bright_white" => Color::White,
        "gray" | "grey" | "bright_black" => Color::DarkGrey,
        "light_gray" | "light_grey" => Color::White,
        _ => Color::White, // default
    }
}

/// Build a RenderConfig from a PromptTheme.
///
/// Maps theme colors to inquire color codes and applies them to the render configuration.
fn theme_from_prompt_theme(theme: &PromptTheme) -> RenderConfig<'_> {
    RenderConfig::default_colored()
        .with_prompt_prefix(Styled::new("").with_fg(parse_color(&theme.question_color)))
        .with_answered_prompt_prefix(Styled::new("").with_fg(parse_color(&theme.success_color)))
        .with_canceled_prompt_indicator(Styled::new("").with_fg(parse_color(&theme.hint_color)))
        .with_highlighted_option_prefix(Styled::new("").with_fg(parse_color(&theme.selected_color)))
        .with_scroll_up_prefix(Styled::new("").with_fg(parse_color(&theme.hint_color)))
        .with_scroll_down_prefix(Styled::new("").with_fg(parse_color(&theme.hint_color)))
        .with_selected_checkbox(Styled::new("").with_fg(parse_color(&theme.selected_color)))
        .with_unselected_checkbox(Styled::new("").with_fg(parse_color(&theme.unselected_color)))
        .with_help_message(StyleSheet::new().with_fg(parse_color(&theme.hint_color)))
        .with_answer(StyleSheet::new().with_fg(parse_color(&theme.success_color)))
        .with_option(StyleSheet::new().with_fg(parse_color(&theme.input_color)))
        .with_selected_option(Some(StyleSheet::new().with_fg(parse_color(&theme.selected_color))))
        .with_text_input(StyleSheet::new().with_fg(parse_color(&theme.input_color)))
        .with_default_value(StyleSheet::new().with_fg(parse_color(&theme.hint_color)))
}

/// A selectable option with id and label.
///
/// Used in `SelectRequest` for single-choice prompts.
///
/// # Example
///
/// ```
/// use scriba::SelectOption;
///
/// let option = SelectOption::new("dev", "Development")
///     .description("Local development environment");
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SelectOption {
    /// Unique identifier for this option.
    pub id: String,
    /// Display label for this option.
    pub label: String,
    /// Optional description shown below label.
    pub description: Option<String>,
}

impl SelectOption {
    /// Create a new selectable option.
    pub fn new(id: impl Into<String>, label: impl Into<String>) -> Self {
        Self {
            id: id.into(),
            label: label.into(),
            description: None,
        }
    }

    /// Add a description to this option.
    pub fn description(mut self, value: impl Into<String>) -> Self {
        self.description = Some(value.into());
        self
    }

    fn display(&self) -> String {
        match &self.description {
            Some(description) => format!("{}{}", self.label, description),
            None => self.label.clone(),
        }
    }
}

/// A selectable option for multi-select prompts.
///
/// Used in `MultiSelectRequest`. Can be pre-selected.
///
/// # Example
///
/// ```
/// use scriba::MultiSelectOption;
///
/// let option = MultiSelectOption::new("logger", "Logger")
///     .description("Styled logging")
///     .selected(true);
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct MultiSelectOption {
    /// Unique identifier for this option.
    pub id: String,
    /// Display label for this option.
    pub label: String,
    /// Optional description shown below label.
    pub description: Option<String>,
    /// Whether this option is pre-selected.
    pub selected: bool,
}

impl MultiSelectOption {
    /// Create a new multi-select option.
    pub fn new(id: impl Into<String>, label: impl Into<String>) -> Self {
        Self {
            id: id.into(),
            label: label.into(),
            description: None,
            selected: false,
        }
    }

    /// Add a description to this option.
    pub fn description(mut self, value: impl Into<String>) -> Self {
        self.description = Some(value.into());
        self
    }

    /// Set whether this option is pre-selected.
    pub fn selected(mut self, value: bool) -> Self {
        self.selected = value;
        self
    }

    fn display(&self) -> String {
        match &self.description {
            Some(description) => format!("{}{}", self.label, description),
            None => self.label.clone(),
        }
    }
}

/// Request for single-choice selection prompt.
///
/// Supports optional pagination via `with_page_size()` for large option lists.
///
/// # Example
///
/// ```
/// use scriba::{SelectRequest, SelectOption};
///
/// let request = SelectRequest::new(
///     "Choose environment",
///     vec![
///         SelectOption::new("dev", "Development"),
///         SelectOption::new("prod", "Production"),
///     ],
/// )
/// .with_page_size(5);
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SelectRequest {
    /// Prompt message to display.
    pub message: String,
    /// Available options to choose from.
    pub options: Vec<SelectOption>,
    /// Optional page size for pagination (default: inquire's default of 7).
    pub page_size: Option<usize>,
}

impl SelectRequest {
    /// Create a new select request.
    pub fn new(message: impl Into<String>, options: Vec<SelectOption>) -> Self {
        Self {
            message: message.into(),
            options,
            page_size: None,
        }
    }

    /// Set pagination page size for large option lists.
    ///
    /// # Example
    ///
    /// ```
    /// use scriba::{SelectRequest, SelectOption};
    ///
    /// let request = SelectRequest::new(
    ///     "Pick one",
    ///     vec![SelectOption::new("a", "Option A")],
    /// )
    /// .with_page_size(5);
    /// assert_eq!(request.page_size, Some(5));
    /// ```
    pub fn with_page_size(mut self, size: usize) -> Self {
        self.page_size = Some(size);
        self
    }
}

/// Request for multi-choice selection prompt.
///
/// Supports optional pagination via `with_page_size()` for large option lists.
///
/// # Example
///
/// ```
/// use scriba::{MultiSelectRequest, MultiSelectOption};
///
/// let request = MultiSelectRequest::new(
///     "Select features",
///     vec![
///         MultiSelectOption::new("logging", "Logging").selected(true),
///         MultiSelectOption::new("prompts", "Prompts"),
///     ],
/// )
/// .with_page_size(5);
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct MultiSelectRequest {
    /// Prompt message to display.
    pub message: String,
    /// Available options to choose from.
    pub options: Vec<MultiSelectOption>,
    /// Optional page size for pagination (default: 7).
    pub page_size: Option<usize>,
}

impl MultiSelectRequest {
    /// Create a new multi-select request.
    pub fn new(message: impl Into<String>, options: Vec<MultiSelectOption>) -> Self {
        Self {
            message: message.into(),
            options,
            page_size: None,
        }
    }

    /// Set pagination page size for large option lists.
    ///
    /// If the number of options exceeds this size, users can scroll through pages.
    /// When `None` (default), inquire uses its default page size of 7.
    ///
    /// # Example
    ///
    /// ```
    /// use scriba::{MultiSelectRequest, MultiSelectOption};
    ///
    /// let request = MultiSelectRequest::new(
    ///     "Select items",
    ///     vec![MultiSelectOption::new("item1", "Item 1")],
    /// )
    /// .with_page_size(10);
    /// ```
    pub fn with_page_size(mut self, size: usize) -> Self {
        self.page_size = Some(size);
        self
    }
}

/// Prompt for text input with theming support.
///
/// Returns `Error::InteractiveRequired` if not in interactive mode.
///
/// # Example
///
/// ```ignore
/// let response = scriba::prompt::text(
///     &config,
///     "Your name?",
///     Some("Anonymous"),
///     None,
///     &theme,
/// )?;
/// ```
pub fn text(
    cfg: &Config,
    message: &str,
    default: Option<&str>,
    help: Option<&str>,
    theme: &PromptTheme,
) -> Result<String> {
    if !cfg.interactive {
        return Err(Error::InteractiveRequired);
    }

    let mut prompt = Text::new(message).with_render_config(theme_from_prompt_theme(theme));

    if let Some(default) = default {
        prompt = prompt.with_default(default);
    }

    if let Some(help) = help {
        prompt = prompt.with_help_message(help);
    }

    prompt.prompt().map_err(map_inquire_error)
}

/// Prompt for yes/no confirmation with theming support.
///
/// Auto-returns `Ok(true)` if `config.auto_yes` is enabled.
/// Returns the default value if not in interactive mode.
///
/// # Example
///
/// ```ignore
/// if scriba::prompt::confirm(&config, "Continue?", false, &theme)? {
///     println!("Confirmed!");
/// }
/// ```
pub fn confirm(cfg: &Config, message: &str, default: bool, theme: &PromptTheme) -> Result<bool> {
    if cfg.auto_yes {
        return Ok(true);
    }

    if !cfg.interactive {
        return Ok(default);
    }

    Confirm::new(message)
        .with_render_config(theme_from_prompt_theme(theme))
        .with_default(default)
        .prompt()
        .map_err(map_inquire_error)
}

/// Prompt user to select one option from a list with theming support.
///
/// Returns the `id` of the selected option.
///
/// # Example
///
/// ```ignore
/// use scriba::{prompt, SelectRequest, SelectOption};
///
/// let request = SelectRequest::new(
///     "Pick one",
///     vec![SelectOption::new("a", "Option A")],
/// );
/// let id = prompt::select(&config, &request, &theme)?;
/// ```
pub fn select(cfg: &Config, request: &SelectRequest, theme: &PromptTheme) -> Result<String> {
    if !cfg.interactive {
        return Err(Error::InteractiveRequired);
    }

    let options = request
        .options
        .iter()
        .map(SelectOption::display)
        .collect::<Vec<_>>();

    let mut prompt = Select::new(&request.message, options).with_render_config(theme_from_prompt_theme(theme));

    if let Some(page_size) = request.page_size {
        prompt = prompt.with_page_size(page_size);
    }

    let selected = prompt.prompt().map_err(map_inquire_error)?;

    let id = request
        .options
        .iter()
        .find(|option| option.display() == selected)
        .map(|option| option.id.clone())
        .ok_or_else(|| Error::Prompt("selected option was not found".to_string()))?;

    Ok(id)
}

/// Prompt user to select multiple options from a list with theming support.
///
/// Returns the `id`s of the selected options.
///
/// # Example
///
/// ```ignore
/// use scriba::{prompt, MultiSelectRequest, MultiSelectOption};
///
/// let request = MultiSelectRequest::new(
///     "Pick multiple",
///     vec![MultiSelectOption::new("a", "Option A")],
/// );
/// let ids = prompt::multiselect(&config, &request, &theme)?;
/// ```
pub fn multiselect(cfg: &Config, request: &MultiSelectRequest, theme: &PromptTheme) -> Result<Vec<String>> {
    if !cfg.interactive {
        return Err(Error::InteractiveRequired);
    }

    let options = request
        .options
        .iter()
        .map(MultiSelectOption::display)
        .collect::<Vec<_>>();

    let defaults = request
        .options
        .iter()
        .enumerate()
        .filter_map(|(idx, option)| option.selected.then_some(idx))
        .collect::<Vec<_>>();

    let mut multiselect = MultiSelect::new(&request.message, options)
        .with_render_config(theme_from_prompt_theme(theme))
        .with_default(&defaults);

    if let Some(page_size) = request.page_size {
        multiselect = multiselect.with_page_size(page_size);
    }

    let selected = multiselect.prompt().map_err(map_inquire_error)?;

    let ids = request
        .options
        .iter()
        .filter(|option| selected.contains(&option.display()))
        .map(|option| option.id.clone())
        .collect::<Vec<_>>();

    Ok(ids)
}

fn map_inquire_error(err: ::inquire::InquireError) -> Error {
    match err {
        ::inquire::InquireError::OperationCanceled
        | ::inquire::InquireError::OperationInterrupted => Error::PromptCancelled,
        other => Error::Prompt(other.to_string()),
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn select_option_new_creates_with_id_and_label() {
        let option = SelectOption::new("dev", "Development");
        assert_eq!(option.id, "dev");
        assert_eq!(option.label, "Development");
        assert_eq!(option.description, None);
    }

    #[test]
    fn select_option_description_sets_description() {
        let option = SelectOption::new("dev", "Development").description("Local environment");
        assert_eq!(option.description, Some("Local environment".into()));
    }

    #[test]
    fn select_option_display_includes_description() {
        let option = SelectOption::new("dev", "Development").description("Local environment");
        assert_eq!(option.display(), "Development — Local environment");
    }

    #[test]
    fn select_option_display_without_description() {
        let option = SelectOption::new("dev", "Development");
        assert_eq!(option.display(), "Development");
    }

    #[test]
    fn multi_select_option_new_creates_unselected() {
        let option = MultiSelectOption::new("logger", "Logger");
        assert_eq!(option.id, "logger");
        assert_eq!(option.label, "Logger");
        assert!(!option.selected);
        assert_eq!(option.description, None);
    }

    #[test]
    fn multi_select_option_selected_sets_flag() {
        let option = MultiSelectOption::new("logger", "Logger").selected(true);
        assert!(option.selected);
    }

    #[test]
    fn multi_select_option_description_sets_description() {
        let option = MultiSelectOption::new("logger", "Logger").description("Logging system");
        assert_eq!(option.description, Some("Logging system".into()));
    }

    #[test]
    fn multi_select_option_builder_is_fluent() {
        let option = MultiSelectOption::new("logger", "Logger")
            .description("Logging system")
            .selected(true);
        assert!(option.selected);
        assert_eq!(option.description, Some("Logging system".into()));
    }

    #[test]
    fn multi_select_option_display_includes_description() {
        let option = MultiSelectOption::new("logger", "Logger").description("Logging system");
        assert_eq!(option.display(), "Logger — Logging system");
    }

    #[test]
    fn multi_select_option_display_without_description() {
        let option = MultiSelectOption::new("logger", "Logger");
        assert_eq!(option.display(), "Logger");
    }

    #[test]
    fn select_request_new_creates_with_message_and_options() {
        let options = vec![SelectOption::new("a", "Option A")];
        let request = SelectRequest::new("Choose", options.clone());
        assert_eq!(request.message, "Choose");
        assert_eq!(request.options, options);
        assert_eq!(request.page_size, None);
    }

    #[test]
    fn select_request_with_page_size_sets_page_size() {
        let options = vec![SelectOption::new("a", "Option A")];
        let request = SelectRequest::new("Choose", options).with_page_size(5);
        assert_eq!(request.page_size, Some(5));
    }

    #[test]
    fn select_request_page_size_can_be_changed() {
        let options = vec![SelectOption::new("a", "Option A")];
        let request = SelectRequest::new("Choose", options)
            .with_page_size(5)
            .with_page_size(10);
        assert_eq!(request.page_size, Some(10));
    }

    #[test]
    fn select_request_builder_is_fluent() {
        let options = vec![
            SelectOption::new("a", "Option A"),
            SelectOption::new("b", "Option B"),
        ];
        let request = SelectRequest::new("Choose", options).with_page_size(3);
        assert_eq!(request.message, "Choose");
        assert_eq!(request.options.len(), 2);
        assert_eq!(request.page_size, Some(3));
    }

    #[test]
    fn multi_select_request_new_creates_with_no_page_size() {
        let options = vec![MultiSelectOption::new("a", "Option A")];
        let request = MultiSelectRequest::new("Select", options.clone());
        assert_eq!(request.message, "Select");
        assert_eq!(request.options, options);
        assert_eq!(request.page_size, None);
    }

    #[test]
    fn multi_select_request_with_page_size_sets_page_size() {
        let options = vec![MultiSelectOption::new("a", "Option A")];
        let request = MultiSelectRequest::new("Select", options).with_page_size(5);
        assert_eq!(request.page_size, Some(5));
    }

    #[test]
    fn multi_select_request_builder_is_fluent() {
        let options = vec![
            MultiSelectOption::new("a", "Option A"),
            MultiSelectOption::new("b", "Option B"),
        ];
        let request = MultiSelectRequest::new("Select items", options).with_page_size(10);
        assert_eq!(request.message, "Select items");
        assert_eq!(request.options.len(), 2);
        assert_eq!(request.page_size, Some(10));
    }

    #[test]
    fn multi_select_request_page_size_can_be_changed() {
        let options = vec![MultiSelectOption::new("a", "Option A")];
        let request = MultiSelectRequest::new("Select", options)
            .with_page_size(5)
            .with_page_size(10);
        assert_eq!(request.page_size, Some(10));
    }
}