问题标签 [maven-checkstyle-plugin]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
2 回答
1355 浏览

java - checkstyle 使用的默认规则是什么?

如果我没有定义 checkstyle 配置,则默认执行几个 checkstyle 规则,是否有 checkstyle 使用的默认规则列表?

这就是我的 Maven 配置的样子:

0 投票
1 回答
191 浏览

jenkins - 来自 jenkins 的警告下一代插件 6.1.1 中使用了哪个版本的 Checkstyle?

我正在尝试在我的 jenkins 服务器上为 maven 项目配置静态代码分析。我想使用谷歌检查基于 Checkstyle 的代码分析。要使用适当的 google 检查 xml 文件,我想知道在警告下一代插件 6.1.1 中使用的 checkstyle 版本。

谁能帮我解决这个问题?

0 投票
0 回答
58 浏览

java - 如果方法上缺少 JavaDoc,CheckStyle 不会发出警告

根据文档,我的 CheckStyle 配置看起来不错,但似乎我错过了一些东西,因为如果 JavaDoc 缺少公共方法的前面,它不会警告我。

如果类中缺少 JavaDoc,我的配置会向我发出警告,但是如果任何公共方法中也缺少 JavaDoc,我也会收到警告。

示例类:

我的 CheckStyle 配置:

0 投票
1 回答
56 浏览

java - Checkstyle - 如何忽略在输出 xml 文件中添加类文件

有没有办法在没有错误时忽略显示类文件。我有带有规则的 checkstyle.xml,当我尝试构建我的项目时,Checkstyle 会验证我的所有文件,然后生成输出 XML 文件。该 XML 倾向于创建 HTML。我想忽略添加通过 CheckStyle 规则验证的类文件而没有任何错误。

0 投票
1 回答
86 浏览

maven - maven checkstyle 插件的 JavaDocMethod 属性在构建期间未找到

当任何公共方法没有有效的 javadoc 时,我想使 maven 构建失败。我正在使用本网站建议的 maven checkstyle 插件。但是,它在构建过程中给我一个错误,即找不到属性 allowUndeclaredRTE。在对此发表评论时,它会在另一个属性上给出错误。

我的 pom 代码片段如下:

0 投票
0 回答
156 浏览

pom.xml - 如何摆脱错误得到一个异常 - 在 checkstyle 中期待 EOF

我想从 checkstyle 检查文件中删除此检查。哪个模块实际上负责引发此错误,因此我可以将此标记为忽略。此外,我已将我的 checkstyle 版本更改为 2.12.1,并将源和目标添加到我的 javav 版本为 1.8,但它仍然在 lambda 上引发 EOF 异常。错误-

Checkstyle_checks.xml

0 投票
1 回答
225 浏览

hyperlink - 如何解决@link JavaDoc在一行和行长之间的Checkstyle冲突?

考虑以下 JavaDoc:

每当我保存此注释所属的 JUnit5 测试类时,都会将{@link }其重新格式化为一行,这是正确的,否则如果我尝试在链接中引入换行符,Maven Checkstyle 插件将抛出错误(javadoc) SingleLineJavadoc: Javadoc comment at column 78 has parse error. Details: mismatched input '\n' expecting MEMBER while parsing REFERENCE:(另外我认为链接在由此呈现的 API 文档中无法正确解析。)

但是,如果我将长链接行保持原样,Maven Checkstyle 插件也会引发(sizes) LineLength: Line is longer than 100 characters (found 125).错误: .

有没有办法解决这个问题?

要求:

  • 100 字符行规则应该保留,但{@link }JavaDoc 中的长标签(在测试类中最明显,但也可能在其他地方)应该被排除在外。
  • 该链接仍应在呈现的 JavaDoc 中解析(即,它应保持有效)。

编辑

我可以从链接中省略包名称,但我想将它们保留在那里,以便它们只解决一件事,而不是潜在地解决同名的东西。

0 投票
1 回答
251 浏览

java - checkstyle JavadocType 仅在类/接口/枚举上

我正在尝试配置 checkstyle 规则,它将验证类、接口和枚举以使用以下配置强制 javadocs:

但是它们得到了反映,即即使我没有在类级别提供任何 java 文档,检查样式​​仍然通过,而不是给出有关缺少的 java 文档的错误。

任何帮助,将不胜感激。

0 投票
0 回答
541 浏览

intellij-idea - 为 IntelliJ 代码样式导入 checkstyle 抑制

主要是出于好奇,但如果您在 maven 项目中使用 checkstyle 配置文件checkstyle.xml和(单独的)抑制文件checkstyle-suppressions.xmlmaven-checkstyle-plugin并且您想使用 CheckStyle 将这些 checkstyle 配置导入 IntelliJ 中的代码样式- IDEA 插件,您可以这样做(例如,参见checkstyle 配置中的 IntelliJ IDEA 代码格式)——但是对于这种代码风格的抑制呢?在 IntelliJ 中设置代码样式时,您只能从一个文件(当然是checkstyle.xml. pom.xml如果在您使用标签时正确指定了抑制,那么此代码样式是否“知道”这些抑制<suppressionsLocation>?它需要了解抑制吗?

0 投票
1 回答
98 浏览

eclipse - 如何将 eclipse formatter.xml 转换为 Checkstyle 规则

以前也有人问过类似的问题,但那是几年前的事了。认为可能存在一些解决方案但无法找到它。

我有一个自定义的 eclipse formatter.xml。需要将其转换为 Checkstyle rules.xml 以使用 maven-checkstyle-plugin 在 maven 项目中强制格式化。

尝试了 formatter-maven-plugin,但在不同的机器上得到不一致的结果

在 Maven 中强制执行自定义格式检查的任何其他方式也足够了。用例 - CI