forked from extern/nushell
Add cursor shape configuration for each edit mode (#7745)
# Description
This PR allows the configuration of cursor shapes in nushell for each
edit mode. This is the change that is in the default_config.nu file.
```
cursor_shape: {
emacs: line # block, underscore, line (line is the default)
vi_insert: block # block, underscore, line (block is the default)
vi_normal: underscore # block, underscore, line (underscore is the default)
}
```
# User-Facing Changes
See above. If you'd prefer a different default, please speak up and let
us know.
# 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.
This commit is contained in:
Darren Schroeder
GitHub
@@ -10,18 +10,21 @@ version = "0.74.1"
|
||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||
|
||||
[dependencies]
|
||||
nu-utils = { path = "../nu-utils", version = "0.74.1" }
|
||||
nu-json = { path = "../nu-json", version = "0.74.1" }
|
||||
nu-utils = { path = "../nu-utils", version = "0.74.1" }
|
||||
nu-json = { path = "../nu-json", version = "0.74.1" }
|
||||
|
||||
byte-unit = "4.0.9"
|
||||
chrono = { version="0.4.23", features= ["serde", "std"], default-features = false }
|
||||
chrono = { version = "0.4.23", features = [
|
||||
"serde",
|
||||
"std",
|
||||
], default-features = false }
|
||||
chrono-humanize = "0.2.1"
|
||||
fancy-regex = "0.10.0"
|
||||
indexmap = { version="1.7" }
|
||||
lru = "0.8.1"
|
||||
fancy-regex = "0.11.0"
|
||||
indexmap = { version = "1.7" }
|
||||
lru = "0.9.0"
|
||||
miette = { version = "5.1.0", features = ["fancy-no-backtrace"] }
|
||||
num-format = "0.4.3"
|
||||
serde = {version = "1.0.143", default-features = false }
|
||||
serde = { version = "1.0.143", default-features = false }
|
||||
serde_json = { version = "1.0", optional = true }
|
||||
strum = "0.24"
|
||||
strum_macros = "0.24"
|
||||
@@ -34,4 +37,4 @@ plugin = ["serde_json"]
|
||||
|
||||
[dev-dependencies]
|
||||
serde_json = "1.0"
|
||||
nu-test-support = { path = "../nu-test-support", version = "0.74.1" }
|
||||
nu-test-support = { path = "../nu-test-support", version = "0.74.1" }
|
||||
|
||||
@@ -52,6 +52,14 @@ impl Default for Hooks {
|
||||
}
|
||||
}
|
||||
|
||||
/// Definition of a Nushell CursorShape (to be mapped to crossterm::cursor::CursorShape)
|
||||
#[derive(Serialize, Deserialize, Clone, Debug, Copy)]
|
||||
pub enum NuCursorShape {
|
||||
UnderScore,
|
||||
Line,
|
||||
Block,
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize, Clone, Debug)]
|
||||
pub struct Config {
|
||||
pub external_completer: Option<usize>,
|
||||
@@ -88,6 +96,9 @@ pub struct Config {
|
||||
pub show_clickable_links_in_ls: bool,
|
||||
pub render_right_prompt_on_last_line: bool,
|
||||
pub explore: HashMap<String, Value>,
|
||||
pub cursor_shape_vi_insert: NuCursorShape,
|
||||
pub cursor_shape_vi_normal: NuCursorShape,
|
||||
pub cursor_shape_emacs: NuCursorShape,
|
||||
}
|
||||
|
||||
impl Default for Config {
|
||||
@@ -127,6 +138,9 @@ impl Default for Config {
|
||||
show_clickable_links_in_ls: true,
|
||||
render_right_prompt_on_last_line: false,
|
||||
explore: HashMap::new(),
|
||||
cursor_shape_vi_insert: NuCursorShape::Block,
|
||||
cursor_shape_vi_normal: NuCursorShape::UnderScore,
|
||||
cursor_shape_emacs: NuCursorShape::Line,
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -628,6 +642,156 @@ impl Value {
|
||||
);
|
||||
}
|
||||
}
|
||||
"cursor_shape" => {
|
||||
macro_rules! reconstruct_cursor_shape {
|
||||
($name:expr, $span:expr) => {
|
||||
Value::string(
|
||||
match $name {
|
||||
NuCursorShape::Line => "line",
|
||||
NuCursorShape::Block => "block",
|
||||
NuCursorShape::UnderScore => "underscore",
|
||||
},
|
||||
*$span,
|
||||
)
|
||||
};
|
||||
}
|
||||
if let Value::Record { cols, vals, span } = &mut vals[index] {
|
||||
for index in (0..cols.len()).rev() {
|
||||
let value = &vals[index];
|
||||
let key2 = cols[index].as_str();
|
||||
match key2 {
|
||||
"vi_insert" => {
|
||||
if let Ok(v) = value.as_string() {
|
||||
let val_str = v.to_lowercase();
|
||||
match val_str.as_ref() {
|
||||
"line" => {
|
||||
config.cursor_shape_vi_insert =
|
||||
NuCursorShape::Line;
|
||||
}
|
||||
"block" => {
|
||||
config.cursor_shape_vi_insert =
|
||||
NuCursorShape::Block;
|
||||
}
|
||||
"underscore" => {
|
||||
config.cursor_shape_vi_insert =
|
||||
NuCursorShape::UnderScore;
|
||||
}
|
||||
_ => {
|
||||
invalid!(Some(*span),
|
||||
"unrecognized $env.config.{key}.{key2} '{val_str}'; expected either 'line', 'block', or 'underscore'"
|
||||
);
|
||||
// Reconstruct
|
||||
vals[index] = reconstruct_cursor_shape!(
|
||||
config.cursor_shape_vi_insert,
|
||||
span
|
||||
);
|
||||
}
|
||||
};
|
||||
} else {
|
||||
invalid!(Some(*span), "should be a string");
|
||||
// Reconstruct
|
||||
vals[index] = reconstruct_cursor_shape!(
|
||||
config.cursor_shape_vi_insert,
|
||||
span
|
||||
);
|
||||
}
|
||||
}
|
||||
"vi_normal" => {
|
||||
if let Ok(v) = value.as_string() {
|
||||
let val_str = v.to_lowercase();
|
||||
match val_str.as_ref() {
|
||||
"line" => {
|
||||
config.cursor_shape_vi_normal =
|
||||
NuCursorShape::Line;
|
||||
}
|
||||
"block" => {
|
||||
config.cursor_shape_vi_normal =
|
||||
NuCursorShape::Block;
|
||||
}
|
||||
"underscore" => {
|
||||
config.cursor_shape_vi_normal =
|
||||
NuCursorShape::UnderScore;
|
||||
}
|
||||
_ => {
|
||||
invalid!(Some(*span),
|
||||
"unrecognized $env.config.{key}.{key2} '{val_str}'; expected either 'line', 'block', or 'underscore'"
|
||||
);
|
||||
// Reconstruct
|
||||
vals[index] = reconstruct_cursor_shape!(
|
||||
config.cursor_shape_vi_normal,
|
||||
span
|
||||
);
|
||||
}
|
||||
};
|
||||
} else {
|
||||
invalid!(Some(*span), "should be a string");
|
||||
// Reconstruct
|
||||
vals[index] = reconstruct_cursor_shape!(
|
||||
config.cursor_shape_vi_normal,
|
||||
span
|
||||
);
|
||||
}
|
||||
}
|
||||
"emacs" => {
|
||||
if let Ok(v) = value.as_string() {
|
||||
let val_str = v.to_lowercase();
|
||||
match val_str.as_ref() {
|
||||
"line" => {
|
||||
config.cursor_shape_emacs = NuCursorShape::Line;
|
||||
}
|
||||
"block" => {
|
||||
config.cursor_shape_emacs =
|
||||
NuCursorShape::Block;
|
||||
}
|
||||
"underscore" => {
|
||||
config.cursor_shape_emacs =
|
||||
NuCursorShape::UnderScore;
|
||||
}
|
||||
_ => {
|
||||
invalid!(Some(*span),
|
||||
"unrecognized $env.config.{key}.{key2} '{val_str}'; expected either 'line', 'block', or 'underscore'"
|
||||
);
|
||||
// Reconstruct
|
||||
vals[index] = reconstruct_cursor_shape!(
|
||||
config.cursor_shape_emacs,
|
||||
span
|
||||
);
|
||||
}
|
||||
};
|
||||
} else {
|
||||
invalid!(Some(*span), "should be a string");
|
||||
// Reconstruct
|
||||
vals[index] = reconstruct_cursor_shape!(
|
||||
config.cursor_shape_emacs,
|
||||
span
|
||||
);
|
||||
}
|
||||
}
|
||||
x => {
|
||||
invalid_key!(
|
||||
cols,
|
||||
vals,
|
||||
index,
|
||||
value.span().ok(),
|
||||
"$env.config.{key}.{x} is an unknown config setting"
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
} else {
|
||||
invalid!(vals[index].span().ok(), "should be a record");
|
||||
// Reconstruct
|
||||
vals[index] = Value::record(
|
||||
vec!["vi_insert".into(), "vi_normal".into(), "emacs".into()],
|
||||
vec![
|
||||
reconstruct_cursor_shape!(config.cursor_shape_vi_insert, span),
|
||||
reconstruct_cursor_shape!(config.cursor_shape_vi_normal, span),
|
||||
reconstruct_cursor_shape!(config.cursor_shape_emacs, span),
|
||||
],
|
||||
*span,
|
||||
);
|
||||
}
|
||||
}
|
||||
"table" => {
|
||||
macro_rules! reconstruct_index_mode {
|
||||
($span:expr) => {
|
||||
@@ -1148,6 +1312,67 @@ impl Value {
|
||||
invalid!(Some(*span), "should be a string");
|
||||
}
|
||||
}
|
||||
"cursor_shape_vi_insert" => {
|
||||
legacy_options_used = true;
|
||||
if let Ok(b) = value.as_string() {
|
||||
let val_str = b.to_lowercase();
|
||||
config.cursor_shape_vi_insert = match val_str.as_ref() {
|
||||
"block" => NuCursorShape::Block,
|
||||
"underline" => NuCursorShape::UnderScore,
|
||||
"line" => NuCursorShape::Line,
|
||||
_ => {
|
||||
invalid!(
|
||||
Some(*span),
|
||||
"unrecognized $env.config.{key} '{val_str}'"
|
||||
);
|
||||
NuCursorShape::Line
|
||||
}
|
||||
};
|
||||
} else {
|
||||
invalid!(Some(*span), "should be a string");
|
||||
}
|
||||
}
|
||||
"cursor_shape_vi_normal" => {
|
||||
legacy_options_used = true;
|
||||
if let Ok(b) = value.as_string() {
|
||||
let val_str = b.to_lowercase();
|
||||
config.cursor_shape_vi_normal = match val_str.as_ref() {
|
||||
"block" => NuCursorShape::Block,
|
||||
"underline" => NuCursorShape::UnderScore,
|
||||
"line" => NuCursorShape::Line,
|
||||
_ => {
|
||||
invalid!(
|
||||
Some(*span),
|
||||
"unrecognized $env.config.{key} '{val_str}'"
|
||||
);
|
||||
NuCursorShape::Line
|
||||
}
|
||||
};
|
||||
} else {
|
||||
invalid!(Some(*span), "should be a string");
|
||||
}
|
||||
}
|
||||
"cursor_shape_emacs" => {
|
||||
legacy_options_used = true;
|
||||
if let Ok(b) = value.as_string() {
|
||||
let val_str = b.to_lowercase();
|
||||
config.cursor_shape_emacs = match val_str.as_ref() {
|
||||
"block" => NuCursorShape::Block,
|
||||
"underline" => NuCursorShape::UnderScore,
|
||||
"line" => NuCursorShape::Line,
|
||||
_ => {
|
||||
invalid!(
|
||||
Some(*span),
|
||||
"unrecognized $env.config.{key} '{val_str}'"
|
||||
);
|
||||
NuCursorShape::Line
|
||||
}
|
||||
};
|
||||
} else {
|
||||
invalid!(Some(*span), "should be a string");
|
||||
}
|
||||
}
|
||||
|
||||
// End legacy options
|
||||
x => {
|
||||
invalid_key!(
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
pub mod ast;
|
||||
mod cli_error;
|
||||
mod config;
|
||||
pub mod config;
|
||||
pub mod engine;
|
||||
mod example;
|
||||
mod exportable;
|
||||
|
||||
Reference in New Issue
Block a user