forked from extern/nushell
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
47 lines
1.3 KiB
Rust
47 lines
1.3 KiB
Rust
use crate::GStat;
|
|
use nu_plugin::{EngineInterface, EvaluatedCall, Plugin, PluginCommand, SimplePluginCommand};
|
|
use nu_protocol::{Category, LabeledError, Signature, Spanned, SyntaxShape, Value};
|
|
|
|
pub struct GStatPlugin;
|
|
|
|
impl Plugin for GStatPlugin {
|
|
fn version(&self) -> String {
|
|
env!("CARGO_PKG_VERSION").into()
|
|
}
|
|
|
|
fn commands(&self) -> Vec<Box<dyn PluginCommand<Plugin = Self>>> {
|
|
vec![Box::new(GStat)]
|
|
}
|
|
}
|
|
|
|
impl SimplePluginCommand for GStat {
|
|
type Plugin = GStatPlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"gstat"
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Get the git status of a repo"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(PluginCommand::name(self))
|
|
.optional("path", SyntaxShape::Filepath, "path to repo")
|
|
.category(Category::Custom("prompt".to_string()))
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_plugin: &GStatPlugin,
|
|
engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
input: &Value,
|
|
) -> Result<Value, LabeledError> {
|
|
let repo_path: Option<Spanned<String>> = call.opt(0)?;
|
|
// eprintln!("input value: {:#?}", &input);
|
|
let current_dir = engine.get_current_dir()?;
|
|
self.gstat(input, ¤t_dir, repo_path, call.head)
|
|
}
|
|
}
|