From 92360d10a3f738d0cf8a9a0be7902e062ec83611 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Munhoz?= Date: Mon, 31 May 2021 17:35:22 -0300 Subject: [PATCH] Add kotlin dsl gradle task configuration in gradletask.md (#3686) * Add kotlin dsl gradle task configuration in gradletask.md * Remove jcenter from gradle task configuration example in the docs --- README.md | 1 + docs/pages/gettingstarted/gradletask.md | 33 +++++++++++++++++++++++-- 2 files changed, 32 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b4cb84658..0f8d5cfec 100644 --- a/README.md +++ b/README.md @@ -219,6 +219,7 @@ If you contributed to detekt but your name is not in the list, please feel free - [Krzysztof Kruczynski](https://github.com/krzykrucz) - Rule fix: ThrowingExceptionInMain, ExitOutsideMain - [Paya Do](https://github.com/payathedo) - Designer for Detekt's logo - [zmunm](https://github.com/zmunm) - New rule: ObjectLiteralToLambda +- [Vinicius Montes Munhoz](https://github.com/vfmunhoz) - Documentation improvement - [Eliezer Graber](https://github.com/eygraber) - Rule fix: ModifierOrder - [Dominik Labuda](https://github.com/Dominick1993) - Gradle plugin improvement diff --git a/docs/pages/gettingstarted/gradletask.md b/docs/pages/gettingstarted/gradletask.md index 967bd6b6a..16a419337 100644 --- a/docs/pages/gettingstarted/gradletask.md +++ b/docs/pages/gettingstarted/gradletask.md @@ -9,7 +9,6 @@ summary: 1. Add following lines to your build.gradle file. 2. Run `gradle detekt` -3. Add `check.dependsOn detekt` if you want to run _detekt_ on every `build` ###### Groovy DSL ```groovy @@ -24,19 +23,49 @@ configurations { task detekt(type: JavaExec) { main = "io.gitlab.arturbosch.detekt.cli.Main" classpath = configurations.detekt + def input = "$projectDir" def config = "$projectDir/detekt.yml" def exclude = ".*/build/.*,.*/resources/.*" def params = [ '-i', input, '-c', config, '-ex', exclude] + args(params) } dependencies { detekt 'io.gitlab.arturbosch.detekt:detekt-cli:{{ site.detekt_version }}' } + +// Remove this line if you don't want to run detekt on every build +check.dependsOn detekt ``` ###### Kotlin DSL ```kotlin -// TODO +repositories { + mavenCentral() +} + +val detekt by configurations.creating + +val detektTask = tasks.register("detekt") { + main = "io.gitlab.arturbosch.detekt.cli.Main" + classpath = detekt + + val input = projectDir + val config = "$projectDir/detekt.yml" + val exclude = ".*/build/.*,.*/resources/.*" + val params = listOf("-i", input, "-c", config, "-ex", exclude) + + args(params) +} + +dependencies { + detekt("io.gitlab.arturbosch.detekt:detekt-cli:{{ site.detekt_version }}") +} + +// Remove this block if you don't want to run detekt on every build +tasks.check { + dependsOn(detektTask) +} ```