1 个稳定版本
14.0.1 | 2024年6月8日 |
---|
#182 在 命令行界面
59 每月下载量
用于 2 个包(通过 brush-interactive)
495KB
13K SLoC
brush-rustyline-fork (brush-rustyline-fork
) 的分支
这是 RustyLine(RustyLine)项目的分支,包含 brush(brush)所需的一些修改。
目前包括
- 使
complete
函数的Completer
特性接受对self
的可变引用。
Rust 中的 Readline 实现,基于 Antirez' Linenoise
支持的平台
- Unix(已在 FreeBSD、Linux 和 macOS 上测试过)
- Windows
- cmd.exe
- Powershell
注意:
- Powershell ISE 不受支持,请查看 问题 #56
- Mintty(Cygwin/MinGW)不受支持
- Windows < Windows 10 上不支持高亮显示/颜色,除非使用 ConEmu 和
ColorMode::Forced
。
示例
use rustyline::error::ReadlineError;
use rustyline::{DefaultEditor, Result};
fn main() -> Result<()> {
// `()` can be used when no completer is required
let mut rl = DefaultEditor::new()?;
#[cfg(feature = "with-file-history")]
if rl.load_history("history.txt").is_err() {
println!("No previous history.");
}
loop {
let readline = rl.readline(">> ");
match readline {
Ok(line) => {
rl.add_history_entry(line.as_str());
println!("Line: {}", line);
},
Err(ReadlineError::Interrupted) => {
println!("CTRL-C");
break
},
Err(ReadlineError::Eof) => {
println!("CTRL-D");
break
},
Err(err) => {
println!("Error: {:?}", err);
break
}
}
}
#[cfg(feature = "with-file-history")]
rl.save_history("history.txt");
Ok(())
}
crates.io
您可以在项目中使用此包,只需在您的 Cargo.toml
中添加以下内容
[dependencies]
rustyline = "14.0.0"
功能
- Unicode(UTF-8)(linenoise 仅支持 ASCII)
- 单词完成(linenoise 仅支持行完成)
- 文件名完成
- 历史搜索(在历史中搜索命令)
- 杀环(删除命令)
- 多行支持(换行)
- 单词命令
- 提示
操作
对所有模式
按键 | 动作 |
---|---|
Home | 将光标移至行首 |
End | 将光标移至行尾 |
Left | 将光标向左移动一个字符 |
Right | 将光标向右移动一个字符 |
Ctrl-C | 中断/取消编辑 |
Ctrl-D, Del | (如果行不为空) 删除光标下的字符 |
Ctrl-D | (如果行不为空) 文件结束 |
Ctrl-J, Ctrl-M, Enter | 完成行输入 |
Ctrl-R | 反向搜索历史记录(Ctrl-S 向前,Ctrl-G 取消) |
Ctrl-T | 交换前一个字符与当前字符 |
Ctrl-U | 从行首删除到光标位置 |
Ctrl-V | 插入任何特殊字符而不执行其相关操作(#65) |
Ctrl-W | 删除光标前的一个单词(使用空白作为单词边界) |
Ctrl-Y | 从Yank缓冲区粘贴 |
Ctrl-Z | 暂停(仅限Unix) |
Ctrl-_ | 撤销 |
Emacs模式(默认模式)
按键 | 动作 |
---|---|
Ctrl-A, Home | 将光标移至行首 |
Ctrl-B, 向左 | 将光标向左移动一个字符 |
Ctrl-E, End | 将光标移至行尾 |
Ctrl-F, 向右 | 将光标向右移动一个字符 |
Ctrl-H, Backspace | 删除光标前的字符 |
Ctrl-I, Tab | 下一个完成项 |
Ctrl-K | 从光标位置删除到行尾 |
Ctrl-L | 清除屏幕 |
Ctrl-N, 向下 | 从历史记录中下一个匹配项 |
Ctrl-P, 向上 | 从历史记录中上一个匹配项 |
Ctrl-X Ctrl-U | 撤销 |
Ctrl-Y | 从Yank缓冲区粘贴(使用Meta-Y粘贴下一个yank) |
Meta-< | 移动到历史记录的第一个条目 |
Meta-> | 移动到历史记录的最后一个条目 |
Meta-B, Alt-Left | 移动光标到前一个单词 |
Meta-C | 将当前单词大写 |
Meta-D | 删除光标前的一个单词 |
Meta-F, Alt-Right | 移动光标到下一个单词 |
Meta-L | 将下一个单词转换为小写 |
Meta-T | 交换单词 |
Meta-U | 将下一个单词转换为大写 |
Meta-Y | 参见Ctrl-Y |
Meta-Backspace | 从当前单词的开始删除,或者如果位于单词之间,则删除到前一个单词的开始 |
Meta-0, 1, ..., - | 指定数字到参数。 – 开始一个负参数。 |
vi命令模式
按键 | 动作 |
---|---|
$, End | 将光标移至行尾 |
. | 重做最后一个文本修改 |
; | 重做最后一个查找命令 |
, | 重做反向方向的最后一个查找命令 |
0, Home | 将光标移至行首 |
^ | 移动到行的第一个非空白字符 |
a | 在光标后插入 |
A | 在行尾插入 |
b | 向左移动一个单词或标记 |
B | 向左移动一个非空白单词 |
c | 更改移动命令的文本 |
C | 更改到行尾的文本(等同于c$) |
d | 删除移动命令的文本 |
D, Ctrl-K | 删除到行尾 |
e | 移动到当前单词的末尾 |
E | 移动到当前非空白单词的末尾 |
f | 移动到下一个char 的出现位置 |
F | 移动到上一个char 的出现位置 |
h, Ctrl-H, Backspace | 向左移动一个字符 |
l, Space | 向右移动一个字符 |
Ctrl-L | 清除屏幕 |
i | 在光标前插入 |
I | 在行首插入 |
+, j, Ctrl-N | 向前移动一个历史命令 |
-, k, Ctrl-P | 向后移动一个历史命令 |
p | 在光标位置插入yank的文本(粘贴) |
P | 在光标前插入yank的文本 |
r | 替换光标下的单个字符(不离开命令模式) |
s | 删除光标下的单个字符并进入输入模式 |
S | 更改当前行(等同于0c$) |
t | 向右移动到下一个char 的出现位置,然后向后移动一个字符 |
T | 将光标左移到上一个 char 发生处,然后向前移动一个字符 |
u | 撤销 |
w | 将光标右移一个单词或标记 |
W | 将光标右移一个非空白单词 |
x | 删除光标下方的单个字符 |
X | 删除光标前方的字符 |
y | 将移动操作复制到缓冲区中(复制) |
vi插入模式
按键 | 动作 |
---|---|
Ctrl-H, Backspace | 删除光标前的字符 |
Ctrl-I, Tab | 下一个完成项 |
Esc | 切换到命令模式 |
Wine
$ cargo run --example example --target 'x86_64-pc-windows-gnu'
...
Error: Io(Error { repr: Os { code: 6, message: "Invalid handle." } })
$ wineconsole --backend=curses target/x86_64-pc-windows-gnu/debug/examples/example.exe
...
终端检查
$ # current settings of all terminal attributes:
$ stty -a
$ # key bindings:
$ bind -p
$ # print out a terminfo description:
$ infocmp
类似项目
库 | 语言 | 操作系统 | 终端 | Unicode | 历史 | 完成 | 键映射 | 删除环 | 撤销 | 颜色 | 提示/自动建议 |
---|---|---|---|---|---|---|---|---|---|---|---|
go-prompt | Go | UX/Win | ANSI | 是 | 是 | 任何 | Emacs/程序 | 否 | 否 | 是 | 是 |
Haskeline | Haskell | UX/Win | 任何 | 是 | 是 | 任何 | Emacs/vi/配置 | 是 | 是 | ? | ? |
isocline | C | UX/Win | ANSI | 是 | 是 | 任何 | Emacs | 否 | 是 | 是 | 是 |
换行 | Rust | UX/Win | 任何 | 是 | 任何 | Emacs/配置 | 是 | 否 | ? | 否 | |
linenoise | C | UX | ANSI | 否 | 是 | 仅一行 | Emacs | 否 | 否 | UX | 是 |
行编辑器 | Rust | UX | ANSI | 不进行增量搜索 | 仅单词 | Emacs/vi/程序 | 否 | 是 | UX | 基于历史 | |
prompt_toolkit | Python | UX/Win | ANSI | 是 | 是 | 任何 | Emacs/vi/配置 | 是 | 是 | UX/Win | 是 |
reedline | Rust | UX/Win | ANSI | 是 | 是 | 任何 | Emacs/vi/绑定 | 否 | 是 | UX/Win | 是 |
replxx | C/C++ | UX/Win | ANSI | 是 | 是 | 仅一行 | Emacs | 是 | 否 | UX/Win | 是 |
Rustyline | Rust | UX/Win | ANSI | 是 | 是 | 任何 | Emacs/vi/绑定 | 是 | 是 | UX/Win 10+ | 是 |
termwiz | Rust | UX/Win | 任何 | ? | 是 | 任何 | Emacs | 否 | 否 | UX/Win | 否 |
多行支持
这是一个非常简单的功能,它只是将超过当前终端宽度的行显示在下一行视觉行上,而不是像输入更多字符时那样水平滚动。目前,此功能始终启用,没有配置选项可以禁用它。
此功能不允许最终用户按下特殊按键序列并进入一个模式,在该模式下按下回车键将在输入缓冲区中添加一个实际的换行符。
实现多行编辑的方法是实现 Validator
特性。
依赖项
~2-18MB
~235K SLoC