nu-cli 0.112.1

CLI-related functionality for Nushell
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

use std::sync::Arc;

use nu_engine::command_prelude::*;
use reedline::{Highlighter, StyledText};

use crate::syntax_highlight::highlight_syntax;

#[derive(Clone)]
pub struct NuHighlight;

impl Command for NuHighlight {
    fn name(&self) -> &str {
        "nu-highlight"
    }

    fn signature(&self) -> Signature {
        Signature::build("nu-highlight")
            .category(Category::Strings)
            .switch(
                "reject-garbage",
                "Return an error if invalid syntax (garbage) was encountered.",
                Some('r'),
            )
            .input_output_types(vec![(Type::String, Type::String)])
    }

    fn description(&self) -> &str {
        "Syntax highlight the input string."
    }

    fn search_terms(&self) -> Vec<&str> {
        vec!["syntax", "color", "convert"]
    }

    fn run(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        call: &Call,
        input: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        let reject_garbage = call.has_flag(engine_state, stack, "reject-garbage")?;
        let head = call.head;

        let signals = engine_state.signals();

        let engine_state = Arc::new(engine_state.clone());
        let stack = Arc::new(stack.clone());

        input.map(
            move |x| match x.coerce_into_string() {
                Ok(line) => {
                    let result = highlight_syntax(&engine_state, &stack, &line, line.len());

                    let highlights = match (reject_garbage, result.found_garbage) {
                        (false, _) => result.text,
                        (true, None) => result.text,
                        (true, Some(span)) => {
                            let error = ShellError::OutsideSpannedLabeledError {
                                src: line,
                                error: "encountered invalid syntax while highlighting".into(),
                                msg: "invalid syntax".into(),
                                span,
                            };
                            return Value::error(error, head);
                        }
                    };

                    Value::string(highlights.render_simple(), head)
                }
                Err(err) => Value::error(err, head),
            },
            signals,
        )
    }

    fn examples(&self) -> Vec<Example<'_>> {
        vec![Example {
            description: "Describe the type of a string",
            example: "'let x = 3' | nu-highlight",
            result: None,
        }]
    }
}

/// A highlighter that does nothing
///
/// Used to remove highlighting from a reedline instance
/// (letting NuHighlighter structs be dropped)
#[derive(Default)]
pub struct NoOpHighlighter {}

impl Highlighter for NoOpHighlighter {
    fn highlight(&self, _line: &str, _cursor: usize) -> reedline::StyledText {
        StyledText::new()
    }
}