mirror of
https://github.com/nushell/nushell
synced 2025-01-16 15:14:26 +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
67 lines
1.6 KiB
Rust
67 lines
1.6 KiB
Rust
use nu_engine::command_prelude::*;
|
|
|
|
#[derive(Clone)]
|
|
pub struct Whoami;
|
|
|
|
impl Command for Whoami {
|
|
fn name(&self) -> &str {
|
|
"whoami"
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Get the current username using uutils/coreutils whoami."
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("whoami")
|
|
.input_output_types(vec![(Type::Nothing, Type::String)])
|
|
.allow_variants_without_examples(true)
|
|
.category(Category::Platform)
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["username", "coreutils"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let output = match uu_whoami::whoami() {
|
|
Ok(username) => username.to_string_lossy().to_string(),
|
|
Err(e) => {
|
|
return Err(ShellError::GenericError {
|
|
error: "Failed to get username".into(),
|
|
msg: e.to_string(),
|
|
span: Some(call.head),
|
|
help: None,
|
|
inner: vec![],
|
|
})
|
|
}
|
|
};
|
|
|
|
Ok(Value::string(output, call.head).into_pipeline_data())
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description: "Get the current username",
|
|
example: "whoami",
|
|
result: None,
|
|
}]
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::Whoami;
|
|
|
|
#[test]
|
|
fn examples_work_as_expected() {
|
|
use crate::test_examples;
|
|
test_examples(Whoami {})
|
|
}
|
|
}
|