├── .editorconfig ├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── build.gradle ├── custom-android-lint-rules ├── build.gradle └── src │ ├── main │ └── kotlin │ │ └── com │ │ └── vanniktech │ │ └── androidlintcustomrules │ │ ├── CustomIssueRegistry.kt │ │ └── NoInternalImportDetector.kt │ └── test │ └── kotlin │ └── com │ └── vanniktech │ └── androidlintcustomrules │ └── NoInternalImportDetectorTest.kt ├── custom-detekt-rules ├── build.gradle └── src │ ├── main │ ├── kotlin │ │ └── com │ │ │ └── vanniktech │ │ │ └── detektcustomrules │ │ │ ├── CustomRuleSetProvider.kt │ │ │ └── NoInternalImportRule.kt │ └── resources │ │ └── META-INF │ │ └── services │ │ └── io.gitlab.arturbosch.detekt.api.RuleSetProvider │ └── test │ └── kotlin │ └── com │ └── vanniktech │ └── detektcustomrules │ └── NoInternalImportRuleTest.kt ├── custom-ktlint-rules ├── build.gradle └── src │ ├── main │ ├── kotlin │ │ └── com │ │ │ └── vanniktech │ │ │ └── ktlintcustomrules │ │ │ ├── CustomRuleSetProvider.kt │ │ │ └── NoInternalImportRule.kt │ └── resources │ │ └── META-INF │ │ └── services │ │ └── com.github.shyiko.ktlint.core.RuleSetProvider │ └── test │ └── kotlin │ └── com │ └── vanniktech │ └── ktlintcustomrules │ └── NoInternalImportRuleTest.kt ├── demo ├── build.gradle ├── code_quality_tools │ └── detekt.yml └── src │ └── main │ └── kotlin │ └── com │ └── vanniktech │ └── kotlinoncodequalitytools │ ├── BrilliantClass.kt │ ├── Configuration.kt │ ├── Foo.kt │ ├── InternalImport.kt │ ├── MyManagerHandlerThatDoesEverything.kt │ ├── Point.kt │ ├── UpperCasePrinter.kt │ └── internal │ └── InternalClass.kt ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat └── settings.gradle /.editorconfig: -------------------------------------------------------------------------------- 1 | [*.{kt,kts}] 2 | indent_size=2 3 | continuation_indent_size=4 4 | max_line_length=124 5 | insert_final_newline=true -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Android Studio 2 | .idea 3 | .gradle 4 | build/ 5 | *.iml 6 | captures/ 7 | local.properties -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: android 2 | 3 | jdk: 4 | - oraclejdk8 5 | 6 | before_install: 7 | # Install SDK license so Android Gradle plugin can install deps. 8 | - mkdir "$ANDROID_HOME/licenses" || true 9 | - echo "d56f5187479451eabf01fb78af6dfcb131a6481e" > "$ANDROID_HOME/licenses/android-sdk-license" 10 | 11 | install: true 12 | 13 | script: ./gradlew clean build 14 | 15 | branches: 16 | except: 17 | - gh-pages 18 | 19 | notifications: 20 | email: false 21 | 22 | before_cache: 23 | - rm -f $HOME/.gradle/caches/modules-2/modules-2.lock 24 | - rm -fr $HOME/.gradle/caches/*/plugin-resolution/ 25 | cache: 26 | directories: 27 | - $HOME/.gradle/caches/ 28 | - $HOME/.gradle/wrapper/ 29 | - $HOME/.android/build-cache -------------------------------------------------------------------------------- /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 [yyyy] [name of copyright owner] 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 | # kotlin-on-code-quality-tools 2 | 3 | Demonstration of Code Quality Tools that are applicable with Kotlin. The sample project uses the following tools: 4 | 5 | - [Android Lint](https://developer.android.com/studio/write/lint) 6 | - [Detekt](https://github.com/arturbosch/detekt) 7 | - [ktlint](https://github.com/shyiko/ktlint) 8 | 9 | ### Custom rules 10 | 11 | Writing your own rules is also straight forward. This project contains rules for: 12 | 13 | - [Android Lint](custom-android-lint-rules) - [Article](https://medium.com/@vanniktech/writing-your-first-lint-check-39ad0e90b9e6) 14 | - [Detekt](custom-detekt-rules) - [Article](https://medium.com/@vanniktech/writing-your-first-detekt-rule-ee940e56428d) 15 | - [ktlint](custom-ktlint-rules) - [Article](https://medium.com/@vanniktech/writing-your-first-ktlint-rule-5a1707f4ca5b) 16 | 17 | Detailed explanations for the rules can be read in the articles. 18 | 19 | ### Slides 20 | 21 | - Droidcon San Francisco 2018 - [Slides](https://docs.google.com/presentation/d/1gqXeoHpQIu2V-BYdc3lfOBszYHmMj2dFEb3vOivKsfA/edit?usp=sharing) 22 | - Mobilization 2018 - [Slides](https://docs.google.com/presentation/d/1sUoQCRHTR01JfaS67Qkd7K1rdRLOhO6QGCelZZwxOKs/edit?usp=sharing) 23 | - Kotlin Meetup in Hamburg - [Slides](https://docs.google.com/presentation/d/1uAS2D1aF1euFmKCgq_IyFX0c2Ph1xE9fuGEPQpfs01E/edit?usp=sharing) -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | buildscript { 2 | ext.kotlinVersion = "1.3.10" 3 | ext.ktlintVersion = "0.29.0" 4 | ext.detektVersion = "1.0.0-RC11" 5 | 6 | repositories { 7 | mavenCentral() 8 | google() 9 | gradlePluginPortal() 10 | jcenter() 11 | } 12 | 13 | dependencies { 14 | classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion" 15 | classpath "com.github.ben-manes:gradle-versions-plugin:0.20.0" 16 | 17 | // Lint. 18 | classpath "com.android.tools.build:gradle:3.3.0-beta04" 19 | } 20 | } 21 | 22 | apply plugin: "com.github.ben-manes.versions" 23 | 24 | wrapper { 25 | gradleVersion = "4.10.2" 26 | distributionType = Wrapper.DistributionType.ALL 27 | } 28 | -------------------------------------------------------------------------------- /custom-android-lint-rules/build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: "kotlin" 2 | 3 | repositories { 4 | google() 5 | mavenCentral() 6 | jcenter() 7 | } 8 | 9 | dependencies { 10 | compileOnly "com.android.tools.lint:lint-api:26.3.0-beta04" 11 | compileOnly "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlinVersion" 12 | 13 | testImplementation "com.android.tools.lint:lint:26.3.0-beta04" 14 | testImplementation "com.android.tools.lint:lint-tests:26.3.0-beta04" 15 | } 16 | 17 | jar { 18 | manifest { 19 | attributes('Lint-Registry-v2': 'com.vanniktech.androidlintcustomrules.CustomIssueRegistry') 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /custom-android-lint-rules/src/main/kotlin/com/vanniktech/androidlintcustomrules/CustomIssueRegistry.kt: -------------------------------------------------------------------------------- 1 | package com.vanniktech.androidlintcustomrules 2 | 3 | import com.android.tools.lint.client.api.IssueRegistry 4 | import com.android.tools.lint.detector.api.CURRENT_API 5 | import com.android.tools.lint.detector.api.Issue 6 | 7 | class CustomIssueRegistry : IssueRegistry() { 8 | override val issues: List get() = listOf(NoInternalImportDetector.ISSUE) 9 | 10 | override val api: Int get() = CURRENT_API 11 | } 12 | -------------------------------------------------------------------------------- /custom-android-lint-rules/src/main/kotlin/com/vanniktech/androidlintcustomrules/NoInternalImportDetector.kt: -------------------------------------------------------------------------------- 1 | package com.vanniktech.androidlintcustomrules 2 | 3 | import com.android.tools.lint.client.api.UElementHandler 4 | import com.android.tools.lint.detector.api.Category 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.JavaContext 9 | import com.android.tools.lint.detector.api.Scope.JAVA_FILE 10 | import com.android.tools.lint.detector.api.Scope.TEST_SOURCES 11 | import com.android.tools.lint.detector.api.Severity.WARNING 12 | import org.jetbrains.uast.UImportStatement 13 | import java.util.EnumSet 14 | 15 | class NoInternalImportDetector : Detector(), Detector.UastScanner { 16 | override fun getApplicableUastTypes() = listOf(UImportStatement::class.java) 17 | 18 | override fun createUastHandler(context: JavaContext): UElementHandler = NoInternalImportHandler(context) 19 | 20 | internal class NoInternalImportHandler(private val context: JavaContext) : UElementHandler() { 21 | override fun visitImportStatement(node: UImportStatement) { 22 | val importReference = node.importReference 23 | val import = importReference?.asSourceString() 24 | 25 | if (import?.contains("internal") == true) { 26 | context.report(ISSUE, node, context.getLocation(importReference), "Importing '$import' which is an internal import.") 27 | } 28 | } 29 | } 30 | 31 | companion object { 32 | val ISSUE = Issue.create("NoInternalImport", 33 | "No internal imports", 34 | "Don't import from an internal package as they are subject to change.", 35 | Category.CORRECTNESS, 10, WARNING, 36 | Implementation(NoInternalImportDetector::class.java, EnumSet.of(JAVA_FILE, TEST_SOURCES)) 37 | ) 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /custom-android-lint-rules/src/test/kotlin/com/vanniktech/androidlintcustomrules/NoInternalImportDetectorTest.kt: -------------------------------------------------------------------------------- 1 | package com.vanniktech.androidlintcustomrules 2 | 3 | import com.android.tools.lint.checks.infrastructure.TestFiles.java 4 | import com.android.tools.lint.checks.infrastructure.TestFiles.kt 5 | import com.android.tools.lint.checks.infrastructure.TestLintTask.lint 6 | import org.junit.Test 7 | 8 | class NoInternalImportRuleTest { 9 | @Test fun noInternalImports() { 10 | lint() 11 | .files(kt(""" 12 | import a.b.c 13 | import a.internal.foo 14 | """).indented()) 15 | .issues(NoInternalImportDetector.ISSUE) 16 | .run() 17 | .expect(""" 18 | |src/test.kt:2: Warning: Importing 'a.internal.foo' which is an internal import. [NoInternalImport] 19 | |import a.internal.foo 20 | | ~~~~~~~~~~~~~~ 21 | |0 errors, 1 warnings""".trimMargin()) 22 | } 23 | 24 | @Test fun noInternalImportsJava() { 25 | lint() 26 | .files(java(""" 27 | import a.b.c; 28 | import a.internal.foo; 29 | """).indented()) 30 | .issues(NoInternalImportDetector.ISSUE) 31 | .run() 32 | .expect(""" 33 | |src/package-info.java:2: Warning: Importing 'a.internal.foo' which is an internal import. [NoInternalImport] 34 | |import a.internal.foo; 35 | | ~~~~~~~~~~~~~~ 36 | |0 errors, 1 warnings""".trimMargin()) 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /custom-detekt-rules/build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: "kotlin" 2 | 3 | repositories { 4 | jcenter() 5 | } 6 | 7 | dependencies { 8 | compileOnly "io.gitlab.arturbosch.detekt:detekt-api:$detektVersion" 9 | 10 | testCompile "junit:junit:4.12" 11 | testCompile "org.assertj:assertj-core:3.11.1" 12 | testCompile "io.gitlab.arturbosch.detekt:detekt-api:$detektVersion" 13 | testCompile "io.gitlab.arturbosch.detekt:detekt-test:$detektVersion" 14 | } 15 | -------------------------------------------------------------------------------- /custom-detekt-rules/src/main/kotlin/com/vanniktech/detektcustomrules/CustomRuleSetProvider.kt: -------------------------------------------------------------------------------- 1 | package com.vanniktech.detektcustomrules 2 | 3 | import io.gitlab.arturbosch.detekt.api.Config 4 | import io.gitlab.arturbosch.detekt.api.RuleSet 5 | import io.gitlab.arturbosch.detekt.api.RuleSetProvider 6 | 7 | class CustomRuleSetProvider : RuleSetProvider { 8 | override val ruleSetId: String = "detekt-custom-rules" 9 | 10 | override fun instance(config: Config) 11 | = RuleSet(ruleSetId, listOf(NoInternalImportRule(config))) 12 | } 13 | -------------------------------------------------------------------------------- /custom-detekt-rules/src/main/kotlin/com/vanniktech/detektcustomrules/NoInternalImportRule.kt: -------------------------------------------------------------------------------- 1 | package com.vanniktech.detektcustomrules 2 | 3 | import io.gitlab.arturbosch.detekt.api.CodeSmell 4 | import io.gitlab.arturbosch.detekt.api.Config 5 | import io.gitlab.arturbosch.detekt.api.Debt 6 | import io.gitlab.arturbosch.detekt.api.Entity 7 | import io.gitlab.arturbosch.detekt.api.Issue 8 | import io.gitlab.arturbosch.detekt.api.Rule 9 | import io.gitlab.arturbosch.detekt.api.Severity 10 | import org.jetbrains.kotlin.psi.KtImportDirective 11 | 12 | class NoInternalImportRule(config: Config = Config.empty) : Rule(config) { 13 | override val issue = Issue(javaClass.simpleName, Severity.Maintainability, 14 | "Don't import from an internal package as they are subject to change.", 15 | Debt.TWENTY_MINS) 16 | 17 | override fun visitImportDirective(importDirective: KtImportDirective) { 18 | val import = importDirective.importPath?.pathStr 19 | 20 | if (import?.contains("internal") == true) { 21 | report(CodeSmell(issue, Entity.from(importDirective), 22 | "Importing '$import' which is an internal import.")) 23 | } 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /custom-detekt-rules/src/main/resources/META-INF/services/io.gitlab.arturbosch.detekt.api.RuleSetProvider: -------------------------------------------------------------------------------- 1 | com.vanniktech.detektcustomrules.CustomRuleSetProvider 2 | -------------------------------------------------------------------------------- /custom-detekt-rules/src/test/kotlin/com/vanniktech/detektcustomrules/NoInternalImportRuleTest.kt: -------------------------------------------------------------------------------- 1 | package com.vanniktech.detektcustomrules 2 | 3 | import io.gitlab.arturbosch.detekt.test.lint 4 | import org.assertj.core.api.Assertions.assertThat 5 | import org.junit.Test 6 | 7 | class NoInternalImportRuleTest { 8 | @Test fun noInternalImports() { 9 | val findings = NoInternalImportRule().lint(""" 10 | import a.b.c 11 | import a.internal.foo 12 | """.trimIndent()) 13 | 14 | assertThat(findings).hasSize(1) 15 | assertThat(findings[0].message).isEqualTo("Importing 'a.internal.foo' which is an internal import.") 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /custom-ktlint-rules/build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: "kotlin" 2 | 3 | repositories { 4 | jcenter() 5 | } 6 | 7 | dependencies { 8 | compileOnly "com.github.shyiko.ktlint:ktlint-core:$ktlintVersion" 9 | 10 | testCompile "junit:junit:4.12" 11 | testCompile "org.assertj:assertj-core:3.11.1" 12 | testCompile "com.github.shyiko.ktlint:ktlint-core:$ktlintVersion" 13 | testCompile "com.github.shyiko.ktlint:ktlint-test:$ktlintVersion" 14 | } 15 | -------------------------------------------------------------------------------- /custom-ktlint-rules/src/main/kotlin/com/vanniktech/ktlintcustomrules/CustomRuleSetProvider.kt: -------------------------------------------------------------------------------- 1 | package com.vanniktech.ktlintcustomrules 2 | 3 | import com.github.shyiko.ktlint.core.RuleSet 4 | import com.github.shyiko.ktlint.core.RuleSetProvider 5 | 6 | class CustomRuleSetProvider : RuleSetProvider { 7 | override fun get() = RuleSet("custom-ktlint-rules", NoInternalImportRule()) 8 | } 9 | -------------------------------------------------------------------------------- /custom-ktlint-rules/src/main/kotlin/com/vanniktech/ktlintcustomrules/NoInternalImportRule.kt: -------------------------------------------------------------------------------- 1 | package com.vanniktech.ktlintcustomrules 2 | 3 | import com.github.shyiko.ktlint.core.Rule 4 | import org.jetbrains.kotlin.com.intellij.lang.ASTNode 5 | import org.jetbrains.kotlin.psi.KtImportDirective 6 | import org.jetbrains.kotlin.psi.stubs.elements.KtStubElementTypes 7 | 8 | class NoInternalImportRule : Rule("no-internal-import") { 9 | override fun visit(node: ASTNode, autoCorrect: Boolean, 10 | emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit) { 11 | if (node.elementType == KtStubElementTypes.IMPORT_DIRECTIVE) { 12 | val importDirective = node.psi as KtImportDirective 13 | val path = importDirective.importPath?.pathStr 14 | if (path?.contains("internal") == true) { 15 | emit(node.startOffset, "Importing '$path' which is an internal import.", false) 16 | } 17 | } 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /custom-ktlint-rules/src/main/resources/META-INF/services/com.github.shyiko.ktlint.core.RuleSetProvider: -------------------------------------------------------------------------------- 1 | com.vanniktech.ktlintcustomrules.CustomRuleSetProvider 2 | -------------------------------------------------------------------------------- /custom-ktlint-rules/src/test/kotlin/com/vanniktech/ktlintcustomrules/NoInternalImportRuleTest.kt: -------------------------------------------------------------------------------- 1 | package com.vanniktech.ktlintcustomrules 2 | 3 | import com.github.shyiko.ktlint.core.LintError 4 | import com.github.shyiko.ktlint.test.lint 5 | import org.assertj.core.api.Assertions.assertThat 6 | import org.junit.Test 7 | 8 | class NoInternalImportRuleTest { 9 | @Test fun noInternalImports() { 10 | assertThat(NoInternalImportRule().lint(""" 11 | import a.b.c 12 | import a.internal.foo 13 | """.trimIndent() 14 | )).containsExactly( 15 | LintError(2, 1, "no-internal-import", "Importing 'a.internal.foo' which is an internal import.") 16 | ) 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /demo/build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: "kotlin" 2 | 3 | repositories { 4 | google() 5 | mavenCentral() 6 | jcenter() 7 | } 8 | 9 | dependencies { 10 | implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlinVersion" 11 | } 12 | 13 | // Lint. 14 | 15 | apply plugin: "com.android.lint" 16 | 17 | lintOptions { 18 | abortOnError true 19 | warningsAsErrors true 20 | // baseline project.file("baseline-lint.xml") 21 | } 22 | 23 | dependencies { 24 | // Unfortunately this does not quite work for Kotlin projects - https://issuetracker.google.com/issues/112526243 25 | lintChecks project(":custom-android-lint-rules") 26 | } 27 | 28 | // Detekt. 29 | 30 | configurations { 31 | detekt 32 | } 33 | 34 | dependencies { 35 | detekt "io.gitlab.arturbosch.detekt:detekt-cli:$detektVersion" 36 | detekt project(":custom-detekt-rules") 37 | } 38 | 39 | def output = new File(project.buildDir, "reports/detekt/") 40 | 41 | task detekt(type: JavaExec, group: "verification", description: "Runs detekt.") { 42 | def configFile = file("code_quality_tools/detekt.yml") 43 | 44 | main = "io.gitlab.arturbosch.detekt.cli.Main" 45 | classpath = project.configurations.detekt 46 | args = [ 47 | "--config", configFile, 48 | "--input", project.file("."), 49 | "--report", "txt:$output/plain.txt,xml:$output/checkstyle.xml,html:$output/report.html" 50 | ] 51 | 52 | // To make this Gradle task incremental - https://medium.com/@vanniktech/making-your-gradle-tasks-incremental-7f26e4ef09c3 53 | inputs.files(project.fileTree(dir: "src", include: "**/*.kt"), configFile) 54 | outputs.dir(output.toString()) 55 | } 56 | 57 | // We don't want them to be checked too since this is a demo and it's supposed to fail here. 58 | // check.dependsOn "detekt" 59 | 60 | // ktlint. 61 | 62 | configurations { 63 | ktlint 64 | } 65 | 66 | dependencies { 67 | ktlint "com.github.shyiko:ktlint:$ktlintVersion" 68 | ktlint project(":custom-ktlint-rules") 69 | } 70 | 71 | def outputDir = "${project.buildDir}/reports/ktlint/" 72 | 73 | task ktlint(type: JavaExec, group: "verification", description: "Runs ktlint.") { 74 | main = "com.github.shyiko.ktlint.Main" 75 | classpath = configurations.ktlint 76 | args = [ 77 | "--reporter=plain", 78 | "--reporter=checkstyle,output=${outputDir}ktlint-checkstyle-report.xml", 79 | "src/**/*.kt" 80 | ] 81 | 82 | // To make this Gradle task incremental - https://medium.com/@vanniktech/making-your-gradle-tasks-incremental-7f26e4ef09c3 83 | inputs.files( 84 | fileTree(dir: "src", include: "**/*.kt"), 85 | fileTree(dir: ".", include: "**/.editorconfig") 86 | ) 87 | outputs.dir(outputDir) 88 | } 89 | 90 | task ktlintFormat(type: JavaExec, group: "formatting") { 91 | description = "Runs ktlint and autoformats your code." 92 | main = "com.github.shyiko.ktlint.Main" 93 | classpath = configurations.ktlint 94 | args = [ 95 | "-F", 96 | "src/**/*.kt" 97 | ] 98 | 99 | // To make this Gradle task incremental - https://medium.com/@vanniktech/making-your-gradle-tasks-incremental-7f26e4ef09c3 100 | inputs.files( 101 | fileTree(dir: "src", include: "**/*.kt"), 102 | fileTree(dir: ".", include: "**/.editorconfig") 103 | ) 104 | outputs.upToDateWhen { true } 105 | } 106 | 107 | // We don't want them to be checked too since this is a demo and it's supposed to fail here. 108 | // check.dependsOn "ktlint" 109 | -------------------------------------------------------------------------------- /demo/code_quality_tools/detekt.yml: -------------------------------------------------------------------------------- 1 | failFast: true 2 | 3 | comments: 4 | UndocumentedPublicFunction: 5 | active: false 6 | UndocumentedPublicClass: 7 | active: false 8 | -------------------------------------------------------------------------------- /demo/src/main/kotlin/com/vanniktech/kotlinoncodequalitytools/BrilliantClass.kt: -------------------------------------------------------------------------------- 1 | package com.vanniktech.kotlinoncodequalitytools 2 | 3 | class BrilliantClass ( val bar: Bar, 4 | val number: Int) { 5 | 6 | class Bar( 7 | 8 | private val value : Int 9 | ) 10 | 11 | override fun toString( ) : String = "BrilliantClass(bar=$bar)" 12 | } 13 | -------------------------------------------------------------------------------- /demo/src/main/kotlin/com/vanniktech/kotlinoncodequalitytools/Configuration.kt: -------------------------------------------------------------------------------- 1 | package com.vanniktech.kotlinoncodequalitytools 2 | 3 | interface Configuration { 4 | /** 5 | * Returns a [Float] with the given [name] from the configuration 6 | */ 7 | fun getFloat(name: String): Float 8 | } 9 | -------------------------------------------------------------------------------- /demo/src/main/kotlin/com/vanniktech/kotlinoncodequalitytools/Foo.kt: -------------------------------------------------------------------------------- 1 | package com.vanniktech.kotlinoncodequalitytools 2 | 3 | class Foo { 4 | fun foo(map: Array) { 5 | for (i in 0 until map.size) { 6 | for (j in 0 until map[i].size) { 7 | map[i][i] += 1 8 | } 9 | } 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /demo/src/main/kotlin/com/vanniktech/kotlinoncodequalitytools/InternalImport.kt: -------------------------------------------------------------------------------- 1 | package com.vanniktech.kotlinoncodequalitytools 2 | 3 | import com.vanniktech.kotlinoncodequalitytools.internal.InternalClass 4 | 5 | class InternalImport(val internalClass: InternalClass) 6 | -------------------------------------------------------------------------------- /demo/src/main/kotlin/com/vanniktech/kotlinoncodequalitytools/MyManagerHandlerThatDoesEverything.kt: -------------------------------------------------------------------------------- 1 | package com.vanniktech.kotlinoncodequalitytools 2 | 3 | class MyManagerHandlerThatDoesEverything { 4 | fun doX() { } 5 | fun handleThis() { } 6 | fun foo() { } 7 | fun doY() { } 8 | fun isDoingY() { } 9 | fun isDoingX() { } 10 | fun buyBeer() { } 11 | fun drinkBeer() { } 12 | fun fetchPizza() { } 13 | fun doWeHaveEnoughCheese() { } 14 | fun relax() { } 15 | fun bar() { } 16 | } 17 | -------------------------------------------------------------------------------- /demo/src/main/kotlin/com/vanniktech/kotlinoncodequalitytools/Point.kt: -------------------------------------------------------------------------------- 1 | package com.vanniktech.kotlinoncodequalitytools 2 | 3 | class Point(val x: Int, val y: Int) 4 | -------------------------------------------------------------------------------- /demo/src/main/kotlin/com/vanniktech/kotlinoncodequalitytools/UpperCasePrinter.kt: -------------------------------------------------------------------------------- 1 | package com.vanniktech.kotlinoncodequalitytools 2 | 3 | class UpperCasePrinter { 4 | fun print(value: String) { 5 | System.out.println(value.toUpperCase()) 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /demo/src/main/kotlin/com/vanniktech/kotlinoncodequalitytools/internal/InternalClass.kt: -------------------------------------------------------------------------------- 1 | package com.vanniktech.kotlinoncodequalitytools.internal 2 | 3 | class InternalClass 4 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vanniktech/kotlin-on-code-quality-tools/fce53064661b8da9a474990d342fe726141f5996/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.2-all.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 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 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /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 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 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 Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | include ':demo' 2 | include ':custom-ktlint-rules' 3 | include ':custom-detekt-rules' 4 | include ':custom-android-lint-rules' --------------------------------------------------------------------------------