CINXE.COM

<!doctype html> <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-1.21.0 docs-doc-page docs-doc-id-gettingstarted/gradle" data-has-hydrated="false"> <head> <meta charset="UTF-8"> <meta name="generator" content="Docusaurus v3.7.0"> <title data-rh="true">Run detekt using the Detekt Gradle Plugin | detekt</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://detekt.dev/docs/1.21.0/gettingstarted/gradle"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="1.21.0"><meta data-rh="true" name="docusaurus_tag" content="docs-default-1.21.0"><meta data-rh="true" name="docsearch:version" content="1.21.0"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-1.21.0"><meta data-rh="true" property="og:title" content="Run detekt using the Detekt Gradle Plugin | detekt"><meta data-rh="true" name="description" content="Detekt requires Gradle 6.1 or higher. We, however, recommend using the version of Gradle that is listed in this table."><meta data-rh="true" property="og:description" content="Detekt requires Gradle 6.1 or higher. We, however, recommend using the version of Gradle that is listed in this table."><meta data-rh="true" name="keywords" content="detekt,static,analysis,code,kotlin"><link data-rh="true" rel="icon" href="/img/favicon.svg"><link data-rh="true" rel="canonical" href="https://detekt.dev/docs/1.21.0/gettingstarted/gradle"><link data-rh="true" rel="alternate" href="https://detekt.dev/docs/1.21.0/gettingstarted/gradle" hreflang="en"><link data-rh="true" rel="alternate" href="https://detekt.dev/docs/1.21.0/gettingstarted/gradle" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://5PZNXB7M3G-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="detekt RSS Feed"> <link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="detekt Atom Feed"> <link rel="search" type="application/opensearchdescription+xml" title="detekt" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.80918a2e.css"> <script src="/assets/js/runtime~main.49574ca9.js" defer="defer"></script> <script src="/assets/js/main.8ff3ed71.js" defer="defer"></script> </head> <body class="navigation-with-keyboard"> <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><link rel="preload" as="image" href="/img/favicon.svg"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/favicon.svg" alt="detekt logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/favicon.svg" alt="detekt logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div>detekt</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/1.21.0/intro">Docs</a><a class="navbar__item navbar__link" href="/blog">Blog</a><a href="https://detekt.dev/kdoc/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">APIs</a><a class="navbar__item navbar__link" href="/marketplace">Marketplace</a></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__link" aria-haspopup="true" aria-expanded="false" role="button" href="/docs/1.21.0/gettingstarted/gradle">1.21.0</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/next/gettingstarted/gradle">Next</a></li><li><a class="dropdown__link" href="/docs/gettingstarted/gradle">1.23.8</a></li><li><a class="dropdown__link" href="/docs/1.23.7/gettingstarted/gradle">1.23.7</a></li><li><a class="dropdown__link" href="/docs/1.23.6/gettingstarted/gradle">1.23.6</a></li><li><a class="dropdown__link" href="/docs/1.23.5/gettingstarted/gradle">1.23.5</a></li><li><a class="dropdown__link" href="/docs/1.23.4/gettingstarted/gradle">1.23.4</a></li><li><a class="dropdown__link" href="/docs/1.23.3/gettingstarted/gradle">1.23.3</a></li><li><a class="dropdown__link" href="/docs/1.23.1/gettingstarted/gradle">1.23.1</a></li><li><a class="dropdown__link" href="/docs/1.23.0/gettingstarted/gradle">1.23.0</a></li><li><a class="dropdown__link" href="/docs/1.22.0/gettingstarted/gradle">1.22.0</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/docs/1.21.0/gettingstarted/gradle">1.21.0</a></li><li><a class="dropdown__link" href="/changelog">All changelogs</a></li></ul></div><a href="https://github.com/detekt/detekt" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link" aria-label="GitHub repository">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite" aria-pressed="false"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search (Command+K)"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg>Search</button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/1.21.0/intro">Welcome</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/1.21.0/introduction/configurations">Introduction</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" href="/docs/1.21.0/gettingstarted/cli">Getting Started</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.21.0/gettingstarted/cli">Run detekt using Command Line Interface</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/1.21.0/gettingstarted/gradle">Run detekt using the Detekt Gradle Plugin</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.21.0/gettingstarted/gradletask">Run detekt using Gradle Task</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.21.0/gettingstarted/mavenanttask">Run detekt using Maven Ant Task</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.21.0/gettingstarted/type-resolution">Using Type Resolution</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.21.0/gettingstarted/git-pre-commit-hook">Run detekt using a Git pre-commit hook</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/1.21.0/rules/comments">Rules Documentation</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/changelog">Changelogs</a></div></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="theme-doc-version-banner alert alert--warning margin-bottom--md" role="alert"><div>This is documentation for detekt 1.21.0, which is no longer actively maintained.</div><div class="margin-top--md">For up-to-date documentation, see the <a href="/docs/gettingstarted/gradle">latest version</a> (1.23.8).</div></div><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item">Getting Started<meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active">Run detekt using the Detekt Gradle Plugin<meta itemprop="position" content="2"></li></ul></nav>Version: 1.21.0<div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Run detekt using the Detekt Gradle Plugin</h1></header>Detekt requires Gradle 6.1 or higher. We, however, recommend using the version of Gradle that is <a href="/docs/introduction/compatibility">listed in this table</a>. <h2 class="anchor anchorWithStickyNavbar_LWe7" id="available-plugin-tasks"><a name="tasks">Available plugin tasks</a><a href="#available-plugin-tasks" class="hash-link" aria-label="Direct link to available-plugin-tasks" title="Direct link to available-plugin-tasks"></a></h2> The Detekt Gradle Plugin will generate multiple tasks: <ul> <li><code>detekt</code> - Runs a detekt analysis and complexity report on your source files. Configure the analysis inside the <code>detekt</code> closure. <ul> <li>By default, the standard rule set without any ignore list is executed on sources files located in <code>src/main/java</code>, <code>src/test/java</code>, <code>src/main/kotlin</code> and <code>src/test/kotlin</code>.</li> <li>Reports are automatically generated in xml, html, txt, md, and sarif format and can be found in <code>build/reports/detekt/detekt.[xml|html|txt|md|sarif]</code> respectively.</li> <li>Please note that the <code>detekt</code> task is automatically run when executing <code>gradle check</code>.</li> <li>You may specify Gradle task CLI option for auto correction, such as <code>gradle detekt --auto-correct</code>.</li> </ul> </li> <li><code>detektGenerateConfig</code> - Generates a default detekt configuration file into your project directory.</li> <li><code>detektBaseline</code> - Similar to <code>detekt</code>, but creates a code smell baseline. Further detekt runs will only feature new smells not in this list.</li> </ul> In addition to these standard tasks, the plugin will also generate a set of experimental tasks that have <a href="/docs/1.21.0/gettingstarted/type-resolution">type resolution</a> enabled. This happens for both, pure JVM projects and Android projects that have the Android Gradle Plugin applied: <ul> <li><code>detektMain</code> - Similar to <code>detekt</code>, but runs only on the <code>main</code> source set (Android: all production source sets)</li> <li><code>detektTest</code> - Similar to <code>detekt</code>, but runs only on the <code>test</code> source set (Android: all JVM and Android Test source sets)</li> <li><code>detektBaselineMain</code> - Similar to <code>detektBaseline</code>, but creates a baseline only for the <code>main</code> source set (Android: multiple baselines for all production source sets)</li> <li><code>detektBaselineTest</code> - Similar to <code>detektBaseline</code>, but creates a baseline only for the <code>test</code> source set (Android: multiple baselines for all JVM and Android Test source sets)</li> <li>Android-only: <code>detekt<Variant></code> - Similar to <code>detekt</code>, but runs only on the specific (test) build variant</li> <li>Android-only: <code>detektBaseline<Variant></code> - Similar to <code>detektBaseline</code>, but creates a baseline only for the specific (test) build variant</li> </ul> Baseline files that are generated for these specific source sets / build variants contain the name of the source set / the name of the build variant in their name, unless otherwise configured, such as <code>detekt-main.xml</code> or <code>detekt-productionDebug.xml</code>. If both, a <code>detekt-main.xml</code> and a <code>detekt.xml</code> baseline file exists in place, the more specific one - <code>detekt-main.xml</code> - takes precedence when the <code>detektMain</code> task is executed, likewise for Android variant-specific baseline files. NOTE: When analyzing Android projects that make use of specific code generators, such as Data Binding, Kotlin synthetic view accessors or else, you might see warnings output while Detekt runs. This is due to the inability to gather the complete compile classpath from the Android Gradle Plugin (<a href="https://issuetracker.google.com/issues/158777988" target="_blank" rel="noopener noreferrer">upstream ticket</a>) and can safely be ignored. Use the Groovy or Kotlin DSL of Gradle to apply the Detekt Gradle Plugin. You can further configure the Plugin using the detekt closure as described <a href="#options-for-detekt-configuration-closure">here</a>. <h3 class="anchor anchorWithStickyNavbar_LWe7" id="configuration"><a name="gradle">Configuration</a><a href="#configuration" class="hash-link" aria-label="Direct link to configuration" title="Direct link to configuration"></a></h3> Using the plugins DSL: <h4 class="anchor anchorWithStickyNavbar_LWe7" id="groovy-dsl">Groovy DSL<a href="#groovy-dsl" class="hash-link" aria-label="Direct link to Groovy DSL" title="Direct link to Groovy DSL"></a></h4> <div class="language-groovy codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-groovy codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv">plugins { id "io.gitlab.arturbosch.detekt" version "1.21.0" } repositories { mavenCentral() } </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="kotlin-dsl">Kotlin DSL<a href="#kotlin-dsl" class="hash-link" aria-label="Direct link to Kotlin DSL" title="Direct link to Kotlin DSL"></a></h4> <div class="language-kotlin codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-kotlin codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv">plugins { id("io.gitlab.arturbosch.detekt") version "1.21.0" } repositories { mavenCentral() } </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> Using legacy plugin application (<code>buildscript{}</code>): <h4 class="anchor anchorWithStickyNavbar_LWe7" id="groovy-dsl-1">Groovy DSL<a href="#groovy-dsl-1" class="hash-link" aria-label="Direct link to Groovy DSL" title="Direct link to Groovy DSL"></a></h4> <div class="language-groovy codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-groovy codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv">buildscript { repositories { gradlePluginPortal() } dependencies { classpath "io.gitlab.arturbosch.detekt:detekt-gradle-plugin:1.21.0" } } apply plugin: "io.gitlab.arturbosch.detekt" repositories { mavenCentral() } </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="kotlin-dsl-1">Kotlin DSL<a href="#kotlin-dsl-1" class="hash-link" aria-label="Direct link to Kotlin DSL" title="Direct link to Kotlin DSL"></a></h4> <div class="language-kotlin codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-kotlin codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv">buildscript { repositories { gradlePluginPortal() } dependencies { classpath("io.gitlab.arturbosch.detekt:detekt-gradle-plugin:1.21.0") } } apply(plugin = "io.gitlab.arturbosch.detekt") repositories { mavenCentral() } </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-for-android-projects"><a name="gradleandroid">Configuration for Android projects</a><a href="#configuration-for-android-projects" class="hash-link" aria-label="Direct link to configuration-for-android-projects" title="Direct link to configuration-for-android-projects"></a></h3> When using Android make sure to have detekt configured in the app/module level <code>build.gradle</code> file. You can configure the plugin in the same way as indicated above. <h4 class="anchor anchorWithStickyNavbar_LWe7" id="groovy-dsl-2">Groovy DSL<a href="#groovy-dsl-2" class="hash-link" aria-label="Direct link to Groovy DSL" title="Direct link to Groovy DSL"></a></h4> <div class="language-groovy codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-groovy codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv">buildscript { repositories { google() mavenCentral() gradlePluginPortal() } dependencies { classpath "com.android.tools.build:gradle:<agp_version>" } } plugins { id "com.android.application" id "org.jetbrains.kotlin.android" version "<kotlin_version>" id "io.gitlab.arturbosch.detekt" version "1.21.0" } repositories { mavenCentral() } </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="kotlin-dsl-2">Kotlin DSL<a href="#kotlin-dsl-2" class="hash-link" aria-label="Direct link to Kotlin DSL" title="Direct link to Kotlin DSL"></a></h4> <div class="language-kotlin codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-kotlin codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv">buildscript { repositories { google() mavenCentral() gradlePluginPortal() } dependencies { classpath("com.android.tools.build:gradle:<agp_version>") } } plugins { id("com.android.application") kotlin("android") version "<kotlin_version>" id("io.gitlab.arturbosch.detekt") version "1.21.0" } repositories { mavenCentral() } </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="options-for-detekt-configuration-closure"><a name="closure">Options for detekt configuration closure</a><a href="#options-for-detekt-configuration-closure" class="hash-link" aria-label="Direct link to options-for-detekt-configuration-closure" title="Direct link to options-for-detekt-configuration-closure"></a></h3> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="groovy-dsl-3">Groovy DSL<a href="#groovy-dsl-3" class="hash-link" aria-label="Direct link to Groovy DSL" title="Direct link to Groovy DSL"></a></h4> <div class="language-groovy codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-groovy codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv">detekt { // Version of Detekt that will be used. When unspecified the latest detekt // version found will be used. Override to stay on the same version. toolVersion = "1.21.0" // The directories where detekt looks for source files. // Defaults to `files("src/main/java", "src/test/java", "src/main/kotlin", "src/test/kotlin")`. source = files( "src/main/kotlin", "gensrc/main/kotlin" ) // Builds the AST in parallel. Rules are always executed in parallel. // Can lead to speedups in larger projects. `false` by default. parallel = false // Define the detekt configuration(s) you want to use. // Defaults to the default detekt configuration. config = files("path/to/config.yml") // Applies the config files on top of detekt's default config file. `false` by default. buildUponDefaultConfig = false // Turns on all the rules. `false` by default. allRules = false // Specifying a baseline file. All findings stored in this file in subsequent runs of detekt. baseline = file("path/to/baseline.xml") // Disables all default detekt rulesets and will only run detekt with custom rules // defined in plugins passed in with `detektPlugins` configuration. `false` by default. disableDefaultRuleSets = false // Adds debug output during task execution. `false` by default. debug = false // If set to `true` the build does not fail when the // maxIssues count was reached. Defaults to `false`. ignoreFailures = false // Android: Don't create tasks for the specified build types (e.g. "release") ignoredBuildTypes = ["release"] // Android: Don't create tasks for the specified build flavor (e.g. "production") ignoredFlavors = ["production"] // Android: Don't create tasks for the specified build variants (e.g. "productionRelease") ignoredVariants = ["productionRelease"] // Specify the base path for file paths in the formatted reports. // If not set, all file paths reported will be absolute file path. basePath = projectDir } </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="kotlin-dsl-3">Kotlin DSL<a href="#kotlin-dsl-3" class="hash-link" aria-label="Direct link to Kotlin DSL" title="Direct link to Kotlin DSL"></a></h4> <div class="language-kotlin codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-kotlin codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv">detekt { // Version of Detekt that will be used. When unspecified the latest detekt // version found will be used. Override to stay on the same version. toolVersion = "1.21.0" // The directories where detekt looks for source files. // Defaults to `files("src/main/java", "src/test/java", "src/main/kotlin", "src/test/kotlin")`. source = files("src/main/java", "src/main/kotlin") // Builds the AST in parallel. Rules are always executed in parallel. // Can lead to speedups in larger projects. `false` by default. parallel = false // Define the detekt configuration(s) you want to use. // Defaults to the default detekt configuration. config = files("path/to/config.yml") // Applies the config files on top of detekt's default config file. `false` by default. buildUponDefaultConfig = false // Turns on all the rules. `false` by default. allRules = false // Specifying a baseline file. All findings stored in this file in subsequent runs of detekt. baseline = file("path/to/baseline.xml") // Disables all default detekt rulesets and will only run detekt with custom rules // defined in plugins passed in with `detektPlugins` configuration. `false` by default. disableDefaultRuleSets = false // Adds debug output during task execution. `false` by default. debug = false // If set to `true` the build does not fail when the // maxIssues count was reached. Defaults to `false`. ignoreFailures = false // Android: Don't create tasks for the specified build types (e.g. "release") ignoredBuildTypes = listOf("release") // Android: Don't create tasks for the specified build flavor (e.g. "production") ignoredFlavors = listOf("production") // Android: Don't create tasks for the specified build variants (e.g. "productionRelease") ignoredVariants = listOf("productionRelease") // Specify the base path for file paths in the formatted reports. // If not set, all file paths reported will be absolute file path. basePath = projectDir } </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="reports">Reports<a href="#reports" class="hash-link" aria-label="Direct link to Reports" title="Direct link to Reports"></a></h3> Report output can be customized for each task. The DSL is the same in both Groovy and Kotlin: <div class="language-kotlin codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-kotlin codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv">tasks.named("detekt").configure { reports { // Enable/Disable XML report (default: true) xml.required.set(true) xml.outputLocation.set(file("build/reports/detekt.xml")) // Enable/Disable HTML report (default: true) html.required.set(true) html.outputLocation.set(file("build/reports/detekt.html")) // Enable/Disable TXT report (default: true) txt.required.set(true) txt.outputLocation.set(file("build/reports/detekt.txt")) // Enable/Disable SARIF report (default: false) sarif.required.set(true) sarif.outputLocation.set(file("build/reports/detekt.sarif")) // Enable/Disable MD report (default: false) md.required.set(true) md.outputLocation.set(file("build/reports/detekt.md")) custom { // The simple class name of your custom report. reportId = "CustomJsonReport" outputLocation.set(file("build/reports/detekt.json")) } } } </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="using-type-resolution">Using Type Resolution<a href="#using-type-resolution" class="hash-link" aria-label="Direct link to Using Type Resolution" title="Direct link to Using Type Resolution"></a></h3> Type resolution is experimental and works only for <a href="#available-plugin-tasks">predefined tasks listed above</a> or when implementing a custom detekt task with the <code>classpath</code> and <code>jvmTarget</code> properties present. More information on type resolution are available on the <a href="/docs/1.21.0/gettingstarted/type-resolution">type resolution</a> page. <h4 class="anchor anchorWithStickyNavbar_LWe7" id="groovy-dsl-4">Groovy DSL<a href="#groovy-dsl-4" class="hash-link" aria-label="Direct link to Groovy DSL" title="Direct link to Groovy DSL"></a></h4> <div class="language-groovy codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-groovy codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv">tasks.withType(io.gitlab.arturbosch.detekt.Detekt).configureEach { jvmTarget = "1.8" } tasks.withType(io.gitlab.arturbosch.detekt.DetektCreateBaselineTask).configureEach { jvmTarget = "1.8" } </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="kotlin-dsl-4">Kotlin DSL<a href="#kotlin-dsl-4" class="hash-link" aria-label="Direct link to Kotlin DSL" title="Direct link to Kotlin DSL"></a></h4> <div class="language-kotlin codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-kotlin codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv">tasks.withType<io.gitlab.arturbosch.detekt.Detekt>().configureEach { this.jvmTarget = "1.8" } tasks.withType<io.gitlab.arturbosch.detekt.DetektCreateBaselineTask>().configureEach { this.jvmTarget = "1.8" } </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="leveraging-gradles-sourcetask---excluding-and-including-source-files"><a name="excluding">Leveraging Gradle's SourceTask - Excluding and including source files</a><a href="#leveraging-gradles-sourcetask---excluding-and-including-source-files" class="hash-link" aria-label="Direct link to leveraging-gradles-sourcetask---excluding-and-including-source-files" title="Direct link to leveraging-gradles-sourcetask---excluding-and-including-source-files"></a></h3> A detekt task extends the Gradle <code>SourceTask</code> to be only scheduled when watched source files are changed. It also allows to match files that should be excluded from the analysis. To do this introduce a query on detekt tasks and define include and exclude patterns outside the detekt closure: <h4 class="anchor anchorWithStickyNavbar_LWe7" id="groovy-dsl-5">Groovy DSL<a href="#groovy-dsl-5" class="hash-link" aria-label="Direct link to Groovy DSL" title="Direct link to Groovy DSL"></a></h4> <div class="language-groovy codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-groovy codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv">detekt { ... } tasks.withType(io.gitlab.arturbosch.detekt.Detekt).configureEach { // include("**/special/package/**") // only analyze a sub package inside src/main/kotlin exclude("**/special/package/internal/**") // but exclude our legacy internal package } tasks.withType(io.gitlab.arturbosch.detekt.DetektCreateBaselineTask).configureEach { // include("**/special/package/**") // only analyze a sub package inside src/main/kotlin exclude("**/special/package/internal/**") // but exclude our legacy internal package } </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="kotlin-dsl-5">Kotlin DSL<a href="#kotlin-dsl-5" class="hash-link" aria-label="Direct link to Kotlin DSL" title="Direct link to Kotlin DSL"></a></h4> <div class="language-kotlin codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-kotlin codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv">detekt { ... } tasks.withType<io.gitlab.arturbosch.detekt.Detekt>().configureEach { // include("**/special/package/**") // only analyze a sub package inside src/main/kotlin exclude("**/special/package/internal/**") // but exclude our legacy internal package } tasks.withType<io.gitlab.arturbosch.detekt.DetektCreateBaselineTask>().configureEach { // include("**/special/package/**") // only analyze a sub package inside src/main/kotlin exclude("**/special/package/internal/**") // but exclude our legacy internal package } </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="defining-custom-detekt-task"><a name="customdetekttask">Defining custom detekt task</a><a href="#defining-custom-detekt-task" class="hash-link" aria-label="Direct link to defining-custom-detekt-task" title="Direct link to defining-custom-detekt-task"></a></h3> Custom tasks for alternative configurations or different source sets can be defined by creating a custom task that uses the type <code>Detekt</code>. <h4 class="anchor anchorWithStickyNavbar_LWe7" id="groovy-dsl-6">Groovy DSL<a href="#groovy-dsl-6" class="hash-link" aria-label="Direct link to Groovy DSL" title="Direct link to Groovy DSL"></a></h4> <div class="language-groovy codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-groovy codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv">tasks.register(name: myDetekt, type: io.gitlab.arturbosch.detekt.Detekt) { description = "Runs a custom detekt build." setSource(files("src/main/kotlin", "src/test/kotlin")) config.setFrom(files("$rootDir/config.yml")) debug = true reports { xml { destination = file("build/reports/mydetekt.xml") } html.destination = file("build/reports/mydetekt.html") } include '**/*.kt' include '**/*.kts' exclude 'resources/' exclude 'build/' } </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="kotlin-dsl-6">Kotlin DSL<a href="#kotlin-dsl-6" class="hash-link" aria-label="Direct link to Kotlin DSL" title="Direct link to Kotlin DSL"></a></h4> <div class="language-kotlin codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-kotlin codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv">tasks.register<io.gitlab.arturbosch.detekt.Detekt>("myDetekt") { description = "Runs a custom detekt build." setSource(files("src/main/kotlin", "src/test/kotlin")) config.setFrom(files("$rootDir/config.yml")) debug = true reports { xml { destination = file("build/reports/mydetekt.xml") } html.destination = file("build/reports/mydetekt.html") } include("**/*.kt") include("**/*.kts") exclude("resources/") exclude("build/") } </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="disabling-detekt-from-the-check-task"><a name="check-lifecycle">Disabling detekt from the check task</a><a href="#disabling-detekt-from-the-check-task" class="hash-link" aria-label="Direct link to disabling-detekt-from-the-check-task" title="Direct link to disabling-detekt-from-the-check-task"></a></h3> Detekt tasks by default are verification tasks. They get executed whenever the Gradle check task gets executed. This aligns with the behavior of other code analysis plugins for Gradle. If you are adding detekt to an already long running project you may want to increase the code quality incrementally and therefore exclude detekt from the check task. <h4 class="anchor anchorWithStickyNavbar_LWe7" id="groovy-dsl-7">Groovy DSL<a href="#groovy-dsl-7" class="hash-link" aria-label="Direct link to Groovy DSL" title="Direct link to Groovy DSL"></a></h4> <div class="language-groovy codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-groovy codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv">check.configure { dependsOn = dependsOn.findAll { it.name != 'detekt' } } </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="kotlin-dsl-7">Kotlin DSL<a href="#kotlin-dsl-7" class="hash-link" aria-label="Direct link to Kotlin DSL" title="Direct link to Kotlin DSL"></a></h4> <div class="language-kotlin codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-kotlin codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv">tasks.named("check").configure { this.setDependsOn(this.dependsOn.filterNot { it is TaskProvider<*> && it.name == "detekt" }) } </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> Instead of disabling detekt for the check task, you may want to increase the build failure threshold in the <a href="/docs/introduction/configurations">configuration file</a>. <h2 class="anchor anchorWithStickyNavbar_LWe7" id="integrating-detekt-inside-your-intellij-idea"><a name="idea">Integrating detekt inside your IntelliJ IDEA</a><a href="#integrating-detekt-inside-your-intellij-idea" class="hash-link" aria-label="Direct link to integrating-detekt-inside-your-intellij-idea" title="Direct link to integrating-detekt-inside-your-intellij-idea"></a></h2> detekt comes with an <a href="https://plugins.jetbrains.com/plugin/10761-detekt" target="_blank" rel="noopener noreferrer">IntelliJ Plugin</a> that you can install directly from the IDE. The plugin offers warning highlight directly inside the IDE as well as support for code formatting. The source code of the plugin is available here: <a href="https://github.com/detekt/detekt-intellij-plugin" target="_blank" rel="noopener noreferrer">detekt/detekt-intellij-plugin</a></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/detekt/detekt/edit/main/website/versioned_docs/version-1.21.0/gettingstarted/gradle.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.21.0/gettingstarted/cli"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Run detekt using Command Line Interface</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.21.0/gettingstarted/gradletask"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Run detekt using Gradle Task</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#available-plugin-tasks" class="table-of-contents__link toc-highlight"><a>Available plugin tasks</a></a><ul><li><a href="#configuration" class="table-of-contents__link toc-highlight"><a>Configuration</a></a></li><li><a href="#configuration-for-android-projects" class="table-of-contents__link toc-highlight"><a>Configuration for Android projects</a></a></li><li><a href="#options-for-detekt-configuration-closure" class="table-of-contents__link toc-highlight"><a>Options for detekt configuration closure</a></a></li><li><a href="#reports" class="table-of-contents__link toc-highlight">Reports</a></li><li><a href="#using-type-resolution" class="table-of-contents__link toc-highlight">Using Type Resolution</a></li><li><a href="#leveraging-gradles-sourcetask---excluding-and-including-source-files" class="table-of-contents__link toc-highlight"><a>Leveraging Gradle's SourceTask - Excluding and including source files</a></a></li><li><a href="#defining-custom-detekt-task" class="table-of-contents__link toc-highlight"><a>Defining custom detekt task</a></a></li><li><a href="#disabling-detekt-from-the-check-task" class="table-of-contents__link toc-highlight"><a>Disabling detekt from the check task</a></a></li></ul></li><li><a href="#integrating-detekt-inside-your-intellij-idea" class="table-of-contents__link toc-highlight"><a>Integrating detekt inside your IntelliJ IDEA</a></a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/gettingstarted/gradle">Getting Started with Gradle</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/gettingstarted/cli">Getting Started with the CLI</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/rules/comments">Rules Documentation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://kotlinlang.slack.com/archives/C88E12QH4" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/detekt" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li><li class="footer__item"><a href="https://github.com/detekt/detekt" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://detekt.dev/kdoc" target="_blank" rel="noopener noreferrer" class="footer__link-item">KDoc<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 detekt team - Built with Docusaurus.</div></div></div></footer></div> </body> </html>