tools/android/checkstyle/chromium-style-5.0.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
   3
   4 <!--
   5   See installation instructions: https://sites.google.com/a/chromium.org/dev/checkstyle
   6 -->
   7 <module name="Checker">
   8   <property name="severity" value="warning"/>
   9   <property name="charset" value="UTF-8"/>
  10   <module name="TreeWalker">
  11     <module name="AvoidStarImport">
  12       <property name="severity" value="error"/>
  13     </module>
  14     <module name="IllegalCatch">
  15       <property name="severity" value="info"/>
  16     </module>
  17     <module name="RedundantImport">
  18       <message key="import.redundant" value="Redundant import: {0}. Use :JavaImportOrganize (ECLIM) or Ctrl+Shift+O (Eclipse) to sort imports"/>
  19       <!-- This check is set to a warning because JNI generator sometimes requires to leave an unused import -->
  20       <property name="severity" value="warning"/>
  21     </module>
  22     <module name="UnusedImports">
  23       <message key="import.unused" value="Unused import: {0}. Use :JavaImportOrganize (ECLIM) or Ctrl+Shift+O (Eclipse) to sort imports"/>
  24       <!-- This check is set to a warning because JNI generator sometimes requires to leave an unused import -->
  25       <property name="severity" value="warning"/>
  26       <property name="processJavadoc" value="true"/>
  27     </module>
  28     <module name="JavadocType">
  29       <property name="severity" value="warning"/>
  30       <property name="tokens" value="INTERFACE_DEF, CLASS_DEF"/>
  31       <property name="scope" value="public"/>
  32       <message key="javadoc.missing" value="Public classes and interfaces require JavaDoc comments."/>
  33     </module>
  34     <module name="JavadocMethod">
  35       <property name="severity" value="info"/>
  36       <property name="scope" value="public"/>
  37       <property name="allowMissingParamTags" value="true"/>
  38       <property name="allowMissingPropertyJavadoc" value="true"/>
  39       <property name="allowMissingReturnTag" value="true"/>
  40       <property name="allowMissingThrowsTags" value="true"/>
  41     </module>
  42     <module name="PackageName">
  43       <property name="severity" value="error"/>
  44       <property name="format" value="^[a-z]+(\.[a-z][a-z0-9_]{1,})*$"/>
  45     </module>
  46     <module name="SimplifyBooleanExpression">
  47       <property name="severity" value="error"/>
  48     </module>
  49     <module name="SimplifyBooleanReturn">
  50       <property name="severity" value="error"/>
  51     </module>
  52     <module name="TypeName">
  53       <property name="severity" value="error"/>
  54     </module>
  55     <module name="ConstantName">
  56       <property name="severity" value="error"/>
  57       <property name="format" value="^([A-Z][A-Z0-9]*(_[A-Z0-9]+)*)|(s[A-Z][a-zA-Z0-9]*)$"/>
  58       <message key="name.invalidPattern" value="Static final field names must either be all caps (e.g. int HEIGHT_PX) for 'true' constants, or start with s (e.g. AtomicInteger sNextId or Runnable sSuspendTask) for fields with mutable state or that don't 'feel' like constants."/>
  59     </module>
  60     <!-- Non-public, non-static field names start with m. -->
  61     <module name="MemberName">
  62         <property name="severity" value="error"/>
  63         <property name="format" value="^m[A-Z][a-zA-Z0-9]*$"/>
  64         <property name="applyToPublic" value="false"/>
  65         <message key="name.invalidPattern" value="Non-public, non-static field names start with m."/>
  66     </module>
  67     <!-- Static field names start with s. -->
  68     <module name="StaticVariableName">
  69         <property name="severity" value="error"/>
  70         <property name="format" value="^s[A-Z][a-zA-Z0-9]*$"/>
  71         <property name="applyToPublic" value="false"/>
  72         <message key="name.invalidPattern" value="Static field names start with s."/>
  73     </module>
  74     <module name="MethodName">
  75         <property name="severity" value="error"/>
  76         <property name="format" value="^[a-z][a-zA-Z0-9_]*$"/>
  77         <message key="name.invalidPattern" value="Method names should start with a lower case letter (e.g. getWidth())"/>
  78     </module>
  79     <module name="ParameterName">
  80       <property name="severity" value="error"/>
  81     </module>
  82     <module name="LocalFinalVariableName">
  83       <property name="severity" value="error"/>
  84       <property name="format" value="^m|s|((([ms][a-z0-9])|([a-ln-rt-z]))[a-zA-Z0-9]*)$"/>
  85       <message key="name.invalidPattern" value="Local variables should be camel-cased (e.g. int minWidth = 4)."/>
  86     </module>
  87     <module name="LocalVariableName">
  88       <property name="severity" value="error"/>
  89       <property name="format" value="^m|s|((([ms][a-z0-9])|([a-ln-rt-z]))[a-zA-Z0-9]*)$"/>
  90       <message key="name.invalidPattern" value="Local variables should be camel-cased (e.g. int minWidth = 4)."/>
  91     </module>
  92     <module name="LineLength">
  93       <property name="severity" value="error"/>
  94       <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
  95       <property name="max" value="100"/>
  96     </module>
  97     <module name="LeftCurly">
  98       <property name="severity" value="error"/>
  99     </module>
 100     <module name="RightCurly">
 101       <property name="severity" value="error"/>
 102     </module>
 103     <module name="NeedBraces">
 104       <message key="needBraces" value="if, for, while, and do require curly braces unless they are single-line statements."/>
 105       <property name="severity" value="error"/>
 106       <property name="tokens" value="LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, LITERAL_IF"/>
 107       <property name="allowSingleLineStatement" value="true"/>
 108     </module>
 109     <module name="EmptyBlock">
 110       <property name="severity" value="error"/>
 111       <property name="option" value="text"/>
 112       <metadata name="altname" value="EmptyCatchBlock"/>
 113     </module>
 114     <module name="UpperEll">
 115       <property name="severity" value="error"/>
 116     </module>
 117     <module name="FallThrough">
 118       <property name="severity" value="error"/>
 119       <property name="reliefPattern" value=".*"/>
 120     </module>
 121     <module name="ModifierOrder">
 122       <property name="severity" value="error"/>
 123     </module>
 124     <module name="WhitespaceAround">
 125       <property name="severity" value="error"/>
 126       <property name="tokens" value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, EQUAL, GE, GT, LAND, LE, LITERAL_ASSERT, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN, TYPE_EXTENSION_AND" />
 127       <property name="allowEmptyConstructors" value="true"/>
 128       <property name="allowEmptyMethods" value="true"/>
 129    </module>
 130     <module name="WhitespaceAfter">
 131       <property name="severity" value="error"/>
 132       <property name="tokens" value="COMMA, SEMI, TYPECAST"/>
 133     </module>
 134     <module name="NoWhitespaceAfter">
 135       <property name="severity" value="error"/>
 136       <property name="tokens" value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS"/>
 137     </module>
 138     <module name="NoWhitespaceBefore">
 139       <property name="severity" value="error"/>
 140       <property name="allowLineBreaks" value="true"/>
 141       <property name="tokens" value="SEMI, DOT, POST_DEC, POST_INC"/>
 142     </module>
 143     <module name="GenericWhitespace">
 144       <property name="severity" value="error"/>
 145       <message key="ws.followed"
 146        value="GenericWhitespace ''{0}'' is followed by whitespace."/>
 147        <message key="ws.preceded"
 148        value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
 149        <message key="ws.illegalFollow"
 150        value="GenericWhitespace ''{0}'' should followed by whitespace."/>
 151        <message key="ws.notPreceded"
 152        value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
 153     </module>
 154     <module name="EmptyStatement">
 155       <property name="severity" value="error"/>
 156     </module>
 157     <module name="NoFinalizer">
 158       <property name="severity" value="info"/>
 159     </module>
 160     <module name="ParenPad">
 161       <property name="severity" value="error"/>
 162     </module>
 163     <module name="MethodParamPad">
 164       <property name="severity" value="error"/>
 165     </module>
 166     <module name="ImportOrder">
 167       <property name="severity" value="error"/>
 168       <message key="import.ordering" value="Wrong order for {0} import. Use :JavaImportOrganize (ECLIM) or Ctrl+Shift+O (Eclipse) to sort imports"/>
 169       <property name="groups" value="android, com, dalvik, gov, junit, libcore, net, org, java, javax"/>
 170       <property name="ordered" value="true"/>
 171       <property name="option" value="top"/>
 172       <property name="separated" value="true"/>
 173     </module>
 174     <module name="Indentation">
 175       <property name="severity" value="error"/>
 176       <property name="basicOffset" value="4"/>
 177       <property name="throwsIndent" value="8"/>
 178       <property name="lineWrappingIndentation" value="8"/>
 179     </module>
 180     <!-- TODO(aurimas): make OperatorWrap into an error once all the warnings are fixed. -->
 181     <module name="OperatorWrap">
 182       <property name="severity" value="error"/>
 183       <property name="option" value="NL" />
 184       <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 " />
 185     </module>
 186     <module name="OperatorWrap">
 187      <property name="severity" value="error"/>
 188      <property name="option" value="eol"/>
 189      <property name="tokens" value="ASSIGN"/>
 190     </module>
 191     <module name="SeparatorWrap">
 192       <property name="severity" value="error"/>
 193       <property name="tokens" value="DOT"/>
 194       <property name="option" value="nl"/>
 195     </module>
 196     <module name="SeparatorWrap">
 197       <property name="severity" value="error"/>
 198       <property name="tokens" value="COMMA"/>
 199       <property name="option" value="EOL"/>
 200     </module>
 201   </module>
 202   <module name="FileTabCharacter">
 203     <property name="severity" value="error"/>
 204   </module>
 205   <module name="RegexpSingleline">
 206     <property name="severity" value="error"/>
 207     <property name="format" value="[ \t]+$"/>
 208     <property name="message" value="Trailing whitespace"/>
 209     </module>
 210   <module name="RegexpHeader">
 211     <property name="severity" value="error"/>
 212     <property name="header" value="^// Copyright 20\d\d The Chromium Authors. All rights reserved.$\n^// Use of this source code is governed by a BSD-style license that can be$\n^// found in the LICENSE file.$"/>
 213   </module>
 214 </module>