├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── checkstyle.gradle
└── config
    ├── checkstyle-noframes-sorted.xsl
    └── checkstyle.xml


/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # Contributing to Freshly Pressed
 2 | 
 3 | Thanks for considering contributing to the project!
 4 | 
 5 | Here's the set of guidelines to follow:
 6 | 
 7 | * Open up issues but please, try to see if that issue has been raised before and possibly fixed
 8 | * Send your Pull Requests with as much background info as possible
 9 | 
10 | ## Commit messages
11 | * Use the present tense ("Add feature" not "Added feature")
12 | * Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
13 | * Limit the first line to 72 characters or less


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License
 2 | 
 3 | Copyright (c) 2010-2015 Stefanos Togoulidis
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in
13 | all copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 | THE SOFTWARE.
22 | 
23 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # checkstyle-android
 2 | 
 3 | A [gradle checkstyle](https://docs.gradle.org/current/userguide/checkstyle_plugin.html) configuration that most closely matches the [Android Code Style Guidelines for Contributors](https://source.android.com/source/code-style.html). Many Android projects chose to follow those guidelines and this checkstyle configuration helps enforce them on your code.
 4 | 
 5 | This is still Work-In-Progress! Only a few rules have been implemented so far. Check the #Contributing section below on how to contrbute ;)
 6 | 
 7 | ## Usage
 8 | 
 9 | You can just grab [the rules file](config/checkstyle.xml) and use it with your own checkstyle setup or you can add this repo as a git submodule:
10 | ```
11 | git submodule add git@github.com:hypest/checkstyle-android.git
12 | ```
13 | Add it in your project's `build.gradle` like this:
14 | ```
15 | apply from: 'checkstyle-android/checkstyle.gradle'
16 | ```
17 | You can now run the checks at the command line:
18 | ```
19 | ./gradlew checkstyle
20 | ```
21 | Xml and html reports will be created in `<project build dir>/reports/checkstyle/`
22 | 
23 | You may opt to have the build fail if checkstyle reports issues. You can enable that by adding to build.gradle:
24 | ```
25 | preBuild.dependsOn('checkstyle')
26 | ```
27 | ## Prerequisities
28 | 
29 | You will need gradle or AndroidStudio.
30 | 
31 | ## Contributing
32 | 
33 | Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and how you can contribute to this project!
34 | 
35 | ## License
36 | 
37 | This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
38 | 


--------------------------------------------------------------------------------
/checkstyle.gradle:
--------------------------------------------------------------------------------
 1 | apply plugin: 'checkstyle'
 2 | 
 3 | checkstyle {
 4 |     toolVersion = "6.5"
 5 | }
 6 | 
 7 | task checkstyle (type: Checkstyle) {
 8 |     description 'Runs Checkstyle inspection against Android sourcesets.'
 9 |     group = 'Code Quality'
10 | 
11 |     ignoreFailures = false
12 |     showViolations = false
13 |     source 'src/main', 'src/release', 'src/androidTest/java'
14 |     include '**/*.java'
15 |     exclude '**/gen/**'
16 |     exclude '**/R.java'
17 |     exclude '**/BuildConfig.java'
18 |     reports {
19 |         xml.destination "$project.buildDir/reports/checkstyle/checkstyle-report.xml"
20 |     }
21 |     classpath = files()
22 |     configFile = file("checkstyle-android/config/checkstyle.xml")
23 | 
24 |     configProperties.lineWidth = 120
25 | }
26 | 
27 | task checkstyleReport << {
28 |     if (file("$buildDir/reports/checkstyle/checkstyle-report.xml").exists()) {
29 |         ant.xslt(in: "$project.buildDir/reports/checkstyle/checkstyle-report.xml",
30 |                 style:"checkstyle-android/config/checkstyle-noframes-sorted.xsl",
31 |                 out:"$project.buildDir/reports/checkstyle/checkstyle-report.html"
32 |         )
33 |     }
34 | }
35 | 
36 | gradle.taskGraph.afterTask {Task task, TaskState state ->
37 |     if (task.name in ['checkstyle']) {
38 |         checkstyleReport.execute()
39 |     }
40 | }
41 | 


--------------------------------------------------------------------------------
/config/checkstyle-noframes-sorted.xsl:
--------------------------------------------------------------------------------
  1 | <xsl:stylesheet	xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
  2 | <xsl:output method="html" indent="yes"/>
  3 | <xsl:decimal-format decimal-separator="." grouping-separator="," />
  4 | 
  5 | <xsl:key name="files" match="file" use="@name" />
  6 | 
  7 | <!-- Checkstyle XML Style Sheet by Stephane Bailliez <sbailliez@apache.org>         -->
  8 | <!-- Part of the Checkstyle distribution found at http://checkstyle.sourceforge.net -->
  9 | <!-- Usage (generates checkstyle_report.html):                                      -->
 10 | <!--    <checkstyle failonviolation="false" config="${check.config}">               -->
 11 | <!--      <fileset dir="${src.dir}" includes="**/*.java"/>                          -->
 12 | <!--      <formatter type="xml" toFile="${doc.dir}/checkstyle_report.xml"/>         -->
 13 | <!--    </checkstyle>                                                               -->
 14 | <!--    <style basedir="${doc.dir}" destdir="${doc.dir}"                            -->
 15 | <!--            includes="checkstyle_report.xml"                                    -->
 16 | <!--            style="${doc.dir}/checkstyle-noframes-sorted.xsl"/>                 -->
 17 | 
 18 | <xsl:template match="checkstyle">
 19 | 	<html>
 20 | 		<head>
 21 | 		<style type="text/css">
 22 |     .bannercell {
 23 |       border: 0px;
 24 |       padding: 0px;
 25 |     }
 26 |     body {
 27 |       margin-left: 10;
 28 |       margin-right: 10;
 29 |       font:normal 80% arial,helvetica,sanserif;
 30 |       background-color:#FFFFFF;
 31 |       color:#000000;
 32 |     }
 33 |     .a td {
 34 |       background: #efefef;
 35 |     }
 36 |     .b td {
 37 |       background: #fff;
 38 |     }
 39 |     th, td {
 40 |       text-align: left;
 41 |       vertical-align: top;
 42 |     }
 43 |     th {
 44 |       font-weight:bold;
 45 |       background: #ccc;
 46 |       color: black;
 47 |     }
 48 |     table, th, td {
 49 |       font-size:100%;
 50 |       border: none
 51 |     }
 52 |     table.log tr td, tr th {
 53 | 
 54 |     }
 55 |     h2 {
 56 |       font-weight:bold;
 57 |       font-size:140%;
 58 |       margin-bottom: 5;
 59 |     }
 60 |     h3 {
 61 |       font-size:100%;
 62 |       font-weight:bold;
 63 |       background: #525D76;
 64 |       color: white;
 65 |       text-decoration: none;
 66 |       padding: 5px;
 67 |       margin-right: 2px;
 68 |       margin-left: 2px;
 69 |       margin-bottom: 0;
 70 |     }
 71 | 		</style>
 72 | 		</head>
 73 | 		<body>
 74 | 			<a name="top"></a>
 75 |       <!-- jakarta logo -->
 76 |       <table border="0" cellpadding="0" cellspacing="0" width="100%">
 77 |       <tr>
 78 |         <td class="bannercell" rowspan="2">
 79 |           <!--a href="http://jakarta.apache.org/">
 80 |           <img src="http://jakarta.apache.org/images/jakarta-logo.gif" alt="http://jakarta.apache.org" align="left" border="0"/>
 81 |           </a-->
 82 |         </td>
 83 |     		<td class="text-align:right"><h2>CheckStyle Audit</h2></td>
 84 |     		</tr>
 85 |     		<tr>
 86 |     		<td class="text-align:right">Designed for use with <a href='http://checkstyle.sourceforge.net/'>CheckStyle</a> and <a href='http://jakarta.apache.org'>Ant</a>.</td>
 87 |     		</tr>
 88 |       </table>
 89 |     	<hr size="1"/>
 90 | 
 91 | 			<!-- Summary part -->
 92 | 			<xsl:apply-templates select="." mode="summary"/>
 93 | 			<hr size="1" width="100%" align="left"/>
 94 | 
 95 | 			<!-- Package List part -->
 96 | 			<xsl:apply-templates select="." mode="filelist"/>
 97 | 			<hr size="1" width="100%" align="left"/>
 98 | 
 99 | 			<!-- For each package create its part -->
100 |             <xsl:apply-templates select="file[@name and generate-id(.) = generate-id(key('files', @name))]" />
101 | 
102 | 			<hr size="1" width="100%" align="left"/>
103 | 
104 | 
105 | 		</body>
106 | 	</html>
107 | </xsl:template>
108 | 
109 | 
110 | 
111 | 	<xsl:template match="checkstyle" mode="filelist">
112 | 		<h3>Files</h3>
113 | 		<table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
114 |       <tr>
115 |         <th>Name</th>
116 |         <th>Errors</th>
117 |       </tr>
118 |           <xsl:for-each select="file[@name and generate-id(.) = generate-id(key('files', @name))]">
119 |                 <xsl:sort data-type="number" order="descending" select="count(key('files', @name)/error)"/>
120 |                 <xsl:variable name="currentName" select="@name" />
121 |                 <xsl:variable name="errorCount" select="count(key('files', @name)/error)"/>
122 |                 <tr>
123 |           <xsl:call-template name="alternated-row"/>
124 | 					<td><a href="#f-{@name}"><xsl:value-of select="@name"/></a></td>
125 | 					<td><xsl:value-of select="$errorCount"/></td>
126 | 				</tr>
127 | 			</xsl:for-each>
128 | 		</table>
129 | 	</xsl:template>
130 | 
131 | 
132 | 	<xsl:template match="file">
133 |     <a name="f-{@name}"></a>
134 |     <h3>File <xsl:value-of select="@name"/></h3>
135 | 
136 |     <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
137 |     	<tr>
138 |     	  <th>Error Description</th>
139 |     	  <th>Line</th>
140 |       </tr>
141 |         <xsl:for-each select="key('files', @name)/error">
142 |           <xsl:sort data-type="number" order="ascending" select="@line"/>
143 |     	<tr>
144 |         <xsl:call-template name="alternated-row"/>
145 |     	  <td><xsl:value-of select="@message"/></td>
146 |     	  <td><xsl:value-of select="@line"/></td>
147 |     	</tr>
148 |     	</xsl:for-each>
149 |     </table>
150 |     <a href="#top">Back to top</a>
151 | 	</xsl:template>
152 | 
153 | 
154 | 	<xsl:template match="checkstyle" mode="summary">
155 | 		<h3>Summary</h3>
156 |         <xsl:variable name="fileCount" select="count(file[@name and generate-id(.) = generate-id(key('files', @name))])"/>
157 | 		<xsl:variable name="errorCount" select="count(file/error)"/>
158 | 		<table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
159 | 		<tr>
160 | 			<th>Files</th>
161 | 			<th>Errors</th>
162 | 		</tr>
163 | 		<tr>
164 | 		  <xsl:call-template name="alternated-row"/>
165 | 			<td><xsl:value-of select="$fileCount"/></td>
166 | 			<td><xsl:value-of select="$errorCount"/></td>
167 | 		</tr>
168 | 		</table>
169 | 	</xsl:template>
170 | 
171 |   <xsl:template name="alternated-row">
172 |     <xsl:attribute name="class">
173 |       <xsl:if test="position() mod 2 = 1">a</xsl:if>
174 |       <xsl:if test="position() mod 2 = 0">b</xsl:if>
175 |     </xsl:attribute>
176 |   </xsl:template>
177 | </xsl:stylesheet>
178 | 
179 | 
180 | 


--------------------------------------------------------------------------------
/config/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 | 
 6 | <module name="Checker">
 7 | 
 8 |   <module name="TreeWalker">
 9 | 
10 |     <!-- https://source.android.com/source/code-style.html#dont-ignore-exceptions -->
11 |     <module name="EmptyCatchBlockCheck">
12 |       <property name="commentFormat" value=".+"/>
13 |     </module>
14 | 
15 |     <!-- https://source.android.com/source/code-style.html#dont-catch-generic-exception -->
16 |     <module name="IllegalCatch">
17 |       <property name="illegalClassNames" value="java.lang.Exception, java.lang.Throwable"/>
18 |     </module>
19 | 
20 |     <!-- https://source.android.com/source/code-style.html#dont-use-finalizers -->
21 |     <module name="NoFinalizer"/>
22 | 
23 |     <!-- https://source.android.com/source/code-style.html#fully-qualify-imports -->
24 |     <module name="AvoidStarImport">
25 |       <property name="excludes" value="java.io,java.util,junit.framework"/>
26 |     </module>
27 | 
28 |     <!-- https://source.android.com/source/code-style.html#use-spaces-for-indentation -->
29 |     <module name="Indentation">
30 |       <property name="basicOffset" value="4"/>
31 |       <property name="lineWrappingIndentation" value="8"/>
32 |     </module>
33 | 
34 |     <!--https://source.android.com/source/code-style.html#follow-field-naming-conventions -->
35 |     <module name="MemberName">
36 |       <!-- non-public members should start with an 'm' -->
37 |       <property name="format" value="^m[A-Z][a-zA-Z0-9]*$"/>
38 |       <property name="applyToPublic" value="false"></property>
39 |       <property name="applyToProtected" value="true"></property>
40 |       <property name="applyToPrivate" value="true"></property>
41 |       <property name="applyToPackage" value="true"></property>
42 |     </module>
43 | 
44 |     <!--https://source.android.com/source/code-style.html#follow-field-naming-conventions -->
45 |     <module name="StaticVariableName">
46 |       <!-- static members should start with an 's' -->
47 |       <property name="format" value="^s[A-Z][a-zA-Z0-9]*$"/>
48 |       <property name="applyToPublic" value="false"></property>
49 |     </module>
50 | 
51 |     <!--https://source.android.com/source/code-style.html#follow-field-naming-conventions -->
52 |     <module name="MemberName">
53 |       <!-- public members should not start with an 'm' -->
54 |       <property name="format" value="^(?:[a-l|n-z][a-zA-Z0-9]*)$|^(?:m[a-z]+[a-zA-Z0-9]*)$"/>
55 |       <property name="applyToPublic" value="true"></property>
56 |       <property name="applyToProtected" value="false"></property>
57 |       <property name="applyToPrivate" value="false"></property>
58 |       <property name="applyToPackage" value="false"></property>
59 |     </module>
60 | 
61 |     <!--https://source.android.com/source/code-style.html#follow-field-naming-conventions -->
62 |     <module name="ConstantName"/>
63 | 
64 |     <module name="FileContentsHolder"/> <!-- Required by comment suppression filters -->
65 | 
66 |   </module>
67 | 
68 |   <!-- https://source.android.com/source/code-style.html#use-spaces-for-indentation -->
69 |   <module name="FileTabCharacter"/>
70 | 
71 |   <!-- Enable suppression comments -->
72 |   <module name="SuppressionCommentFilter">
73 |     <property name="offCommentFormat" value="CHECKSTYLE IGNORE\s+(\S+)"/>
74 |     <property name="onCommentFormat" value="CHECKSTYLE END IGNORE\s+(\S+)"/>
75 |     <property name="checkFormat" value="$1"/>
76 |   </module>
77 |   <module name="SuppressWithNearbyCommentFilter">
78 |     <!-- Syntax is "SUPPRESS CHECKSTYLE name" -->
79 |     <property name="commentFormat" value="SUPPRESS CHECKSTYLE (\w+)"/>
80 |     <property name="checkFormat" value="$1"/>
81 |     <property name="influenceFormat" value="1"/>
82 |   </module>
83 | </module>


--------------------------------------------------------------------------------