CINXE.COM
<!doctype html> <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-1.23.8 docs-doc-page docs-doc-id-rules/naming" data-has-hydrated="false"> <head> <meta charset="UTF-8"> <meta name="generator" content="Docusaurus v3.7.0"> <title data-rh="true">Naming Rule Set | 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/rules/naming"><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.8"><meta data-rh="true" name="docusaurus_tag" content="docs-default-1.23.8"><meta data-rh="true" name="docsearch:version" content="1.23.8"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-1.23.8"><meta data-rh="true" property="og:title" content="Naming Rule Set | detekt"><meta data-rh="true" name="description" content="The naming ruleset contains rules which assert the naming of different parts of the codebase."><meta data-rh="true" property="og:description" content="The naming ruleset contains rules which assert the naming of different parts of the codebase."><meta data-rh="true" name="keywords" content="rules,naming"><link data-rh="true" rel="icon" href="/img/favicon.svg"><link data-rh="true" rel="canonical" href="https://detekt.dev/docs/rules/naming"><link data-rh="true" rel="alternate" href="https://detekt.dev/docs/rules/naming" hreflang="en"><link data-rh="true" rel="alternate" href="https://detekt.dev/docs/rules/naming" 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/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/rules/naming">1.23.8</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/next/rules/naming">Next</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/docs/rules/naming">1.23.8</a></li><li><a class="dropdown__link" href="/docs/1.23.7/rules/naming">1.23.7</a></li><li><a class="dropdown__link" href="/docs/1.23.6/rules/naming">1.23.6</a></li><li><a class="dropdown__link" href="/docs/1.23.5/rules/naming">1.23.5</a></li><li><a class="dropdown__link" href="/docs/1.23.4/rules/naming">1.23.4</a></li><li><a class="dropdown__link" href="/docs/1.23.3/rules/naming">1.23.3</a></li><li><a class="dropdown__link" href="/docs/1.23.1/rules/naming">1.23.1</a></li><li><a class="dropdown__link" href="/docs/1.23.0/rules/naming">1.23.0</a></li><li><a class="dropdown__link" href="/docs/1.22.0/rules/naming">1.22.0</a></li><li><a class="dropdown__link" href="/docs/1.21.0/rules/naming">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" href="/docs/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/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/gettingstarted/cli">Getting Started</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/rules/comments">Rules Documentation</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/rules/comments">Comments Rule Set</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/rules/complexity">Complexity Rule Set</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/rules/coroutines">Coroutines Rule Set</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/rules/empty-blocks">Empty-blocks Rule Set</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/rules/exceptions">Exceptions Rule Set</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/rules/formatting">Formatting Rule Set</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/rules/libraries">Libraries Rule Set</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/rules/naming">Naming Rule Set</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/rules/performance">Performance Rule Set</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/rules/potential-bugs">Potential-bugs Rule Set</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/rules/ruleauthors">Ruleauthors Rule Set</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/rules/style">Style Rule Set</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="/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="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"><span class="breadcrumbs__link">Rules Documentation</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Naming Rule Set</span><meta itemprop="position" content="2"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: 1.23.8</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>Naming Rule Set</h1></header><p>The naming ruleset contains rules which assert the naming of different parts of the codebase.</p> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="booleanpropertynaming">BooleanPropertyNaming<a href="#booleanpropertynaming" class="hash-link" aria-label="Direct link to BooleanPropertyNaming" title="Direct link to BooleanPropertyNaming"></a></h3> <p>Reports when a boolean property doesn't match a pattern</p> <p><strong>Active by default</strong>: No</p> <p><strong>Requires Type Resolution</strong></p> <p><strong>Debt</strong>: 5min</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-options">Configuration options:<a href="#configuration-options" class="hash-link" aria-label="Direct link to Configuration options:" title="Direct link to Configuration options:"></a></h4> <ul> <li> <p><code>allowedPattern</code> (default: <code>'^(is|has|are)'</code>)</p> <p>naming pattern</p> </li> <li> <p><del><code>ignoreOverridden</code></del> (default: <code>true</code>)</p> <p><strong>Deprecated</strong>: This configuration is ignored and will be removed in the future</p> <p>ignores properties that have the override modifier</p> </li> </ul> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="noncompliant-code">Noncompliant Code:<a href="#noncompliant-code" class="hash-link" aria-label="Direct link to Noncompliant Code:" title="Direct link to Noncompliant Code:"></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"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> progressBar</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Boolean </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</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> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="compliant-code">Compliant Code:<a href="#compliant-code" class="hash-link" aria-label="Direct link to Compliant Code:" title="Direct link to Compliant Code:"></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"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> hasProgressBar</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Boolean </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</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> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="classnaming">ClassNaming<a href="#classnaming" class="hash-link" aria-label="Direct link to ClassNaming" title="Direct link to ClassNaming"></a></h3> <p>Reports class or object names that do not follow the specified naming convention.</p> <p><strong>Active by default</strong>: Yes - Since v1.0.0</p> <p><strong>Debt</strong>: 5min</p> <p><strong>Aliases</strong>: ClassName</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-options-1">Configuration options:<a href="#configuration-options-1" class="hash-link" aria-label="Direct link to Configuration options:" title="Direct link to Configuration options:"></a></h4> <ul> <li> <p><code>classPattern</code> (default: <code>'[A-Z][a-zA-Z0-9]*'</code>)</p> <p>naming pattern</p> </li> </ul> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="constructorparameternaming">ConstructorParameterNaming<a href="#constructorparameternaming" class="hash-link" aria-label="Direct link to ConstructorParameterNaming" title="Direct link to ConstructorParameterNaming"></a></h3> <p>Reports constructor parameter names that do not follow the specified naming convention.</p> <p><strong>Active by default</strong>: Yes - Since v1.0.0</p> <p><strong>Debt</strong>: 5min</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-options-2">Configuration options:<a href="#configuration-options-2" class="hash-link" aria-label="Direct link to Configuration options:" title="Direct link to Configuration options:"></a></h4> <ul> <li> <p><code>parameterPattern</code> (default: <code>'[a-z][A-Za-z0-9]*'</code>)</p> <p>naming pattern</p> </li> <li> <p><code>privateParameterPattern</code> (default: <code>'[a-z][A-Za-z0-9]*'</code>)</p> <p>naming pattern</p> </li> <li> <p><code>excludeClassPattern</code> (default: <code>'$^'</code>)</p> <p>ignores variables in classes which match this regex</p> </li> <li> <p><del><code>ignoreOverridden</code></del> (default: <code>true</code>)</p> <p><strong>Deprecated</strong>: This configuration is ignored and will be removed in the future</p> <p>ignores constructor properties that have the override modifier</p> </li> </ul> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="enumnaming">EnumNaming<a href="#enumnaming" class="hash-link" aria-label="Direct link to EnumNaming" title="Direct link to EnumNaming"></a></h3> <p>Reports enum names that do not follow the specified naming convention.</p> <p><strong>Active by default</strong>: Yes - Since v1.0.0</p> <p><strong>Debt</strong>: 5min</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-options-3">Configuration options:<a href="#configuration-options-3" class="hash-link" aria-label="Direct link to Configuration options:" title="Direct link to Configuration options:"></a></h4> <ul> <li> <p><code>enumEntryPattern</code> (default: <code>'[A-Z][_a-zA-Z0-9]*'</code>)</p> <p>naming pattern</p> </li> </ul> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="forbiddenclassname">ForbiddenClassName<a href="#forbiddenclassname" class="hash-link" aria-label="Direct link to ForbiddenClassName" title="Direct link to ForbiddenClassName"></a></h3> <p>Reports class names which are forbidden per configuration. By default, this rule does not report any classes. Examples for forbidden names might be too generic class names like <code>...Manager</code>.</p> <p><strong>Active by default</strong>: No</p> <p><strong>Debt</strong>: 5min</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-options-4">Configuration options:<a href="#configuration-options-4" class="hash-link" aria-label="Direct link to Configuration options:" title="Direct link to Configuration options:"></a></h4> <ul> <li> <p><code>forbiddenName</code> (default: <code>[]</code>)</p> <p>forbidden class names</p> </li> </ul> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="functionmaxlength">FunctionMaxLength<a href="#functionmaxlength" class="hash-link" aria-label="Direct link to FunctionMaxLength" title="Direct link to FunctionMaxLength"></a></h3> <p>Reports when very long function names are used.</p> <p><strong>Active by default</strong>: No</p> <p><strong>Debt</strong>: 5min</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-options-5">Configuration options:<a href="#configuration-options-5" class="hash-link" aria-label="Direct link to Configuration options:" title="Direct link to Configuration options:"></a></h4> <ul> <li> <p><code>maximumFunctionNameLength</code> (default: <code>30</code>)</p> <p>maximum name length</p> </li> </ul> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="functionminlength">FunctionMinLength<a href="#functionminlength" class="hash-link" aria-label="Direct link to FunctionMinLength" title="Direct link to FunctionMinLength"></a></h3> <p>Reports when very short function names are used.</p> <p><strong>Active by default</strong>: No</p> <p><strong>Debt</strong>: 5min</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-options-6">Configuration options:<a href="#configuration-options-6" class="hash-link" aria-label="Direct link to Configuration options:" title="Direct link to Configuration options:"></a></h4> <ul> <li> <p><code>minimumFunctionNameLength</code> (default: <code>3</code>)</p> <p>minimum name length</p> </li> </ul> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="functionnaming">FunctionNaming<a href="#functionnaming" class="hash-link" aria-label="Direct link to FunctionNaming" title="Direct link to FunctionNaming"></a></h3> <p>Reports function names that do not follow the specified naming convention. One exception are factory functions used to create instances of classes. These factory functions can have the same name as the class being created.</p> <p><strong>Active by default</strong>: Yes - Since v1.0.0</p> <p><strong>Debt</strong>: 5min</p> <p><strong>Aliases</strong>: FunctionName</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-options-7">Configuration options:<a href="#configuration-options-7" class="hash-link" aria-label="Direct link to Configuration options:" title="Direct link to Configuration options:"></a></h4> <ul> <li> <p><code>functionPattern</code> (default: <code>'[a-z][a-zA-Z0-9]*'</code>)</p> <p>naming pattern</p> </li> <li> <p><code>excludeClassPattern</code> (default: <code>'$^'</code>)</p> <p>ignores functions in classes which match this regex</p> </li> <li> <p><del><code>ignoreOverridden</code></del> (default: <code>true</code>)</p> <p><strong>Deprecated</strong>: This configuration is ignored and will be removed in the future</p> <p>ignores functions that have the override modifier</p> </li> </ul> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="functionparameternaming">FunctionParameterNaming<a href="#functionparameternaming" class="hash-link" aria-label="Direct link to FunctionParameterNaming" title="Direct link to FunctionParameterNaming"></a></h3> <p>Reports function parameter names that do not follow the specified naming convention.</p> <p><strong>Active by default</strong>: Yes - Since v1.0.0</p> <p><strong>Debt</strong>: 5min</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-options-8">Configuration options:<a href="#configuration-options-8" class="hash-link" aria-label="Direct link to Configuration options:" title="Direct link to Configuration options:"></a></h4> <ul> <li> <p><code>parameterPattern</code> (default: <code>'[a-z][A-Za-z0-9]*'</code>)</p> <p>naming pattern</p> </li> <li> <p><code>excludeClassPattern</code> (default: <code>'$^'</code>)</p> <p>ignores variables in classes which match this regex</p> </li> <li> <p><del><code>ignoreOverriddenFunctions</code></del> (default: <code>true</code>)</p> <p><strong>Deprecated</strong>: Use <code>ignoreOverridden</code> instead</p> <p>ignores overridden functions with parameters not matching the pattern</p> </li> <li> <p><del><code>ignoreOverridden</code></del> (default: <code>true</code>)</p> <p><strong>Deprecated</strong>: This configuration is ignored and will be removed in the future</p> <p>ignores overridden functions with parameters not matching the pattern</p> </li> </ul> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="invalidpackagedeclaration">InvalidPackageDeclaration<a href="#invalidpackagedeclaration" class="hash-link" aria-label="Direct link to InvalidPackageDeclaration" title="Direct link to InvalidPackageDeclaration"></a></h3> <p>Reports when the file location does not match the declared package.</p> <p><strong>Active by default</strong>: Yes - Since v1.21.0</p> <p><strong>Debt</strong>: 5min</p> <p><strong>Aliases</strong>: PackageDirectoryMismatch</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-options-9">Configuration options:<a href="#configuration-options-9" class="hash-link" aria-label="Direct link to Configuration options:" title="Direct link to Configuration options:"></a></h4> <ul> <li> <p><code>rootPackage</code> (default: <code>''</code>)</p> <p>if specified this part of the package structure is ignored</p> </li> <li> <p><code>requireRootInDeclaration</code> (default: <code>false</code>)</p> <p>requires the declaration to start with the specified rootPackage</p> </li> </ul> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="lambdaparameternaming">LambdaParameterNaming<a href="#lambdaparameternaming" class="hash-link" aria-label="Direct link to LambdaParameterNaming" title="Direct link to LambdaParameterNaming"></a></h3> <p>Reports lambda parameter names that do not follow the specified naming convention.</p> <p><strong>Active by default</strong>: No</p> <p><strong>Debt</strong>: 5min</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-options-10">Configuration options:<a href="#configuration-options-10" class="hash-link" aria-label="Direct link to Configuration options:" title="Direct link to Configuration options:"></a></h4> <ul> <li> <p><code>parameterPattern</code> (default: <code>'[a-z][A-Za-z0-9]*|_'</code>)</p> <p>naming pattern</p> </li> </ul> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="matchingdeclarationname">MatchingDeclarationName<a href="#matchingdeclarationname" class="hash-link" aria-label="Direct link to MatchingDeclarationName" title="Direct link to MatchingDeclarationName"></a></h3> <p>"If a Kotlin file contains a single non-private class (potentially with related top-level declarations), its name should be the same as the name of the class, with the .kt extension appended. If a file contains multiple classes, or only top-level declarations, choose a name describing what the file contains, and name the file accordingly. Use camel humps with an uppercase first letter (e.g. ProcessDeclarations.kt).</p> <p>The name of the file should describe what the code in the file does. Therefore, you should avoid using meaningless words such as "Util" in file names." - Official Kotlin Style Guide</p> <p>More information at: <a href="https://kotlinlang.org/docs/coding-conventions.html" target="_blank" rel="noopener noreferrer">https://kotlinlang.org/docs/coding-conventions.html</a></p> <p><strong>Active by default</strong>: Yes - Since v1.0.0</p> <p><strong>Debt</strong>: 5min</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-options-11">Configuration options:<a href="#configuration-options-11" class="hash-link" aria-label="Direct link to Configuration options:" title="Direct link to Configuration options:"></a></h4> <ul> <li> <p><code>mustBeFirst</code> (default: <code>true</code>)</p> <p>name should only be checked if the file starts with a class or object</p> </li> <li> <p><code>multiplatformTargets</code> (default: <code>['ios', 'android', 'js', 'jvm', 'native', 'iosArm64', 'iosX64', 'macosX64', 'mingwX64', 'linuxX64']</code>)</p> <p>kotlin multiplatform targets, used to allow file names like <code>MyClass.jvm.kt</code></p> </li> </ul> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="noncompliant-code-1">Noncompliant Code:<a href="#noncompliant-code-1" class="hash-link" aria-label="Direct link to Noncompliant Code:" title="Direct link to Noncompliant Code:"></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"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Foo </span><span class="token comment" style="color:#999988;font-style:italic">// FooUtils.kt</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"></span><span class="token keyword" style="color:#00009f">fun</span><span class="token plain"> Bar</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">toFoo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" 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 keyword" style="color:#00009f">fun</span><span class="token plain"> Foo</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">toBar</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Bar </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">..</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> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="compliant-code-1">Compliant Code:<a href="#compliant-code-1" class="hash-link" aria-label="Direct link to Compliant Code:" title="Direct link to Compliant Code:"></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"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Foo </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// Foo.kt</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token keyword" style="color:#00009f">fun</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">stuff</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">42</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"></span><span class="token keyword" style="color:#00009f">fun</span><span class="token plain"> Bar</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">toFoo</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Foo </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">..</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> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="membernameequalsclassname">MemberNameEqualsClassName<a href="#membernameequalsclassname" class="hash-link" aria-label="Direct link to MemberNameEqualsClassName" title="Direct link to MemberNameEqualsClassName"></a></h3> <p>This rule reports a member that has the same as the containing class or object. This might result in confusion. The member should either be renamed or changed to a constructor. Factory functions that create an instance of the class are exempt from this rule.</p> <p><strong>Active by default</strong>: Yes - Since v1.2.0</p> <p><strong>Debt</strong>: 5min</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-options-12">Configuration options:<a href="#configuration-options-12" class="hash-link" aria-label="Direct link to Configuration options:" title="Direct link to Configuration options:"></a></h4> <ul> <li> <p><del><code>ignoreOverriddenFunction</code></del> (default: <code>true</code>)</p> <p><strong>Deprecated</strong>: Use <code>ignoreOverridden</code> instead</p> <p>if overridden functions and properties should be ignored</p> </li> <li> <p><code>ignoreOverridden</code> (default: <code>true</code>)</p> <p>if overridden functions and properties should be ignored</p> </li> </ul> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="noncompliant-code-2">Noncompliant Code:<a href="#noncompliant-code-2" class="hash-link" aria-label="Direct link to Noncompliant Code:" title="Direct link to Noncompliant Code:"></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"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> MethodNameEqualsClassName </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"> </span><span class="token keyword" style="color:#00009f">fun</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">methodNameEqualsClassName</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</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"></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"></span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> PropertyNameEqualsClassName </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"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> propertyEqualsClassName </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0</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> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="compliant-code-2">Compliant Code:<a href="#compliant-code-2" class="hash-link" aria-label="Direct link to Compliant Code:" title="Direct link to Compliant Code:"></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"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> Manager </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"> </span><span class="token keyword" style="color:#00009f">companion</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">object</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"> </span><span class="token comment" style="color:#999988;font-style:italic">// factory functions can have the same name as the class</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token keyword" style="color:#00009f">fun</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">manager</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Manager </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 keyword" style="color:#00009f">return</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">Manager</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><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> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="nonameshadowing">NoNameShadowing<a href="#nonameshadowing" class="hash-link" aria-label="Direct link to NoNameShadowing" title="Direct link to NoNameShadowing"></a></h3> <p>Disallows shadowing variable declarations. Shadowing makes it impossible to access a variable with the same name in the scope.</p> <p><strong>Active by default</strong>: Yes - Since v1.21.0</p> <p><strong>Requires Type Resolution</strong></p> <p><strong>Debt</strong>: 5min</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="noncompliant-code-3">Noncompliant Code:<a href="#noncompliant-code-3" class="hash-link" aria-label="Direct link to Noncompliant Code:" title="Direct link to Noncompliant Code:"></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"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">fun</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">test</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">i</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Int</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> j</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Int</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> k</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Int</span><span class="token punctuation" style="color:#393A34">)</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"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> i </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">j</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">to</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2</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">listOf</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">map</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> k </span><span class="token operator" style="color:#393A34">-></span><span class="token plain"> </span><span class="token function" style="color:#d73a49">println</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">k</span><span class="token punctuation" style="color:#393A34">)</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"> </span><span class="token function" style="color:#d73a49">listOf</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">forEach</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"> </span><span class="token function" style="color:#d73a49">listOf</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">forEach</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"> </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> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="compliant-code-3">Compliant Code:<a href="#compliant-code-3" class="hash-link" aria-label="Direct link to Compliant Code:" title="Direct link to Compliant Code:"></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"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">fun</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">test</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">i</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Int</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> j</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Int</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> k</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Int</span><span class="token punctuation" style="color:#393A34">)</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"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> x </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">y</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> _</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">to</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2</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">listOf</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">map</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> z </span><span class="token operator" style="color:#393A34">-></span><span class="token plain"> </span><span class="token function" style="color:#d73a49">println</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">z</span><span class="token punctuation" style="color:#393A34">)</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"> </span><span class="token function" style="color:#d73a49">listOf</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">forEach</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"> </span><span class="token function" style="color:#d73a49">listOf</span><span class="token punctuation" style="color:#393A34">(</span><span class="token number" style="color:#36acaa">2</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">forEach</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> x </span><span class="token operator" 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><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> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="nonbooleanpropertyprefixedwithis">NonBooleanPropertyPrefixedWithIs<a href="#nonbooleanpropertyprefixedwithis" class="hash-link" aria-label="Direct link to NonBooleanPropertyPrefixedWithIs" title="Direct link to NonBooleanPropertyPrefixedWithIs"></a></h3> <p>Reports when property with 'is' prefix doesn't have a boolean type. Please check the <a href="https://docs.oracle.com/javase/specs/jls/se8/html/jls-8.html#jls-8.3.2" target="_blank" rel="noopener noreferrer">chapter 8.3.2 at Java Language Specification</a></p> <p><strong>Active by default</strong>: No</p> <p><strong>Requires Type Resolution</strong></p> <p><strong>Debt</strong>: 5min</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="noncompliant-code-4">Noncompliant Code:<a href="#noncompliant-code-4" class="hash-link" aria-label="Direct link to Noncompliant Code:" title="Direct link to Noncompliant Code:"></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"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> isEnabled</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Int </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">500</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> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="compliant-code-4">Compliant Code:<a href="#compliant-code-4" class="hash-link" aria-label="Direct link to Compliant Code:" title="Direct link to Compliant Code:"></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"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">val</span><span class="token plain"> isEnabled</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Boolean </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">false</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> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="objectpropertynaming">ObjectPropertyNaming<a href="#objectpropertynaming" class="hash-link" aria-label="Direct link to ObjectPropertyNaming" title="Direct link to ObjectPropertyNaming"></a></h3> <p>Reports property names inside objects that do not follow the specified naming convention.</p> <p><strong>Active by default</strong>: Yes - Since v1.0.0</p> <p><strong>Debt</strong>: 5min</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-options-13">Configuration options:<a href="#configuration-options-13" class="hash-link" aria-label="Direct link to Configuration options:" title="Direct link to Configuration options:"></a></h4> <ul> <li> <p><code>constantPattern</code> (default: <code>'[A-Za-z][_A-Za-z0-9]*'</code>)</p> <p>naming pattern</p> </li> <li> <p><code>propertyPattern</code> (default: <code>'[A-Za-z][_A-Za-z0-9]*'</code>)</p> <p>naming pattern</p> </li> <li> <p><code>privatePropertyPattern</code> (default: <code>'(_)?[A-Za-z][_A-Za-z0-9]*'</code>)</p> <p>naming pattern</p> </li> </ul> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="packagenaming">PackageNaming<a href="#packagenaming" class="hash-link" aria-label="Direct link to PackageNaming" title="Direct link to PackageNaming"></a></h3> <p>Reports package names that do not follow the specified naming convention.</p> <p><strong>Active by default</strong>: Yes - Since v1.0.0</p> <p><strong>Debt</strong>: 5min</p> <p><strong>Aliases</strong>: PackageName, PackageDirectoryMismatch</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-options-14">Configuration options:<a href="#configuration-options-14" class="hash-link" aria-label="Direct link to Configuration options:" title="Direct link to Configuration options:"></a></h4> <ul> <li> <p><code>packagePattern</code> (default: <code>'[a-z]+(\.[a-z][A-Za-z0-9]*)*'</code>)</p> <p>naming pattern</p> </li> </ul> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="toplevelpropertynaming">TopLevelPropertyNaming<a href="#toplevelpropertynaming" class="hash-link" aria-label="Direct link to TopLevelPropertyNaming" title="Direct link to TopLevelPropertyNaming"></a></h3> <p>Reports top level constant that which do not follow the specified naming convention.</p> <p><strong>Active by default</strong>: Yes - Since v1.0.0</p> <p><strong>Debt</strong>: 5min</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-options-15">Configuration options:<a href="#configuration-options-15" class="hash-link" aria-label="Direct link to Configuration options:" title="Direct link to Configuration options:"></a></h4> <ul> <li> <p><code>constantPattern</code> (default: <code>'[A-Z][_A-Z0-9]*'</code>)</p> <p>naming pattern</p> </li> <li> <p><code>propertyPattern</code> (default: <code>'[A-Za-z][_A-Za-z0-9]*'</code>)</p> <p>naming pattern</p> </li> <li> <p><code>privatePropertyPattern</code> (default: <code>'_?[A-Za-z][_A-Za-z0-9]*'</code>)</p> <p>naming pattern</p> </li> </ul> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="variablemaxlength">VariableMaxLength<a href="#variablemaxlength" class="hash-link" aria-label="Direct link to VariableMaxLength" title="Direct link to VariableMaxLength"></a></h3> <p>Reports when very long variable names are used.</p> <p><strong>Active by default</strong>: No</p> <p><strong>Debt</strong>: 5min</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-options-16">Configuration options:<a href="#configuration-options-16" class="hash-link" aria-label="Direct link to Configuration options:" title="Direct link to Configuration options:"></a></h4> <ul> <li> <p><code>maximumVariableNameLength</code> (default: <code>64</code>)</p> <p>maximum name length</p> </li> </ul> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="variableminlength">VariableMinLength<a href="#variableminlength" class="hash-link" aria-label="Direct link to VariableMinLength" title="Direct link to VariableMinLength"></a></h3> <p>Reports when very short variable names are used.</p> <p><strong>Active by default</strong>: No</p> <p><strong>Debt</strong>: 5min</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-options-17">Configuration options:<a href="#configuration-options-17" class="hash-link" aria-label="Direct link to Configuration options:" title="Direct link to Configuration options:"></a></h4> <ul> <li> <p><code>minimumVariableNameLength</code> (default: <code>1</code>)</p> <p>minimum name length</p> </li> </ul> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="variablenaming">VariableNaming<a href="#variablenaming" class="hash-link" aria-label="Direct link to VariableNaming" title="Direct link to VariableNaming"></a></h3> <p>Reports variable names that do not follow the specified naming convention.</p> <p><strong>Active by default</strong>: Yes - Since v1.0.0</p> <p><strong>Debt</strong>: 5min</p> <h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuration-options-18">Configuration options:<a href="#configuration-options-18" class="hash-link" aria-label="Direct link to Configuration options:" title="Direct link to Configuration options:"></a></h4> <ul> <li> <p><code>variablePattern</code> (default: <code>'[a-z][A-Za-z0-9]*'</code>)</p> <p>naming pattern</p> </li> <li> <p><code>privateVariablePattern</code> (default: <code>'(_)?[a-z][A-Za-z0-9]*'</code>)</p> <p>naming pattern</p> </li> <li> <p><code>excludeClassPattern</code> (default: <code>'$^'</code>)</p> <p>ignores variables in classes which match this regex</p> </li> <li> <p><del><code>ignoreOverridden</code></del> (default: <code>true</code>)</p> <p><strong>Deprecated</strong>: This configuration is ignored and will be removed in the future</p> <p>ignores member properties that have the override modifier</p> </li> </ul></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.8/rules/naming.md" 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/rules/libraries"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Libraries Rule Set</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/rules/performance"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Performance Rule Set</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="#booleanpropertynaming" class="table-of-contents__link toc-highlight">BooleanPropertyNaming</a></li><li><a href="#classnaming" class="table-of-contents__link toc-highlight">ClassNaming</a></li><li><a href="#constructorparameternaming" class="table-of-contents__link toc-highlight">ConstructorParameterNaming</a></li><li><a href="#enumnaming" class="table-of-contents__link toc-highlight">EnumNaming</a></li><li><a href="#forbiddenclassname" class="table-of-contents__link toc-highlight">ForbiddenClassName</a></li><li><a href="#functionmaxlength" class="table-of-contents__link toc-highlight">FunctionMaxLength</a></li><li><a href="#functionminlength" class="table-of-contents__link toc-highlight">FunctionMinLength</a></li><li><a href="#functionnaming" class="table-of-contents__link toc-highlight">FunctionNaming</a></li><li><a href="#functionparameternaming" class="table-of-contents__link toc-highlight">FunctionParameterNaming</a></li><li><a href="#invalidpackagedeclaration" class="table-of-contents__link toc-highlight">InvalidPackageDeclaration</a></li><li><a href="#lambdaparameternaming" class="table-of-contents__link toc-highlight">LambdaParameterNaming</a></li><li><a href="#matchingdeclarationname" class="table-of-contents__link toc-highlight">MatchingDeclarationName</a></li><li><a href="#membernameequalsclassname" class="table-of-contents__link toc-highlight">MemberNameEqualsClassName</a></li><li><a href="#nonameshadowing" class="table-of-contents__link toc-highlight">NoNameShadowing</a></li><li><a href="#nonbooleanpropertyprefixedwithis" class="table-of-contents__link toc-highlight">NonBooleanPropertyPrefixedWithIs</a></li><li><a href="#objectpropertynaming" class="table-of-contents__link toc-highlight">ObjectPropertyNaming</a></li><li><a href="#packagenaming" class="table-of-contents__link toc-highlight">PackageNaming</a></li><li><a href="#toplevelpropertynaming" class="table-of-contents__link toc-highlight">TopLevelPropertyNaming</a></li><li><a href="#variablemaxlength" class="table-of-contents__link toc-highlight">VariableMaxLength</a></li><li><a href="#variableminlength" class="table-of-contents__link toc-highlight">VariableMinLength</a></li><li><a href="#variablenaming" class="table-of-contents__link toc-highlight">VariableNaming</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>