consola 0.0.0-alpha.0

🐨 Elegant Console Logger for Rust and Browser
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
//! Prompt system for interactive user input (feature "prompt-demand")
//!
//! Provides abstractions for interactive prompts using the `demand` crate.
//! Browser environments will return an error if prompts are attempted.
//! Note: WASM running in Node.js, Wasmer, or other runtimes may support prompts.

use std::error::Error as StdError;
use thiserror::Error;

/// Strategy for handling prompt cancellation
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PromptCancelStrategy {
    /// Return an error on cancellation
    Reject,
    /// Return a default value on cancellation
    Default,
    /// Return Undefined outcome
    Undefined,
    /// Return Null value
    Null,
    /// Return a Symbol indicating cancellation
    Symbol,
}

/// Outcome of a prompt operation
#[derive(Debug, Clone, PartialEq)]
pub enum PromptOutcome<T> {
    /// Successfully obtained a value
    Value(T),
    /// Prompt was cancelled and strategy chose Undefined
    Undefined,
    /// Prompt was cancelled and strategy chose Null
    NullValue,
    /// Prompt was cancelled and strategy chose Symbol
    SymbolCancel,
    /// Prompt was cancelled and strategy was Reject
    Cancelled,
}

impl<T> PromptOutcome<T> {
    /// Unwrap the value or panic
    pub fn unwrap(self) -> T {
        match self {
            PromptOutcome::Value(v) => v,
            _ => panic!("called `PromptOutcome::unwrap()` on a non-Value variant"),
        }
    }

    /// Get the value or a default
    pub fn unwrap_or(self, default: T) -> T {
        match self {
            PromptOutcome::Value(v) => v,
            _ => default,
        }
    }

    /// Check if this is a Value
    pub fn is_value(&self) -> bool {
        matches!(self, PromptOutcome::Value(_))
    }
}

/// Error type for prompt operations
#[derive(Debug, Error)]
pub enum PromptError {
    /// Prompt was cancelled by user
    #[error("prompt cancelled by user")]
    Cancelled,
    /// Prompt not supported (e.g., in browsers)
    #[error("prompts not supported in this environment (browser)")]
    NotSupported,
    /// Internal error from demand crate
    #[cfg(feature = "prompt-demand")]
    #[error("prompt error: {0}")]
    DemandError(String),
    /// Generic error
    #[error("prompt error: {0}")]
    Other(Box<dyn StdError + Send + Sync>),
}

/// Trait for prompt providers
pub trait PromptProvider: Send + Sync {
    /// Prompt for a text input
    fn text(
        &self,
        prompt: &str,
        default: Option<&str>,
    ) -> Result<PromptOutcome<String>, PromptError>;

    /// Prompt for a yes/no confirmation
    fn confirm(
        &self,
        prompt: &str,
        default: Option<bool>,
    ) -> Result<PromptOutcome<bool>, PromptError>;

    /// Prompt for a single selection from a list
    fn select(&self, prompt: &str, options: &[&str]) -> Result<PromptOutcome<usize>, PromptError>;

    /// Prompt for multiple selections from a list
    fn multiselect(
        &self,
        prompt: &str,
        options: &[&str],
    ) -> Result<PromptOutcome<Vec<usize>>, PromptError>;
}

/// Check if we're running in a browser environment
#[cfg(target_arch = "wasm32")]
fn is_browser() -> bool {
    #[cfg(feature = "wasm")]
    {
        use js_sys::Reflect;
        use wasm_bindgen::JsCast;
        use wasm_bindgen::prelude::*;

        // Check if `window` is defined and is an object
        if let Ok(window) = js_sys::global().dyn_into::<web_sys::Window>() {
            return true; // We’re in a browser
        }

        // Some browsers expose `self` (WebWorker)
        if Reflect::has(&js_sys::global(), &"self".into()).unwrap_or(false) {
            return js_sys::global()
                .dyn_into::<web_sys::WorkerGlobalScope>()
                .is_ok();
        }

        false
    }
    #[cfg(not(feature = "wasm"))]
    {
        // If wasm feature isn't enabled but we're on wasm32, conservatively assume browser
        true
    }
}

