Skip to content

Commit

Permalink
Added checkstyle configuration file.
Browse files Browse the repository at this point in the history 
* Added checkstyle configuration file. Checkstyle checks
  Java code against our style guide. It integrates with
  Eclipse/Eclim or can be run as a standalone script. (See
  http://checkstyle.sourceforge.net/)

BUG=318404

Review URL: https://codereview.chromium.org/68333003

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@234774 0039d316-1c4b-4281-b951-d872f2087c98
  • Loading branch information
apiccion@chromium.org committed Nov 13, 2013
1 parent f995cfc commit 2c884f3
Show file tree
Hide file tree
Showing 2 changed files with 145 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
.pydevproject
# Settings directory for eclipse
/.settings
.checkstyle
cscope.*
Session.vim
tags
Expand Down
144 changes: 144 additions & 0 deletions tools/android/checkstyle/chromium-style-5.0.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">

<!--
See installation instructions: https://sites.google.com/a/chromium.org/dev/checkstyle
-->
<module name="Checker">
<property name="severity" value="warning"/>
<property name="charset" value="UTF-8"/>
<module name="TreeWalker">
<module name="AvoidStarImport">
<property name="severity" value="error"/>
</module>
<module name="IllegalCatch">
<property name="severity" value="error"/>
</module>
<module name="RedundantImport">
<message key="import.redundant" value="Redundant import: {0}. Use :JavaImportOrganize (ECLIM) or Ctrl+Shift+O (Eclipse) to sort imports"/>
<property name="severity" value="error"/>
</module>
<module name="UnusedImports">
<property name="severity" value="error"/>
<message key="import.unused" value="Unused import: {0}. Use :JavaImportOrganize (ECLIM) or Ctrl+Shift+O (Eclipse) to sort imports"/>
</module>
<module name="JavadocType">
<property name="severity" value="warning"/>
<property name="scope" value="protected"/>
</module>
<module name="JavadocMethod">
<property name="severity" value="warning"/>
<property name="scope" value="public"/>
<property name="allowMissingParamTags" value="true"/>
<property name="allowMissingPropertyJavadoc" value="true"/>
<property name="allowMissingReturnTag" value="true"/>
<property name="allowMissingThrowsTags" value="true"/>
</module>
<module name="PackageName">
<property name="severity" value="warning"/>
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]{1,})*$"/>
</module>
<module name="TypeName">
<property name="severity" value="warning"/>
</module>
<module name="ConstantName">
<property name="severity" value="warning"/>
<message key="name.invalidPattern" value="Variable ''{0}'' is a constant and thus should be in ALL_CAPS."/>
</module>
<!-- Non-public, non-static field names start with m. -->
<module name="MemberName">
<property name="format" value="^m[A-Z][a-zA-Z0-9]*$"/>
<property name="applyToPublic" value="false"/>
<message key="name.invalidPattern" value="Non-public, non-static field names start with m."/>
</module>
<!-- Static field names start with s. -->
<module name="StaticVariableName">
<property name="format" value="^s[A-Z][a-zA-Z0-9]*$"/>
<property name="applyToPublic" value="false"/>
<message key="name.invalidPattern" value="Static field names start with s."/>
</module>
<module name="MethodName" />
<module name="ParameterName">
<property name="severity" value="warning"/>
</module>
<module name="LocalFinalVariableName">
<property name="severity" value="warning"/>
</module>
<module name="LocalVariableName">
<property name="severity" value="warning"/>
</module>
<module name="LineLength">
<property name="severity" value="error"/>
<property name="ignorePattern" value="^import.*$" />
<property name="max" value="100"/>
</module>
<module name="LeftCurly">
<property name="severity" value="warning"/>
</module>
<module name="RightCurly">
<property name="severity" value="warning"/>
</module>
<module name="NeedBraces">
<property name="severity" value="warning"/>
<property name="tokens" value="LITERAL_FOR, LITERAL_WHILE, LITERAL_DO"/>
</module>
<module name="EmptyBlock">
<property name="severity" value="error"/>
<metadata name="altname" value="EmptyCatchBlock"/>
</module>
<module name="UpperEll">
<property name="severity" value="error"/>
</module>
<module name="FallThrough">
<property name="severity" value="error"/>
<property name="reliefPattern" value=".*"/>
</module>
<module name="ModifierOrder"/>
<module name="WhitespaceAround">
<property name="severity" value="error"/>
<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, LCURLY, 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, RCURLY, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN, TYPE_EXTENSION_AND" />
</module>
<module name="WhitespaceAfter">
<property name="tokens" value="COMMA, SEMI, TYPECAST"/>
</module>
<module name="NoWhitespaceAfter">
<property name="severity" value="error"/>
<property name="tokens" value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS"/>
</module>
<module name="NoWhitespaceBefore">
<property name="severity" value="error"/>
<property name="allowLineBreaks" value="true"/>
<property name="tokens" value="SEMI, DOT, POST_DEC, POST_INC"/>
</module>
<module name="NoFinalizer">
<property name="severity" value="error"/>
</module>
<module name="ParenPad">
<property name="severity" value="warning"/>
</module>
<module name="ImportOrder">
<property name="severity" value="warning"/>
<message key="import.ordering" value="Wrong order for {0} import. Use :JavaImportOrganize (ECLIM) or Ctrl+Shift+O (Eclipse) to sort imports"/>
<property name="groups" value="android, com, org, java"/>
<property name="ordered" value="true"/>
<property name="option" value="top"/>
<property name="separated" value="true"/>
</module>
<module name="Indentation">
<property name="basicOffset" value="4"/>
</module>
</module>
<module name="FileTabCharacter"/>
<module name="RegexpSingleline">
<property name="format" value="((//.*)|(\*.*))FIXME"/>
<property name="message" value="TODO is preferred to FIXME. e.g. &quot;TODO(johndoe):"/>
</module>
<module name="RegexpSingleline">
<property name="format" value="((//.*)|(\*.*))(?&lt;!TODO\(.{0,100})(TODO[^(])|(TODO\([^)]*$)"/>
<property name="message" value="All TODOs should be named. e.g. &quot;TODO(johndoe):"/>
</module>
<module name="RegexpSingleline">
<property name="format" value="[ \t]+$"/>
<property name="message" value="Trailing whitespace"/>
</module>
</module>

0 comments on commit 2c884f3

Please sign in to comment.