使Vim中的空白字符可见

使Vim中空白字符可见

参考引用：vim技巧：设置空格和Tab字符可见，并自定义显示的字符颜色

1. 前言

不同于Visual Studio Code, Sublime Text等拥有GUI的高级文本编辑器，Vim作为Linux系统中命令行环境的常用文本编辑器，Vim的上手难度很高，且配置较为复杂。除了使用SSH连接远程服务器通过本机Visual Studio Code编写代码，有时候也需要使用Vim对服务器脚本、配置等文件进行修改。

偶然看到思否一篇文章介绍了如何使Vim中展示空白字符，让我印象深刻。毕竟Python这种语言对于是Tab还是Space的格式化要求较高；同时git提交的时候也会由于空白字符的问题产生不必要的更改。

于是记录我的Vim配置如下。

2. 介绍

执行 :setlocal list 命令后，会把 tab 字符显示为 CTRL-I 键的显示字符，实际显示为 ^I。同时会在行末显示一个 $ 字符。默认不会显示空格。

这个 list 选项是一个 “local to window“ 选项，也就是可以使用 :setlocal 命令来设置成只在当前窗口生效，这样设置之后，用 :edit 命令再打开其他文件，在新的窗口上没有开启这个设置，不会影响其他文件。

如果想要在打开代码文件时，才显示空格或 tab 字符，打开其他类型文件，例如 txt 文件、markdown 文件、makefile 文件等，不显示空格或 tab 字符，就可以使用 :setlocal list 命令。如果需要设置成全局状态，所有窗口都开启这个设置，可以使用 :set list 命令。

由于把 tab 字符显示为 ^I 不够直观，不想在行末显示 $ 字符，且需要显示空格，所以再执行 set listchars=tab:>~,trail:. 命令来设置 tab 字符和空格的显示样式，且行末不显示字符。

这个 listchars 选项是一个 “global” 选项，一旦设置，对所有窗口都生效，用于设置 list 属性会显示哪些字符、以及如何显示。常见的选项值说明如下：

• eol:c
  设置行末显示字符为 c。这里 c 可以换成任意一个字符，例如默认的 $ 字符、或者改成 # 字符，等等。
  显然，要设置成一个可见字符，才能明显地看到显示效果。
  如果没有设置这一项，行末不显示任何字符。
• tab:xy
  设置 tab 字符的显示样式，字符 x 总是会显示，会显示零个或多个字符 y 以填充到 tab 字符的显示宽度。
  例如，设置为 tab:>-，且 tab 字符的显示宽度是 4，那么 tab 字符会显示为 >---。
  实际显示的时候，可能只显示一个 >，或者只显示 >-。这个跟 tab 字符所在的位置有关。假设 tab 字符的显示宽度为 4，意味着 tab 字符的宽度总是停在 4 的倍数行上，当手动输入 3 个空格，再输入一个 tab 字符时，tab 字符只会显示一个空白字符，那么就只显示所设置的字符 x，对于刚才的例子来说，就是只显示 > 字符。
  在实际测试时，如有设置 :set expandtab，会把 tab 字符转换成空格，输入 tab 键不会得到 tab 字符，要先执行 :set noexpandtab 命令，关闭这个设置再来测试。
• tab:xyz
  设置 tab 字符的显示样式，字符 z 总是会显示，显示字符 z 之后，如果还有可显示的位置，字符 x 会显示在开头，在字符 x 和 字符 z 中间显示零个或多个字符 y 以填充到 tab 字符的显示宽度。
  例如，设置为 tab:<->，且 tab 字符的显示为 4，那么 tab 字符会显示为 <-->。
  实际显示的时候，可能只显示一个 >，或者显示为 <>、<-> 等，跟 tab 字符所在的位置有关。如上面说明所示。
• 如果没有设置 tab: 这一项，tab 字符默认会显示为 ^I。
• space:c
  设置所有的空格显示为字符 c，包括行首空格、行中间的空格、行末空格都会显示。
  这里 c 可以换成任意一个字符。
  如果没有设置这一项，空格显示为默认的空白。
• trail:c
  设置行末空格显示为字符 c，会覆盖 space: 这一项的设置，且只覆盖行末空格的显示。
  这里 c 可以换成任意一个字符。
  如果没有设置这一项，行末空格保持为 space: 这一项的设置。
• 不同设置项之间，用英文逗号 , 隔开。例如，tab:>~,trail:. 设置了 tab 字符和行末空格的显示样式。

