Repository: incubator-ratis Updated Branches: refs/heads/master 5c37675fa -> 16cadb68b
RATIS-131. Add checkstyle configuration. Project: http://git-wip-us.apache.org/repos/asf/incubator-ratis/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-ratis/commit/16cadb68 Tree: http://git-wip-us.apache.org/repos/asf/incubator-ratis/tree/16cadb68 Diff: http://git-wip-us.apache.org/repos/asf/incubator-ratis/diff/16cadb68 Branch: refs/heads/master Commit: 16cadb68b8bd157e92662ab1ed427463a8e2ee91 Parents: 5c37675 Author: Tsz Wo Nicholas Sze <[email protected]> Authored: Wed Nov 14 13:24:20 2018 -0800 Committer: Tsz Wo Nicholas Sze <[email protected]> Committed: Wed Nov 14 13:24:20 2018 -0800 ---------------------------------------------------------------------- dev-support/checkstyle.xml | 206 ++++++++++++++++++++++++++++++++++++++++ pom.xml | 7 +- 2 files changed, 212 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-ratis/blob/16cadb68/dev-support/checkstyle.xml ---------------------------------------------------------------------- diff --git a/dev-support/checkstyle.xml b/dev-support/checkstyle.xml new file mode 100644 index 0000000..6291db7 --- /dev/null +++ b/dev-support/checkstyle.xml @@ -0,0 +1,206 @@ +<?xml version="1.0"?> +<!-- + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. See accompanying LICENSE file. +--> +<!DOCTYPE module PUBLIC + "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" + "https://checkstyle.org/dtds/configuration_1_3.dtd";> + +<!-- + + Checkstyle configuration for Apache Ratis that is based on the sun_checks.xml file + that checks the coding conventions from: + + - the Java Language Specification at + http://java.sun.com/docs/books/jls/second_edition/html/index.html + + - the Sun Code Conventions at http://java.sun.com/docs/codeconv/ + + - the Javadoc guidelines at + http://java.sun.com/j2se/javadoc/writingdoccomments/index.html + + - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html + + - some best practices + + Checkstyle is very configurable. Be sure to read the documentation at + http://checkstyle.sf.net (or in your downloaded distribution). + + Most Checks are configurable, be sure to consult the documentation. + + To completely disable a check, just comment it out or delete it from the file. + + Finally, it is worth reading the documentation. + +--> + +<module name="Checker"> + <!-- + If you set the basedir property below, then all reported file + names will be relative to the specified directory. See + https://checkstyle.org/5.x/config.html#Checker + + <property name="basedir" value="${basedir}"/> + --> + + <property name="fileExtensions" value="java, properties, xml"/> + + <module name="SuppressWarningsFilter"/> + <module name="SuppressionCommentFilter"/> + <module name="SuppressWithNearbyCommentFilter"/> + + <!-- Checks that a package-info.java file exists for each package. --> + <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage --> + <!-- module name="JavadocPackage"/ --> + + <!-- Checks whether files end with a new line. --> + <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile --> + <!-- module name="NewlineAtEndOfFile"/ --> + + <!-- Checks that property files contain the same keys. --> + <!-- See http://checkstyle.sf.net/config_misc.html#Translation --> + <module name="Translation"/> + + <!-- Checks for Size Violations. --> + <!-- See http://checkstyle.sf.net/config_sizes.html --> + <module name="FileLength"/> + + <!-- Checks for whitespace --> + <!-- See http://checkstyle.sf.net/config_whitespace.html --> + <module name="FileTabCharacter"/> + + <!-- Miscellaneous other checks. --> + <!-- See http://checkstyle.sf.net/config_misc.html --> + <module name="RegexpSingleline"> + <property name="format" value="\s+$"/> + <property name="minimum" value="0"/> + <property name="maximum" value="0"/> + <property name="message" value="Line has trailing spaces."/> + </module> + + <!-- Checks for Headers --> + <!-- See http://checkstyle.sf.net/config_header.html --> + <!-- <module name="Header"> --> + <!-- <property name="headerFile" value="${checkstyle.header.file}"/> --> + <!-- <property name="fileExtensions" value="java"/> --> + <!-- </module> --> + + <module name="TreeWalker"> + <module name="SuppressWarningsHolder"/> + + <!-- Checks for Javadoc comments. --> + <!-- See http://checkstyle.sf.net/config_javadoc.html --> + <!-- + <module name="JavadocMethod"/> + <module name="JavadocType"> + <property name="scope" value="public"/> + <property name="allowMissingParamTags" value="true"/> + </module> + <module name="JavadocVariable"/> + <module name="JavadocStyle"/> + --> + + <!-- Checks for Naming Conventions. --> + <!-- See http://checkstyle.sf.net/config_naming.html --> + <module name="ConstantName"/> + <module name="LocalFinalVariableName"/> + <module name="LocalVariableName"/> + <module name="MemberName"/> + <module name="MethodName"/> + <module name="PackageName"/> + <module name="ParameterName"/> + <module name="StaticVariableName"/> + <module name="TypeName"/> + + <!-- Checks for imports --> + <!-- See http://checkstyle.sf.net/config_import.html --> + <!-- module name="AvoidStarImport"/ --> + <module name="IllegalImport"/> <!-- defaults to sun.* packages --> + <module name="RedundantImport"/> + <module name="UnusedImports"> + <property name="processJavadoc" value="false"/> + </module> + + <!-- Checks for Size Violations. --> + <!-- See http://checkstyle.sf.net/config_sizes.html --> + <module name="LineLength"> + <property name="max" value="120"/> + </module> + <module name="MethodLength"/> + <module name="ParameterNumber"> + <property name="ignoreOverriddenMethods" value="true"/> + </module> + + <!-- Checks for whitespace --> + <!-- See http://checkstyle.sf.net/config_whitespace.html --> + <!-- + <module name="EmptyForIteratorPad"/> + <module name="GenericWhitespace"/> + <module name="MethodParamPad"/> + <module name="NoWhitespaceAfter"/> + <module name="NoWhitespaceBefore"/> + <module name="OperatorWrap"/> + <module name="ParenPad"/> + <module name="TypecastParenPad"/> + <module name="WhitespaceAfter"/> + <module name="WhitespaceAround"/> + --> + + <!-- Modifier Checks --> + <!-- See http://checkstyle.sf.net/config_modifiers.html --> + <module name="ModifierOrder"/> + <module name="RedundantModifier"/> + + <!-- Checks for blocks. You know, those {}'s --> + <!-- See http://checkstyle.sf.net/config_blocks.html --> + <module name="AvoidNestedBlocks"/> + <module name="EmptyBlock"/> + <module name="LeftCurly"/> + <module name="NeedBraces"/> + <module name="RightCurly"/> + + <!-- Checks for common coding problems --> + <!-- See http://checkstyle.sf.net/config_coding.html --> + <!-- module name="AvoidInlineConditionals"/ --> + <module name="EmptyStatement"/> + <module name="EqualsHashCode"/> + <module name="HiddenField"> + <property name="ignoreConstructorParameter" value="true"/> + <property name="ignoreSetter" value="true"/> + <property name="setterCanReturnItsClass" value="true"/> + </module> + <module name="IllegalInstantiation"/> + <!-- module name="InnerAssignment"/--> + <!-- module name="MagicNumber"/ --> + <module name="MissingSwitchDefault"/> + <module name="SimplifyBooleanExpression"/> + <module name="SimplifyBooleanReturn"/> + + <!-- Checks for class design --> + <!-- See http://checkstyle.sf.net/config_design.html --> + <module name="DesignForExtension"/> + <module name="FinalClass"/> + <module name="HideUtilityClassConstructor"/> + <module name="InterfaceIsType"/> + <module name="VisibilityModifier"/> + + <!-- Miscellaneous other checks. --> + <!-- See http://checkstyle.sf.net/config_misc.html --> + <module name="ArrayTypeStyle"/> + <!-- module name="FinalParameters"/ --> + <!-- module name="TodoComment"/ --> + <module name="UpperEll"/> + + </module> + +</module> http://git-wip-us.apache.org/repos/asf/incubator-ratis/blob/16cadb68/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index 811ea18..77c54c4 100644 --- a/pom.xml +++ b/pom.xml @@ -136,7 +136,7 @@ <maven-antrun-plugin.version>1.7</maven-antrun-plugin.version> <maven-assembly-plugin.version>3.0.0</maven-assembly-plugin.version> <maven-bundle-plugin.version>2.5.3</maven-bundle-plugin.version> - <maven-checkstyle-plugin.version>2.15</maven-checkstyle-plugin.version> + <maven-checkstyle-plugin.version>3.0.0</maven-checkstyle-plugin.version> <maven-clean-plugin.version>3.0.0</maven-clean-plugin.version> <maven-clover2-plugin.version>3.3.0</maven-clover2-plugin.version> <maven-compiler-plugin.version>3.7.0</maven-compiler-plugin.version> @@ -675,6 +675,11 @@ <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> <version>${maven-checkstyle-plugin.version}</version> + <configuration> + <configLocation>${basedir}/../dev-support/checkstyle.xml</configLocation> + <failOnViolation>false</failOnViolation> + <linkXRef>false</linkXRef> + </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId>
