java - Travis checkstyle 警告

标签 java gradle checkstyle travis-ci

我开始将 CheckStyle 与 Gradle 和 Travis CI 结合使用。现在我希望如果存在样式错误,Build 将被标记为“警告”。你能帮我做这些设置吗?

.travis.yml:

language: java
sudo: false
jdk:
    - oraclejdk8
    - oraclejdk7

build.gradle:

apply plugin: 'java'
apply plugin: 'checkstyle'

repositories {
    mavenCentral()
}

dependencies {
    testCompile group: 'junit', name: 'junit', version: '4.+'
    checkstyle group: 'com.puppycrawl.tools', name: 'checkstyle', version: '6.1.1'
    compile group: 'com.github.lalyos', name: 'jfiglet', version: '0.0.5'
}
jar {
    from { configurations.compile.collect { it.isDirectory() ? it : zipTree(it) } }
    manifest {
        attributes 'Main-Class': 'io.github.laufi.heisserdraht.Main'
    }
}

我的 Checkstyle 配置是常规的 Google 配置:

<property name="severity" value="warning"/>

<!-- Checks for whitespace                               -->
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
    <module name="FileTabCharacter">
        <property name="eachLine" value="true"/>
    </module>

<module name="TreeWalker">
    <module name="OuterTypeFilename"/>
    <module name="IllegalTokenText">
        <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
        <property name="format" value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
        <property name="message" value="Avoid using corresponding octal or Unicode escape."/>
    </module>
    <module name="AvoidEscapedUnicodeCharacters">
        <property name="allowEscapesForControlCharacters" value="true"/>
        <property name="allowByTailComment" value="true"/>
        <property name="allowNonPrintableEscapes" value="true"/>
    </module>
    <module name="LineLength">
        <property name="max" value="100"/>
        <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
    </module>
    <module name="AvoidStarImport"/>
    <module name="OneTopLevelClass"/>
    <module name="NoLineWrap"/>
    <module name="EmptyBlock">
        <property name="option" value="TEXT"/>
        <property name="tokens" value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
    </module>
    <module name="NeedBraces"/>
    <module name="LeftCurly">
        <property name="maxLineLength" value="100"/>
    </module>
    <module name="RightCurly"/>
    <module name="RightCurly">
        <property name="option" value="alone"/>
        <property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/>
    </module>
    <module name="WhitespaceAround">
        <property name="allowEmptyConstructors" value="true"/>
        <property name="allowEmptyMethods" value="true"/>
        <property name="allowEmptyTypes" value="true"/>
        <property name="allowEmptyLoops" value="true"/>
        <message key="ws.notFollowed"
         value="WhitespaceAround: ''{0}'' is not followed by whitespace."/>
         <message key="ws.notPreceded"
         value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
    </module>
    <module name="OneStatementPerLine"/>
    <module name="MultipleVariableDeclarations"/>
    <module name="ArrayTypeStyle"/>
    <module name="MissingSwitchDefault"/>
    <module name="FallThrough"/>
    <module name="UpperEll"/>
    <module name="ModifierOrder"/>
    <module name="EmptyLineSeparator">
        <property name="allowNoEmptyLineBetweenFields" value="true"/>
    </module>
    <module name="SeparatorWrap">
        <property name="tokens" value="DOT"/>
        <property name="option" value="nl"/>
    </module>
    <module name="SeparatorWrap">
        <property name="tokens" value="COMMA"/>
        <property name="option" value="EOL"/>
    </module>
    <module name="PackageName">
        <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
        <message key="name.invalidPattern"
         value="Package name ''{0}'' must match pattern ''{1}''."/>
    </module>
    <module name="TypeName">
        <message key="name.invalidPattern"
         value="Type name ''{0}'' must match pattern ''{1}''."/>
    </module>
    <module name="MemberName">
        <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
        <message key="name.invalidPattern"
         value="Member name ''{0}'' must match pattern ''{1}''."/>
    </module>
    <module name="ParameterName">
        <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
        <message key="name.invalidPattern"
         value="Parameter name ''{0}'' must match pattern ''{1}''."/>
    </module>
    <module name="LocalVariableName">
        <property name="tokens" value="VARIABLE_DEF"/>
        <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
        <property name="allowOneCharVarInForLoop" value="true"/>
        <message key="name.invalidPattern"
         value="Local variable name ''{0}'' must match pattern ''{1}''."/>
    </module>
    <module name="ClassTypeParameterName">
        <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
        <message key="name.invalidPattern"
         value="Class type name ''{0}'' must match pattern ''{1}''."/>
    </module>
    <module name="MethodTypeParameterName">
        <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
        <message key="name.invalidPattern"
         value="Method type name ''{0}'' must match pattern ''{1}''."/>
    </module>
    <module name="NoFinalizer"/>
    <module name="GenericWhitespace">
        <message key="ws.followed"
         value="GenericWhitespace ''{0}'' is followed by whitespace."/>
         <message key="ws.preceded"
         value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
         <message key="ws.illegalFollow"
         value="GenericWhitespace ''{0}'' should followed by whitespace."/>
         <message key="ws.notPreceded"
         value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
    </module>
    <module name="Indentation">
        <property name="basicOffset" value="2"/>
        <property name="braceAdjustment" value="0"/>
        <property name="caseIndent" value="2"/>
        <property name="throwsIndent" value="4"/>
        <property name="lineWrappingIndentation" value="4"/>
        <property name="arrayInitIndent" value="2"/>
    </module>
    <module name="AbbreviationAsWordInName">
        <property name="ignoreFinal" value="false"/>
        <property name="allowedAbbreviationLength" value="1"/>
    </module>
    <module name="OverloadMethodsDeclarationOrder"/>
    <module name="VariableDeclarationUsageDistance"/>
    <module name="CustomImportOrder">
        <property name="thirdPartyPackageRegExp" value=".*"/>
        <property name="specialImportsRegExp" value="com.google"/>
        <property name="sortImportsInGroupAlphabetically" value="true"/>
        <property name="customImportOrderRules" value="STATIC###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE"/>
    </module>
    <module name="MethodParamPad"/>
    <module name="OperatorWrap">
        <property name="option" value="NL"/>
        <property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR "/>
    </module>
    <module name="AnnotationLocation">
        <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
    </module>
    <module name="AnnotationLocation">
        <property name="tokens" value="VARIABLE_DEF"/>
        <property name="allowSamelineMultipleAnnotations" value="true"/>
    </module>
    <module name="NonEmptyAtclauseDescription"/>
    <module name="JavadocTagContinuationIndentation"/>
    <module name="SummaryJavadocCheck">
        <property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
    </module>
    <module name="JavadocParagraph"/>
    <module name="AtclauseOrder">
        <property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
        <property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
    </module>
    <module name="JavadocMethod">
        <property name="scope" value="public"/>
        <property name="allowMissingParamTags" value="true"/>
        <property name="allowMissingThrowsTags" value="true"/>
        <property name="allowMissingReturnTag" value="true"/>
        <property name="minLineCount" value="2"/>
        <property name="allowedAnnotations" value="Override, Test"/>
        <property name="allowThrowsTagsForSubclasses" value="true"/>
    </module>
    <module name="MethodName">
        <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
        <message key="name.invalidPattern"
         value="Method name ''{0}'' must match pattern ''{1}''."/>
    </module>
    <module name="SingleLineJavadoc"/>
