mirror of
https://github.com/nushell/nushell.git
synced 2025-05-02 00:54:25 +02:00
95b78eee25
# Description
The meaning of the word usage is specific to describing how a command
function is *used* and not a synonym for general description. Usage can
be used to describe the SYNOPSIS or EXAMPLES sections of a man page
where the permitted argument combinations are shown or example *uses*
are given.
Let's not confuse people and call it what it is a description.
Our `help` command already creates its own *Usage* section based on the
available arguments and doesn't refer to the description with usage.
# User-Facing Changes
`help commands` and `scope commands` will now use `description` or
`extra_description`
`usage`-> `description`
`extra_usage` -> `extra_description`
Breaking change in the plugin protocol:
In the signature record communicated with the engine.
`usage`-> `description`
`extra_usage` -> `extra_description`
The same rename also takes place for the methods on
`SimplePluginCommand` and `PluginCommand`
# Tests + Formatting
- Updated plugin protocol specific changes
# After Submitting
- [ ] update plugin protocol doc
97 lines
2.7 KiB
Rust
97 lines
2.7 KiB
Rust
use nu_engine::command_prelude::*;
|
|
|
|
#[derive(Clone)]
|
|
pub struct LoadEnv;
|
|
|
|
impl Command for LoadEnv {
|
|
fn name(&self) -> &str {
|
|
"load-env"
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Loads an environment update from a record."
|
|
}
|
|
|
|
fn signature(&self) -> nu_protocol::Signature {
|
|
Signature::build("load-env")
|
|
.input_output_types(vec![
|
|
(Type::record(), Type::Nothing),
|
|
(Type::Nothing, Type::Nothing),
|
|
])
|
|
.allow_variants_without_examples(true)
|
|
.optional(
|
|
"update",
|
|
SyntaxShape::Record(vec![]),
|
|
"The record to use for updates.",
|
|
)
|
|
.category(Category::FileSystem)
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let arg: Option<Record> = call.opt(engine_state, stack, 0)?;
|
|
let span = call.head;
|
|
|
|
let record = match arg {
|
|
Some(record) => record,
|
|
None => match input {
|
|
PipelineData::Value(Value::Record { val, .. }, ..) => val.into_owned(),
|
|
_ => {
|
|
return Err(ShellError::UnsupportedInput {
|
|
msg: "'load-env' expects a single record".into(),
|
|
input: "value originated from here".into(),
|
|
msg_span: span,
|
|
input_span: input.span().unwrap_or(span),
|
|
})
|
|
}
|
|
},
|
|
};
|
|
|
|
for prohibited in ["FILE_PWD", "CURRENT_FILE", "PWD"] {
|
|
if record.contains(prohibited) {
|
|
return Err(ShellError::AutomaticEnvVarSetManually {
|
|
envvar_name: prohibited.to_string(),
|
|
span: call.head,
|
|
});
|
|
}
|
|
}
|
|
|
|
for (env_var, rhs) in record {
|
|
stack.add_env_var(env_var, rhs);
|
|
}
|
|
Ok(PipelineData::empty())
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Load variables from an input stream",
|
|
example: r#"{NAME: ABE, AGE: UNKNOWN} | load-env; $env.NAME"#,
|
|
result: Some(Value::test_string("ABE")),
|
|
},
|
|
Example {
|
|
description: "Load variables from an argument",
|
|
example: r#"load-env {NAME: ABE, AGE: UNKNOWN}; $env.NAME"#,
|
|
result: Some(Value::test_string("ABE")),
|
|
},
|
|
]
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::LoadEnv;
|
|
|
|
#[test]
|
|
fn examples_work_as_expected() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(LoadEnv {})
|
|
}
|
|
}
|