nu_command/env/config/
config_.rs

1use nu_cmd_base::util::get_editor;
2use nu_engine::{command_prelude::*, env_to_strings, get_full_help};
3use nu_protocol::{PipelineMetadata, shell_error::io::IoError};
4use nu_system::ForegroundChild;
5use nu_utils::ConfigFileKind;
6
7#[cfg(feature = "os")]
8use nu_protocol::process::PostWaitCallback;
9
10#[derive(Clone)]
11pub struct ConfigMeta;
12
13impl Command for ConfigMeta {
14    fn name(&self) -> &str {
15        "config"
16    }
17
18    fn signature(&self) -> Signature {
19        Signature::build(self.name())
20            .category(Category::Env)
21            .input_output_types(vec![(Type::Nothing, Type::String)])
22    }
23
24    fn description(&self) -> &str {
25        "Edit nushell configuration files."
26    }
27
28    fn extra_description(&self) -> &str {
29        "You must use one of the following subcommands. Using this command as-is will only produce this help message."
30    }
31
32    fn run(
33        &self,
34        engine_state: &EngineState,
35        stack: &mut Stack,
36        call: &Call,
37        _input: PipelineData,
38    ) -> Result<PipelineData, ShellError> {
39        Ok(Value::string(get_full_help(self, engine_state, stack), call.head).into_pipeline_data())
40    }
41
42    fn search_terms(&self) -> Vec<&str> {
43        vec!["options", "setup"]
44    }
45}
46
47#[cfg(not(feature = "os"))]
48pub(super) fn start_editor(
49    _: ConfigFileKind,
50    _: &EngineState,
51    _: &mut Stack,
52    call: &Call,
53) -> Result<PipelineData, ShellError> {
54    Err(ShellError::DisabledOsSupport {
55        msg: "Running external commands is not available without OS support.".to_string(),
56        span: call.head,
57    })
58}
59
60#[cfg(feature = "os")]
61pub(super) fn start_editor(
62    kind: ConfigFileKind,
63    engine_state: &EngineState,
64    stack: &mut Stack,
65    call: &Call,
66) -> Result<PipelineData, ShellError> {
67    // Find the editor executable.
68
69    let (editor_name, editor_args) = get_editor(engine_state, stack, call.head)?;
70    let paths = nu_engine::env::path_str(engine_state, stack, call.head)?;
71    let cwd = engine_state.cwd(Some(stack))?;
72    let editor_executable =
73        crate::which(&editor_name, &paths, cwd.as_ref()).ok_or(ShellError::ExternalCommand {
74            label: format!("`{editor_name}` not found"),
75            help: "Failed to find the editor executable".into(),
76            span: call.head,
77        })?;
78
79    let nu_const_path = kind.nu_const_path();
80    let Some(config_path) = engine_state.get_config_path(nu_const_path) else {
81        return Err(ShellError::GenericError {
82            error: format!("Could not find $nu.{nu_const_path}"),
83            msg: format!("Could not find $nu.{nu_const_path}"),
84            span: None,
85            help: None,
86            inner: vec![],
87        });
88    };
89    let config_path = config_path.to_string_lossy().to_string();
90
91    // Create the command.
92    let mut command = std::process::Command::new(editor_executable);
93
94    // Configure PWD.
95    command.current_dir(cwd);
96
97    // Configure environment variables.
98    let envs = env_to_strings(engine_state, stack)?;
99    command.env_clear();
100    command.envs(envs);
101
102    // Configure args.
103    command.arg(config_path);
104    command.args(editor_args);
105
106    // Spawn the child process. On Unix, also put the child process to
107    // foreground if we're in an interactive session.
108    #[cfg(windows)]
109    let child = ForegroundChild::spawn(command);
110    #[cfg(unix)]
111    let child = ForegroundChild::spawn(
112        command,
113        engine_state.is_interactive,
114        engine_state.is_background_job(),
115        &engine_state.pipeline_externals_state,
116    );
117
118    let child = child.map_err(|err| {
119        IoError::new_with_additional_context(
120            err,
121            call.head,
122            None,
123            "Could not spawn foreground child",
124        )
125    })?;
126
127    let post_wait_callback = PostWaitCallback::for_job_control(engine_state, None, None);
128
129    // Wrap the output into a `PipelineData::byte_stream`.
130    let child = nu_protocol::process::ChildProcess::new(
131        child,
132        None,
133        false,
134        call.head,
135        Some(post_wait_callback),
136    )?;
137
138    Ok(PipelineData::byte_stream(
139        ByteStream::child(child, call.head),
140        None,
141    ))
142}
143
144pub(super) fn handle_call(
145    kind: ConfigFileKind,
146    engine_state: &EngineState,
147    stack: &mut Stack,
148    call: &Call,
149) -> Result<PipelineData, ShellError> {
150    let default_flag = call.has_flag(engine_state, stack, "default")?;
151    let doc_flag = call.has_flag(engine_state, stack, "doc")?;
152
153    Ok(match (default_flag, doc_flag) {
154        (false, false) => {
155            return super::config_::start_editor(kind, engine_state, stack, call);
156        }
157        (true, true) => {
158            return Err(ShellError::IncompatibleParameters {
159                left_message: "can't use `--default` at the same time".into(),
160                left_span: call.get_flag_span(stack, "default").expect("has flag"),
161                right_message: "because of `--doc`".into(),
162                right_span: call.get_flag_span(stack, "doc").expect("has flag"),
163            });
164        }
165        (true, false) => kind.default(),
166        (false, true) => kind.doc(),
167    }
168    .into_value(call.head)
169    .into_pipeline_data_with_metadata(
170        PipelineMetadata::default().with_content_type(Some("application/x-nuscript".into())),
171    ))
172}
nu_command/env/config/config_.rs

nu_command/env/config/
config_.rs