#[cfg(not(target_arch = "wasm32"))]
fn is_browser() -> bool {
    false
}

/// Default prompt provider using the demand crate
#[cfg(feature = "prompt-demand")]
pub struct DefaultDemandPrompt {
    cancel_strategy: PromptCancelStrategy,
}

#[cfg(feature = "prompt-demand")]
impl DefaultDemandPrompt {
    /// Create a new prompt provider with the given cancellation strategy
    pub fn new(cancel_strategy: PromptCancelStrategy) -> Self {
        Self { cancel_strategy }
    }

    /// Create a new prompt provider with default cancellation strategy (Reject)
    pub fn new_default() -> Self {
        Self::new(PromptCancelStrategy::Reject)
    }

    /// Map demand interruption to outcome based on strategy
    fn map_cancellation<T>(&self) -> PromptOutcome<T> {
        match self.cancel_strategy {
            PromptCancelStrategy::Reject => PromptOutcome::Cancelled,
            PromptCancelStrategy::Default => PromptOutcome::Cancelled, // Caller should handle default
            PromptCancelStrategy::Undefined => PromptOutcome::Undefined,
            PromptCancelStrategy::Null => PromptOutcome::NullValue,
            PromptCancelStrategy::Symbol => PromptOutcome::SymbolCancel,
        }
    }
}

#[cfg(feature = "prompt-demand")]
impl PromptProvider for DefaultDemandPrompt {
    fn text(
        &self,
        prompt: &str,
        default: Option<&str>,
    ) -> Result<PromptOutcome<String>, PromptError> {
        // Check if we're in a browser at runtime
        if is_browser() {
            return Err(PromptError::NotSupported);
        }

        let mut input = demand::Input::new(prompt);
        if let Some(def) = default {
            input = input.placeholder(def);
        }

        match input.run() {
            Ok(value) => Ok(PromptOutcome::Value(value)),
            Err(_e) => {
                // Assume interruption/cancellation
                if matches!(self.cancel_strategy, PromptCancelStrategy::Default) {
                    if let Some(def) = default {
                        Ok(PromptOutcome::Value(def.to_string()))
                    } else {
                        Ok(self.map_cancellation())
                    }
                } else {
                    Ok(self.map_cancellation())
                }
            }
        }
    }

    fn confirm(
        &self,
        prompt: &str,
        default: Option<bool>,
    ) -> Result<PromptOutcome<bool>, PromptError> {
        // Check if we're in a browser at runtime
        if is_browser() {
            return Err(PromptError::NotSupported);
        }

        let confirm = demand::Confirm::new(prompt);
        // Note: demand::Confirm doesn't expose a method to set default in v1.7

        match confirm.run() {
            Ok(value) => Ok(PromptOutcome::Value(value)),
            Err(_e) => {
                // Assume interruption/cancellation
                if matches!(self.cancel_strategy, PromptCancelStrategy::Default) {
                    if let Some(def) = default {
                        Ok(PromptOutcome::Value(def))
                    } else {
                        Ok(self.map_cancellation())
                    }
                } else {
                    Ok(self.map_cancellation())
                }
            }
        }
    }

    fn select(&self, prompt: &str, options: &[&str]) -> Result<PromptOutcome<usize>, PromptError> {
        // Check if we're in a browser at runtime
        if is_browser() {
            return Err(PromptError::NotSupported);
        }

        // For now, implement a simple text-based selection
        // This is a simplified implementation until we can properly use demand::Select
        let mut input_text = format!("{}\nOptions:\n", prompt);
        for (i, opt) in options.iter().enumerate() {
            input_text.push_str(&format!("{}. {}\n", i + 1, opt));
        }
        input_text.push_str("Enter number: ");

        let input = demand::Input::new(&input_text);
        match input.run() {
            Ok(value) => {
                if let Ok(num) = value.trim().parse::<usize>() {
                    if num > 0 && num <= options.len() {
                        Ok(PromptOutcome::Value(num - 1))
                    } else {
                        Ok(self.map_cancellation())
                    }
                } else {
                    Ok(self.map_cancellation())
                }
            }
            Err(_e) => Ok(self.map_cancellation()),
        }
    }

