mirror of
https://github.com/nushell/nushell.git
synced 2025-06-08 11:06:55 +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
94 lines
2.6 KiB
Rust
94 lines
2.6 KiB
Rust
use nu_engine::command_prelude::*;
|
|
|
|
#[derive(Clone)]
|
|
pub struct Debug;
|
|
|
|
impl Command for Debug {
|
|
fn name(&self) -> &str {
|
|
"debug"
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Debug print the value(s) piped in."
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("debug")
|
|
.input_output_types(vec![
|
|
(
|
|
Type::List(Box::new(Type::Any)),
|
|
Type::List(Box::new(Type::String)),
|
|
),
|
|
(Type::Any, Type::String),
|
|
])
|
|
.category(Category::Debug)
|
|
.switch("raw", "Prints the raw value representation", Some('r'))
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let head = call.head;
|
|
let config = stack.get_config(engine_state);
|
|
let raw = call.has_flag(engine_state, stack, "raw")?;
|
|
|
|
// Should PipelineData::Empty result in an error here?
|
|
|
|
input.map(
|
|
move |x| {
|
|
if raw {
|
|
Value::string(x.to_debug_string(), head)
|
|
} else {
|
|
Value::string(x.to_expanded_string(", ", &config), head)
|
|
}
|
|
},
|
|
engine_state.signals(),
|
|
)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Debug print a string",
|
|
example: "'hello' | debug",
|
|
result: Some(Value::test_string("hello")),
|
|
},
|
|
Example {
|
|
description: "Debug print a list",
|
|
example: "['hello'] | debug",
|
|
result: Some(Value::list(
|
|
vec![Value::test_string("hello")],
|
|
Span::test_data(),
|
|
)),
|
|
},
|
|
Example {
|
|
description: "Debug print a table",
|
|
example:
|
|
"[[version patch]; ['0.1.0' false] ['0.1.1' true] ['0.2.0' false]] | debug",
|
|
result: Some(Value::list(
|
|
vec![
|
|
Value::test_string("{version: 0.1.0, patch: false}"),
|
|
Value::test_string("{version: 0.1.1, patch: true}"),
|
|
Value::test_string("{version: 0.2.0, patch: false}"),
|
|
],
|
|
Span::test_data(),
|
|
)),
|
|
},
|
|
]
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
#[test]
|
|
fn test_examples() {
|
|
use super::Debug;
|
|
use crate::test_examples;
|
|
test_examples(Debug {})
|
|
}
|
|
}
|