Skip to content

Latest commit

 

History

History
87 lines (73 loc) · 5.31 KB

README_cn.md

File metadata and controls

87 lines (73 loc) · 5.31 KB

vim-floaterm-repl

English Document

这是一个基于 vim-floaterm 的 Vim 插件，用于在浮动终端中与不同语言的 REPL (Read-Eval-Print Loop) 程序交互。

需求

  • 有:terminal 命令的 vim或 neovim , 具体版本需求要比vim-floaterm 要高一些
  • 安装相应的repl 程序，比如ipython, radian

原理

该插件的主要功能是允许用户将 Vim/neovim 编辑器中的代码片段发送到已启动的 REPL 程序中执行，并将结果显示在浮动终端中。其核心原理包括：

  • REPL 程序管理: 通过全局变量 g:floaterm_repl_programs 存储不同文件类型关联的 REPL 启动命令。例如，Python 文件类型关联 ipython 或 python3 命令。
  • 代码块标记: 允许用户在代码中使用特定标记（例如 Python 中的 # %%）来定义代码块。插件会识别这些标记，方便用户按块发送代码。
  • 清屏和退出命令: 为不同编程语言的 REPL 定义了清屏和退出的命令，例如 JavaScript 的 .clear 和 .exit。
  • 浮动终端交互: 依赖 vim-floaterm 插件来创建和管理浮动终端，并在其中启动 REPL 程序。插件通过 vim-floaterm 提供的接口发送代码和命令。t:floaterm_repl_termnames 是一个 tab 级别的变量，用于存储文件类型和 buffer number 组合的索引与浮动终端名称的映射关系，方便后续查找和操作对应的浮动终端。
  • 代码发送流程: 当用户执行发送代码的命令时，插件会获取选定的代码范围（当前行、选定行、代码块等），然后将其发送到与当前文件类型关联的 REPL 进程。
  • floaterm 位置动态调整: 会根据屏幕 列/行比调整 floaterm window 的位置在右还是下面

命令

以下是 vim-floaterm-repl 插件提供的主要命令及其功能：

  • !感叹号的意义: 当一个命令后面有一个感叹号时，意义是发送代码后，留在光标当前位置。
  • FloatermReplStart: 启动当前文件类型的 REPL 程序。如果已配置多个可执行的 REPL 程序，会弹出一个列表供用户选择。
  • FloatermReplSend [range]: 将指定范围的代码发送到 REPL。
    • 可以使用行号范围，例如 :10,20FloatermReplSend 发送第 10 到 20 行。
    • 如果没有指定范围，则发送当前行。
  • FloatermReplSendVisual: 将可视模式下选中的代码发送到 REPL。
  • FloatermReplSendBlock: 发送当前代码块到 REPL。代码块由 g:floaterm_repl_block_mark 定义的标记分隔。默认的标记是 # %%。
  • FloatermReplSendFromBegin: 从文件开头发送到当前行（或上一行代码块标记）。
  • FloatermReplSendToEnd: 从当前行发送到文件末尾。
  • FloatermReplSendAll: 发送整个文件内容到 REPL。
  • FloatermReplSendNewlineOrStart:
    • 如果 REPL 未启动，则启动 REPL。
    • 如果 REPL 已启动，则发送一个换行符到 REPL。
  • FloatermReplSendClear: 发送清屏命令到 REPL，清除 REPL 终端的显示。
  • FloatermReplSendExit: 发送退出命令到 REPL，关闭 REPL 进程。
  • FloatermReplSendWord: 发送光标下的单词到 REPL。
  • FloatermReplMark [range]: visual标记一个代码块或可视选择，方便后续发送。
  • FloatermReplSendMark: 发送之前使用 FloatermReplMark 命令标记的代码。
  • FloatermReplQuickuiMark: （可能依赖 vim-quickui 插件）快速查看标记的代码。

配置

可以通过配置 Vim 全局变量来自定义插件的行为：

  • g:floaterm_repl_programs: 一个字典，用于配置不同文件类型关联的 REPL 启动命令。
  • g:floaterm_repl_block_mark: 一个字典，用于配置不同文件类型的代码块标记。
  • g:floaterm_repl_clear: 一个字典，用于配置不同文件类型的 REPL 清屏命令。
  • g:floaterm_repl_exit: 一个字典，用于配置不同文件类型的 REPL 退出命令。

典型keymap

使用<M-e>作为操作的前缀, 注意感叹号。

" start
nnoremap <silent><M-e>r :FloatermReplStart!<Cr>
nnoremap <silent><M-e><Cr> :FloatermReplSendNewlineOrStart<Cr>
" basic send
nnoremap <silent><M-e>n :FloatermReplSend<Cr>
nnoremap <silent><M-e>l :FloatermReplSend!<Cr>
xnoremap <silent><M-e>n :FloatermReplSendVisual<Cr>
xnoremap <silent><M-e>l :FloatermReplSendVisual!<Cr>
nnoremap <silent><M-e>q :FloatermReplSendExit<Cr>
" block send
xnoremap <silent><M-e><M-e>   :FloatermReplSendVisual<Cr>
xnoremap <silent><M-e><Space> :FloatermReplSendVisual!<Cr>
nnoremap <silent><M-e><M-e>   :FloatermReplSendBlock<Cr>
nnoremap <silent><M-e><Space> :FloatermReplSendBlock!<Cr>
" send above/below/all lines
nnoremap <silent><M-e>b :FloatermReplSendFromBegin!<Cr>
nnoremap <silent><M-e>e :FloatermReplSendToEnd!<Cr>
nnoremap <silent><M-e>a :FloatermReplSendAll!<Cr>
" send word
nnoremap <silent><M-e>k :FloatermReplSendWord<Cr>
xnoremap <silent><M-e>k :FloatermReplSendWord!<Cr>
" mark print send
nnoremap <silent><M-e><M-m> :FloatermReplMark<Cr>
xnoremap <silent><M-e><M-m> :FloatermReplMark!<Cr>
nnoremap <silent><M-e><M-l> :FloatermReplSendMark<Cr>
nnoremap <silent><M-e><M-r> :FloatermReplQuickuiMark<Cr>
" clear
nnoremap <silent><M-e><M-c> :FloatermReplSendClear<Cr>