mirror of
https://github.com/nushell/nushell.git
synced 2025-07-09 10:57:54 +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
59 lines
1.7 KiB
Rust
59 lines
1.7 KiB
Rust
use nu_plugin::{EngineInterface, EvaluatedCall, SimplePluginCommand};
|
|
use nu_protocol::{Category, Example, LabeledError, Signature, Type, Value};
|
|
|
|
use crate::ExamplePlugin;
|
|
|
|
/// `<value> | example view span`
|
|
pub struct ViewSpan;
|
|
|
|
impl SimplePluginCommand for ViewSpan {
|
|
type Plugin = ExamplePlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"example view span"
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Example command for looking up the contents of a parser span"
|
|
}
|
|
|
|
fn extra_description(&self) -> &str {
|
|
"Shows the original source code of the expression that generated the value passed as input."
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.input_output_type(Type::Any, Type::String)
|
|
.category(Category::Experimental)
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["example"]
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
example: "('hello ' ++ 'world') | example view span",
|
|
description: "Show the source code of the expression that generated a value",
|
|
result: Some(Value::test_string("'hello ' ++ 'world'")),
|
|
}]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_plugin: &ExamplePlugin,
|
|
engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
input: &Value,
|
|
) -> Result<Value, LabeledError> {
|
|
let contents = engine.get_span_contents(input.span())?;
|
|
Ok(Value::string(String::from_utf8_lossy(&contents), call.head))
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn test_examples() -> Result<(), nu_protocol::ShellError> {
|
|
use nu_plugin_test_support::PluginTest;
|
|
PluginTest::new("example", ExamplePlugin.into())?.test_command_examples(&ViewSpan)
|
|
}
|