mirror of
https://github.com/nushell/nushell.git
synced 2025-05-14 11:44:35 +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
77 lines
2.2 KiB
Rust
77 lines
2.2 KiB
Rust
use nu_engine::command_prelude::*;
|
|
|
|
#[derive(Clone)]
|
|
pub struct ViewFiles;
|
|
|
|
impl Command for ViewFiles {
|
|
fn name(&self) -> &str {
|
|
"view files"
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"View the files registered in nushell's EngineState memory."
|
|
}
|
|
|
|
fn extra_description(&self) -> &str {
|
|
"These are files parsed and loaded at runtime."
|
|
}
|
|
|
|
fn signature(&self) -> nu_protocol::Signature {
|
|
Signature::build("view files")
|
|
.input_output_types(vec![(
|
|
Type::Nothing,
|
|
Type::Table(
|
|
[
|
|
("filename".into(), Type::String),
|
|
("start".into(), Type::Int),
|
|
("end".into(), Type::Int),
|
|
("size".into(), Type::Int),
|
|
]
|
|
.into(),
|
|
),
|
|
)])
|
|
.category(Category::Debug)
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let mut records = vec![];
|
|
|
|
for file in engine_state.files() {
|
|
let start = file.covered_span.start;
|
|
let end = file.covered_span.end;
|
|
records.push(Value::record(
|
|
record! {
|
|
"filename" => Value::string(&*file.name, call.head),
|
|
"start" => Value::int(start as i64, call.head),
|
|
"end" => Value::int(end as i64, call.head),
|
|
"size" => Value::int(end as i64 - start as i64, call.head),
|
|
},
|
|
call.head,
|
|
));
|
|
}
|
|
|
|
Ok(Value::list(records, call.head).into_pipeline_data())
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "View the files registered in Nushell's EngineState memory",
|
|
example: r#"view files"#,
|
|
result: None,
|
|
},
|
|
Example {
|
|
description: "View how Nushell was originally invoked",
|
|
example: r#"view files | get 0"#,
|
|
result: None,
|
|
},
|
|
]
|
|
}
|
|
}
|