IntelliJ IDEA 代码格式化配置的检查风格。

57

我决定为Android Maven插件做出贡献。

他们使用了非常特殊的代码风格格式。我需要花一些时间修改IDEA代码格式规则以满足他们的要求。

幸运的是,有checkstyle配置。我已经安装了IDEA的check-style插件,并立即看到我的当前格式有哪些错误。

不幸的是,我没有找到将checkstyle配置导入到IDEA格式规则中的方法。

我想知道是否可能做到这一点。

6个回答

75

终于有好消息了:

从4.24.0版本开始,checkstyle-IDEA可以导入checkstyle配置文件。

现在有一种解决方案:

  1. 请安装CheckStyle-IDEA插件(http://plugins.jetbrains.com/plugin/1065?pr=idea)。这个插件可以通过插件库(设置|插件|浏览存储库)找到。

  2. 进入设置|编辑器|代码样式,选择要将CheckStyle配置导入的代码样式。

  3. 单击“管理…”|“导入…”,选择“CheckStyle配置”并选择相应的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


太棒了!我会尝试的!谢谢分享! - Eugen Martynov
7
可以将智慧诗句导出为Checkstyle格式吗?从IDEA设置中导出。 - Eugen Martynov
2
这似乎仍然不是使用CheckStyle规则配置格式的解决方案。 - Sander Verhagen
4
@SanderVerhagen,是的。一旦您导入了配置,请确保将其应用于项目,然后执行 ctrl-shift-alt-L 来格式化当前文件... - helt
8
能否将Idea代码样式导出为checkstyle.xml文件? - carlspring
@SanderVerhagen 如果你也安装了Save Actions插件并将其配置为在保存时重新格式化文件,那么它将自动在保存时生效。 - Archmede

23

难过 :( 团队之间共享代码格式的常见方式是什么?我看到了一篇关于./idea文件夹中某个文件的帖子。但我通常避免将IDE特定文件提交到存储库中。 - Eugen Martynov
4
.idea/codeStyleSettings.xml,详见常见问题解答 - CrazyCoder

6

有一个不太好看的解决方法,但我一直都能使用:

首先按照这里所述将 Checkstyle 格式导入到 Eclipse 中: 如何从 Checkstyle 配置生成 Eclipse 格式化程序配置?

然后从 Eclipse 导出格式(通过“Windows”菜单 -> “首选项” -> “Java” -> “代码样式” -> “格式化程序” -> “编辑” -> “导出”),并将生成的 *.xml 文件导入到 IntelliJ IDEA 中。

当然,如果您周围没有人使用 Eclipse,这种方法可能有点奇怪,因为您必须安装它才能将 Checkstyle 格式“转换”为 IntelliJ 可读的格式;但是,如果每个项目只需要执行一次,则比手动调整格式要好得多。


2

这对我起作用了。

  1. 转到首选项 > 编辑器 > 代码样式 > Java
  2. Scheme下拉菜单中,导入您想要的checkstyle.xmlimport-cecktyle-scheme
  3. Intellij将新导入的方案称为默认副本
  4. 使用Rename选项选择任何其他名称。enter image description here

1
刚刚按照Intellij的建议运行了mvn spotless:apply命令。这帮助我自动解决了问题。

0
我的解决方案是使用Adapter for Eclipse Code Formatter。适用于 IntelliJ IDEA 2022.3.1。
  1. 使用设置 -> 插件 -> Adapter for Eclipse Code Formatter进行安装。
  2. 重启后,使用设置 -> Adapter for Eclipse Code Formatter
    • 使用 Eclipse 的代码格式化程序
    • Eclipse 格式化程序配置 -> Eclipse 工作区/项目文件夹或配置文件

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接