nu-cmd-lang 0.112.2

Nushell's core language commands
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

use nu_engine::command_prelude::*;

#[derive(Clone)]
pub struct AttrComplete;

impl Command for AttrComplete {
    fn name(&self) -> &str {
        "attr complete"
    }

    fn signature(&self) -> Signature {
        Signature::build("attr complete")
            .input_output_type(Type::Nothing, Type::String)
            .allow_variants_without_examples(true)
            .required(
                "completer",
                SyntaxShape::String,
                "Name of the completion command.",
            )
            .category(Category::Core)
    }

    fn description(&self) -> &str {
        "Attribute for using another command as a completion source for all arguments."
    }

    fn run(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        call: &Call,
        _input: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        let arg: Spanned<String> = call.req(engine_state, stack, 0)?;
        run_impl(arg)
    }

    fn run_const(
        &self,
        working_set: &StateWorkingSet,
        call: &Call,
        _input: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        let arg: Spanned<String> = call.req_const(working_set, 0)?;
        run_impl(arg)
    }

    fn is_const(&self) -> bool {
        true
    }

    fn examples(&self) -> Vec<Example<'_>> {
        vec![Example {
            description: "Use another command as completion source.",
            example: "\
                def complete-foo [spans: list<string>] {\n    \
                    [bar baz qux spam eggs] | where $it not-in $spans\n\
                }\n\n\
                @complete 'complete-foo'\n\
                def foo [...args] { $args }\
            ",
            result: None,
        }]
    }
}

fn run_impl(Spanned { item, span }: Spanned<String>) -> Result<PipelineData, ShellError> {
    Ok(Value::string(item, span).into_pipeline_data())
}

#[derive(Clone)]
pub struct AttrCompleteExternal;

impl Command for AttrCompleteExternal {
    fn name(&self) -> &str {
        "attr complete external"
    }

    fn signature(&self) -> Signature {
        Signature::build("attr complete external")
            .input_output_type(Type::Nothing, Type::Nothing)
            .allow_variants_without_examples(true)
            .category(Category::Core)
    }

    fn description(&self) -> &str {
        "Attribute for enabling use of the external completer for internal commands."
    }

    fn run(
        &self,
        _: &EngineState,
        _: &mut Stack,
        _: &Call,
        _: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        Ok(PipelineData::empty())
    }

    fn run_const(
        &self,
        _: &StateWorkingSet,
        _: &Call,
        _: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        Ok(PipelineData::empty())
    }

    fn is_const(&self) -> bool {
        true
    }

    fn examples(&self) -> Vec<Example<'_>> {
        vec![Example {
            description: "Use the external completer for a wrapper command.",
            example: "\
                @complete external\n\
                def --wrapped jc [...args] {\n    \
                    ^jc ...$args | from json\n\
                }\
            ",
            result: None,
        }]
    }
}