mirror of
https://github.com/nushell/nushell.git
synced 2025-04-29 23:54:26 +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
93 lines
2.5 KiB
Rust
93 lines
2.5 KiB
Rust
use nu_engine::{command_prelude::*, eval_block};
|
|
use nu_protocol::{debugger::WithoutDebug, engine::Closure};
|
|
|
|
#[derive(Clone)]
|
|
pub struct WithEnv;
|
|
|
|
impl Command for WithEnv {
|
|
fn name(&self) -> &str {
|
|
"with-env"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("with-env")
|
|
.input_output_types(vec![(Type::Any, Type::Any)])
|
|
.required(
|
|
"variable",
|
|
SyntaxShape::Any,
|
|
"The environment variable to temporarily set.",
|
|
)
|
|
.required(
|
|
"block",
|
|
SyntaxShape::Closure(None),
|
|
"The block to run once the variable is set.",
|
|
)
|
|
.category(Category::Env)
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Runs a block with an environment variable set."
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
with_env(engine_state, stack, call, input)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description: "Set by key-value record",
|
|
example: r#"with-env {X: "Y", W: "Z"} { [$env.X $env.W] }"#,
|
|
result: Some(Value::list(
|
|
vec![Value::test_string("Y"), Value::test_string("Z")],
|
|
Span::test_data(),
|
|
)),
|
|
}]
|
|
}
|
|
}
|
|
|
|
fn with_env(
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let env: Record = call.req(engine_state, stack, 0)?;
|
|
let capture_block: Closure = call.req(engine_state, stack, 1)?;
|
|
let block = engine_state.get_block(capture_block.block_id);
|
|
let mut stack = stack.captures_to_stack_preserve_out_dest(capture_block.captures);
|
|
|
|
// TODO: factor list of prohibited env vars into common place
|
|
for prohibited in ["PWD", "FILE_PWD", "CURRENT_FILE"] {
|
|
if env.contains(prohibited) {
|
|
return Err(ShellError::AutomaticEnvVarSetManually {
|
|
envvar_name: prohibited.into(),
|
|
span: call.head,
|
|
});
|
|
}
|
|
}
|
|
|
|
for (k, v) in env {
|
|
stack.add_env_var(k, v);
|
|
}
|
|
|
|
eval_block::<WithoutDebug>(engine_state, &mut stack, block, input)
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(WithEnv {})
|
|
}
|
|
}
|