如何解决 Intellij Idea 的所有 checkstyle 问题？

Posted 2023-02-21

【中文标题】如何解决 Intellij Idea 的所有 checkstyle 问题？

【英文标题】：How fix all check style issues with Intellij Idea?

【发布时间】：2013-11-25 23:29:18

【问题描述】：

我有一个用于 maven checkstyle 插件的 xml 配置文件。我已经安装了 Intellij Idea 插件并查看了所有的 checkstyle 违规。有没有办法自动修复其中的大部分？例如自动格式化设置？有没有办法将 Intellij Idea 设置为从 checktyle 配置文件自动格式化？

【问题讨论】：

如果您在设置中有自定义/添加的代码样式，那么在文件中如果您按“Ctrl+Alt+L”将重新格式化代码

【参考方案1】：

首先导入您的代码样式配置

重新格式化您的代码。

【参考方案2】：

现在有一个选项。

checkstyle-IDEA 自 4.24.0 起具有 checkstyle 配置导入功能。

请安装 CheckStyle-IDEA 插件 (http://plugins.jetbrains.com/plugin/1065?pr=idea)，可以找到 通过插件存储库（设置|插件|浏览存储库）。去 Settings|Editor|Code Style，选择要导入的代码样式 CheckStyle 配置到。点击齿轮，然后“导入方案”，选择 “CheckStyle Configuration”并选择对应的CheckStyle 配置文件。单击确定。最后你会看到一条消息 “CheckStyle 配置设置已导入...方案”。

如果遇到任何问题，可以为 CheckStyle 插件在这里： https://github.com/jshiell/checkstyle-idea/issues。这个问题是 实际上是 https://github.com/jshiell/checkstyle-idea/issues/126.

该功能可用的CheckStyle插件版本为4.24.0

复制自https://youtrack.jetbrains.com/issue/IDEA-61520#comment=27-1292600。从here复制答案

编辑：为了清晰起见并符合当前的 UI 设计，已更改引用。

【讨论】：

注意 - 这对我不起作用，我正准备写一个错误报告，然后我注意到我有一个本地 .editorconfig 文件。结果证明 .editorconfig 文件取代了其他编辑器设置。具体来说，我的 .editorconfig 文件指定了 indent_size = 4，但 google 的 checkstyle xml 指定了 2。一旦我在 .editorconfig 中注释掉该行，自动格式就起作用了。

导入现有的 xml 如何启用自动修复问题？

@AdamWise 如此真实.. 我被这个文件困扰了一段时间，问题是 4 个空格和 2 个空格缩进。谢谢

我看不到“管理”按钮

【参考方案3】：

我也有同样的问题。据我所知，用于重新格式化的规则无法从 Checkstyle 配置中导入。您可以在 Idea 的代码样式配置 (File -> Settings -> Code Style) 中配置您的 Checkstyle 规则，然后根据规则重新格式化代码 (Code -> Reformat Code [Ctrl+Alt+L])（您可以一次将其应用于整个代码库）。