CINXE.COM
<!doctype html> <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-1.23.5 docs-doc-page docs-doc-id-intro" data-has-hydrated="false"> <head> <meta charset="UTF-8"> <meta name="generator" content="Docusaurus v3.7.0"> <title data-rh="true">Welcome | 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.23.5/intro"><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.23.5"><meta data-rh="true" name="docusaurus_tag" content="docs-default-1.23.5"><meta data-rh="true" name="docsearch:version" content="1.23.5"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-1.23.5"><meta data-rh="true" property="og:title" content="Welcome | detekt"><meta data-rh="true" name="description" content="detekt logo"><meta data-rh="true" property="og:description" content="detekt logo"><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.23.5/intro"><link data-rh="true" rel="alternate" href="https://detekt.dev/docs/1.23.5/intro" hreflang="en"><link data-rh="true" rel="alternate" href="https://detekt.dev/docs/1.23.5/intro" 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.bf91fd30.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><b class="navbar__title text--truncate">detekt</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/1.23.5/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.23.5/intro">1.23.5</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/next/intro">Next</a></li><li><a class="dropdown__link" href="/docs/intro">1.23.8</a></li><li><a class="dropdown__link" href="/docs/1.23.7/intro">1.23.7</a></li><li><a class="dropdown__link" href="/docs/1.23.6/intro">1.23.6</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/docs/1.23.5/intro">1.23.5</a></li><li><a class="dropdown__link" href="/docs/1.23.4/intro">1.23.4</a></li><li><a class="dropdown__link" href="/docs/1.23.3/intro">1.23.3</a></li><li><a class="dropdown__link" href="/docs/1.23.1/intro">1.23.1</a></li><li><a class="dropdown__link" href="/docs/1.23.0/intro">1.23.0</a></li><li><a class="dropdown__link" href="/docs/1.22.0/intro">1.22.0</a></li><li><a class="dropdown__link" href="/docs/1.21.0/intro">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)"><span class="DocSearch-Button-Container"><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><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></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 menu__link--active" aria-current="page" href="/docs/1.23.5/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.23.5/introduction/configurations">Introduction</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="/docs/1.23.5/gettingstarted/cli">Getting Started</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="/docs/1.23.5/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<!-- --> <b>1.23.5</b>, which is no longer actively maintained.</div><div class="margin-top--md">For up-to-date documentation, see the <b><a href="/docs/intro">latest version</a></b> (<!-- -->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 itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Welcome</span><meta itemprop="position" content="1"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: 1.23.5</span><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>Welcome</h1></header><p><img decoding="async" loading="lazy" alt="detekt logo" src="data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjI1IiBoZWlnaHQ9IjUzIiB2aWV3Qm94PSIwIDAgMjI1IDUzIiBmaWxsPSJub25lIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8cGF0aCBkPSJNODguODg4MyA0Mi4yNjY1VjcuOTk0ODdIODEuNjk1NFYyMC4zODlDNzkuOTkxOCAxOC4zNzAzIDc3LjYyNTcgMTYuNjMzMiA3My43OTI2IDE2LjYzMzJDNjcuNzgyOCAxNi42MzMyIDYyLjI0NjEgMjEuMjM0MSA2Mi4yNDYxIDI5LjYzNzdWMjkuNzMxNkM2Mi4yNDYxIDM4LjEzNTIgNjcuODc3NCA0Mi43MzYgNzMuNzkyNiA0Mi43MzZDNzcuNTMxMSA0Mi43MzYgNzkuOTQ0NSA0MC45OTg5IDgxLjY5NTQgMzguNjUxNlY0Mi4yNjY1SDg4Ljg4ODNaTTgxLjc5IDI5LjczMTZDODEuNzkgMzMuOTA5OSA3OC45OTggMzYuNjc5OCA3NS42MzgyIDM2LjY3OThDNzIuMjc4MyAzNi42Nzk4IDY5LjQzOSAzMy45MDk5IDY5LjQzOSAyOS43MzE2VjI5LjYzNzdDNjkuNDM5IDI1LjQxMjQgNzIuMjc4MyAyMi42ODk0IDc1LjYzODIgMjIuNjg5NEM3OC45OTggMjIuNjg5NCA4MS43OSAyNS40NTkzIDgxLjc5IDI5LjYzNzdWMjkuNzMxNloiIGZpbGw9IiMyMjIyMjIiLz4KPHBhdGggZD0iTTEyMC4zMjUgMzAuMzg4OFYzMC4yOTQ5QzEyMC4zMjUgMjMuMTU4OSAxMTYuNDQ0IDE2LjYzMzIgMTA3Ljk3NCAxNi42MzMyQzEwMC41OTEgMTYuNjMzMiA5NS40MzM0IDIyLjU0ODYgOTUuNDMzNCAyOS43MzE2VjI5LjgyNTRDOTUuNDMzNCAzNy41MjQ4IDEwMS4wNjUgNDIuODI5OSAxMDguNjgzIDQyLjgyOTlDMTEzLjI3NCA0Mi44Mjk5IDExNi42ODEgNDEuMDQ1OSAxMTkuMDQ3IDM4LjEzNTJMMTE0LjkzIDM0LjUyMDJDMTEyLjk0MiAzNi4zNTExIDExMS4xOTIgMzcuMTAyMyAxMDguNzc4IDM3LjEwMjNDMTA1LjU2IDM3LjEwMjMgMTAzLjI4OSAzNS40MTIyIDEwMi41NzkgMzIuMTcyOEgxMjAuMjNDMTIwLjI3NyAzMS41MTU2IDEyMC4zMjUgMzEuMDkzIDEyMC4zMjUgMzAuMzg4OFpNMTEzLjMyMSAyNy43MTI4SDEwMi40ODRDMTAzLjA1MiAyNC40NzM0IDEwNC45OTIgMjIuMzYwOCAxMDcuOTc0IDIyLjM2MDhDMTExLjAwMiAyMi4zNjA4IDExMi44OTUgMjQuNTIwNCAxMTMuMzIxIDI3LjcxMjhaIiBmaWxsPSIjMjIyMjIyIi8+CjxwYXRoIGQ9Ik0xNDEuMjc4IDQxLjIzMzdWMzUuNTA2MUMxNDAuMjM3IDM2LjA2OTUgMTM5LjA1NCAzNi4zOTgxIDEzNy43MjkgMzYuMzk4MUMxMzYuMTIgMzYuMzk4MSAxMzUuNDEgMzUuNiAxMzUuNDEgMzMuOTU2OFYyMy4yMDU5SDE0MS4zNzNWMTcuMTAyN0gxMzUuNDFWMTAuNjcwOUgxMjguMjE3VjE3LjEwMjdIMTI1LjE4OVYyMy4yMDU5SDEyOC4yMTdWMzUuMTMwNUMxMjguMjE3IDQwLjk1MiAxMzEuMTk5IDQyLjY4OTEgMTM1LjU5OSA0Mi42ODkxQzEzOC4wMTMgNDIuNjg5MSAxMzkuNzY0IDQyLjEyNTcgMTQxLjI3OCA0MS4yMzM3WiIgZmlsbD0iIzIyMjIyMiIvPgo8cGF0aCBkPSJNMTcyLjAwOCAzMC4zODg4VjMwLjI5NDlDMTcyLjAwOCAyMy4xNTg5IDE2OC4xMjggMTYuNjMzMiAxNTkuNjU3IDE2LjYzMzJDMTUyLjI3NSAxNi42MzMyIDE0Ny4xMTcgMjIuNTQ4NiAxNDcuMTE3IDI5LjczMTZWMjkuODI1NEMxNDcuMTE3IDM3LjUyNDggMTUyLjc0OCA0Mi44Mjk5IDE2MC4zNjcgNDIuODI5OUMxNjQuOTU4IDQyLjgyOTkgMTY4LjM2NSA0MS4wNDU5IDE3MC43MzEgMzguMTM1MkwxNjYuNjE0IDM0LjUyMDJDMTY0LjYyNiAzNi4zNTExIDE2Mi44NzUgMzcuMTAyMyAxNjAuNDYyIDM3LjEwMjNDMTU3LjI0NCAzNy4xMDIzIDE1NC45NzMgMzUuNDEyMiAxNTQuMjYzIDMyLjE3MjhIMTcxLjkxNEMxNzEuOTYxIDMxLjUxNTYgMTcyLjAwOCAzMS4wOTMgMTcyLjAwOCAzMC4zODg4Wk0xNjUuMDA1IDI3LjcxMjhIMTU0LjE2OEMxNTQuNzM2IDI0LjQ3MzQgMTU2LjY3NiAyMi4zNjA4IDE1OS42NTcgMjIuMzYwOEMxNjIuNjg2IDIyLjM2MDggMTY0LjU3OSAyNC41MjA0IDE2NS4wMDUgMjcuNzEyOFoiIGZpbGw9IiMyMjIyMjIiLz4KPHBhdGggZD0iTTIwMy4yNzggNDIuMjY2NUwxOTMuMjkzIDI3LjAwODZMMjAyLjk0NyAxNy4xMDI3SDE5NC4zMzRMMTg1LjkxMSAyNi4yNTc0VjcuOTk0ODdIMTc4LjcxOFY0Mi4yNjY1SDE4NS45MTFWMzQuNjE0MUwxODguNDE5IDMxLjk4NUwxOTUuMDQ0IDQyLjI2NjVIMjAzLjI3OFoiIGZpbGw9IiMyMjIyMjIiLz4KPHBhdGggZD0iTTIyNC45MDUgNDEuMjMzN1YzNS41MDYxQzIyMy44NjQgMzYuMDY5NSAyMjIuNjgxIDM2LjM5ODEgMjIxLjM1NiAzNi4zOTgxQzIxOS43NDcgMzYuMzk4MSAyMTkuMDM3IDM1LjYgMjE5LjAzNyAzMy45NTY4VjIzLjIwNTlIMjI1VjE3LjEwMjdIMjE5LjAzN1YxMC42NzA5SDIxMS44NDRWMTcuMTAyN0gyMDguODE2VjIzLjIwNTlIMjExLjg0NFYzNS4xMzA1QzIxMS44NDQgNDAuOTUyIDIxNC44MjYgNDIuNjg5MSAyMTkuMjI3IDQyLjY4OTFDMjIxLjY0IDQyLjY4OTEgMjIzLjM5MSA0Mi4xMjU3IDIyNC45MDUgNDEuMjMzN1oiIGZpbGw9IiMyMjIyMjIiLz4KPHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik0yLjE4NjExIDBDMC45Nzg3NTUgMCAwIDAuOTc4NzU1IDAgMi4xODYxMVY0MC43NzFDMCA0MS45NzgzIDAuOTc4NzU1IDQyLjk1NzEgMi4xODYxMSA0Mi45NTcxSDI0LjI1MzRDMjUuNjUyNSA0Mi45NTcxIDI2LjYyNTggNDEuNTQ3MyAyNi4zNzc0IDQwLjE3MDVDMjYuMjEwOSAzOS4yNDgxIDI2LjEyNCAzOC4yOTgxIDI2LjEyNCAzNy4zMjc5QzI2LjEyNCAyOC41NDQzIDMzLjI0NDUgMjEuNDIzOSA0Mi4wMjggMjEuNDIzOUM0Mi44Njg5IDIxLjQyMzkgNDMuNjk0NSAyMS40ODkyIDQ0LjUwMDEgMjEuNjE0OUM0NS44NTc4IDIxLjgyNjggNDcuMjIgMjAuODU4NSA0Ny4yMiAxOS40ODQ0VjIuMTg2MTFDNDcuMjIgMC45Nzg3NTUgNDYuMjQxMiAwIDQ1LjAzMzkgMEgyLjE4NjExWiIgZmlsbD0idXJsKCNwYWludDBfbGluZWFyKSIvPgo8cGF0aCBkPSJNNTUuMzM1OCA0OC42MTY2TDU0Ljc2NzMgNDguMDQ4MUw1My4yNDIxIDQ2LjUyMjlMNTIuOTUxNiA0Ni4yMzI0QzUyLjI0MjcgNDUuNTIzNCA1Mi4xODU1IDQ0LjQwNjcgNTIuNjczIDQzLjUzMDZDNTMuNjI5OSA0MS44MTA5IDU0LjE3NjIgMzkuODMzIDU0LjE3NjIgMzcuNzI5M0M1NC4xNzYyIDMyLjkxMDQgNTEuMzE0NyAyOC43NDk5IDQ3LjIwMjkgMjYuODUwMUM0Ni41MTk2IDI2LjUzNDQgNDUuODAyNCAyNi4yODA4IDQ1LjA1NzMgMjYuMDk3NEM0NC4zNjM2IDI1LjkyNjggNDMuNjQ2NyAyNS44MTY0IDQyLjkxMTggMjUuNzcyN0M0Mi42NzQ5IDI1Ljc1ODcgNDIuNDM2OSAyNS43NDk1IDQyLjE5NjYgMjUuNzQ5NUMzOC41MTY2IDI1Ljc0OTUgMzUuMjIwMyAyNy40MTg4IDMzLjAyMTEgMzAuMDM4MUMzMS45Nzg0IDMxLjI4MDIgMzEuMTgzOCAzMi43MzU3IDMwLjcxMTQgMzQuMzI5M0MzMC4zOTE2IDM1LjQwNzkgMzAuMjE3IDM2LjU0ODEgMzAuMjE3IDM3LjcyOTFDMzAuMjE3IDM4LjAyOTMgMzAuMjMxOSAzOC4zMjU5IDMwLjI1MzcgMzguNjIwNUMzMC4zMDgyIDM5LjM1NTkgMzAuNDI2NSA0MC4wNzMzIDMwLjYwODIgNDAuNzY2QzMwLjgwMzggNDEuNTExNyAzMS4wNjg5IDQyLjIyOTYgMzEuMzk3NCA0Mi45MTE2QzMzLjMzMzIgNDYuOTI5NSAzNy40NDY1IDQ5LjcwODkgNDIuMTk2NyA0OS43MDg5QzQzLjk1NyA0OS43MDg5IDQ1LjYyOTEgNDkuMzI1OSA0Ny4xMzU3IDQ4LjY0MDNDNDcuOTg0MSA0OC4yNTQzIDQ5LjAwNDYgNDguMzUzNiA0OS42NjM2IDQ5LjAxMjdMNTAuMDg5NCA0OS40Mzg1TDUxLjYzMDEgNTAuOTc5NEw1Mi4zMDE2IDUxLjY1MDlDNTIuNzIwNSA1Mi4wNjk5IDUzLjI2OTcgNTIuMjc5NCA1My44MTg2IDUyLjI3OTRDNTQuMzY3NyA1Mi4yNzk0IDU0LjkxNjkgNTIuMDY5OSA1NS4zMzU3IDUxLjY1MDlDNTYuMTczOCA1MC44MTI5IDU2LjE3MzggNDkuNDU0NCA1NS4zMzU4IDQ4LjYxNjZaTTQyLjE5NjcgNDUuNDE4QzM5Ljk1MjUgNDUuNDE4IDM3LjkzIDQ0LjQ1MSAzNi41MjMyIDQyLjkxMjJDMzUuOTQ4NSA0Mi4yODM2IDM1LjQ3NzIgNDEuNTU5NCAzNS4xMzUgNDAuNzY2N0MzNC44NDUgNDAuMDk1NCAzNC42NDkzIDM5LjM3NDYgMzQuNTYxNyAzOC42MjExQzM0LjUyNzcgMzguMzI4MyAzNC41MDg0IDM4LjAzMTQgMzQuNTA4NCAzNy43Mjk3QzM0LjUwODQgMzMuNDkwMyAzNy45NTc0IDMwLjA0MTMgNDIuMTk2OCAzMC4wNDEzQzQyLjQzNzkgMzAuMDQxMyA0Mi42NzYyIDMwLjA1MzkgNDIuOTEyIDMwLjA3NTZDNDMuNjYzOCAzMC4xNDU1IDQ0LjM4MzcgMzAuMzI0MiA0NS4wNTc2IDMwLjU5NTZDNDUuODQ1OCAzMC45MTI3IDQ2LjU2ODkgMzEuMzU2NCA0Ny4yMDMxIDMxLjkwMkM0OC44NDM0IDMzLjMxMzEgNDkuODg1MiAzNS40MDE1IDQ5Ljg4NTIgMzcuNzI5N0M0OS44ODUgNDEuOTY4OCA0Ni40MzYxIDQ1LjQxOCA0Mi4xOTY3IDQ1LjQxOFoiIGZpbGw9InVybCgjcGFpbnQxX2xpbmVhcikiLz4KPHBhdGggZD0iTTkuOTkzNiAyNS42OTc5QzkuMzQyMTcgMjUuNjk3OSA4Ljg0NjE4IDI1LjQ5NTggOC41MDU2NiAyNS4wOTE0QzguMTY1MTQgMjQuNjcwOSA3Ljk5NDg3IDI0LjE2OTUgNy45OTQ4NyAyMy41ODczVjIzLjQ5MDNDNy45OTQ4NyAyMi45MDggOC4xNjUxNCAyMi40MTQ3IDguNTA1NjYgMjIuMDEwNEM4Ljg0NjE4IDIxLjU4OTkgOS4zNDIxNyAyMS4zNzk2IDkuOTkzNiAyMS4zNzk2QzEwLjY0NSAyMS4zNzk2IDExLjE0MSAyMS41ODk5IDExLjQ4MTUgMjIuMDEwNEMxMS44MjIxIDIyLjQxNDcgMTEuOTkyMyAyMi45MDggMTEuOTkyMyAyMy40OTAzVjIzLjU4NzNDMTEuOTkyMyAyNC4xNjk1IDExLjgyMjEgMjQuNjcwOSAxMS40ODE1IDI1LjA5MTRDMTEuMTQxIDI1LjQ5NTggMTAuNjQ1IDI1LjY5NzkgOS45OTM2IDI1LjY5NzlaTTguMTcyNTQgMTAuODE1OFY3Ljk5NDg3SDExLjgxNDdWMTAuODE1OEwxMC42NTk4IDE5LjE2MTJIOS4zMjczNkw4LjE3MjU0IDEwLjgxNThaIiBmaWxsPSJ3aGl0ZSIvPgo8cGF0aCBkPSJNMjAuMjcyOSAyNS42OTc5QzE5LjYyMTUgMjUuNjk3OSAxOS4xMjU1IDI1LjQ5NTggMTguNzg1IDI1LjA5MTRDMTguNDQ0NCAyNC42NzA5IDE4LjI3NDIgMjQuMTY5NSAxOC4yNzQyIDIzLjU4NzNWMjMuNDkwM0MxOC4yNzQyIDIyLjkwOCAxOC40NDQ0IDIyLjQxNDcgMTguNzg1IDIyLjAxMDRDMTkuMTI1NSAyMS41ODk5IDE5LjYyMTUgMjEuMzc5NiAyMC4yNzI5IDIxLjM3OTZDMjAuOTI0MyAyMS4zNzk2IDIxLjQyMDMgMjEuNTg5OSAyMS43NjA4IDIyLjAxMDRDMjIuMTAxNCAyMi40MTQ3IDIyLjI3MTYgMjIuOTA4IDIyLjI3MTYgMjMuNDkwM1YyMy41ODczQzIyLjI3MTYgMjQuMTY5NSAyMi4xMDE0IDI0LjY3MDkgMjEuNzYwOCAyNS4wOTE0QzIxLjQyMDMgMjUuNDk1OCAyMC45MjQzIDI1LjY5NzkgMjAuMjcyOSAyNS42OTc5Wk0xOC40NTE4IDEwLjgxNThWNy45OTQ4N0gyMi4wOTRWMTAuODE1OEwyMC45MzkxIDE5LjE2MTJIMTkuNjA2N0wxOC40NTE4IDEwLjgxNThaIiBmaWxsPSJ3aGl0ZSIvPgo8ZGVmcz4KPGxpbmVhckdyYWRpZW50IGlkPSJwYWludDBfbGluZWFyIiB4MT0iNS4yMjJlLTA3IiB5MT0iNDEuMzM2MSIgeDI9IjUxLjk4MiIgeTI9IjMzLjI5IiBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSI+CjxzdG9wIHN0b3AtY29sb3I9IiM3OTQyRUUiLz4KPHN0b3Agb2Zmc2V0PSIxIiBzdG9wLWNvbG9yPSIjRkY0NjUxIi8+CjwvbGluZWFyR3JhZGllbnQ+CjxsaW5lYXJHcmFkaWVudCBpZD0icGFpbnQxX2xpbmVhciIgeDE9IjUzLjAxMjEiIHkxPSI1MS41NDY1IiB4Mj0iNjAuOTgwMSIgeTI9IjMwLjI0MjMiIGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIj4KPHN0b3Agc3RvcC1jb2xvcj0iIzc5NDJFRSIvPgo8c3RvcCBvZmZzZXQ9IjEiIHN0b3AtY29sb3I9IiNGRjQ2NTEiLz4KPC9saW5lYXJHcmFkaWVudD4KPC9kZWZzPgo8L3N2Zz4K" title="detekt logo" width="225" height="53" class="img_ev3q"> <img decoding="async" loading="lazy" alt="detekt in action" src="/assets/images/detekt_in_action-28584853d114ee77b5b013bb77b2bce7.png" title="detekt in action" width="1390" height="535" class="img_ev3q"></p> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="features">Features<a href="#features" class="hash-link" aria-label="Direct link to Features" title="Direct link to Features"></a></h3> <ul> <li>Code smell analysis for your <a href="https://kotlinlang.org/" target="_blank" rel="noopener noreferrer">Kotlin</a> projects.</li> <li>Highly configurable rule sets.</li> <li>Generate baselines to suppress existing issues for legacy projects while making sure no new issues are introduced.</li> <li>Suppress issues in source files using <code>@Suppress</code> annotations.</li> <li>Support for different report formats: HTML, Markdown, <a href="https://sarifweb.azurewebsites.net/" target="_blank" rel="noopener noreferrer">SARIF</a>, XML (Checkstyle) and custom reports.</li> <li><a href="/docs/1.23.5/introduction/extensions">Extend detekt</a> with custom rule sets and reports.</li> <li>Complexity reports based on lines of code, cyclomatic complexity and number of code smells.</li> <li>First party integration with Gradle with our <a href="/docs/1.23.5/gettingstarted/gradle">Gradle plugin</a>.</li> <li>A community of <a href="https://github.com/topics/detekt-plugin" target="_blank" rel="noopener noreferrer">third party plugins</a> that adds more rules and features to detekt.</li> </ul> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="quick-start-with-gradle">Quick Start with Gradle<a href="#quick-start-with-gradle" class="hash-link" aria-label="Direct link to Quick Start with Gradle" title="Direct link to Quick Start with Gradle"></a></h3> <p>Apply the following configuration to your Gradle project build file:</p> <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"><span class="token-line" style="color:#393A34"><span class="token plain">plugins </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token function" style="color:#d73a49">id</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string-literal singleline string" style="color:#e3116c">"io.gitlab.arturbosch.detekt"</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">version</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string-literal singleline string" style="color:#e3116c">"1.23.5"</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">repositories </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token function" style="color:#d73a49">mavenCentral</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><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></span></button></div></div></div> <p>You can find what is the <strong>latest version of detekt</strong> in the <a href="/changelog">release notes</a>.</p> <p>Once you have set up detekt in your project, simply run <code>gradlew detekt</code>.</p> <p>To change the default behaviour of detekt rules, first generate yourself a detekt configuration file by running <code>gradlew detektGenerateConfig</code> task and applying any changes to the generated file.</p> <p>Don't forget to reference the newly generated config inside the <code>detekt { }</code> closure. Optionally, it is possible to slim down the configuration file to only the changes from the default configuration, by applying the <code>buildUponDefaultConfig</code> option:</p> <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"><span class="token-line" style="color:#393A34"><span class="token plain">detekt </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> toolVersion </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token string-literal singleline string" style="color:#e3116c">"1.23.5"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> config</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">setFrom</span><span class="token punctuation" style="color:#393A34">(</span><span class="token function" style="color:#d73a49">file</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string-literal singleline string" style="color:#e3116c">"config/detekt/detekt.yml"</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> buildUponDefaultConfig </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><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></span></button></div></div></div> <p>To enable/disable detekt reports use the <code>withType</code> method to set defaults for all detekt tasks at once:</p> <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"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Kotlin DSL</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">tasks</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">withType</span><span class="token operator" style="color:#393A34"><</span><span class="token plain">Detekt</span><span class="token operator" style="color:#393A34">></span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">configureEach</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> reports </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> xml</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">required</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">set</span><span class="token punctuation" style="color:#393A34">(</span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> html</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">required</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">set</span><span class="token punctuation" style="color:#393A34">(</span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> txt</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">required</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">set</span><span class="token punctuation" style="color:#393A34">(</span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> sarif</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">required</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">set</span><span class="token punctuation" style="color:#393A34">(</span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> md</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">required</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">set</span><span class="token punctuation" style="color:#393A34">(</span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><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></span></button></div></div></div> <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"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Groovy DSL</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">tasks</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">withType</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">Detekt</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">configureEach </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> reports </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> xml</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">required</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">set</span><span class="token punctuation" style="color:#393A34">(</span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> html</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">required</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">set</span><span class="token punctuation" style="color:#393A34">(</span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> txt</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">required</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">set</span><span class="token punctuation" style="color:#393A34">(</span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> sarif</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">required</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">set</span><span class="token punctuation" style="color:#393A34">(</span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> md</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">required</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">set</span><span class="token punctuation" style="color:#393A34">(</span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><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></span></button></div></div></div> <p>See <a href="/docs/1.23.5/introduction/reporting">reporting</a> docs for more details on configuring reports.</p> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="adding-more-rule-sets">Adding more rule sets<a href="#adding-more-rule-sets" class="hash-link" aria-label="Direct link to Adding more rule sets" title="Direct link to Adding more rule sets"></a></h3> <p>detekt itself provides a wrapper over <a href="https://github.com/pinterest/ktlint" target="_blank" rel="noopener noreferrer">ktlint</a> as the <code>formatting</code> rule set which can be easily added to the Gradle configuration:</p> <div class="language-gradle codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-gradle codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">dependencies {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:1.23.5")</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><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></span></button></div></div></div></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.23.5/intro.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--next" href="/docs/1.23.5/introduction/configurations"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">detekt Configuration File</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="#features" class="table-of-contents__link toc-highlight">Features</a></li><li><a href="#quick-start-with-gradle" class="table-of-contents__link toc-highlight">Quick Start with Gradle</a></li><li><a href="#adding-more-rule-sets" class="table-of-contents__link toc-highlight">Adding more rule sets</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>