mirror of
https://github.com/nushell/nushell.git
synced 2025-05-23 08:01:18 +00: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
65 lines
1.9 KiB
Rust
65 lines
1.9 KiB
Rust
use nu_plugin::{EngineInterface, EvaluatedCall, PluginCommand};
|
|
use nu_protocol::{Category, Example, LabeledError, PipelineData, Signature, SyntaxShape, Type};
|
|
|
|
use crate::ExamplePlugin;
|
|
|
|
/// `<list> | example for-each { |value| ... }`
|
|
pub struct ForEach;
|
|
|
|
impl PluginCommand for ForEach {
|
|
type Plugin = ExamplePlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"example for-each"
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Example execution of a closure with a stream"
|
|
}
|
|
|
|
fn extra_description(&self) -> &str {
|
|
"Prints each value the closure returns to stderr"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.input_output_type(Type::ListStream, Type::Nothing)
|
|
.required(
|
|
"closure",
|
|
SyntaxShape::Closure(Some(vec![SyntaxShape::Any])),
|
|
"The closure to run for each input value",
|
|
)
|
|
.category(Category::Experimental)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
example: "ls | get name | example for-each { |f| ^file $f }",
|
|
description: "example with an external command",
|
|
result: None,
|
|
}]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_plugin: &ExamplePlugin,
|
|
engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, LabeledError> {
|
|
let closure = call.req(0)?;
|
|
let config = engine.get_config()?;
|
|
for value in input {
|
|
let result = engine.eval_closure(&closure, vec![value.clone()], Some(value))?;
|
|
eprintln!("{}", result.to_expanded_string(", ", &config));
|
|
}
|
|
Ok(PipelineData::Empty)
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn test_examples() -> Result<(), nu_protocol::ShellError> {
|
|
use nu_plugin_test_support::PluginTest;
|
|
PluginTest::new("example", ExamplePlugin.into())?.test_command_examples(&ForEach)
|
|
}
|