mirror of
https://github.com/nushell/nushell.git
synced 2025-04-30 16:14:27 +02:00
a5c604c283
# Description Working on uniformizing the ending messages regarding methods usage() and extra_usage(). This is related to the issue https://github.com/nushell/nushell/issues/5066 after discussing it with @jntrnr # User-Facing Changes None. # Tests + Formatting Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass # After Submitting If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date.
77 lines
2.1 KiB
Rust
77 lines
2.1 KiB
Rust
use nu_protocol::ast::Call;
|
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
|
use nu_protocol::{
|
|
Category, Example, IntoPipelineData, PipelineData, ShellError, Signature, Type, Value,
|
|
};
|
|
use terminal_size::{terminal_size, Height, Width};
|
|
|
|
#[derive(Clone)]
|
|
pub struct TermSize;
|
|
|
|
impl Command for TermSize {
|
|
fn name(&self) -> &str {
|
|
"term size"
|
|
}
|
|
|
|
fn usage(&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(vec![
|
|
("columns".into(), Type::Int),
|
|
("rows".into(), Type::Int),
|
|
]),
|
|
)])
|
|
}
|
|
|
|
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 {
|
|
cols: vec!["columns".into(), "rows".into()],
|
|
vals: vec![
|
|
Value::int(cols.0 as i64, head),
|
|
Value::int(rows.0 as i64, head),
|
|
],
|
|
span: head,
|
|
}
|
|
.into_pipeline_data())
|
|
}
|
|
}
|