[GitHub] incubator-distributedlog pull request #54: DL-129: Enable checkstyle plugin ...

[sijie <gi...@git.apache.org>]

Github user sijie commented on a diff in the pull request:

    https://github.com/apache/incubator-distributedlog/pull/54#discussion_r92026632
  
    --- Diff: distributedlog-build-tools/src/main/resources/distributedlog/checkstyle.xml ---
    @@ -0,0 +1,443 @@
    +<?xml version="1.0" encoding="UTF-8"?>
    +<!--
    +    Licensed to the Apache Software Foundation (ASF) under one or more
    +    contributor license agreements.  See the NOTICE file distributed with
    +    this work for additional information regarding copyright ownership.
    +    The ASF licenses this file to You 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.
    +-->
    +<!DOCTYPE module PUBLIC
    +    "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
    +    "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
    +
    +<!-- This is a checkstyle configuration file. For descriptions of
    +what the following rules do, please see the checkstyle configuration
    +page at http://checkstyle.sourceforge.net/config.html -->
    +
    +<module name="Checker">
    +
    +  <module name="FileTabCharacter">
    +    <!-- Checks that there are no tab characters in the file. -->
    +  </module>
    +
    +  <module name="RegexpSingleline">
    +    <!-- Checks that TODOs don't have stuff in parenthesis, e.g., username. -->
    +    <property name="format" value="((//.*)|(\*.*))TODO\(" />
    +    <property name="message" value="TODO comments must not include usernames." />
    +    <property name="severity" value="error" />
    +  </module>
    +
    +  <module name="RegexpSingleline">
    +    <property name="format" value="\s+$"/>
    +    <property name="message" value="Trailing whitespace"/>
    +    <property name="severity" value="error"/>
    +  </module>
    +
    +  <module name="RegexpSingleline">
    +    <property name="format" value="Throwables.propagate\("/>
    +    <property name="message" value="Throwables.propagate is deprecated"/>
    +    <property name="severity" value="error"/>
    +  </module>
    +
    +  <!-- Prevent *Tests.java as tools may not pick them up -->
    +  <module name="RegexpOnFilename">
    +    <property name="fileNamePattern" value=".*Tests\.java$" />
    +  </module>
    +
    +  <!-- Allow use of comment to suppress javadocstyle -->
    +  <module name="SuppressionCommentFilter">
    +    <property name="offCommentFormat" value="CHECKSTYLE.OFF\: ([\w\|]+)"/>
    +    <property name="onCommentFormat" value="CHECKSTYLE.ON\: ([\w\|]+)"/>
    +    <property name="checkFormat" value="$1"/>
    +  </module>
    +  <module name="SuppressionFilter">
    +    <property name="file" value="${checkstyle.suppressions.file}" default="suppressions.xml" />
    +  </module>
    +
    +  <!-- Check that every module has a package-info.java -->
    +  <module name="JavadocPackage"/>
    +
    +  <!-- All Java AST specific tests live under TreeWalker module. -->
    +  <module name="TreeWalker">
    +
    +    <module name="TodoComment">
    +      <!-- Checks that disallowed strings are not used in comments.  -->
    +      <property name="format" value="(FIXME)|(XXX)|(@author)" />
    +    </module>
    +
    +    <!--
    +
    +    IMPORT CHECKS
    +
    +    -->
    +
    +    <module name="RedundantImport">
    +      <!-- Checks for redundant import statements. -->
    +      <property name="severity" value="error"/>
    +      <message key="import.redundancy"
    +               value="Redundant import {0}."/>
    +    </module>
    +
    +    <module name="ImportOrder">
    +      <!-- Checks for out of order import statements. -->
    +      <property name="severity" value="error"/>
    +      <!-- This ensures that static imports go first. -->
    +      <property name="option" value="top"/>
    +      <property name="sortStaticImportsAlphabetically" value="true"/>
    +      <property name="tokens" value="STATIC_IMPORT, IMPORT"/>
    +      <message key="import.ordering"
    +               value="Import {0} appears after other imports that it should precede"/>
    +    </module>
    +
    +    <module name="AvoidStarImport">
    +      <property name="severity" value="error"/>
    +    </module>
    +
    +    <module name="IllegalImport">
    +      <property name="illegalPkgs" value="autovalue.shaded, avro.shaded, com.google.api.client.repackaged, com.google.appengine.repackaged, io.netty.util.internal"/>
    --- End diff --
    
    add 'bk-shade' to avoid importing shaded bookkeeper dependencies?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---