opendaylight/commons/checkstyle/src/main/resources/controller/checkstyle.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE module PUBLIC
   3     "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
   4     "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
   5 <module name="Checker">
   6
   7 <!--
   8      ======================================================================
   9         Please do not add new Checkstyle check modules here anymore:
  10
  11         1. https://git.opendaylight.org/gerrit/#/c/39797/ has aligned
  12         odl-parent's common Checkstyle rule set to include these.
  13
  14         2. As a next step, perhaps you would like to accept odl-parent's
  15         Checkstyle definition as errors instead of warnings for Controller?
  16         This is possible via violationSeverity=error as documented on
  17         https://wiki.opendaylight.org/view/BestPractices/Coding_Guidelines#Checkstyle
  18
  19         Please contact odlparent-dev@lists.opendaylight.org if you feel
  20         a Checkstyle rule is too strict in general and should be reviewed.
  21
  22         3. Ultimately this entire project (org.opendaylight.controller:checkstyle)
  23         should then be deleted, and dependencies to it removed.
  24      ======================================================================
  25  -->
  26
  27     <module name="FileTabCharacter">
  28         <property name="eachLine" value="true"/>
  29     </module>
  30
  31     <module name="RegexpSingleline">
  32         <!-- \s matches whitespace character, $ matches end of line. -->
  33         <property name="format" value="\s+$"/>
  34         <property name="message" value="Line has trailing spaces."/>
  35     </module>
  36     <module name="TreeWalker">
  37        <module name="RedundantImport"/>
  38        <module name="UnusedImports"/>
  39        <module name="AvoidStarImport"/>
  40        <module name="UpperEll"/>
  41        <module name="EmptyStatement"/>
  42        <module name="EqualsHashCode"/>
  43     </module>
  44
  45 </module>