mirror of
https://github.com/nushell/nushell.git
synced 2025-07-12 20:35:18 +02:00
<!--
if this PR closes one or more issues, you can automatically link the PR
with
them by using one of the [*linking
keywords*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword),
e.g.
- this PR should close #xxxx
- fixes #xxxx
you can also mention related issues, PRs or discussions!
-->
# Description
<!--
Thank you for improving Nushell. Please, check our [contributing
guide](../CONTRIBUTING.md) and talk to the core team before making major
changes.
Description of your pull request goes here. **Provide examples and/or
screenshots** if your changes affect the user experience.
-->
Related issue and PR, #11825 #11864
This improves the signature of `commandline`.
## Before
`commandline` returns different types depending on the flags and an
aurgument.
| command | input | output | description |
|-----------------------------|---------|---------|----------------------------------------|
| `commandline` | nothing | string | get current cursor line |
| `commandline arg` | nothing | nothing | replace the cursor line with
`arg` |
| `commandline --append arg` | nothing | nothing | append `arg` to the
end of cursor line |
| `commandline --insert arg` | nothing | nothing | insert `arg` to the
position of cursor |
| `commandline --replace arg` | nothing | nothing | replace the cursor
line with `arg` |
| `commandline --cursor` | nothing | int | get current cursor position |
| `commandline --cursor pos` | nothing | nothing | set cursor position
to pos |
| `commandline --cursor-end` | nothing | nothing | set cursor position
to end |
`help commandline` shows that `commandline` accepts string as pipeline
input, but `commandline` ignores pipeline input.
```
Input/output types:
╭───┬─────────┬─────────╮
│ # │ input │ output │
├───┼─────────┼─────────┤
│ 0 │ nothing │ nothing │
│ 1 │ string │ string │
╰───┴─────────┴─────────╯
```
671bd08bcd/crates/nu-cli/src/commands/commandline.rs (L70)
This is misleading.
Due to the change #11864 , typecheck does not work well.
https://github.com/nushell/nushell/pull/11864#discussion_r1491814054
## After
Separate `commandline` into subcommands so that each subcommands returns
the same type for the same input type.
| command | input | output | description |
|----------------------------------|---------|---------|----------------------------------------|
| `commandline` | nothing | string | get current cursor line |
| `commandline edit arg` | nothing | nothing | replace the cursor line
with `arg` |
| `commandline edit --append arg` | nothing | nothing | append `arg` to
the end of cursor line |
| `commandline edit --insert arg` | nothing | nothing | insert `arg` to
the position of cursor |
| `commandline edit --replace arg` | nothing | nothing | replace the
cursor line with `arg` |
| `commandline get-cursor` | nothing | int | get current cursor position
|
| `commandline set-cursor pos` | nothing | nothing | set cursor position
to pos |
| `commandline set-cursor --end` | nothing | nothing | set cursor
position to end |
# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->
# 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` to
check that you're using the standard code style
- `cargo test --workspace` to check that all tests pass (on Windows make
sure to [enable developer
mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging))
- `cargo run -- -c "use std testing; testing run-tests --path
crates/nu-std"` to run the tests for the standard library
> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```
-->
# 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.
-->
190 lines
7.8 KiB
Rust
190 lines
7.8 KiB
Rust
use nu_engine::CallExt;
|
|
use nu_protocol::{
|
|
ast::Call,
|
|
engine::{Command, EngineState, Stack},
|
|
Category, IntoPipelineData, PipelineData, ShellError, Signature, SyntaxShape, Type, Value,
|
|
};
|
|
use unicode_segmentation::UnicodeSegmentation;
|
|
|
|
#[derive(Clone)]
|
|
pub struct Commandline;
|
|
|
|
impl Command for Commandline {
|
|
fn name(&self) -> &str {
|
|
"commandline"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("commandline")
|
|
.input_output_types(vec![
|
|
(Type::Nothing, Type::Nothing),
|
|
(Type::String, Type::String),
|
|
])
|
|
.switch(
|
|
"cursor",
|
|
"Set or get the current cursor position",
|
|
Some('c'),
|
|
)
|
|
.switch(
|
|
"cursor-end",
|
|
"Set the current cursor position to the end of the buffer",
|
|
Some('e'),
|
|
)
|
|
.switch(
|
|
"append",
|
|
"appends the string to the end of the buffer",
|
|
Some('a'),
|
|
)
|
|
.switch(
|
|
"insert",
|
|
"inserts the string into the buffer at the cursor position",
|
|
Some('i'),
|
|
)
|
|
.switch(
|
|
"replace",
|
|
"replaces the current contents of the buffer (default)",
|
|
Some('r'),
|
|
)
|
|
.optional(
|
|
"cmd",
|
|
SyntaxShape::String,
|
|
"the string to perform the operation with",
|
|
)
|
|
.category(Category::Core)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"View or modify the current command line input buffer."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["repl", "interactive"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
if let Some(cmd) = call.opt::<Value>(engine_state, stack, 0)? {
|
|
let span = cmd.span();
|
|
let cmd = cmd.coerce_into_string()?;
|
|
let mut repl = engine_state.repl_state.lock().expect("repl state mutex");
|
|
|
|
if call.has_flag(engine_state, stack, "cursor")? {
|
|
nu_protocol::report_error_new(
|
|
engine_state,
|
|
&ShellError::GenericError {
|
|
error: "`--cursor (-c)` is deprecated".into(),
|
|
msg: "Setting the current cursor position by `--cursor (-c)` is deprecated"
|
|
.into(),
|
|
span: Some(call.arguments_span()),
|
|
help: Some("Use `commandline set-cursor`".into()),
|
|
inner: vec![],
|
|
},
|
|
);
|
|
match cmd.parse::<i64>() {
|
|
Ok(n) => {
|
|
repl.cursor_pos = if n <= 0 {
|
|
0usize
|
|
} else {
|
|
repl.buffer
|
|
.grapheme_indices(true)
|
|
.map(|(i, _c)| i)
|
|
.nth(n as usize)
|
|
.unwrap_or(repl.buffer.len())
|
|
}
|
|
}
|
|
Err(_) => {
|
|
return Err(ShellError::CantConvert {
|
|
to_type: "int".to_string(),
|
|
from_type: "string".to_string(),
|
|
span,
|
|
help: Some(format!(r#"string "{cmd}" does not represent a valid int"#)),
|
|
})
|
|
}
|
|
}
|
|
} else if call.has_flag(engine_state, stack, "append")? {
|
|
nu_protocol::report_error_new(
|
|
engine_state,
|
|
&ShellError::GenericError {
|
|
error: "`--append (-a)` is deprecated".into(),
|
|
msg: "Appending the string to the end of the buffer by `--append (-a)` is deprecated".into(),
|
|
span: Some(call.arguments_span()),
|
|
help: Some("Use `commandline edit --append (-a)`".into()),
|
|
inner: vec![],
|
|
},
|
|
);
|
|
repl.buffer.push_str(&cmd);
|
|
} else if call.has_flag(engine_state, stack, "insert")? {
|
|
nu_protocol::report_error_new(
|
|
engine_state,
|
|
&ShellError::GenericError {
|
|
error: "`--insert (-i)` is deprecated".into(),
|
|
msg: "Inserts the string into the buffer at the cursor position by `--insert (-i)` is deprecated".into(),
|
|
span: Some(call.arguments_span()),
|
|
help: Some("Use `commandline edit --insert (-i)`".into()),
|
|
inner: vec![],
|
|
},
|
|
);
|
|
let cursor_pos = repl.cursor_pos;
|
|
repl.buffer.insert_str(cursor_pos, &cmd);
|
|
repl.cursor_pos += cmd.len();
|
|
} else {
|
|
nu_protocol::report_error_new(
|
|
engine_state,
|
|
&ShellError::GenericError {
|
|
error: "`--replace (-r)` is deprecated".into(),
|
|
msg: "Replaceing the current contents of the buffer by `--replace (-p)` or positional argument is deprecated".into(),
|
|
span: Some(call.arguments_span()),
|
|
help: Some("Use `commandline edit --replace (-r)`".into()),
|
|
inner: vec![],
|
|
},
|
|
);
|
|
repl.buffer = cmd;
|
|
repl.cursor_pos = repl.buffer.len();
|
|
}
|
|
Ok(Value::nothing(call.head).into_pipeline_data())
|
|
} else {
|
|
let mut repl = engine_state.repl_state.lock().expect("repl state mutex");
|
|
if call.has_flag(engine_state, stack, "cursor-end")? {
|
|
nu_protocol::report_error_new(
|
|
engine_state,
|
|
&ShellError::GenericError {
|
|
error: "`--cursor-end (-e)` is deprecated".into(),
|
|
msg: "Setting the current cursor position to the end of the buffer by `--cursor-end (-e)` is deprecated".into(),
|
|
span: Some(call.arguments_span()),
|
|
help: Some("Use `commandline set-cursor --end (-e)`".into()),
|
|
inner: vec![],
|
|
},
|
|
);
|
|
repl.cursor_pos = repl.buffer.len();
|
|
Ok(Value::nothing(call.head).into_pipeline_data())
|
|
} else if call.has_flag(engine_state, stack, "cursor")? {
|
|
nu_protocol::report_error_new(
|
|
engine_state,
|
|
&ShellError::GenericError {
|
|
error: "`--cursor (-c)` is deprecated".into(),
|
|
msg: "Getting the current cursor position by `--cursor (-c)` is deprecated"
|
|
.into(),
|
|
span: Some(call.arguments_span()),
|
|
help: Some("Use `commandline get-cursor`".into()),
|
|
inner: vec![],
|
|
},
|
|
);
|
|
let char_pos = repl
|
|
.buffer
|
|
.grapheme_indices(true)
|
|
.chain(std::iter::once((repl.buffer.len(), "")))
|
|
.position(|(i, _c)| i == repl.cursor_pos)
|
|
.expect("Cursor position isn't on a grapheme boundary");
|
|
Ok(Value::string(char_pos.to_string(), call.head).into_pipeline_data())
|
|
} else {
|
|
Ok(Value::string(repl.buffer.to_string(), call.head).into_pipeline_data())
|
|
}
|
|
}
|
|
}
|
|
}
|