mirror of
https://github.com/nushell/nushell.git
synced 2025-07-08 02:17:22 +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
77 lines
2.1 KiB
Rust
77 lines
2.1 KiB
Rust
use super::hex::{operate, ActionType};
|
|
use nu_engine::command_prelude::*;
|
|
|
|
#[derive(Clone)]
|
|
pub struct DecodeHex;
|
|
|
|
impl Command for DecodeHex {
|
|
fn name(&self) -> &str {
|
|
"decode hex"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("decode hex")
|
|
.input_output_types(vec![
|
|
(Type::String, Type::Binary),
|
|
(
|
|
Type::List(Box::new(Type::String)),
|
|
Type::List(Box::new(Type::Binary)),
|
|
),
|
|
(Type::table(), Type::table()),
|
|
(Type::record(), Type::record()),
|
|
])
|
|
.allow_variants_without_examples(true)
|
|
.rest(
|
|
"rest",
|
|
SyntaxShape::CellPath,
|
|
"For a data structure input, decode data at the given cell paths",
|
|
)
|
|
.category(Category::Formats)
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Hex decode a value."
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Hex decode a value and output as binary",
|
|
example: "'0102030A0a0B' | decode hex",
|
|
result: Some(Value::binary(
|
|
[0x01, 0x02, 0x03, 0x0A, 0x0A, 0x0B],
|
|
Span::test_data(),
|
|
)),
|
|
},
|
|
Example {
|
|
description: "Whitespaces are allowed to be between hex digits",
|
|
example: "'01 02 03 0A 0a 0B' | decode hex",
|
|
result: Some(Value::binary(
|
|
[0x01, 0x02, 0x03, 0x0A, 0x0A, 0x0B],
|
|
Span::test_data(),
|
|
)),
|
|
},
|
|
]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
operate(ActionType::Decode, engine_state, stack, call, input)
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
crate::test_examples(DecodeHex)
|
|
}
|
|
}
|