nu-command 0.112.2

Nushell's built-in 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

use super::clipboard::provider::{Clipboard, create_clipboard};
use crate::viewers::render_value_as_plain_table_text;
use nu_engine::command_prelude::*;

#[derive(Clone)]
pub struct ClipCopy;

impl ClipCopy {
    fn copy_text(
        engine_state: &EngineState,
        stack: &mut Stack,
        input: &Value,
        span: Span,
        config: &nu_protocol::Config,
    ) -> Result<(), ShellError> {
        let text = match input {
            Value::String { val, .. } => val.to_owned(),
            _ => render_value_as_plain_table_text(engine_state, stack, input.clone(), span)?,
        };

        create_clipboard(config, engine_state, stack).copy_text(&text)
    }
}

impl Command for ClipCopy {
    fn name(&self) -> &str {
        "clip copy"
    }

    fn signature(&self) -> Signature {
        Signature::build(self.name())
            .input_output_types(vec![(Type::Any, Type::Any)])
            .switch("show", "Display copied value in the output.", Some('s'))
            .category(Category::System)
    }

    fn description(&self) -> &str {
        "Copy the input into the clipboard."
    }

    fn run(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        call: &Call,
        input: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        let value = input.into_value(call.head)?;
        let config = stack.get_config(engine_state);

        Self::copy_text(engine_state, stack, &value, call.head, &config)?;

        if call.has_flag(engine_state, stack, "show")? {
            Ok(value.into_pipeline_data())
        } else {
            Ok(Value::nothing(call.head).into_pipeline_data())
        }
    }

    fn examples(&self) -> Vec<Example<'_>> {
        vec![
            Example {
                example: "'hello' | clip copy",
                description: "Copy a string to the clipboard.",
                result: None,
            },
            Example {
                example: "$env | clip copy --show",
                description: "Copy a structured value and pass it through.",
                result: None,
            },
            Example {
                example: "ls | clip copy",
                description: "Copy structured values as plain table text without ANSI escape sequences.",
                result: None,
            },
        ]
    }
}