SpaceVim踩坑之java代码格式化_neoformat: formatters remark failed to run-CSDN博客

本文链接：https://blog.csdn.net/lxyoucan/article/details/114433464

个人理解：SpaceVim是一套不错的vim插件集合。
也是因为有SpaceVim才让我入门vim，爱上vim。

一直想实现ssh远程服务做开发调试这件事情，SpaceVim让我看到了这个想法的可行性。实践的过程中遇到一此小坑，记录一下，让后来人少走弯路。

环境

理论上环境是通过的，大同小异。我的环境是：

项目	Value
系统	macOS Big Sur 11.2
vim	VIM - Vi IMproved 8.2
SpaceVim	version : 1.7.0-dev

解决方案一（官方推荐）

下载 google-java-format
我的保存路径如下：~/.SpaceVim.d/lib/google-java-format-1.9-all-deps.jar
这个路径放哪里行，我主.SpaceVim.d目录为了方便我后期移到其他机器上使用。
配置文件vim ~/.SpaceVim.d/init.toml增加一行

[[layers]]
name = “lang#java” 下面增加如下一行。

 java_formatter_jar = "~/.SpaceVim.d/lib/google-java-format-1.9-all-deps.jar"

在这里插入图片描述
重启nvim编辑java文件这下可以java代码格式化了。
可以通过:Neoformat格式化，或者快捷键：空格 b f

解决方案二（摸索出来的）

为了快速解决，直接上解决方案，有兴趣的也可以看下一节的探索过程。
第一步：编辑下面文件：

vim ~/.SpaceVim/autoload/SpaceVim/layers/lang/java.vim

并把以下代码注释掉：

let g:neoformat_enabled_java = get(g:, 'neoformat_enabled_java', ['googlefmt'])
  let g:neoformat_java_googlefmt = {
        \ 'exe': 'java',
        \ 'args': ['-jar', s:java_formatter_jar, '-'],
        \ 'stdin': 1,
        \ }
  try
    let g:neoformat_enabled_java += neoformat#formatters#java#enabled()
  catch
  endtry

如图：
在这里插入图片描述
第二步安装 astyle
安装过程建议直接参考官网即可，我的实践记录见：《vim安装插件实现Java代码格式化》仅供参考

然后就可以愉快的使用SpaceVim格式化java代码啦。
重启nvim编辑java文件这下可以java代码格式化了。
可以通过:Neoformat格式化，或者快捷键：空格 b f

探索过程

SpaceVim（Java）代码格式化
先看一下官网的使用说明：
https://spacevim.org/cn/use-vim-as-a-java-ide/

关于代码格式化的官方描述如下：

SpaceVim官方文档摘

代码格式化
基于 format 模块，可以使用 SPC b f 对当前代码进行格式化，format 模块主要包括插件 neoformat。该插件提供了格式化框架，对于 java 的支持，还需要安装 uncrustify 或者 astyle。同时，你也可以使用谷歌的 java formatter。

在这里插入图片描述

这个文档看起来很简单，但是在我执行代码格式化的时候会报如下的错：
Neoformat: formatters java failed to run
在这里插入图片描述
然后我又认真的看了一下文档，可能是回为我电脑上需要安装

uncrustify
astyle
谷歌的 java formatter。
其中之一吧。

看起来看简单的样子，然后我就尝试在Centos 7上安装uncrustify 然后依然报错。

Neoformat: formatters java failed to run

既然报错了，不慌还有两个选择。这次我想换个环境试试，换到我的macOS上做测试，为了知晓 neoformat的运行原理，我在纯净的vim上做安装 neoformat测试。
测试环境：
neoformat + astyle 比我想像中的还要简单，一次就成功啦。花了不到10分钟就搞定了。
详见：《vim安装插件实现Java代码格式化》

本以为这就搞定了，然后并没有，错误照旧。
看文档的意思是：只要安装了上面3个组件中的一种就可以了。那么为什么我正确的安装了astyle还是不行呢？

猜测1：neoformat版本不一样？
实测把我安装neoformat复制过去，问题依旧。

猜测2：SpaceVim在哪个地方配置了neoformat什么东西？
为了这个猜测我找呀找，果然验证了我的猜测。

~/.SpaceVim/autoload/SpaceVim/layers/lang/java.vim

这个文件中保存了java相关的neoformat配置。相关代码如下：

let g:neoformat_enabled_java = get(g:, 'neoformat_enabled_java', ['googlefmt'])
  let g:neoformat_java_googlefmt = {
        \ 'exe': 'java',
        \ 'args': ['-jar', s:java_formatter_jar, '-'],
        \ 'stdin': 1,
        \ }
  try
    let g:neoformat_enabled_java += neoformat#formatters#java#enabled()
  catch
  endtry

看到这个以后，有点上头，竟然是写死的googlefmt。那么官方说明文档java篇的我没有看到有说明，当然也有可能在其他地方有介绍只是我没有看到。比如：~/.SpaceVim/autoload/SpaceVim/layers/lang/java.vim文件的注释里是有介绍的。
在这里插入图片描述