    fn multiselect(
        &self,
        prompt: &str,
        options: &[&str],
    ) -> Result<PromptOutcome<Vec<usize>>, PromptError> {
        // Check if we're in a browser at runtime
        if is_browser() {
            return Err(PromptError::NotSupported);
        }

        // For now, implement a simple text-based multi-selection
        let mut input_text = format!("{}\nOptions:\n", prompt);
        for (i, opt) in options.iter().enumerate() {
            input_text.push_str(&format!("{}. {}\n", i + 1, opt));
        }
        input_text.push_str("Enter numbers (comma-separated): ");

        let input = demand::Input::new(&input_text);
        match input.run() {
            Ok(value) => {
                let indices: Vec<usize> = value
                    .split(',')
                    .filter_map(|s| s.trim().parse::<usize>().ok())
                    .filter(|&n| n > 0 && n <= options.len())
                    .map(|n| n - 1)
                    .collect();
                Ok(PromptOutcome::Value(indices))
            }
            Err(_e) => Ok(self.map_cancellation()),
        }
    }
}

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

    #[test]
    fn test_cancel_strategy_variants() {
        assert_eq!(PromptCancelStrategy::Reject, PromptCancelStrategy::Reject);
        assert_ne!(PromptCancelStrategy::Reject, PromptCancelStrategy::Default);
        assert_eq!(PromptCancelStrategy::Default, PromptCancelStrategy::Default);
        assert_eq!(
            PromptCancelStrategy::Undefined,
            PromptCancelStrategy::Undefined
        );
        assert_eq!(PromptCancelStrategy::Null, PromptCancelStrategy::Null);
        assert_eq!(PromptCancelStrategy::Symbol, PromptCancelStrategy::Symbol);
    }

    #[test]
    fn test_cancel_strategy_clone() {
        let strategy = PromptCancelStrategy::Reject;
        let cloned = strategy;
        assert_eq!(strategy, cloned);
    }

    #[test]
    fn test_prompt_outcome_value() {
        let outcome = PromptOutcome::Value(42);
        assert!(outcome.is_value());
        assert_eq!(outcome.unwrap(), 42);
    }

    #[test]
    fn test_prompt_outcome_undefined() {
        let outcome: PromptOutcome<i32> = PromptOutcome::Undefined;
        assert!(!outcome.is_value());
        assert_eq!(outcome.unwrap_or(99), 99);
    }

    #[test]
    fn test_prompt_outcome_null() {
        let outcome: PromptOutcome<String> = PromptOutcome::NullValue;
        assert!(!outcome.is_value());
        assert_eq!(outcome.unwrap_or("default".to_string()), "default");
    }

    #[test]
    fn test_prompt_outcome_symbol_cancel() {
        let outcome: PromptOutcome<bool> = PromptOutcome::SymbolCancel;
        assert!(!outcome.is_value());
        assert!(outcome.unwrap_or(true));
    }

    #[test]
    fn test_prompt_outcome_cancelled() {
        let outcome: PromptOutcome<i32> = PromptOutcome::Cancelled;
        assert!(!outcome.is_value());
    }

    #[test]
    fn test_prompt_outcome_unwrap_or() {
        let outcome: PromptOutcome<i32> = PromptOutcome::Cancelled;
        assert_eq!(outcome.unwrap_or(99), 99);

        let outcome = PromptOutcome::Value(42);
        assert_eq!(outcome.unwrap_or(99), 42);
    }

    #[test]
    fn test_prompt_outcome_clone() {
        let outcome = PromptOutcome::Value(42);
        let cloned = outcome.clone();
        assert_eq!(cloned.unwrap(), 42);
    }

    #[test]
    fn test_prompt_outcome_equality() {
        assert_eq!(PromptOutcome::Value(42), PromptOutcome::Value(42));
        assert_ne!(PromptOutcome::Value(42), PromptOutcome::Value(43));
        assert_eq!(PromptOutcome::<i32>::Cancelled, PromptOutcome::Cancelled);
        assert_eq!(PromptOutcome::<i32>::Undefined, PromptOutcome::Undefined);
    }

    #[test]
    #[should_panic(expected = "called `PromptOutcome::unwrap()` on a non-Value variant")]
    fn test_prompt_outcome_unwrap_panics_cancelled() {
        let outcome: PromptOutcome<i32> = PromptOutcome::Cancelled;
        outcome.unwrap();
    }

    #[test]
    #[should_panic(expected = "called `PromptOutcome::unwrap()` on a non-Value variant")]
    fn test_prompt_outcome_unwrap_panics_undefined() {
        let outcome: PromptOutcome<i32> = PromptOutcome::Undefined;
        outcome.unwrap();
    }

    #[test]
    #[should_panic(expected = "called `PromptOutcome::unwrap()` on a non-Value variant")]
    fn test_prompt_outcome_unwrap_panics_null() {
        let outcome: PromptOutcome<i32> = PromptOutcome::NullValue;
        outcome.unwrap();
    }

    #[test]
    #[should_panic(expected = "called `PromptOutcome::unwrap()` on a non-Value variant")]
    fn test_prompt_outcome_unwrap_panics_symbol() {
        let outcome: PromptOutcome<i32> = PromptOutcome::SymbolCancel;
        outcome.unwrap();
    }

    #[test]
    fn test_prompt_error_display() {
        let err = PromptError::Cancelled;
        assert_eq!(err.to_string(), "prompt cancelled by user");

        let err = PromptError::NotSupported;
        assert_eq!(
            err.to_string(),
            "prompts not supported in this environment (browser)"
        );
    }

    #[cfg(feature = "prompt-demand")]
    #[test]
    fn test_prompt_error_demand() {
        let err = PromptError::DemandError("test error".to_string());
        assert_eq!(err.to_string(), "prompt error: test error");
    }

    #[test]
    fn test_prompt_error_other() {
        let err = PromptError::Other(Box::new(std::io::Error::other("io error")));
        assert!(err.to_string().contains("prompt error"));
    }

    #[cfg(feature = "prompt-demand")]
    #[test]
    fn test_default_demand_prompt_creation() {
        let prompt = DefaultDemandPrompt::new_default();
        assert_eq!(prompt.cancel_strategy, PromptCancelStrategy::Reject);

        let prompt = DefaultDemandPrompt::new(PromptCancelStrategy::Default);
        assert_eq!(prompt.cancel_strategy, PromptCancelStrategy::Default);

        let prompt = DefaultDemandPrompt::new(PromptCancelStrategy::Undefined);
        assert_eq!(prompt.cancel_strategy, PromptCancelStrategy::Undefined);
    }

    #[cfg(feature = "prompt-demand")]
    #[test]
    fn test_map_cancellation_strategies() {
        let prompt = DefaultDemandPrompt::new(PromptCancelStrategy::Reject);
        let outcome: PromptOutcome<String> = prompt.map_cancellation();
        assert_eq!(outcome, PromptOutcome::Cancelled);

        let prompt = DefaultDemandPrompt::new(PromptCancelStrategy::Undefined);
        let outcome: PromptOutcome<String> = prompt.map_cancellation();
        assert_eq!(outcome, PromptOutcome::Undefined);

        let prompt = DefaultDemandPrompt::new(PromptCancelStrategy::Null);
        let outcome: PromptOutcome<String> = prompt.map_cancellation();
        assert_eq!(outcome, PromptOutcome::NullValue);

        let prompt = DefaultDemandPrompt::new(PromptCancelStrategy::Symbol);
        let outcome: PromptOutcome<String> = prompt.map_cancellation();
        assert_eq!(outcome, PromptOutcome::SymbolCancel);

        let prompt = DefaultDemandPrompt::new(PromptCancelStrategy::Default);
        let outcome: PromptOutcome<String> = prompt.map_cancellation();
        assert_eq!(outcome, PromptOutcome::Cancelled);
    }

    #[test]
    fn test_is_browser_on_native() {
        // On native platforms, is_browser() should always return false
        #[cfg(not(target_arch = "wasm32"))]
        assert!(!is_browser());
    }

    // Test that prompt methods work with different strategies in browser environments
    #[cfg(all(feature = "prompt-demand", not(target_arch = "wasm32")))]
    #[test]
    fn test_prompt_methods_return_not_supported_on_mock_browser() {
        // Since we can't actually run in a browser during tests, we test the logic
        // by verifying the prompt provider trait is properly implemented

        struct MockPromptProvider {
            strategy: PromptCancelStrategy,
        }

        impl PromptProvider for MockPromptProvider {
            fn text(
                &self,
                _prompt: &str,
                _default: Option<&str>,
            ) -> Result<PromptOutcome<String>, PromptError> {
                // Mock always returns cancelled to test cancellation handling
                Ok(match self.strategy {
                    PromptCancelStrategy::Reject => PromptOutcome::Cancelled,
                    PromptCancelStrategy::Default => PromptOutcome::Cancelled,
                    PromptCancelStrategy::Undefined => PromptOutcome::Undefined,
                    PromptCancelStrategy::Null => PromptOutcome::NullValue,
                    PromptCancelStrategy::Symbol => PromptOutcome::SymbolCancel,
                })
            }

            fn confirm(
                &self,
                _prompt: &str,
                _default: Option<bool>,
            ) -> Result<PromptOutcome<bool>, PromptError> {
                Ok(match self.strategy {
                    PromptCancelStrategy::Reject => PromptOutcome::Cancelled,
                    PromptCancelStrategy::Default => PromptOutcome::Cancelled,
                    PromptCancelStrategy::Undefined => PromptOutcome::Undefined,
                    PromptCancelStrategy::Null => PromptOutcome::NullValue,
                    PromptCancelStrategy::Symbol => PromptOutcome::SymbolCancel,
                })
            }

            fn select(
                &self,
                _prompt: &str,
                _options: &[&str],
            ) -> Result<PromptOutcome<usize>, PromptError> {
                Ok(match self.strategy {
                    PromptCancelStrategy::Reject => PromptOutcome::Cancelled,
                    PromptCancelStrategy::Default => PromptOutcome::Cancelled,
                    PromptCancelStrategy::Undefined => PromptOutcome::Undefined,
                    PromptCancelStrategy::Null => PromptOutcome::NullValue,
                    PromptCancelStrategy::Symbol => PromptOutcome::SymbolCancel,
                })
            }

            fn multiselect(
                &self,
                _prompt: &str,
                _options: &[&str],
            ) -> Result<PromptOutcome<Vec<usize>>, PromptError> {
                Ok(match self.strategy {
                    PromptCancelStrategy::Reject => PromptOutcome::Cancelled,
                    PromptCancelStrategy::Default => PromptOutcome::Cancelled,
                    PromptCancelStrategy::Undefined => PromptOutcome::Undefined,
                    PromptCancelStrategy::Null => PromptOutcome::NullValue,
                    PromptCancelStrategy::Symbol => PromptOutcome::SymbolCancel,
                })
            }
        }

        let mock = MockPromptProvider {
            strategy: PromptCancelStrategy::Reject,
        };
        let result = mock.text("test", None);
        assert!(result.is_ok());
        assert_eq!(result.unwrap(), PromptOutcome::Cancelled);

        let mock = MockPromptProvider {
            strategy: PromptCancelStrategy::Undefined,
        };
        let result = mock.confirm("test", None);
        assert!(result.is_ok());
        assert_eq!(result.unwrap(), PromptOutcome::Undefined);
    }
}