如何避免spring-javaformat将枚举值自动格式化为单行

你可以根据项目需求选择以下任意一种方案：

方案1：局部跳过格式化 #

针对需要保留自定义排版的枚举，直接在代码前后添加格式化开关注释即可跳过该部分的格式化逻辑：

// formatter:off
public enum Color {
    YELLOW("Yellow"),
    WHITE("White");
}
// formatter:on

该方案对全局规则无影响，适合仅少量枚举需要保留单行排版的场景。

方案2：全局配置枚举换行规则 #

如果需要项目内所有枚举都默认保留每个值单独一行的排版，可以修改全局格式化配置：

1. 在项目根目录新建eclipse-formatter.xml文件，写入如下规则：

<profile version="1.0">
    <!-- 配置枚举常量每个单独占一行 -->
    <setting id="org.eclipse.jdt.core.formatter.alignment_for_enum_constants" value="16" />
    <setting id="org.eclipse.jdt.core.formatter.enum_constants_wrap_policy" value="2" />
</profile>

2. 在build.gradle的spring-javaformat配置块中指定自定义规则文件：

springJavaFormat {
    formatterConfig = file("eclipse-formatter.xml")
}

方案3：轻量兼容方案 #

不需要修改任何配置，只需要在每个枚举值的末尾添加单行注释标识，插件就不会将多个枚举值合并：

public enum Color {
    YELLOW("Yellow"), //
    WHITE("White"); //
}

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