├── .gitignore ├── LICENSE ├── README.md ├── build.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat └── src ├── main └── java │ └── com │ └── getbase │ └── lint │ ├── CustomIssueRegistry.java │ ├── issues │ ├── AncientMinSdkDetector.java │ ├── CursorWrapperDetector.java │ ├── EnumDetector.java │ ├── InvalidLintIdDetector.java │ ├── MicroOrmDetector.java │ └── TypeDefDetector.java │ └── utils │ ├── AstTreePrinter.java │ └── GradleUtils.java └── test ├── java └── com │ └── getbase │ └── lint │ ├── BaseLintDetectorTest.java │ ├── EnumDetectorTest.java │ └── InvalidLintIdDetectorTest.java └── resources ├── enum ├── TheEnum.java └── expected ├── enum_with_javadoc ├── TheEnum.java └── expected ├── enum_with_suppression ├── TheEnum.java └── expected └── invalid_lint_id_single_gradle_file ├── build.gradle └── expected /.gitignore: -------------------------------------------------------------------------------- 1 | .gradle 2 | /local.properties 3 | /.idea/workspace.xml 4 | /.idea/libraries 5 | .DS_Store 6 | /build 7 | 8 | gen 9 | 10 | .idea 11 | *.iml -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2015 Zendesk 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Android lint rules 2 | 3 | Custom Android Lint rules 4 | 5 | ## Copyright and license 6 | 7 | Copyright 2015 Zendesk 8 | 9 | Licensed under the [Apache License, Version 2.0](LICENSE) 10 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'java' 2 | 3 | buildscript { 4 | repositories { 5 | jcenter() 6 | } 7 | dependencies { 8 | classpath 'com.android.tools.build:gradle:1.3.1' 9 | classpath 'com.github.ben-manes:gradle-versions-plugin:0.11.3' 10 | } 11 | } 12 | 13 | apply plugin: 'com.github.ben-manes.versions' 14 | 15 | repositories { 16 | jcenter() 17 | } 18 | 19 | dependencies { 20 | compile 'com.android.tools.lint:lint-api:24.5.0' 21 | compile 'com.android.tools.lint:lint-checks:24.5.0' 22 | compile 'com.android.tools.lint:lint:24.5.0' 23 | compile gradleApi() 24 | testCompile 'com.android.tools.lint:lint-tests:24.5.0' 25 | } 26 | 27 | jar { 28 | baseName 'com.getbase.lint' 29 | version '1.0' 30 | 31 | manifest { 32 | attributes 'Manifest-Version': 1.0 33 | attributes 'Lint-Registry': 'com.getbase.lint.CustomIssueRegistry' 34 | } 35 | } 36 | 37 | configurations { 38 | lintChecks 39 | } 40 | 41 | dependencies { 42 | lintChecks files(jar) 43 | } 44 | 45 | task install(type: Copy) { 46 | from configurations.lintChecks 47 | into System.getProperty("user.home") + '/.android/lint/' 48 | } -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/zendesk/android-lint-rules/f664ea2abe23690a1176e3613132ef5470a298fa/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Tue Jun 16 14:34:30 CEST 2015 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-2.4-all.zip 7 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 10 | DEFAULT_JVM_OPTS="" 11 | 12 | APP_NAME="Gradle" 13 | APP_BASE_NAME=`basename "$0"` 14 | 15 | # Use the maximum available, or set MAX_FD != -1 to use that value. 16 | MAX_FD="maximum" 17 | 18 | warn ( ) { 19 | echo "$*" 20 | } 21 | 22 | die ( ) { 23 | echo 24 | echo "$*" 25 | echo 26 | exit 1 27 | } 28 | 29 | # OS specific support (must be 'true' or 'false'). 30 | cygwin=false 31 | msys=false 32 | darwin=false 33 | case "`uname`" in 34 | CYGWIN* ) 35 | cygwin=true 36 | ;; 37 | Darwin* ) 38 | darwin=true 39 | ;; 40 | MINGW* ) 41 | msys=true 42 | ;; 43 | esac 44 | 45 | # For Cygwin, ensure paths are in UNIX format before anything is touched. 46 | if $cygwin ; then 47 | [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 48 | fi 49 | 50 | # Attempt to set APP_HOME 51 | # Resolve links: $0 may be a link 52 | PRG="$0" 53 | # Need this for relative symlinks. 54 | while [ -h "$PRG" ] ; do 55 | ls=`ls -ld "$PRG"` 56 | link=`expr "$ls" : '.*-> \(.*\)$'` 57 | if expr "$link" : '/.*' > /dev/null; then 58 | PRG="$link" 59 | else 60 | PRG=`dirname "$PRG"`"/$link" 61 | fi 62 | done 63 | SAVED="`pwd`" 64 | cd "`dirname \"$PRG\"`/" >&- 65 | APP_HOME="`pwd -P`" 66 | cd "$SAVED" >&- 67 | 68 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 69 | 70 | # Determine the Java command to use to start the JVM. 71 | if [ -n "$JAVA_HOME" ] ; then 72 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 73 | # IBM's JDK on AIX uses strange locations for the executables 74 | JAVACMD="$JAVA_HOME/jre/sh/java" 75 | else 76 | JAVACMD="$JAVA_HOME/bin/java" 77 | fi 78 | if [ ! -x "$JAVACMD" ] ; then 79 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 80 | 81 | Please set the JAVA_HOME variable in your environment to match the 82 | location of your Java installation." 83 | fi 84 | else 85 | JAVACMD="java" 86 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 87 | 88 | Please set the JAVA_HOME variable in your environment to match the 89 | location of your Java installation." 90 | fi 91 | 92 | # Increase the maximum file descriptors if we can. 93 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then 94 | MAX_FD_LIMIT=`ulimit -H -n` 95 | if [ $? -eq 0 ] ; then 96 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 97 | MAX_FD="$MAX_FD_LIMIT" 98 | fi 99 | ulimit -n $MAX_FD 100 | if [ $? -ne 0 ] ; then 101 | warn "Could not set maximum file descriptor limit: $MAX_FD" 102 | fi 103 | else 104 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 105 | fi 106 | fi 107 | 108 | # For Darwin, add options to specify how the application appears in the dock 109 | if $darwin; then 110 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 111 | fi 112 | 113 | # For Cygwin, switch paths to Windows format before running java 114 | if $cygwin ; then 115 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 116 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules 158 | function splitJvmOpts() { 159 | JVM_OPTS=("$@") 160 | } 161 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS 162 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" 163 | 164 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" 165 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 12 | set DEFAULT_JVM_OPTS= 13 | 14 | set DIRNAME=%~dp0 15 | if "%DIRNAME%" == "" set DIRNAME=. 16 | set APP_BASE_NAME=%~n0 17 | set APP_HOME=%DIRNAME% 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windowz variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | if "%@eval[2+2]" == "4" goto 4NT_args 53 | 54 | :win9xME_args 55 | @rem Slurp the command line arguments. 56 | set CMD_LINE_ARGS= 57 | set _SKIP=2 58 | 59 | :win9xME_args_slurp 60 | if "x%~1" == "x" goto execute 61 | 62 | set CMD_LINE_ARGS=%* 63 | goto execute 64 | 65 | :4NT_args 66 | @rem Get arguments from the 4NT Shell from JP Software 67 | set CMD_LINE_ARGS=%$ 68 | 69 | :execute 70 | @rem Setup the command line 71 | 72 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if "%ERRORLEVEL%"=="0" goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 85 | exit /b 1 86 | 87 | :mainEnd 88 | if "%OS%"=="Windows_NT" endlocal 89 | 90 | :omega 91 | -------------------------------------------------------------------------------- /src/main/java/com/getbase/lint/CustomIssueRegistry.java: -------------------------------------------------------------------------------- 1 | package com.getbase.lint; 2 | 3 | import com.android.tools.lint.client.api.IssueRegistry; 4 | import com.android.tools.lint.detector.api.Issue; 5 | import com.getbase.lint.issues.AncientMinSdkDetector; 6 | import com.getbase.lint.issues.CursorWrapperDetector; 7 | import com.getbase.lint.issues.EnumDetector; 8 | import com.getbase.lint.issues.InvalidLintIdDetector; 9 | import com.getbase.lint.issues.MicroOrmDetector; 10 | import com.getbase.lint.issues.TypeDefDetector; 11 | 12 | import java.util.Arrays; 13 | import java.util.List; 14 | 15 | public class CustomIssueRegistry extends IssueRegistry { 16 | @Override 17 | public List getIssues() { 18 | return Arrays.asList( 19 | AncientMinSdkDetector.ISSUE, 20 | MicroOrmDetector.NO_PUBLIC_DEFAULT_CONSTRUCTOR_ISSUE, 21 | EnumDetector.ENUMS_ARE_BAD_ISSUE, 22 | TypeDefDetector.WRONG_RETENTION_POLICY, 23 | CursorWrapperDetector.USE_CROSS_PROCESS_CURSOR_WRAPPERS, 24 | InvalidLintIdDetector.ISSUE 25 | ); 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /src/main/java/com/getbase/lint/issues/AncientMinSdkDetector.java: -------------------------------------------------------------------------------- 1 | package com.getbase.lint.issues; 2 | 3 | import com.android.tools.lint.detector.api.Category; 4 | import com.android.tools.lint.detector.api.Context; 5 | import com.android.tools.lint.detector.api.Detector; 6 | import com.android.tools.lint.detector.api.Implementation; 7 | import com.android.tools.lint.detector.api.Issue; 8 | import com.android.tools.lint.detector.api.Scope; 9 | import com.android.tools.lint.detector.api.Severity; 10 | 11 | import java.util.Calendar; 12 | import java.util.EnumSet; 13 | 14 | public class AncientMinSdkDetector extends Detector { 15 | 16 | private static final int SUGGESTED_MIN_SDK_VERSION = 15; 17 | private static final int YEAR = Calendar.getInstance().get(Calendar.YEAR); 18 | 19 | public static final Issue ISSUE = Issue.create( 20 | "AncientMinSdk", 21 | "Supporting ancient Android versions", 22 | "It's " + YEAR + ", time to bump your minSdkVersion to " + SUGGESTED_MIN_SDK_VERSION, 23 | Category.CORRECTNESS, 24 | 10, 25 | Severity.FATAL, 26 | new Implementation(AncientMinSdkDetector.class, EnumSet.noneOf(Scope.class))); 27 | 28 | @Override 29 | public void afterCheckProject(Context context) { 30 | super.afterCheckProject(context); 31 | 32 | int minSdk = context.getProject().getMinSdk(); 33 | 34 | if (minSdk != -1 && minSdk < SUGGESTED_MIN_SDK_VERSION) { 35 | context.report(ISSUE, null, "Ancient minSdkVersion detected"); 36 | } 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /src/main/java/com/getbase/lint/issues/CursorWrapperDetector.java: -------------------------------------------------------------------------------- 1 | package com.getbase.lint.issues; 2 | 3 | import com.android.tools.lint.detector.api.Category; 4 | import com.android.tools.lint.detector.api.Detector; 5 | import com.android.tools.lint.detector.api.Detector.JavaScanner; 6 | import com.android.tools.lint.detector.api.Implementation; 7 | import com.android.tools.lint.detector.api.Issue; 8 | import com.android.tools.lint.detector.api.JavaContext; 9 | import com.android.tools.lint.detector.api.Scope; 10 | import com.android.tools.lint.detector.api.Severity; 11 | 12 | import java.util.Collections; 13 | import java.util.List; 14 | 15 | import lombok.ast.AstVisitor; 16 | import lombok.ast.ClassDeclaration; 17 | import lombok.ast.ForwardingAstVisitor; 18 | import lombok.ast.Node; 19 | import lombok.ast.TypeReference; 20 | 21 | public class CursorWrapperDetector extends Detector implements JavaScanner { 22 | public static final Issue USE_CROSS_PROCESS_CURSOR_WRAPPERS = Issue 23 | .create( 24 | "PreferCrossProcessCursorWrappers", 25 | "Prefer CrossProcessCursorWrapper over CursorWrapper", 26 | "" + 27 | "CrossProcessCursorWrapper provides better performance than " + 28 | "regular CursorWrapper when Cursor is used in the remote " + 29 | "process.", 30 | Category.PERFORMANCE, 31 | 1, 32 | Severity.INFORMATIONAL, 33 | new Implementation(CursorWrapperDetector.class, Scope.JAVA_FILE_SCOPE)) 34 | .addMoreInfo("http://developer.android.com/reference/android/database/CrossProcessCursor.html"); 35 | 36 | @Override 37 | public List> getApplicableNodeTypes() { 38 | return Collections.>singletonList(ClassDeclaration.class); 39 | } 40 | 41 | private static final String CURSOR_WRAPPER = "android.database.CursorWrapper"; 42 | 43 | @Override 44 | public AstVisitor createJavaVisitor(final JavaContext context) { 45 | if (context.getProject().getMinSdk() < 15) return null; 46 | 47 | return new ForwardingAstVisitor() { 48 | @Override 49 | public boolean visitClassDeclaration(ClassDeclaration node) { 50 | TypeReference extending = node.astExtending(); 51 | if (extending != null) { 52 | if (CURSOR_WRAPPER.equals(context.resolve(extending).getSignature())) { 53 | context.report( 54 | USE_CROSS_PROCESS_CURSOR_WRAPPERS, 55 | node, 56 | context.getLocation(node.astName()), 57 | String.format( 58 | "%1$s can extend CrossProcessCursorWrapper", 59 | node.astName().astValue() 60 | ) 61 | ); 62 | } 63 | } 64 | 65 | return super.visitClassDeclaration(node); 66 | } 67 | }; 68 | } 69 | } 70 | -------------------------------------------------------------------------------- /src/main/java/com/getbase/lint/issues/EnumDetector.java: -------------------------------------------------------------------------------- 1 | package com.getbase.lint.issues; 2 | 3 | import com.android.tools.lint.detector.api.Category; 4 | import com.android.tools.lint.detector.api.Detector; 5 | import com.android.tools.lint.detector.api.Detector.JavaScanner; 6 | import com.android.tools.lint.detector.api.Implementation; 7 | import com.android.tools.lint.detector.api.Issue; 8 | import com.android.tools.lint.detector.api.JavaContext; 9 | import com.android.tools.lint.detector.api.Scope; 10 | import com.android.tools.lint.detector.api.Severity; 11 | 12 | import java.util.Collections; 13 | import java.util.List; 14 | 15 | import lombok.ast.AstVisitor; 16 | import lombok.ast.EnumDeclaration; 17 | import lombok.ast.ForwardingAstVisitor; 18 | import lombok.ast.Node; 19 | 20 | public class EnumDetector extends Detector implements JavaScanner { 21 | public static final Issue ENUMS_ARE_BAD_ISSUE = Issue.create( 22 | "EnumsAreBad", 23 | "M'kay?", 24 | "" + 25 | "Every byte is sacred,\n" + 26 | "Every byte is great.\n" + 27 | "If a byte is wasted,\n" + 28 | "Colt gets quite irate.", 29 | Category.PERFORMANCE, 30 | 1, 31 | Severity.INFORMATIONAL, 32 | new Implementation(EnumDetector.class, Scope.JAVA_FILE_SCOPE)); 33 | 34 | @Override 35 | public List> getApplicableNodeTypes() { 36 | return Collections.>singletonList(EnumDeclaration.class); 37 | } 38 | 39 | @Override 40 | public AstVisitor createJavaVisitor(final JavaContext context) { 41 | return new ForwardingAstVisitor() { 42 | @Override 43 | public boolean visitEnumDeclaration(EnumDeclaration node) { 44 | context.report( 45 | ENUMS_ARE_BAD_ISSUE, 46 | node.astName(), 47 | context.getLocation(node.astName()), 48 | String.format( 49 | "Consider using int constants instead of %1$s", 50 | node.astName().astValue() 51 | ) 52 | ); 53 | 54 | return super.visitEnumDeclaration(node); 55 | } 56 | }; 57 | } 58 | } 59 | -------------------------------------------------------------------------------- /src/main/java/com/getbase/lint/issues/InvalidLintIdDetector.java: -------------------------------------------------------------------------------- 1 | package com.getbase.lint.issues; 2 | 3 | import static com.google.common.base.Preconditions.checkNotNull; 4 | 5 | import com.android.annotations.NonNull; 6 | import com.android.tools.lint.detector.api.Category; 7 | import com.android.tools.lint.detector.api.Context; 8 | import com.android.tools.lint.detector.api.Detector; 9 | import com.android.tools.lint.detector.api.Detector.GradleScanner; 10 | import com.android.tools.lint.detector.api.Implementation; 11 | import com.android.tools.lint.detector.api.Issue; 12 | import com.android.tools.lint.detector.api.Location; 13 | import com.android.tools.lint.detector.api.Scope; 14 | import com.android.tools.lint.detector.api.Severity; 15 | import com.getbase.lint.utils.GradleUtils; 16 | import com.google.common.base.Function; 17 | import com.google.common.base.Predicates; 18 | import com.google.common.collect.FluentIterable; 19 | import com.google.common.collect.ImmutableList; 20 | import com.google.common.collect.ImmutableSet; 21 | import com.google.common.collect.Iterables; 22 | 23 | import org.codehaus.groovy.ast.CodeVisitorSupport; 24 | import org.codehaus.groovy.ast.builder.AstBuilder; 25 | import org.codehaus.groovy.ast.expr.ArgumentListExpression; 26 | import org.codehaus.groovy.ast.expr.ConstantExpression; 27 | import org.codehaus.groovy.ast.expr.Expression; 28 | import org.codehaus.groovy.ast.expr.MethodCallExpression; 29 | import org.codehaus.groovy.ast.expr.TupleExpression; 30 | import org.codehaus.groovy.ast.expr.VariableExpression; 31 | 32 | import java.io.File; 33 | import java.util.ArrayList; 34 | import java.util.List; 35 | import java.util.Map; 36 | import java.util.Stack; 37 | 38 | public class InvalidLintIdDetector extends Detector implements GradleScanner { 39 | public static final Issue ISSUE = Issue.create( 40 | "InvalidLintId", 41 | "Referencing non-existing lint issue id in your config", 42 | "Configuration references lint rule which doesn't exist, probably because of typo", 43 | Category.CORRECTNESS, 44 | 10, 45 | Severity.FATAL, 46 | new Implementation( 47 | InvalidLintIdDetector.class, 48 | Scope.GRADLE_SCOPE 49 | ) 50 | ); 51 | 52 | @Override 53 | public boolean appliesTo(@NonNull Context context, @NonNull File file) { 54 | return true; 55 | } 56 | 57 | @Override 58 | public void visitBuildScript(@NonNull Context context, Map sharedData) { 59 | ImmutableSet validIssuesIds = getValidIssuesIds(context); 60 | 61 | for (IssueReference issueReference : extractIssuesReferences(context)) { 62 | if (!validIssuesIds.contains(issueReference.getIssueId())) { 63 | context.report( 64 | ISSUE, 65 | issueReference.getLocation(), 66 | String.format( 67 | "Unknown lint issue id: %1$s", 68 | issueReference.getIssueId() 69 | ) 70 | ); 71 | } 72 | } 73 | } 74 | 75 | private static abstract class IssueReference { 76 | abstract String getIssueId(); 77 | abstract Location getLocation(); 78 | } 79 | 80 | private static ImmutableSet getValidIssuesIds(Context context) { 81 | return FluentIterable 82 | .from(context.getDriver().getRegistry().getIssues()) 83 | .transform(new Function() { 84 | @Override 85 | public String apply(Issue input) { 86 | return input.getId(); 87 | } 88 | }) 89 | .toSet(); 90 | } 91 | 92 | private static Iterable extractIssuesReferences(final Context context) { 93 | BuildScriptVisitor visitor = new BuildScriptVisitor(); 94 | 95 | String buildScriptSource = checkNotNull(context.getContents()); 96 | 97 | Iterables 98 | .getOnlyElement(new AstBuilder().buildFromString(buildScriptSource)) 99 | .visit(visitor); 100 | 101 | return FluentIterable 102 | .from(visitor.mIssueIdsExpressions) 103 | .transform(new Function() { 104 | @Override 105 | public IssueReference apply(final Expression expression) { 106 | return new IssueReference() { 107 | @Override 108 | String getIssueId() { 109 | return expression.getText(); 110 | } 111 | 112 | @Override 113 | Location getLocation() { 114 | return GradleUtils.createLocation(context, expression); 115 | } 116 | }; 117 | } 118 | }); 119 | } 120 | 121 | private static class BuildScriptVisitor extends CodeVisitorSupport { 122 | private final Stack mScopeStack = new Stack<>(); 123 | 124 | public final List mIssueIdsExpressions = new ArrayList<>(); 125 | 126 | @Override 127 | public void visitMethodCallExpression(MethodCallExpression call) { 128 | int stackSize = mScopeStack.size(); 129 | 130 | System.out.println(call); 131 | 132 | call.getObjectExpression().visit(this); 133 | call.getMethod().visit(this); 134 | 135 | if (parseLintIssuesId()) { 136 | if (call.getArguments() instanceof ArgumentListExpression) { 137 | FluentIterable 138 | .from(((ArgumentListExpression) call.getArguments()).getExpressions()) 139 | .filter(Predicates.instanceOf(ConstantExpression.class)) 140 | .copyInto(mIssueIdsExpressions); 141 | } 142 | } else { 143 | call.getArguments().visit(this); 144 | } 145 | 146 | mScopeStack.setSize(stackSize); 147 | } 148 | 149 | @Override 150 | public void visitTupleExpression(TupleExpression expression) { 151 | super.visitTupleExpression(expression); 152 | } 153 | 154 | private static final ImmutableList LINT_OPTIONS_SCOPE = ImmutableList.of("android", "lintOptions"); 155 | private static final ImmutableSet ISSUE_CONFIG_METHODS = ImmutableSet.of( 156 | "check", 157 | "disable", 158 | "enable", 159 | "error", 160 | "fatal", 161 | "ignore", 162 | "warning" 163 | ); 164 | 165 | private boolean parseLintIssuesId() { 166 | return ISSUE_CONFIG_METHODS.contains(mScopeStack.peek()) && scopeStackInitMatches(LINT_OPTIONS_SCOPE); 167 | } 168 | 169 | private boolean scopeStackInitMatches(Iterable expectedMatch) { 170 | Iterable init = Iterables.limit(mScopeStack, mScopeStack.size() - 1); 171 | return Iterables.elementsEqual(init, expectedMatch); 172 | } 173 | 174 | @Override 175 | public void visitVariableExpression(VariableExpression expression) { 176 | updateScope(expression); 177 | } 178 | 179 | @Override 180 | public void visitConstantExpression(ConstantExpression expression) { 181 | updateScope(expression); 182 | } 183 | 184 | private void updateScope(Expression expression) { 185 | String text = expression.getText(); 186 | if (!text.equals("this")) { 187 | mScopeStack.push(text); 188 | } 189 | } 190 | } 191 | } 192 | -------------------------------------------------------------------------------- /src/main/java/com/getbase/lint/issues/MicroOrmDetector.java: -------------------------------------------------------------------------------- 1 | package com.getbase.lint.issues; 2 | 3 | import static com.android.SdkConstants.CONSTRUCTOR_NAME; 4 | 5 | import com.android.tools.lint.detector.api.Category; 6 | import com.android.tools.lint.detector.api.ClassContext; 7 | import com.android.tools.lint.detector.api.Detector; 8 | import com.android.tools.lint.detector.api.Detector.ClassScanner; 9 | import com.android.tools.lint.detector.api.Implementation; 10 | import com.android.tools.lint.detector.api.Issue; 11 | import com.android.tools.lint.detector.api.LintUtils; 12 | import com.android.tools.lint.detector.api.Scope; 13 | import com.android.tools.lint.detector.api.Severity; 14 | 15 | import org.objectweb.asm.Opcodes; 16 | import org.objectweb.asm.tree.AnnotationNode; 17 | import org.objectweb.asm.tree.ClassNode; 18 | import org.objectweb.asm.tree.FieldNode; 19 | import org.objectweb.asm.tree.MethodNode; 20 | 21 | import java.util.List; 22 | 23 | public class MicroOrmDetector extends Detector implements ClassScanner { 24 | 25 | public static final Issue NO_PUBLIC_DEFAULT_CONSTRUCTOR_ISSUE = Issue.create( 26 | "MicroOrmDefaultConstructor", 27 | "MicroOrm annotated class without public default constructor", 28 | "`MicroOrm.fromCursor()` and `MicroOrm.getFunctionFor()` needs a public default constructor.", 29 | Category.CORRECTNESS, 30 | 7, 31 | Severity.WARNING, 32 | new Implementation(MicroOrmDetector.class, Scope.CLASS_FILE_SCOPE)); 33 | 34 | @Override 35 | public void checkClass(ClassContext context, ClassNode classNode) { 36 | super.checkClass(context, classNode); 37 | 38 | if (!isInstantiable(classNode) && isAnnotatedByMicroOrm(classNode)) { 39 | 40 | context.report( 41 | NO_PUBLIC_DEFAULT_CONSTRUCTOR_ISSUE, 42 | context.getLocation(classNode), 43 | String.format( 44 | "This class should provide a public default constructor (a constructor with no arguments) (%1$s)", 45 | ClassContext.createSignature(classNode.name, null, null) 46 | ) 47 | ); 48 | } 49 | } 50 | 51 | private static final String COLUMN_ANNOTATION_DESC = "Lorg/chalup/microorm/annotations/Column;"; 52 | private static final String EMBEDDED_ANNOTATION_DESC = "Lorg/chalup/microorm/annotations/Embedded;"; 53 | 54 | private static boolean isAnnotatedByMicroOrm(ClassNode classNode) { 55 | for (Object f : classNode.fields) { 56 | FieldNode field = (FieldNode) f; 57 | if (field.visibleAnnotations != null) { 58 | for (Object a : field.visibleAnnotations) { 59 | AnnotationNode annotationNode = (AnnotationNode) a; 60 | if (COLUMN_ANNOTATION_DESC.equals(annotationNode.desc) || EMBEDDED_ANNOTATION_DESC.equals(annotationNode.desc)) { 61 | return true; 62 | } 63 | } 64 | } 65 | } 66 | 67 | return false; 68 | } 69 | 70 | private static boolean isInstantiable(ClassNode classNode) { 71 | if ((classNode.access & Opcodes.ACC_PUBLIC) == 0) { 72 | return false; 73 | } 74 | 75 | if (classNode.name.indexOf('$') != -1 && !LintUtils.isStaticInnerClass(classNode)) { 76 | return false; 77 | } 78 | 79 | @SuppressWarnings("rawtypes") 80 | List methodList = classNode.methods; 81 | for (Object m : methodList) { 82 | MethodNode method = (MethodNode) m; 83 | if (method.name.equals(CONSTRUCTOR_NAME)) { 84 | if (method.desc.equals("()V")) { 85 | return (method.access & Opcodes.ACC_PUBLIC) != 0; 86 | } 87 | } 88 | } 89 | return false; 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /src/main/java/com/getbase/lint/issues/TypeDefDetector.java: -------------------------------------------------------------------------------- 1 | package com.getbase.lint.issues; 2 | 3 | import com.android.SdkConstants; 4 | import com.android.tools.lint.client.api.JavaParser.ResolvedNode; 5 | import com.android.tools.lint.detector.api.Category; 6 | import com.android.tools.lint.detector.api.Detector; 7 | import com.android.tools.lint.detector.api.Detector.JavaScanner; 8 | import com.android.tools.lint.detector.api.Implementation; 9 | import com.android.tools.lint.detector.api.Issue; 10 | import com.android.tools.lint.detector.api.JavaContext; 11 | import com.android.tools.lint.detector.api.Scope; 12 | import com.android.tools.lint.detector.api.Severity; 13 | import com.google.common.base.Preconditions; 14 | 15 | import java.lang.annotation.Retention; 16 | import java.lang.annotation.RetentionPolicy; 17 | import java.util.Collections; 18 | import java.util.List; 19 | 20 | import lombok.ast.Annotation; 21 | import lombok.ast.AnnotationDeclaration; 22 | import lombok.ast.AstVisitor; 23 | import lombok.ast.ForwardingAstVisitor; 24 | import lombok.ast.Node; 25 | import lombok.ast.Select; 26 | 27 | public class TypeDefDetector extends Detector implements JavaScanner { 28 | public static final Issue WRONG_RETENTION_POLICY = Issue.create( 29 | "WrongTypeDefRetentionPolicy", 30 | "Wrong or missing RetentionPolicy on @IntDef or @StringDef exposed by library", 31 | "The RetentionPolicy.SOURCE is required to correctly detect misuse " + 32 | "of methods annotated with this @IntDef and @StringDef.", 33 | Category.CORRECTNESS, 34 | 1, 35 | Severity.ERROR, 36 | new Implementation(TypeDefDetector.class, Scope.JAVA_FILE_SCOPE)); 37 | 38 | @Override 39 | public List> getApplicableNodeTypes() { 40 | return Collections.>singletonList(AnnotationDeclaration.class); 41 | } 42 | 43 | @Override 44 | public AstVisitor createJavaVisitor(final JavaContext context) { 45 | if (!context.getProject().isLibrary()) return null; 46 | 47 | return new ForwardingAstVisitor() { 48 | @Override 49 | public boolean visitAnnotationDeclaration(final AnnotationDeclaration node) { 50 | AnnotationDeclarationVisitor visitor = new AnnotationDeclarationVisitor(context); 51 | node.accept(visitor); 52 | if (visitor.reportWrongRetentionPolicy()) { 53 | context.report( 54 | WRONG_RETENTION_POLICY, 55 | context.getLocation(node), 56 | "Use @Retention(RetentionPolicy.SOURCE) for @IntDef and @StringDef annotations" 57 | ); 58 | } 59 | 60 | return super.visitAnnotationDeclaration(node); 61 | } 62 | }; 63 | } 64 | 65 | private static class AnnotationDeclarationVisitor extends ForwardingAstVisitor { 66 | private final JavaContext mContext; 67 | 68 | private boolean mIsTypeDef; 69 | private boolean mIsRetentionPolicyCorrect; 70 | 71 | private AnnotationDeclarationVisitor(JavaContext context) { 72 | mContext = context; 73 | } 74 | 75 | @Override 76 | public boolean visitAnnotation(Annotation annotationNode) { 77 | ResolvedNode resolve = mContext.resolve(annotationNode); 78 | 79 | String signature = resolve.getSignature(); 80 | if (signature.equals(SdkConstants.INT_DEF_ANNOTATION) || 81 | signature.equals(SdkConstants.STRING_DEF_ANNOTATION)) { 82 | mIsTypeDef = true; 83 | } else if (signature.equals(Retention.class.getName())) { 84 | List valueValues = annotationNode.getValueValues(); 85 | Preconditions.checkArgument(valueValues.size() == 1); 86 | 87 | Node value = valueValues.get(0); 88 | value.accept(new ForwardingAstVisitor() { 89 | @Override 90 | public boolean visitSelect(Select node) { 91 | String retentionPolicy = node.astIdentifier().astValue(); 92 | if (retentionPolicy.equals(RetentionPolicy.SOURCE.toString())) { 93 | mIsRetentionPolicyCorrect = true; 94 | } 95 | return super.visitSelect(node); 96 | } 97 | }); 98 | } 99 | 100 | return super.visitAnnotation(annotationNode); 101 | } 102 | 103 | public boolean reportWrongRetentionPolicy() { 104 | return mIsTypeDef && !mIsRetentionPolicyCorrect; 105 | } 106 | } 107 | } 108 | -------------------------------------------------------------------------------- /src/main/java/com/getbase/lint/utils/AstTreePrinter.java: -------------------------------------------------------------------------------- 1 | package com.getbase.lint.utils; 2 | 3 | import lombok.ast.ForwardingAstVisitor; 4 | import lombok.ast.Node; 5 | 6 | public class AstTreePrinter extends ForwardingAstVisitor { 7 | private int mIndentLevel = 0; 8 | 9 | private String getIndent() { 10 | return mIndentLevel > 0 11 | ? String.format("%1$" + 4*mIndentLevel + "s", "") 12 | : ""; 13 | } 14 | 15 | @Override 16 | public boolean visitNode(Node node) { 17 | System.out.println(String.format("%1$s%2$s: %3$s", getIndent(), node.getClass(), node)); 18 | mIndentLevel += 1; 19 | return super.visitNode(node); 20 | } 21 | 22 | @Override 23 | public void endVisit(Node node) { 24 | mIndentLevel -= 1; 25 | super.endVisit(node); 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /src/main/java/com/getbase/lint/utils/GradleUtils.java: -------------------------------------------------------------------------------- 1 | package com.getbase.lint.utils; 2 | 3 | import com.android.annotations.NonNull; 4 | import com.android.tools.lint.detector.api.Context; 5 | import com.android.tools.lint.detector.api.DefaultPosition; 6 | import com.android.tools.lint.detector.api.Location; 7 | import com.android.utils.Pair; 8 | 9 | import org.codehaus.groovy.ast.ASTNode; 10 | import org.codehaus.groovy.ast.expr.Expression; 11 | import org.codehaus.groovy.ast.expr.TupleExpression; 12 | 13 | import java.util.List; 14 | 15 | public final class GradleUtils { 16 | private GradleUtils() { 17 | } 18 | 19 | @NonNull 20 | private static Pair getOffsets(ASTNode node, Context context) { 21 | if (node.getLastLineNumber() == -1 && node instanceof TupleExpression) { 22 | // Workaround: TupleExpressions yield bogus offsets, so use its 23 | // children instead 24 | TupleExpression exp = (TupleExpression) node; 25 | List expressions = exp.getExpressions(); 26 | if (!expressions.isEmpty()) { 27 | return Pair.of( 28 | getOffsets(expressions.get(0), context).getFirst(), 29 | getOffsets(expressions.get(expressions.size() - 1), context).getSecond()); 30 | } 31 | } 32 | String source = context.getContents(); 33 | assert source != null; // because we successfully parsed 34 | int start = 0; 35 | int end = source.length(); 36 | int line = 1; 37 | int startLine = node.getLineNumber(); 38 | int startColumn = node.getColumnNumber(); 39 | int endLine = node.getLastLineNumber(); 40 | int endColumn = node.getLastColumnNumber(); 41 | int column = 1; 42 | for (int index = 0, len = end; index < len; index++) { 43 | if (line == startLine && column == startColumn) { 44 | start = index; 45 | } 46 | if (line == endLine && column == endColumn) { 47 | end = index; 48 | break; 49 | } 50 | 51 | char c = source.charAt(index); 52 | if (c == '\n') { 53 | line++; 54 | column = 1; 55 | } else { 56 | column++; 57 | } 58 | } 59 | 60 | return Pair.of(start, end); 61 | } 62 | 63 | public static Location createLocation(@NonNull Context context, @NonNull ASTNode node) { 64 | Pair offsets = getOffsets(node, context); 65 | int fromLine = node.getLineNumber() - 1; 66 | int fromColumn = node.getColumnNumber() - 1; 67 | int toLine = node.getLastLineNumber() - 1; 68 | int toColumn = node.getLastColumnNumber() - 1; 69 | return Location.create(context.file, 70 | new DefaultPosition(fromLine, fromColumn, offsets.getFirst()), 71 | new DefaultPosition(toLine, toColumn, offsets.getSecond())); 72 | } 73 | } 74 | -------------------------------------------------------------------------------- /src/test/java/com/getbase/lint/BaseLintDetectorTest.java: -------------------------------------------------------------------------------- 1 | package com.getbase.lint; 2 | 3 | import com.android.tools.lint.checks.infrastructure.LintDetectorTest; 4 | import com.android.tools.lint.detector.api.Detector; 5 | import com.android.tools.lint.detector.api.Issue; 6 | import com.getbase.lint.issues.EnumDetector; 7 | import com.google.common.base.Charsets; 8 | import com.google.common.collect.ImmutableList; 9 | import com.google.common.io.Resources; 10 | 11 | import java.io.IOException; 12 | import java.io.InputStream; 13 | import java.net.URL; 14 | import java.util.List; 15 | 16 | public abstract class BaseLintDetectorTest extends LintDetectorTest { 17 | @Override 18 | protected InputStream getTestResource(String relativePath, boolean expectExists) { 19 | InputStream stream = getClass().getClassLoader().getResourceAsStream(relativePath); 20 | if (!expectExists && stream == null) { 21 | return null; 22 | } 23 | return stream; 24 | } 25 | 26 | protected String getExpectedError(String relativePath) throws IOException { 27 | URL resource = getClass().getClassLoader().getResource(relativePath); 28 | 29 | assertNotNull(resource); 30 | 31 | return Resources.toString(resource, Charsets.UTF_8); 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /src/test/java/com/getbase/lint/EnumDetectorTest.java: -------------------------------------------------------------------------------- 1 | package com.getbase.lint; 2 | 3 | import com.android.tools.lint.detector.api.Detector; 4 | import com.android.tools.lint.detector.api.Issue; 5 | import com.getbase.lint.issues.EnumDetector; 6 | import com.google.common.collect.ImmutableList; 7 | 8 | import java.util.List; 9 | 10 | public class EnumDetectorTest extends BaseLintDetectorTest { 11 | @Override 12 | protected Detector getDetector() { 13 | return new EnumDetector(); 14 | } 15 | 16 | @Override 17 | protected List getIssues() { 18 | return ImmutableList.of(EnumDetector.ENUMS_ARE_BAD_ISSUE); 19 | } 20 | 21 | public void testHappyPath() throws Exception { 22 | test("enum"); 23 | } 24 | 25 | public void testCorrectLocation() throws Exception { 26 | test("enum_with_javadoc"); 27 | } 28 | 29 | public void testSuppressionSupport() throws Exception { 30 | test("enum_with_suppression"); 31 | } 32 | 33 | private void test(String resourceDirectory) throws Exception { 34 | assertEquals(getExpectedError(resourceDirectory + "/expected"), lintFiles(resourceDirectory + "/TheEnum.java")); 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /src/test/java/com/getbase/lint/InvalidLintIdDetectorTest.java: -------------------------------------------------------------------------------- 1 | package com.getbase.lint; 2 | 3 | import com.android.tools.lint.detector.api.Detector; 4 | import com.android.tools.lint.detector.api.Issue; 5 | import com.getbase.lint.issues.InvalidLintIdDetector; 6 | import com.google.common.collect.ImmutableList; 7 | 8 | import java.util.List; 9 | 10 | public class InvalidLintIdDetectorTest extends BaseLintDetectorTest { 11 | @Override 12 | protected Detector getDetector() { 13 | return new InvalidLintIdDetector(); 14 | } 15 | 16 | @Override 17 | protected List getIssues() { 18 | return ImmutableList.of(InvalidLintIdDetector.ISSUE); 19 | } 20 | 21 | public void testSingleGradleFile() throws Exception { 22 | test("invalid_lint_id_single_gradle_file"); 23 | } 24 | 25 | private void test(String resourceDirectory) throws Exception { 26 | assertEquals(getExpectedError(resourceDirectory + "/expected"), lintFiles(resourceDirectory + "/build.gradle")); 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /src/test/resources/enum/TheEnum.java: -------------------------------------------------------------------------------- 1 | package com.getbase.lint; 2 | 3 | public enum TheEnum { 4 | ONE, 5 | TWO, 6 | THREE 7 | } 8 | -------------------------------------------------------------------------------- /src/test/resources/enum/expected: -------------------------------------------------------------------------------- 1 | enum/TheEnum.java:3: Information: Consider using int constants instead of TheEnum [EnumsAreBad] 2 | public enum TheEnum { 3 | ~~~~~~~ 4 | 0 errors, 1 warnings 5 | -------------------------------------------------------------------------------- /src/test/resources/enum_with_javadoc/TheEnum.java: -------------------------------------------------------------------------------- 1 | package enum_with_javadoc; 2 | 3 | // javadocs you don't want to see in your lint message 4 | public enum TheEnum { 5 | ONE, 6 | TWO, 7 | THREE 8 | } 9 | -------------------------------------------------------------------------------- /src/test/resources/enum_with_javadoc/expected: -------------------------------------------------------------------------------- 1 | enum_with_javadoc/TheEnum.java:4: Information: Consider using int constants instead of TheEnum [EnumsAreBad] 2 | public enum TheEnum { 3 | ~~~~~~~ 4 | 0 errors, 1 warnings 5 | -------------------------------------------------------------------------------- /src/test/resources/enum_with_suppression/TheEnum.java: -------------------------------------------------------------------------------- 1 | package enum_with_suppression; 2 | 3 | //noinspection EnumsAreBad 4 | public enum TheEnum { 5 | ONE, 6 | TWO, 7 | THREE 8 | } 9 | -------------------------------------------------------------------------------- /src/test/resources/enum_with_suppression/expected: -------------------------------------------------------------------------------- 1 | No warnings. -------------------------------------------------------------------------------- /src/test/resources/invalid_lint_id_single_gradle_file/build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'com.android.application' 2 | 3 | android { 4 | compileSdkVersion 23 5 | buildToolsVersion "23.0.1" 6 | 7 | defaultConfig { 8 | applicationId "com.getbase.invalidlintid" 9 | minSdkVersion 15 10 | targetSdkVersion 23 11 | versionCode 1 12 | versionName "1.0" 13 | } 14 | buildTypes { 15 | debug { 16 | minifyEnabled true 17 | proguardFiles 'proguard-rules.pro' 18 | } 19 | release { 20 | minifyEnabled true 21 | proguardFiles 'proguard-rules.pro' 22 | } 23 | } 24 | lintOptions { 25 | fatal 'UnusedResource' 26 | } 27 | } 28 | 29 | dependencies { 30 | compile fileTree(dir: 'libs', include: ['*.jar']) 31 | testCompile 'junit:junit:4.12' 32 | } 33 | -------------------------------------------------------------------------------- /src/test/resources/invalid_lint_id_single_gradle_file/expected: -------------------------------------------------------------------------------- 1 | invalid_lint_id_single_gradle_file/build.gradle:25: Error: Unknown lint issue id: UnusedResource [InvalidLintId] 2 | fatal 'UnusedResource' 3 | ~~~~~~~~~~~~~~~~ 4 | 1 errors, 0 warnings 5 | --------------------------------------------------------------------------------