mirror of
https://github.com/nushell/nushell.git
synced 2025-05-20 18:00:49 +02: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.
114 lines
3.3 KiB
Rust
114 lines
3.3 KiB
Rust
use nu_engine::command_prelude::*;
|
|
use reedline::{
|
|
get_reedline_edit_commands, get_reedline_keybinding_modifiers, get_reedline_keycodes,
|
|
get_reedline_prompt_edit_modes, get_reedline_reedline_events,
|
|
};
|
|
|
|
#[derive(Clone)]
|
|
pub struct KeybindingsList;
|
|
|
|
impl Command for KeybindingsList {
|
|
fn name(&self) -> &str {
|
|
"keybindings list"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.input_output_types(vec![(Type::Nothing, Type::Table(vec![]))])
|
|
.switch("modifiers", "list of modifiers", Some('m'))
|
|
.switch("keycodes", "list of keycodes", Some('k'))
|
|
.switch("modes", "list of edit modes", Some('o'))
|
|
.switch("events", "list of reedline event", Some('e'))
|
|
.switch("edits", "list of edit commands", Some('d'))
|
|
.category(Category::Platform)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"List available options that can be used to create keybindings."
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Get list of key modifiers",
|
|
example: "keybindings list --modifiers",
|
|
result: None,
|
|
},
|
|
Example {
|
|
description: "Get list of reedline events and edit commands",
|
|
example: "keybindings list -e -d",
|
|
result: None,
|
|
},
|
|
Example {
|
|
description: "Get list with all the available options",
|
|
example: "keybindings list",
|
|
result: None,
|
|
},
|
|
]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let records = if call.named_len() == 0 {
|
|
let all_options = ["modifiers", "keycodes", "edits", "modes", "events"];
|
|
all_options
|
|
.iter()
|
|
.flat_map(|argument| get_records(argument, call.head))
|
|
.collect()
|
|
} else {
|
|
call.named_iter()
|
|
.flat_map(|(argument, _, _)| get_records(argument.item.as_str(), call.head))
|
|
.collect()
|
|
};
|
|
|
|
Ok(Value::list(records, call.head).into_pipeline_data())
|
|
}
|
|
}
|
|
|
|
fn get_records(entry_type: &str, span: Span) -> Vec<Value> {
|
|
let values = match entry_type {
|
|
"modifiers" => get_reedline_keybinding_modifiers().sorted(),
|
|
"keycodes" => get_reedline_keycodes().sorted(),
|
|
"edits" => get_reedline_edit_commands().sorted(),
|
|
"modes" => get_reedline_prompt_edit_modes().sorted(),
|
|
"events" => get_reedline_reedline_events().sorted(),
|
|
_ => Vec::new(),
|
|
};
|
|
|
|
values
|
|
.iter()
|
|
.map(|edit| edit.split('\n'))
|
|
.flat_map(|edit| edit.map(|edit| convert_to_record(edit, entry_type, span)))
|
|
.collect()
|
|
}
|
|
|
|
fn convert_to_record(edit: &str, entry_type: &str, span: Span) -> Value {
|
|
Value::record(
|
|
record! {
|
|
"type" => Value::string(entry_type, span),
|
|
"name" => Value::string(edit, span),
|
|
},
|
|
span,
|
|
)
|
|
}
|
|
|
|
// Helper to sort a vec and return a vec
|
|
trait SortedImpl {
|
|
fn sorted(self) -> Self;
|
|
}
|
|
|
|
impl<E> SortedImpl for Vec<E>
|
|
where
|
|
E: std::cmp::Ord,
|
|
{
|
|
fn sorted(mut self) -> Self {
|
|
self.sort();
|
|
self
|
|
}
|
|
}
|