mirror of
https://github.com/nushell/nushell.git
synced 2025-05-29 11:01:19 +00:00
c747ec75c9
# Description
When implementing a `Command`, one must also import all the types
present in the function signatures for `Command`. This makes it so that
we often import the same set of types in each command implementation
file. E.g., something like this:
```rust
use nu_protocol::ast::Call;
use nu_protocol::engine::{Command, EngineState, Stack};
use nu_protocol::{
record, Category, Example, IntoInterruptiblePipelineData, IntoPipelineData, PipelineData,
ShellError, Signature, Span, Type, Value,
};
```
This PR adds the `nu_engine::command_prelude` module which contains the
necessary and commonly used types to implement a `Command`:
```rust
// command_prelude.rs
pub use crate::CallExt;
pub use nu_protocol::{
ast::{Call, CellPath},
engine::{Command, EngineState, Stack},
record, Category, Example, IntoInterruptiblePipelineData, IntoPipelineData, IntoSpanned,
PipelineData, Record, ShellError, Signature, Span, Spanned, SyntaxShape, Type, Value,
};
```
This should reduce the boilerplate needed to implement a command and
also gives us a place to track the breadth of the `Command` API. I tried
to be conservative with what went into the prelude modules, since it
might be hard/annoying to remove items from the prelude in the future.
Let me know if something should be included or excluded.
74 lines
2.1 KiB
Rust
74 lines
2.1 KiB
Rust
use nu_engine::command_prelude::*;
|
|
|
|
#[derive(Clone)]
|
|
pub struct ViewFiles;
|
|
|
|
impl Command for ViewFiles {
|
|
fn name(&self) -> &str {
|
|
"view files"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"View the files registered in nushell's EngineState memory."
|
|
}
|
|
|
|
fn extra_usage(&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(vec![
|
|
("filename".into(), Type::String),
|
|
("start".into(), Type::Int),
|
|
("end".into(), Type::Int),
|
|
("size".into(), Type::Int),
|
|
]),
|
|
)])
|
|
.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,
|
|
},
|
|
]
|
|
}
|
|
}
|