mirror of
https://github.com/nushell/nushell.git
synced 2025-04-18 02:08:20 +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
69 lines
1.9 KiB
Rust
69 lines
1.9 KiB
Rust
use nu_engine::command_prelude::*;
|
|
use terminal_size::{terminal_size, Height, Width};
|
|
|
|
#[derive(Clone)]
|
|
pub struct TermSize;
|
|
|
|
impl Command for TermSize {
|
|
fn name(&self) -> &str {
|
|
"term size"
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Returns a record containing the number of columns (width) and rows (height) of the terminal."
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("term size")
|
|
.category(Category::Platform)
|
|
.input_output_types(vec![(
|
|
Type::Nothing,
|
|
Type::Record([("columns".into(), Type::Int), ("rows".into(), Type::Int)].into()),
|
|
)])
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Return the columns (width) and rows (height) of the terminal",
|
|
example: "term size",
|
|
result: None,
|
|
},
|
|
Example {
|
|
description: "Return the columns (width) of the terminal",
|
|
example: "(term size).columns",
|
|
result: None,
|
|
},
|
|
Example {
|
|
description: "Return the rows (height) of the terminal",
|
|
example: "(term size).rows",
|
|
result: None,
|
|
},
|
|
]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let head = call.head;
|
|
|
|
let (cols, rows) = match terminal_size() {
|
|
Some((w, h)) => (Width(w.0), Height(h.0)),
|
|
None => (Width(0), Height(0)),
|
|
};
|
|
|
|
Ok(Value::record(
|
|
record! {
|
|
"columns" => Value::int(cols.0 as i64, head),
|
|
"rows" => Value::int(rows.0 as i64, head),
|
|
},
|
|
head,
|
|
)
|
|
.into_pipeline_data())
|
|
}
|
|
}
|