在 Vim 中使用 graphviz.vim 畫(huà)圖

Tamic 發(fā)布于2019-06-28 10:33 / 2463人閱讀

摘要：官方有很多示例，使用時(shí)也可以參考一些其他的優(yōu)秀案例，比如本文并不會(huì)對(duì)本身做太多介紹，而是分享如何在中使用插件方便畫(huà)圖。對(duì)于可選項(xiàng)，我采用了傳入?yún)?shù)進(jìn)行調(diào)控。用于編譯當(dāng)前文件，可以指定編譯程序和擴(kuò)展名，默認(rèn)是。

本文主要介紹 graphviz.vim, fork 自 wmgraphviz.vim，但是除了復(fù)用補(bǔ)全數(shù)據(jù)，我?guī)缀踔貙?xiě)了所有內(nèi)容，并做了很多改進(jìn)。

可能很多人沒(méi)用過(guò) graphviz，它是一個(gè)開(kāi)源的圖可視化工具，使用 DOT 語(yǔ)言進(jìn)行繪制，優(yōu)點(diǎn)是可以自動(dòng)布局，尤其適用于復(fù)雜的流程圖，結(jié)構(gòu)圖等等。官方有很多示例，使用時(shí)也可以參考一些其他的優(yōu)秀案例，比如：

本文并不會(huì)對(duì) graphviz 本身做太多介紹，而是分享如何在 Vim 中使用 graphviz.vim 插件方便畫(huà)圖。

wmgraphviz.vim 是 graphviz.vim 的前身，提供了一些補(bǔ)全，一鍵編譯，查看編譯后文件等功能。但是使用起來(lái)感覺(jué)不是那么 fashion，很久以來(lái)也幾乎沒(méi)怎么更新，比如依然在于 ! 進(jìn)行外部調(diào)用。

graphviz.vim 整個(gè)插件非常簡(jiǎn)單，本質(zhì)上就是封裝了一些編譯，一鍵查看的命令而已，主要改進(jìn)包括：

命令更少，配置項(xiàng)更簡(jiǎn)單。

只有 :Graphviz 和 :GraphvizCompile 兩個(gè)命令，:Graphviz 用于打開(kāi)編譯后的文件，:GraphvizCompile 用于編譯當(dāng)前文件。如果 :Graphviz! 則相當(dāng)于 :GraphvizCompile | Graphviz。對(duì)于可選項(xiàng)，我采用了傳入?yún)?shù)進(jìn)行調(diào)控。

支持 ncm2 和 coc.nvim。

這個(gè)很簡(jiǎn)單，只是簡(jiǎn)單封裝了下 Omni 補(bǔ)全以適應(yīng) ncm2 和 coc.nvim。

安裝

使用 vim-plug 進(jìn)行安裝：

Plug "liuchengxu/graphviz.vim"

用法

:Graphviz 打開(kāi)編譯后的文件，文件名取自當(dāng)前文件，輔以不同后綴。默認(rèn)是打開(kāi) pdf 類(lèi)型，比如當(dāng)前打開(kāi)的文件叫 foo.dot，那么 :Graphviz 是嘗試打開(kāi) foo.pdf 的文件，可以傳入擴(kuò)展名進(jìn)行指定。

" 默認(rèn)打開(kāi) pdf 文件
" 可選項(xiàng): "ps", "pdf", "png", "jpg", "gif", "svg"
:Graphviz

" 打開(kāi) png 文件
:Graphviz png

:Graphviz! 會(huì)在目標(biāo)文件不存在的情況下，嘗試調(diào)用 :GraphvizCompile 進(jìn)行編譯然后再打開(kāi)，相當(dāng)于 :GraphvizCompile | Graphviz。

:GraphvizCompile 用于編譯當(dāng)前文件，可以指定編譯程序和擴(kuò)展名，默認(rèn)是 dot pdf。

" :GraphvizCompile [exe] [format]

" 默認(rèn)是用 dot 編譯成 pdf
" :GraphvizCompile dot pdf
:GraphvizCompile

" 指定編譯成 png 格式
:GraphvizCompile png

" 指定用 dot 編譯成 gif 格式，實(shí)際上我沒(méi)用過(guò)除 dot 的其他編譯項(xiàng):(
:GraphvizCompile dot gif

其他一些可選配置項(xiàng)：

" 指定打開(kāi)文件的命令。默認(rèn)會(huì)根據(jù)平臺(tái)自動(dòng)選擇
" macOS 使用 open, Linux 使用 xdg-open 等
let g:graphviz_viewer = "open"

" 默認(rèn)編譯生成 pdf 格式，如果想要其他格式，將 pdf 換成其他格式即可
let g:graphviz_output_format = "pdf"

我基本只用 macOS, 所以 Windows 或者 Linux 沒(méi)怎么測(cè)試過(guò)，如果遇到問(wèn)題，可以到 graphviz.vim 提 issue，我會(huì)盡量解決 :(。