自动生成的代码不符合 CheckStyle 标准 (jHipster)

Question

我已经开始在最近的一个项目中使用 jHipster，该工具可用于使用 Spring 启动后端自动生成 REST api 应用程序的完整堆栈。这应该可以节省大量编写样板代码的时间...

不幸的是，在我的工作中，我们有以一组 CheckStyle 规则的形式遵守的编码标准。任何不遵守这些规则的代码都会导致构建失败。我目前遇到的是这个自动生成的代码在很多地方都没有通过 CheckStyle 规则。目前我正在通过手动搜索解决每个问题的代码来处理这个问题。

我不禁觉得一定有更好的方法来做到这一点，例如：

• 配置 IDE (intelliJ) 以确保生成的代码匹配 CheckStyle 规则。当直接编码到 IDE.
时，这当然是可能的
• 配置 jHipster 以在自动生成代码之前了解 CheckStyle 规则。
• 运行 之后的脚本可以自动修复任何 CheckStyle 失败。 （我相信这一定是可行的！）

如果有人知道解决此问题的最佳方法以及过去是否有人做过类似的事情，那将是一件好事。

Answer 1

抑制所有自动生成文件的违规行为，因为它不受您的控制。
http://checkstyle.sourceforge.net/config_filters.html#SuppressionFilter

如果您在包含手动维护的非生成代码的文件中有自动生成的代码，请使用注释抑制。
http://checkstyle.sourceforge.net/config_filters.html#SuppressionCommentFilter

您不应该为并非为此目的而编写的代码设置样式，您不是在编写它，一些实用程序是并且它不是根据您的样式规范构建的。如果您再次生成文件，它将撤消您所做的任何手动更改。