</module>

最佳答案

你可以看看Violations Gradle Plugin ,但这只会使构建失败而不会发出警告。你的 .travis.yml 需要类似的东西:

...
script:
  - ./build.sh
  - 'if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then bash ./gradlew check -PdiffFrom=$TRAVIS_PULL_REQUEST_BRANCH -PdiffTo=$TRAVIS_BRANCH ; fi'
...

并且在 build.gradle 中设置:

...
 diffFrom = project.properties.diffFrom // Can be empty (ignored), Git-commit or any Git-reference
 diffTo = project.properties.diffTo // Same as above
 diffMaxViolations = 99 // Will fail the build if number of violations, in the diff within from/to, is higher
...

自述文件中有更多详细信息。

另一个想法是使用 Violation Comments to GitHub在拉取请求中以评论的形式报告违规行为。

关于java - Travis checkstyle 警告,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/27602732/

相关文章:

java - 如何在 jdbc 连接上传递用户名或用户 IP 地址?

java - DocumentListener 干扰我的 JTextField

Android gradle build 错误 :(9, 0) Gradle DSL 方法未找到 : 'compile()' .

gradle - 无法在 gradle maven-publish 插件中传输工件 pom

gradle - 如何在Github Actions中将Checkstyle结果报告为请求请求注释?

java - 当为我的类调用隐式 toString() 时,我可以列出所有情况吗?

java - 如何使用扩展 AbstractTableModel 的类正确更新 Jtable?

gradle - 从 Gradle 插件添加存储库

java - 如何在 google checkstyle.xml 中的方法之前添加一个选项卡

java - 使用现有插件定义 findbugs 检测器