Vim调用system()在iTerm2中出现多余转义字符的问题排查

我在.vimrc中定义了如下函数：

function! GitBranch()
  return system("git rev-parse --abbrev-ref HEAD 2>/dev/null | tr -d '\n'")
endfunction

但在iTerm2中使用时，屏幕底部会出现一串奇怪的字符：^[[?12;4$y。该问题仅在iTerm2中出现（Mac默认终端无此情况），且与system()的调用内容无关——即使替换为system("echo test")，仍会出现相同的字符序列。

• zsh 5.8.1 (x86_64-apple-darwin22.0)
• $TERM 为 xterm-256color
• Vim版本详情：

VIM - Vi IMproved 9.0 (2022 Jun 28, compiled Dec 16 2022 23:29:16)
macOS version - arm64
Included patches: 1-981
Compiled by root@apple.com
Normal version without GUI.  Features included (+) or not (-):
+acl               +file_in_path      +mouse_urxvt       -tag_any_white
-arabic            +find_in_path      +mouse_xterm       -tcl
+autocmd           +float             +multi_byte        +termguicolors
+autochdir         +folding           +multi_lang        +terminal
-autoservername    -footer            -mzscheme          +terminfo
-balloon_eval      +fork()            +netbeans_intg     +termresponse
-balloon_eval_term -gettext           +num64             +textobjects
-browse            -hangul_input      +packages          +textprop
++builtin_terms    +iconv             +path_extra        +timers
+byte_offset       +insert_expand     -perl              +title
+channel           +ipv6              +persistent_undo   -toolbar
+cindent           +job               +popupwin          +user_commands
-clientserver      +jumplist          +postscript        -vartabs
+clipboard         -keymap            +printer           +vertsplit
+cmdline_compl     +lambda            -profile           +vim9script
+cmdline_hist      -langmap           -python            +viminfo
+cmdline_info      +libcall           -python3           +virtualedit
+comments          +linebreak         +quickfix          +visual
+conceal           +lispindent        +reltime           +visualextra
+cryptv            +listcmds          -rightleft         +vreplace
+cscope            +localmap          -ruby              +wildignore
+cursorbind        -lua               +scrollbind        +wildmenu
+cursorshape       +menu              +signs             +windows
+dialog_con        +mksession         +smartindent       +writebackup
+diff              +modify_fname      -sodium            -X11
+digraphs          +mouse             -sound             -xfontset
-dnd               -mouseshape        +spell             -xim
-ebcdic            +mouse_dec         +startuptime       -xpm
-emacs_tags        -mouse_gpm         +statusline        -xsmp
+eval              -mouse_jsbterm     -sun_workshop      -xterm_clipboard
+ex_extra          +mouse_netterm     +syntax            -xterm_save
+extra_search      +mouse_sgr         +tag_binary
-farsi             -mouse_sysmouse    -tag_old_static
   system vimrc file: "$VIM/vimrc"
     user vimrc file: "$HOME/.vimrc"
 2nd user vimrc file: "~/.vim/vimrc"
      user exrc file: "$HOME/.exrc"
       defaults file: "$VIMRUNTIME/defaults.vim"
  fall-back for $VIM: "/usr/share/vim"
Compilation: gcc -c -I. -Iproto -DHAVE_CONFIG_H   -DMACOS_X_UNIX  -g -O2 -U_FORTIFY_SOURCE -D_FORTIFY_SOURCE=1
Linking: gcc   -L/usr/local/lib -o vim        -lm -lncurses  -liconv -framework Cocoa

^[[?12;4$y是iTerm2特有的光标形状切换控制序列，用于将光标切换为插入模式下的竖线形状。问题出在Vim调用system()时，子shell会继承当前终端的环境设置（包括TERM和iTerm2的光标自动切换配置），导致iTerm2的光标控制逻辑被触发，控制序列直接输出到终端界面上。Mac默认终端没有类似的自动光标切换机制，所以不会出现这个问题。

方案1：临时修改子shell的TERM环境 #

在system()调用中临时设置TERM=dumb，让子shell不输出任何终端控制序列：

function! GitBranch()
  return system("TERM=dumb git rev-parse --abbrev-ref HEAD 2>/dev/null | tr -d '\n'")
endfunction

这个方法简单直接，能快速屏蔽终端控制序列的输出。

方案2：禁用iTerm2的光标自动切换功能 #

打开iTerm2偏好设置，依次进入Profiles -> Terminal，取消勾选**"Automatically change cursor shape based on current keymap"**。这样iTerm2不会主动发送光标形状切换的控制序列，从根源上避免问题。

方案3：使用Vim Job API替代system()（推荐） #

Vim的Job API是更现代的外部命令调用方式，不会直接继承终端的控制设置，能彻底避免控制序列泄露：

function! GitBranch()
  let job_id = job_start('git rev-parse --abbrev-ref HEAD 2>/dev/null', {'out_io': 'buffer'})
  call job_wait(job_id)
  let output = join(getbufline(job_id, 1, '$'), '')
  call deletebuf(job_id)
  return substitute(output, '\n', '', 'g')
endfunction

这个方案不仅解决了当前问题，还支持异步调用，适合更复杂的场景。

内容的提问来源于stack exchange，提问作者Jack