基于上面说明，可以知道 set listchars=tab:>~,trail:. 命令设置 tab 字符显示为 >~~~~ 的样式（假设 tab 字符的显示宽度是 4），设置行末空格显示为点号 .，不显示行首空格和行中间的空格，行末不显示字符。如果需要显示所有空格，可以把 trail 改成 space。

进行前面的设置之后，空格和 tab 字符已经可见，但是显示的字符颜色使用了 hi SpecialKey 这一项的颜色，可以执行 :hi 命令查看 SpecialKey 对应的颜色是什么，跟 vim 使用的颜色主题有关，不同颜色主题可能有不同的颜色，例如蓝色、绿色、黑底白色等。

这个显示颜色会跟代码文件本身的颜色高亮混在一起，不方便区分。假设 tab 字符显示为 >~~~~，字符颜色是蓝色，如果后面跟着蓝色的代码关键字，就跟代码关键字显示成一个整体，不方便看到代码关键字。前面把行末空格显示为点号 .，如果某句注释的行末有空格，容易误以为是注释本身的点号。

为了方便区分于代码文件自身的颜色高亮，可以使用下面命令来设置可见的空格和 tab 字符显示为灰色，不那么显眼，方便区分于代码文件自身的颜色高亮：

:hi SpecialKey guifg=darkgrey ctermfg=darkgrey

如果不想显示成灰色，可以修改上面 guifg、ctermfg 的值，设置成个人喜欢的颜色。

这样设置之后，会有一个问题，就是修改了默认 hi SpecialKey 这一项的颜色。而 vim 会用到这个颜色来显示自身的一些内容，例如执行 :map 命令，显示映射的快捷键时，按键字符就显示为 hi SpecialKey 这一项的颜色，改成灰色后，不太显眼。

为了避免直接修改 hi SpecialKey 这一项的颜色，我们可以自定义一个颜色组，并设置为只对空格和 tab 字符生效，具体如下所示：

:highlight MyTabSpace guifg=darkgrey ctermfg=darkgrey
:match MyTabSpace /\t\| /

这里用 :highlight 命令（这个命令也可以简写为 :hi 命令）来自定义了一个 MyTabSpace 颜色组，显示为灰色。然后用 :match 命令设置 MyTabSpace 颜色组对空格和 tab 字符生效。上面的 \t 就是 tab 字符。不同字符串之间用 | 隔开，书写的时候要使用 \| 转义。在 | 后面的空白字符就是空格。

如前面说明，我们可能只想在查看代码文件时，才设置空格和 tab 字符可见，并且最好是自动开启。这个就需要在 ~/.vimrc 文件中进行配置。完整配置如下：

" 创建一个新的 MyTabSpace 组,并设置它的颜色
highlight MyTabSpace guifg=darkgrey ctermfg=darkgrey
" 指定tab字符和空格的颜色组为MyTabSpace,不同字符串之间用|隔开,要使用\|转义.
match MyTabSpace /\t\| /
" 针对特定类型的代码文件,设置显示Tab键和行尾空格以便在查看代码时注意到它们
autocmd FileType c,cpp,java,xml setlocal list | set listchars=tab:>~,trail:.

这段配置先使用 :highlight 命令（在 .vimrc 文件中书写时，省略了前面的冒号）自定义一个 MyTabSpace 颜色组，颜色为灰色。然后用 :match 命令设置 MyTabSpace 颜色组对空格和 tab 字符生效。由于空格和 tab 字符默认不可见，所以对于没有设置空格和 tab 字符可见的文件窗口来说，这个设置没有影响。

后面使用 :autocmd 命令针对 c,cpp,java,xml 这些类型的文件自动设置空格和tab 字符可见，就能看到这些字符显示为灰色。其他类型文件没有自动设置，不受影响。如有需要，可以自行添加其他类型的文件后缀名。

可以使用 :help 'list' 命令查看 list 选项的说明。
可以使用 :help 'listchars' 命令查看 listchars 选项的说明。
可以使用 :help :highlight 命令查看设置颜色高亮的更多说明。
可以使用 :help :match 命令查看如何设置指定字符串的显示颜色组。
可以使用 :help :autocmd 命令查看如何针对特定类型文件自动执行指定命令。

3. 配置

在home目录下新建.vimrc配置文件：

vim ~/.vimrc

填入

set tabstop=4
set shiftwidth=4
set expandtab
set autoindent
set softtabstop=4
set ruler
syntax on
set showmode
set encoding=utf-8
set t_Co=256
set laststatus=2

set list
set listchars=tab:⇥⇥,space:·,eol:⤦
highlight TabSpaceColor guifg=darkgrey ctermfg=darkgrey
match TabSpaceColor /\t\| \|\n\|\r/

从而可以显示空格、制表符和换行符。效果：

打赏