Neoformat：Neovim/Vim代码格式化插件详解

Neoformat：Neovim/Vim代码格式化插件详解

【免费下载链接】neoformat 项目地址: https://gitcode.com/gh_mirrors/ne/neoformat

什么是Neoformat？

Neoformat是一款专为Neovim和Vim8设计的代码格式化插件，它通过集成多种代码格式化工具，为开发者提供统一的代码格式化体验。该插件支持超过50种编程语言，能够在不保存文件的情况下直接格式化当前缓冲区内容，同时保留光标位置、标记等编辑器状态。

核心特性

1. 多格式化器支持：每个文件类型可配置多个格式化器，当第一个格式化器失败时会自动尝试下一个
2. 无保存操作：直接读取缓冲区内容进行格式化，无需先保存文件
3. 状态保持：格式化后保留光标位置、跳转记录和标记
4. 灵活输入：支持通过stdin或临时文件两种方式向格式化器传递数据
5. 视觉选择格式化：可对选中的代码块进行格式化，甚至临时指定不同文件类型

安装方法

使用主流Vim插件管理器安装：

" 使用vim-plug安装
Plug 'sbdchd/neoformat'

安装后无需额外配置即可开始使用基础功能。

基础使用

基本格式化命令

" 格式化整个缓冲区
:Neoformat

" 指定使用某个格式化器（需当前文件类型支持）
:Neoformat jsbeautify

视觉选择区域格式化

" 先进入可视模式选择代码块，然后执行（注意需要加!）
:'<,'>Neoformat! python

" 指定格式化器
:'<,'>Neoformat! python yapf

保存时自动格式化

augroup fmt
  autocmd!
  autocmd BufWritePre * undojoin | Neoformat
augroup END

undojoin命令将Neoformat的修改与之前的修改合并到同一个撤销块中，提供更流畅的撤销体验。

高级配置

自定义格式化器

let g:neoformat_python_autopep8 = {
      \ 'exe': 'autopep8',
      \ 'args': ['-s 4', '-E'],
      \ 'replace': 1,    " 直接替换文件而非更新缓冲区
      \ 'stdin': 1,      " 通过stdin传递数据
      \ 'valid_exit_codes': [0, 23],
      \ 'no_append': 1,
      \ }

配置选项说明：

• exe: 格式化器可执行文件名（必需）
• args: 命令行参数列表
• replace: 直接替换文件而非更新缓冲区
• stdin: 是否通过stdin传递数据
• valid_exit_codes: 视为成功的退出码
• no_append: 不自动追加文件路径到命令末尾

全局配置选项

" 尝试使用formatprg作为格式化器
let g:neoformat_try_formatprg = 1

" 启用基础格式化功能（文件类型无特定格式化器时）
let g:neoformat_basic_format_align = 1    " 对齐
let g:neoformat_basic_format_retab = 1    " tab转空格
let g:neoformat_basic_format_trim = 1     " 修剪末尾空格

" 运行所有启用的格式化器（默认在第一个成功后停止）
let g:neoformat_run_all_formatters = 1

" 仅在出错时显示消息
let g:neoformat_only_msg_on_error = 1

" 调试日志
let g:neoformat_verbose = 1

添加新格式化器

要为新的文件类型添加格式化器，需要创建对应的Vim脚本文件：

1. 在插件目录下创建文件：autoload/neoformat/formatters/文件类型.vim
2. 按照以下模板编写代码：

function! neoformat#formatters#文件类型#enabled() abort
    return ['格式化器1', '格式化器2']
endfunction

function! neoformat#formatters#文件类型#格式化器1() abort
    return {
        \ 'exe': '可执行文件名',
        \ 'args': ['-参数1', '-参数2'],
        \ 'stdin': 1
        \ }
endfunction

支持的语言和工具

Neoformat支持绝大多数主流编程语言，包括但不限于：

• Python: yapf, autopep8, black, isort
• JavaScript/TypeScript: prettier, standard, eslint_d
• Go: gofmt, goimports
• Ruby: rubocop, rufo
• Rust: rustfmt
• C/C++: clang-format, uncrustify
• Java: clang-format, astyle
• HTML/CSS: prettier, csscomb
• Shell: shfmt
• SQL: sqlformat

完整列表请参考插件文档，几乎涵盖了所有需要格式化的开发场景。

使用建议

1. 对于团队项目，建议统一配置格式化规则文件（如.prettierrc、.editorconfig等）
2. 结合Git钩子，确保提交的代码都经过格式化
3. 对于大型项目，可以针对不同文件类型配置最适合的格式化器
4. 考虑将格式化命令映射到快捷键，如：nnoremap <leader>f :Neoformat<CR>

Neoformat通过统一接口整合了各种代码格式化工具，极大简化了开发者的工作流程，是追求代码风格一致性的理想选择。

【免费下载链接】neoformat 项目地址: https://gitcode.com/gh_mirrors/ne/neoformat