blob: 5930a541ea8aafc8a2c96f87971047e0b75bd7df [file]
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="canonical" href="https://pinterest.github.io/ktlint/dev-snapshot/rules/standard/">
<link rel="prev" href="../code-styles/">
<link rel="next" href="../experimental/">
<link rel="icon" href="../../assets/images/favicon.ico">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">
<title>Standard rules - Ktlint</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.484c7ddc.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="pink" data-md-color-accent="indigo">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#annotation-formatting" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
<aside class="md-banner md-banner--warning">
<div class="md-banner__inner md-grid md-typeset">
You're viewing the SNAPSHOT version of the documentation. Be sure to use the
<a href="../../../dev-snapshot/install/snapshot-build">
<strong>SNAPSHOT version of ktlint</strong>
</a>
, or go to the latest
<a href="../../..">
<strong>RELEASE version of the documentation</strong>
</a>
</div>
<script>var el=document.querySelector("[data-md-component=outdated]"),base=new URL("../.."),outdated=__md_get("__outdated",sessionStorage,base);!0===outdated&&el&&(el.hidden=!1)</script>
</aside>
</div>
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="Ktlint" class="md-header__button md-logo" aria-label="Ktlint" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Ktlint
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Standard rules
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="pink" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="pink" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
</a>
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/pinterest/ktlint" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33s1.71.11 2.5.33c1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2"/></svg>
</div>
<div class="md-source__repository">
pinterest/ktlint
</div>
</a>
</div>
</nav>
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="../../install/setup/" class="md-tabs__link">
Installation
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="../code-styles/" class="md-tabs__link">
Rules
</a>
</li>
<li class="md-tabs__item">
<a href="../../api/overview/" class="md-tabs__link">
API
</a>
</li>
<li class="md-tabs__item">
<a href="../../faq/" class="md-tabs__link">
FAQ
</a>
</li>
<li class="md-tabs__item">
<a href="../../contributing/overview/" class="md-tabs__link">
Contributing
</a>
</li>
</ul>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="Ktlint" class="md-nav__button md-logo" aria-label="Ktlint" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
Ktlint
</label>
<div class="md-nav__source">
<a href="https://github.com/pinterest/ktlint" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33s1.71.11 2.5.33c1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2"/></svg>
</div>
<div class="md-source__repository">
pinterest/ktlint
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
<label class="md-nav__link" for="__nav_1" id="__nav_1_label" tabindex="0">
<span class="md-ellipsis">
Home
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_1">
<span class="md-nav__icon md-icon"></span>
Home
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
<span class="md-ellipsis">
Features
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../quick-start/" class="md-nav__link">
<span class="md-ellipsis">
Quick start
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Installation
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Installation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../install/setup/" class="md-nav__link">
<span class="md-ellipsis">
Recommended setup
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../install/cli/" class="md-nav__link">
<span class="md-ellipsis">
Command line
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../install/integrations/" class="md-nav__link">
<span class="md-ellipsis">
Integrations
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../install/snapshot-build/" class="md-nav__link">
<span class="md-ellipsis">
Snapshot build
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-ellipsis">
Rules
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Rules
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../code-styles/" class="md-nav__link">
<span class="md-ellipsis">
Code styles
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Standard rules
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Standard rules
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#annotation-formatting" class="md-nav__link">
<span class="md-ellipsis">
Annotation formatting
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#blank-line-between-when-conditions" class="md-nav__link">
<span class="md-ellipsis">
Blank line between when-conditions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#binary-expression-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Binary expression wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#blank-line-before-declarations" class="md-nav__link">
<span class="md-ellipsis">
Blank line before declarations
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#block-comment-initial-star-alignment" class="md-nav__link">
<span class="md-ellipsis">
Block comment initial star alignment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#chain-method-continuation" class="md-nav__link">
<span class="md-ellipsis">
Chain method continuation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#class-signature" class="md-nav__link">
<span class="md-ellipsis">
Class signature
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#enum-entry" class="md-nav__link">
<span class="md-ellipsis">
Enum entry
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#file-name" class="md-nav__link">
<span class="md-ellipsis">
File name
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#final-newline" class="md-nav__link">
<span class="md-ellipsis">
Final newline
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#function-expression-body" class="md-nav__link">
<span class="md-ellipsis">
Function expression body
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#function-literal" class="md-nav__link">
<span class="md-ellipsis">
Function literal
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#function-signature" class="md-nav__link">
<span class="md-ellipsis">
Function signature
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#function-type-modifier-spacing" class="md-nav__link">
<span class="md-ellipsis">
Function type modifier spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#if-else-bracing" class="md-nav__link">
<span class="md-ellipsis">
If else bracing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#import-ordering" class="md-nav__link">
<span class="md-ellipsis">
Import ordering
</span>
</a>
<nav class="md-nav" aria-label="Import ordering">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#ij_kotlin_packages_to_use_import_on_demand" class="md-nav__link">
<span class="md-ellipsis">
ij_kotlin_packages_to_use_import_on_demand
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#indentation" class="md-nav__link">
<span class="md-ellipsis">
Indentation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#kdoc" class="md-nav__link">
<span class="md-ellipsis">
KDoc
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#mixed-condition-operators" class="md-nav__link">
<span class="md-ellipsis">
Mixed condition operators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#naming" class="md-nav__link">
<span class="md-ellipsis">
Naming
</span>
</a>
<nav class="md-nav" aria-label="Naming">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#backing-property-naming" class="md-nav__link">
<span class="md-ellipsis">
Backing property naming
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#class-naming" class="md-nav__link">
<span class="md-ellipsis">
Class naming
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#function-naming" class="md-nav__link">
<span class="md-ellipsis">
Function naming
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#package-name" class="md-nav__link">
<span class="md-ellipsis">
Package name
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#property-naming" class="md-nav__link">
<span class="md-ellipsis">
Property naming
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#no-blank-lines-in-list" class="md-nav__link">
<span class="md-ellipsis">
No blank lines in list
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-consecutive-comments" class="md-nav__link">
<span class="md-ellipsis">
No consecutive comments
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-empty-file" class="md-nav__link">
<span class="md-ellipsis">
No empty file
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-empty-first-line-at-start-in-class-body" class="md-nav__link">
<span class="md-ellipsis">
No empty first line at start in class body
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-single-line-block-comment" class="md-nav__link">
<span class="md-ellipsis">
No single line block comment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#ktlint-suppression-rule" class="md-nav__link">
<span class="md-ellipsis">
Ktlint-suppression rule
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#max-line-length" class="md-nav__link">
<span class="md-ellipsis">
Max line length
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#modifier-order" class="md-nav__link">
<span class="md-ellipsis">
Modifier order
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#multiline-if-else" class="md-nav__link">
<span class="md-ellipsis">
Multiline if-else
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#multiline-loop" class="md-nav__link">
<span class="md-ellipsis">
Multiline loop
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-blank-lines-before" class="md-nav__link">
<span class="md-ellipsis">
No blank lines before }
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-blank-lines-in-chained-method-calls" class="md-nav__link">
<span class="md-ellipsis">
No blank lines in chained method calls
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-consecutive-blank-lines" class="md-nav__link">
<span class="md-ellipsis">
No consecutive blank lines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-empty-class-bodies" class="md-nav__link">
<span class="md-ellipsis">
No empty ({}) class bodies
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-leading-empty-lines-in-method-blocks" class="md-nav__link">
<span class="md-ellipsis">
No leading empty lines in method blocks
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-line-break-after-else" class="md-nav__link">
<span class="md-ellipsis">
No line break after else
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-line-break-before-assignment" class="md-nav__link">
<span class="md-ellipsis">
No line break before assignment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-multi-spaces" class="md-nav__link">
<span class="md-ellipsis">
No multi spaces
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-semicolons" class="md-nav__link">
<span class="md-ellipsis">
No semicolons
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-trailing-whitespaces" class="md-nav__link">
<span class="md-ellipsis">
No trailing whitespaces
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-unit-as-return-type" class="md-nav__link">
<span class="md-ellipsis">
No Unit as return type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-unused-imports" class="md-nav__link">
<span class="md-ellipsis">
No unused imports
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-wildcard-imports" class="md-nav__link">
<span class="md-ellipsis">
No wildcard imports
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#spacing" class="md-nav__link">
<span class="md-ellipsis">
Spacing
</span>
</a>
<nav class="md-nav" aria-label="Spacing">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#angle-bracket-spacing" class="md-nav__link">
<span class="md-ellipsis">
Angle bracket spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#annotation-spacing" class="md-nav__link">
<span class="md-ellipsis">
Annotation spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#blank-line-between-declarations-with-annotations" class="md-nav__link">
<span class="md-ellipsis">
Blank line between declarations with annotations
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#blank-line-between-declaration-with-comments" class="md-nav__link">
<span class="md-ellipsis">
Blank line between declaration with comments
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#colon-spacing" class="md-nav__link">
<span class="md-ellipsis">
Colon spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#comma-spacing" class="md-nav__link">
<span class="md-ellipsis">
Comma spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#comment-spacing" class="md-nav__link">
<span class="md-ellipsis">
Comment spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#curly-spacing" class="md-nav__link">
<span class="md-ellipsis">
Curly spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#dot-spacing" class="md-nav__link">
<span class="md-ellipsis">
Dot spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#double-colon-spacing" class="md-nav__link">
<span class="md-ellipsis">
Double colon spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#function-return-type-spacing" class="md-nav__link">
<span class="md-ellipsis">
Function return type spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#function-start-of-body-spacing" class="md-nav__link">
<span class="md-ellipsis">
Function start of body spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#function-type-reference-spacing" class="md-nav__link">
<span class="md-ellipsis">
Function type reference spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#fun-keyword-spacing" class="md-nav__link">
<span class="md-ellipsis">
Fun keyword spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#kdoc-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Kdoc wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#keyword-spacing" class="md-nav__link">
<span class="md-ellipsis">
Keyword spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#modifier-list-spacing" class="md-nav__link">
<span class="md-ellipsis">
Modifier list spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#nullable-type-spacing" class="md-nav__link">
<span class="md-ellipsis">
Nullable type spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#operator-spacing" class="md-nav__link">
<span class="md-ellipsis">
Operator spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#parameter-list-spacing" class="md-nav__link">
<span class="md-ellipsis">
Parameter list spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#parenthesis-spacing" class="md-nav__link">
<span class="md-ellipsis">
Parenthesis spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#range-spacing" class="md-nav__link">
<span class="md-ellipsis">
Range spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#spacing-between-function-name-and-opening-parenthesis" class="md-nav__link">
<span class="md-ellipsis">
Spacing between function name and opening parenthesis
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#square-brackets-spacing" class="md-nav__link">
<span class="md-ellipsis">
Square brackets spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#then-spacing" class="md-nav__link">
<span class="md-ellipsis">
Then spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#try-catch-finally-spacing" class="md-nav__link">
<span class="md-ellipsis">
Try catch finally spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type-argument-list-spacing" class="md-nav__link">
<span class="md-ellipsis">
Type argument list spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type-parameter-list-spacing" class="md-nav__link">
<span class="md-ellipsis">
Type parameter list spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unary-operator-spacing" class="md-nav__link">
<span class="md-ellipsis">
Unary operator spacing
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#string-template" class="md-nav__link">
<span class="md-ellipsis">
String template
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#string-template-indent" class="md-nav__link">
<span class="md-ellipsis">
String template indent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#trailing-comma-on-call-site" class="md-nav__link">
<span class="md-ellipsis">
Trailing comma on call site
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#trailing-comma-on-declaration-site" class="md-nav__link">
<span class="md-ellipsis">
Trailing comma on declaration site
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type-argument-comment" class="md-nav__link">
<span class="md-ellipsis">
Type argument comment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type-parameter-comment" class="md-nav__link">
<span class="md-ellipsis">
Type parameter comment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unnecessary-parenthesis-before-trailing-lambda" class="md-nav__link">
<span class="md-ellipsis">
Unnecessary parenthesis before trailing lambda
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#value-argument-comment" class="md-nav__link">
<span class="md-ellipsis">
Value argument comment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#value-parameter-comment" class="md-nav__link">
<span class="md-ellipsis">
Value parameter comment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#when-entry-bracing" class="md-nav__link">
<span class="md-ellipsis">
When-entry bracing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#wrapping" class="md-nav__link">
<span class="md-ellipsis">
Wrapping
</span>
</a>
<nav class="md-nav" aria-label="Wrapping">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#argument-list-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Argument list wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#chain-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Chain wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#comment-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Comment wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#context-receiver-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Context receiver wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#context-receiver-list-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Context receiver list wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#enum-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Enum wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#if-else-wrapping" class="md-nav__link">
<span class="md-ellipsis">
If else wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#multiline-expression-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Multiline expression wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#parameter-list-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Parameter list wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#parameter-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Parameter wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#property-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Property wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#statement-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Statement wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#wrapping_1" class="md-nav__link">
<span class="md-ellipsis">
Wrapping
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../experimental/" class="md-nav__link">
<span class="md-ellipsis">
Experimental rules
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../dependencies/" class="md-nav__link">
<span class="md-ellipsis">
Dependencies
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../configuration-ktlint/" class="md-nav__link">
<span class="md-ellipsis">
KtLint configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../configuration-intellij-idea/" class="md-nav__link">
<span class="md-ellipsis">
IntelliJ IDEA configuration
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
API
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
API
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../api/overview/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/custom-integration/" class="md-nav__link">
<span class="md-ellipsis">
Custom integration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/custom-rule-set/" class="md-nav__link">
<span class="md-ellipsis">
Custom rule set
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/custom-reporter/" class="md-nav__link">
<span class="md-ellipsis">
Custom reporter
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../api/badge/" class="md-nav__link">
<span class="md-ellipsis">
Badge
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../faq/" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Contributing
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Contributing
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../contributing/overview/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../contributing/guidelines/" class="md-nav__link">
<span class="md-ellipsis">
Guidelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../contributing/code-of-conduct/" class="md-nav__link">
<span class="md-ellipsis">
Code of conduct
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#annotation-formatting" class="md-nav__link">
<span class="md-ellipsis">
Annotation formatting
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#blank-line-between-when-conditions" class="md-nav__link">
<span class="md-ellipsis">
Blank line between when-conditions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#binary-expression-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Binary expression wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#blank-line-before-declarations" class="md-nav__link">
<span class="md-ellipsis">
Blank line before declarations
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#block-comment-initial-star-alignment" class="md-nav__link">
<span class="md-ellipsis">
Block comment initial star alignment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#chain-method-continuation" class="md-nav__link">
<span class="md-ellipsis">
Chain method continuation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#class-signature" class="md-nav__link">
<span class="md-ellipsis">
Class signature
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#enum-entry" class="md-nav__link">
<span class="md-ellipsis">
Enum entry
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#file-name" class="md-nav__link">
<span class="md-ellipsis">
File name
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#final-newline" class="md-nav__link">
<span class="md-ellipsis">
Final newline
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#function-expression-body" class="md-nav__link">
<span class="md-ellipsis">
Function expression body
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#function-literal" class="md-nav__link">
<span class="md-ellipsis">
Function literal
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#function-signature" class="md-nav__link">
<span class="md-ellipsis">
Function signature
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#function-type-modifier-spacing" class="md-nav__link">
<span class="md-ellipsis">
Function type modifier spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#if-else-bracing" class="md-nav__link">
<span class="md-ellipsis">
If else bracing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#import-ordering" class="md-nav__link">
<span class="md-ellipsis">
Import ordering
</span>
</a>
<nav class="md-nav" aria-label="Import ordering">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#ij_kotlin_packages_to_use_import_on_demand" class="md-nav__link">
<span class="md-ellipsis">
ij_kotlin_packages_to_use_import_on_demand
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#indentation" class="md-nav__link">
<span class="md-ellipsis">
Indentation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#kdoc" class="md-nav__link">
<span class="md-ellipsis">
KDoc
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#mixed-condition-operators" class="md-nav__link">
<span class="md-ellipsis">
Mixed condition operators
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#naming" class="md-nav__link">
<span class="md-ellipsis">
Naming
</span>
</a>
<nav class="md-nav" aria-label="Naming">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#backing-property-naming" class="md-nav__link">
<span class="md-ellipsis">
Backing property naming
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#class-naming" class="md-nav__link">
<span class="md-ellipsis">
Class naming
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#function-naming" class="md-nav__link">
<span class="md-ellipsis">
Function naming
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#package-name" class="md-nav__link">
<span class="md-ellipsis">
Package name
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#property-naming" class="md-nav__link">
<span class="md-ellipsis">
Property naming
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#no-blank-lines-in-list" class="md-nav__link">
<span class="md-ellipsis">
No blank lines in list
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-consecutive-comments" class="md-nav__link">
<span class="md-ellipsis">
No consecutive comments
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-empty-file" class="md-nav__link">
<span class="md-ellipsis">
No empty file
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-empty-first-line-at-start-in-class-body" class="md-nav__link">
<span class="md-ellipsis">
No empty first line at start in class body
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-single-line-block-comment" class="md-nav__link">
<span class="md-ellipsis">
No single line block comment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#ktlint-suppression-rule" class="md-nav__link">
<span class="md-ellipsis">
Ktlint-suppression rule
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#max-line-length" class="md-nav__link">
<span class="md-ellipsis">
Max line length
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#modifier-order" class="md-nav__link">
<span class="md-ellipsis">
Modifier order
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#multiline-if-else" class="md-nav__link">
<span class="md-ellipsis">
Multiline if-else
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#multiline-loop" class="md-nav__link">
<span class="md-ellipsis">
Multiline loop
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-blank-lines-before" class="md-nav__link">
<span class="md-ellipsis">
No blank lines before }
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-blank-lines-in-chained-method-calls" class="md-nav__link">
<span class="md-ellipsis">
No blank lines in chained method calls
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-consecutive-blank-lines" class="md-nav__link">
<span class="md-ellipsis">
No consecutive blank lines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-empty-class-bodies" class="md-nav__link">
<span class="md-ellipsis">
No empty ({}) class bodies
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-leading-empty-lines-in-method-blocks" class="md-nav__link">
<span class="md-ellipsis">
No leading empty lines in method blocks
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-line-break-after-else" class="md-nav__link">
<span class="md-ellipsis">
No line break after else
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-line-break-before-assignment" class="md-nav__link">
<span class="md-ellipsis">
No line break before assignment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-multi-spaces" class="md-nav__link">
<span class="md-ellipsis">
No multi spaces
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-semicolons" class="md-nav__link">
<span class="md-ellipsis">
No semicolons
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-trailing-whitespaces" class="md-nav__link">
<span class="md-ellipsis">
No trailing whitespaces
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-unit-as-return-type" class="md-nav__link">
<span class="md-ellipsis">
No Unit as return type
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-unused-imports" class="md-nav__link">
<span class="md-ellipsis">
No unused imports
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#no-wildcard-imports" class="md-nav__link">
<span class="md-ellipsis">
No wildcard imports
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#spacing" class="md-nav__link">
<span class="md-ellipsis">
Spacing
</span>
</a>
<nav class="md-nav" aria-label="Spacing">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#angle-bracket-spacing" class="md-nav__link">
<span class="md-ellipsis">
Angle bracket spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#annotation-spacing" class="md-nav__link">
<span class="md-ellipsis">
Annotation spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#blank-line-between-declarations-with-annotations" class="md-nav__link">
<span class="md-ellipsis">
Blank line between declarations with annotations
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#blank-line-between-declaration-with-comments" class="md-nav__link">
<span class="md-ellipsis">
Blank line between declaration with comments
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#colon-spacing" class="md-nav__link">
<span class="md-ellipsis">
Colon spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#comma-spacing" class="md-nav__link">
<span class="md-ellipsis">
Comma spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#comment-spacing" class="md-nav__link">
<span class="md-ellipsis">
Comment spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#curly-spacing" class="md-nav__link">
<span class="md-ellipsis">
Curly spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#dot-spacing" class="md-nav__link">
<span class="md-ellipsis">
Dot spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#double-colon-spacing" class="md-nav__link">
<span class="md-ellipsis">
Double colon spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#function-return-type-spacing" class="md-nav__link">
<span class="md-ellipsis">
Function return type spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#function-start-of-body-spacing" class="md-nav__link">
<span class="md-ellipsis">
Function start of body spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#function-type-reference-spacing" class="md-nav__link">
<span class="md-ellipsis">
Function type reference spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#fun-keyword-spacing" class="md-nav__link">
<span class="md-ellipsis">
Fun keyword spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#kdoc-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Kdoc wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#keyword-spacing" class="md-nav__link">
<span class="md-ellipsis">
Keyword spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#modifier-list-spacing" class="md-nav__link">
<span class="md-ellipsis">
Modifier list spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#nullable-type-spacing" class="md-nav__link">
<span class="md-ellipsis">
Nullable type spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#operator-spacing" class="md-nav__link">
<span class="md-ellipsis">
Operator spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#parameter-list-spacing" class="md-nav__link">
<span class="md-ellipsis">
Parameter list spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#parenthesis-spacing" class="md-nav__link">
<span class="md-ellipsis">
Parenthesis spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#range-spacing" class="md-nav__link">
<span class="md-ellipsis">
Range spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#spacing-between-function-name-and-opening-parenthesis" class="md-nav__link">
<span class="md-ellipsis">
Spacing between function name and opening parenthesis
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#square-brackets-spacing" class="md-nav__link">
<span class="md-ellipsis">
Square brackets spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#then-spacing" class="md-nav__link">
<span class="md-ellipsis">
Then spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#try-catch-finally-spacing" class="md-nav__link">
<span class="md-ellipsis">
Try catch finally spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type-argument-list-spacing" class="md-nav__link">
<span class="md-ellipsis">
Type argument list spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type-parameter-list-spacing" class="md-nav__link">
<span class="md-ellipsis">
Type parameter list spacing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unary-operator-spacing" class="md-nav__link">
<span class="md-ellipsis">
Unary operator spacing
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#string-template" class="md-nav__link">
<span class="md-ellipsis">
String template
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#string-template-indent" class="md-nav__link">
<span class="md-ellipsis">
String template indent
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#trailing-comma-on-call-site" class="md-nav__link">
<span class="md-ellipsis">
Trailing comma on call site
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#trailing-comma-on-declaration-site" class="md-nav__link">
<span class="md-ellipsis">
Trailing comma on declaration site
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type-argument-comment" class="md-nav__link">
<span class="md-ellipsis">
Type argument comment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type-parameter-comment" class="md-nav__link">
<span class="md-ellipsis">
Type parameter comment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unnecessary-parenthesis-before-trailing-lambda" class="md-nav__link">
<span class="md-ellipsis">
Unnecessary parenthesis before trailing lambda
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#value-argument-comment" class="md-nav__link">
<span class="md-ellipsis">
Value argument comment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#value-parameter-comment" class="md-nav__link">
<span class="md-ellipsis">
Value parameter comment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#when-entry-bracing" class="md-nav__link">
<span class="md-ellipsis">
When-entry bracing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#wrapping" class="md-nav__link">
<span class="md-ellipsis">
Wrapping
</span>
</a>
<nav class="md-nav" aria-label="Wrapping">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#argument-list-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Argument list wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#chain-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Chain wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#comment-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Comment wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#context-receiver-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Context receiver wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#context-receiver-list-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Context receiver list wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#enum-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Enum wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#if-else-wrapping" class="md-nav__link">
<span class="md-ellipsis">
If else wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#multiline-expression-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Multiline expression wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#parameter-list-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Parameter list wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#parameter-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Parameter wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#property-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Property wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#statement-wrapping" class="md-nav__link">
<span class="md-ellipsis">
Statement wrapping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#wrapping_1" class="md-nav__link">
<span class="md-ellipsis">
Wrapping
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1>Standard rules</h1>
<h2 id="annotation-formatting">Annotation formatting<a class="headerlink" href="#annotation-formatting" title="Permanent link">&para;</a></h2>
<p>Multiple annotations should be on a separate line than the annotated declaration. Annotations with parameters should be on separate lines. Annotations should be followed by a space.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_1_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="c1">// A single annotation (without parameters) is allowed on same line as annotated construct</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="nd">@FunctionalInterface</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">FooBar</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span><span class="nd">@JvmField</span><span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nv">foo</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="w"> </span><span class="nd">@Test</span><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">bar</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="p">}</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="c1">// A class or function parameter may have a single annotation with parameter(s) on the same line</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo</span><span class="p">(</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="w"> </span><span class="nd">@Path</span><span class="p">(</span><span class="s">&quot;fooId&quot;</span><span class="p">)</span><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">fooId</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="p">,</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="w"> </span><span class="nd">@NotNull</span><span class="p">(</span><span class="s">&quot;bar&quot;</span><span class="p">)</span><span class="w"> </span><span class="n">bar</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="p">,</span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="p">)</span>
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a>
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a><span class="c1">// Multiple annotations (without parameters) are allowed on the same line</span>
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a><span class="nd">@Foo</span><span class="w"> </span><span class="nd">@Bar</span>
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a><span class="kd">class</span><span class="w"> </span><span class="nc">FooBar</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a><span class="w"> </span><span class="nd">@Foo</span><span class="w"> </span><span class="nd">@Bar</span>
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a><span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nv">foo</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span>
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a>
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a><span class="w"> </span><span class="nd">@Foo</span><span class="w"> </span><span class="nd">@Bar</span>
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">bar</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a><span class="p">}</span>
<a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a>
<a id="__codelineno-0-24" name="__codelineno-0-24" href="#__codelineno-0-24"></a><span class="c1">// An array of annotations (without parameters) is allowed on same line as annotated construct</span>
<a id="__codelineno-0-25" name="__codelineno-0-25" href="#__codelineno-0-25"></a><span class="err">@</span><span class="o">[</span><span class="n">Foo</span><span class="w"> </span><span class="n">Bar</span><span class="o">]</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">FooBar2</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-0-26" name="__codelineno-0-26" href="#__codelineno-0-26"></a><span class="w"> </span><span class="err">@</span><span class="o">[</span><span class="n">Foo</span><span class="w"> </span><span class="n">Bar</span><span class="o">]</span><span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nv">foo</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span>
<a id="__codelineno-0-27" name="__codelineno-0-27" href="#__codelineno-0-27"></a>
<a id="__codelineno-0-28" name="__codelineno-0-28" href="#__codelineno-0-28"></a><span class="w"> </span><span class="err">@</span><span class="o">[</span><span class="n">Foo</span><span class="w"> </span><span class="n">Bar</span><span class="o">]</span><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">bar</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
<a id="__codelineno-0-29" name="__codelineno-0-29" href="#__codelineno-0-29"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="c1">// An annotation with parameter(s) is not allowed on same line as annotated construct</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;Unused&quot;</span><span class="p">)</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">FooBar</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w"> </span><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;Unused&quot;</span><span class="p">)</span><span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nv">foo</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span>
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w"> </span><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;Unused&quot;</span><span class="p">)</span><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">bar</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="p">}</span>
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="c1">// Multiple annotation on same line as annotated construct are not allowed</span>
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="nd">@Foo</span><span class="w"> </span><span class="nd">@Bar</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">FooBar</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="w"> </span><span class="nd">@Foo</span><span class="w"> </span><span class="nd">@Bar</span><span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nv">foo</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span>
<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="w"> </span><span class="nd">@Foo</span><span class="w"> </span><span class="nd">@Bar</span><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">bar</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>ktlint_annotation_handle_annotations_with_parameters_same_as_annotations_without_parameters</code><br/><i>Handle listed annotations identical to annotations without parameters. Value is a comma separated list of names without the <code>@</code> prefix. Use <code>*</code> for all annotations with parameters.</i></td>
<td style="text-align: center;"><code>unset</code></td>
<td style="text-align: center;"><code>unset</code></td>
<td style="text-align: center;"><code>unset</code></td>
</tr>
</tbody>
</table>
<p>Rule id: <code>standard:annotation</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:annotation&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>ktlint_standard_annotation = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>ktlint_standard_annotation = disabled
</code></pre></div></li>
</ol>
<h2 id="blank-line-between-when-conditions">Blank line between when-conditions<a class="headerlink" href="#blank-line-between-when-conditions" title="Permanent link">&para;</a></h2>
<p>Consistently add or remove a blank line between when-conditions in a when-statement. A blank line is only added between when-conditions if the when-statement contains at lease one multiline when-condition. If a when-statement only contains single line when-conditions, then the blank lines between the when-conditions are removed.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Ktlint uses <code>.editorconfig</code> property <code>ij_kotlin_line_break_after_multiline_when_entry</code> but applies it also on single line entries to increase consistency.</p>
</div>
<div class="tabbed-set tabbed-alternate" data-tabs="2:2"><input checked="checked" id="__tabbed_2_1" name="__tabbed_2" type="radio" /><input id="__tabbed_2_2" name="__tabbed_2" type="radio" /><div class="tabbed-labels"><label for="__tabbed_2_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_2_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="p">(</span><span class="n">bar</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="w"> </span><span class="n">BAR1</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="s">&quot;bar1&quot;</span>
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="w"> </span><span class="n">BAR2</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="s">&quot;bar2&quot;</span>
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kc">null</span>
<a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-5-7" name="__codelineno-5-7" href="#__codelineno-5-7"></a>
<a id="__codelineno-5-8" name="__codelineno-5-8" href="#__codelineno-5-8"></a><span class="c1">// ij_kotlin_line_break_after_multiline_when_entry = true</span>
<a id="__codelineno-5-9" name="__codelineno-5-9" href="#__codelineno-5-9"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-5-10" name="__codelineno-5-10" href="#__codelineno-5-10"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="p">(</span><span class="n">bar</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-5-11" name="__codelineno-5-11" href="#__codelineno-5-11"></a><span class="w"> </span><span class="n">BAR1</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="s">&quot;bar1&quot;</span>
<a id="__codelineno-5-12" name="__codelineno-5-12" href="#__codelineno-5-12"></a>
<a id="__codelineno-5-13" name="__codelineno-5-13" href="#__codelineno-5-13"></a><span class="w"> </span><span class="n">BAR2</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-5-14" name="__codelineno-5-14" href="#__codelineno-5-14"></a><span class="w"> </span><span class="s">&quot;bar2&quot;</span>
<a id="__codelineno-5-15" name="__codelineno-5-15" href="#__codelineno-5-15"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-5-16" name="__codelineno-5-16" href="#__codelineno-5-16"></a>
<a id="__codelineno-5-17" name="__codelineno-5-17" href="#__codelineno-5-17"></a><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kc">null</span>
<a id="__codelineno-5-18" name="__codelineno-5-18" href="#__codelineno-5-18"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-5-19" name="__codelineno-5-19" href="#__codelineno-5-19"></a>
<a id="__codelineno-5-20" name="__codelineno-5-20" href="#__codelineno-5-20"></a><span class="c1">// ij_kotlin_line_break_after_multiline_when_entry = true</span>
<a id="__codelineno-5-21" name="__codelineno-5-21" href="#__codelineno-5-21"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo3</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-5-22" name="__codelineno-5-22" href="#__codelineno-5-22"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="p">(</span><span class="n">bar</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-5-23" name="__codelineno-5-23" href="#__codelineno-5-23"></a><span class="w"> </span><span class="n">BAR1</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="s">&quot;bar1&quot;</span>
<a id="__codelineno-5-24" name="__codelineno-5-24" href="#__codelineno-5-24"></a>
<a id="__codelineno-5-25" name="__codelineno-5-25" href="#__codelineno-5-25"></a><span class="w"> </span><span class="c1">// BAR2 comment</span>
<a id="__codelineno-5-26" name="__codelineno-5-26" href="#__codelineno-5-26"></a><span class="w"> </span><span class="n">BAR2</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="s">&quot;bar2&quot;</span>
<a id="__codelineno-5-27" name="__codelineno-5-27" href="#__codelineno-5-27"></a>
<a id="__codelineno-5-28" name="__codelineno-5-28" href="#__codelineno-5-28"></a><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kc">null</span>
<a id="__codelineno-5-29" name="__codelineno-5-29" href="#__codelineno-5-29"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-5-30" name="__codelineno-5-30" href="#__codelineno-5-30"></a>
<a id="__codelineno-5-31" name="__codelineno-5-31" href="#__codelineno-5-31"></a><span class="c1">// ij_kotlin_line_break_after_multiline_when_entry = false</span>
<a id="__codelineno-5-32" name="__codelineno-5-32" href="#__codelineno-5-32"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo4</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-5-33" name="__codelineno-5-33" href="#__codelineno-5-33"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="p">(</span><span class="n">bar</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-5-34" name="__codelineno-5-34" href="#__codelineno-5-34"></a><span class="w"> </span><span class="n">BAR1</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="s">&quot;bar1&quot;</span>
<a id="__codelineno-5-35" name="__codelineno-5-35" href="#__codelineno-5-35"></a><span class="w"> </span><span class="n">BAR2</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-5-36" name="__codelineno-5-36" href="#__codelineno-5-36"></a><span class="w"> </span><span class="s">&quot;bar2&quot;</span>
<a id="__codelineno-5-37" name="__codelineno-5-37" href="#__codelineno-5-37"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-5-38" name="__codelineno-5-38" href="#__codelineno-5-38"></a><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kc">null</span>
<a id="__codelineno-5-39" name="__codelineno-5-39" href="#__codelineno-5-39"></a><span class="w"> </span><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="c1">// ij_kotlin_line_break_after_multiline_when_entry = true | false (no blank lines in simple when-statement)</span>
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="p">(</span><span class="n">bar</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="w"> </span><span class="n">BAR1</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="s">&quot;bar1&quot;</span>
<a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a>
<a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-6"></a><span class="w"> </span><span class="n">BAR2</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="s">&quot;bar2&quot;</span>
<a id="__codelineno-6-7" name="__codelineno-6-7" href="#__codelineno-6-7"></a>
<a id="__codelineno-6-8" name="__codelineno-6-8" href="#__codelineno-6-8"></a><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kc">null</span>
<a id="__codelineno-6-9" name="__codelineno-6-9" href="#__codelineno-6-9"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-6-10" name="__codelineno-6-10" href="#__codelineno-6-10"></a>
<a id="__codelineno-6-11" name="__codelineno-6-11" href="#__codelineno-6-11"></a><span class="c1">// ij_kotlin_line_break_after_multiline_when_entry = true (missing newline after BAR1)</span>
<a id="__codelineno-6-12" name="__codelineno-6-12" href="#__codelineno-6-12"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-6-13" name="__codelineno-6-13" href="#__codelineno-6-13"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="p">(</span><span class="n">bar</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-6-14" name="__codelineno-6-14" href="#__codelineno-6-14"></a><span class="w"> </span><span class="n">BAR1</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="s">&quot;bar1&quot;</span>
<a id="__codelineno-6-15" name="__codelineno-6-15" href="#__codelineno-6-15"></a><span class="w"> </span><span class="n">BAR2</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-6-16" name="__codelineno-6-16" href="#__codelineno-6-16"></a><span class="w"> </span><span class="s">&quot;bar2&quot;</span>
<a id="__codelineno-6-17" name="__codelineno-6-17" href="#__codelineno-6-17"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-6-18" name="__codelineno-6-18" href="#__codelineno-6-18"></a>
<a id="__codelineno-6-19" name="__codelineno-6-19" href="#__codelineno-6-19"></a><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kc">null</span>
<a id="__codelineno-6-20" name="__codelineno-6-20" href="#__codelineno-6-20"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-6-21" name="__codelineno-6-21" href="#__codelineno-6-21"></a>
<a id="__codelineno-6-22" name="__codelineno-6-22" href="#__codelineno-6-22"></a><span class="c1">// ij_kotlin_line_break_after_multiline_when_entry = true (missing newline after BAR1, and BAR2)</span>
<a id="__codelineno-6-23" name="__codelineno-6-23" href="#__codelineno-6-23"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo3</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-6-24" name="__codelineno-6-24" href="#__codelineno-6-24"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="p">(</span><span class="n">bar</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-6-25" name="__codelineno-6-25" href="#__codelineno-6-25"></a><span class="w"> </span><span class="n">BAR1</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="s">&quot;bar1&quot;</span>
<a id="__codelineno-6-26" name="__codelineno-6-26" href="#__codelineno-6-26"></a><span class="w"> </span><span class="c1">// BAR2 comment</span>
<a id="__codelineno-6-27" name="__codelineno-6-27" href="#__codelineno-6-27"></a><span class="w"> </span><span class="n">BAR2</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="s">&quot;bar2&quot;</span>
<a id="__codelineno-6-28" name="__codelineno-6-28" href="#__codelineno-6-28"></a><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kc">null</span>
<a id="__codelineno-6-29" name="__codelineno-6-29" href="#__codelineno-6-29"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-6-30" name="__codelineno-6-30" href="#__codelineno-6-30"></a>
<a id="__codelineno-6-31" name="__codelineno-6-31" href="#__codelineno-6-31"></a><span class="c1">// ij_kotlin_line_break_after_multiline_when_entry = false (unexpected newline after BAR2)</span>
<a id="__codelineno-6-32" name="__codelineno-6-32" href="#__codelineno-6-32"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo4</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-6-33" name="__codelineno-6-33" href="#__codelineno-6-33"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="p">(</span><span class="n">bar</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-6-34" name="__codelineno-6-34" href="#__codelineno-6-34"></a><span class="w"> </span><span class="n">BAR1</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="s">&quot;bar1&quot;</span>
<a id="__codelineno-6-35" name="__codelineno-6-35" href="#__codelineno-6-35"></a><span class="w"> </span><span class="n">BAR2</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-6-36" name="__codelineno-6-36" href="#__codelineno-6-36"></a><span class="w"> </span><span class="s">&quot;bar2&quot;</span>
<a id="__codelineno-6-37" name="__codelineno-6-37" href="#__codelineno-6-37"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-6-38" name="__codelineno-6-38" href="#__codelineno-6-38"></a>
<a id="__codelineno-6-39" name="__codelineno-6-39" href="#__codelineno-6-39"></a><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kc">null</span>
<a id="__codelineno-6-40" name="__codelineno-6-40" href="#__codelineno-6-40"></a><span class="w"> </span><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>ij_kotlin_line_break_after_multiline_when_entry</code><br/><i>Despite its name, forces a blank line between single line and multiline when-entries when at least one multiline when-entry is found in the when-statement.</i></td>
<td style="text-align: center;"><code>true</code></td>
<td style="text-align: center;"><code>true</code></td>
<td style="text-align: center;"><code>true</code></td>
</tr>
</tbody>
</table>
<p>Rule id: <code>standard:blank-line-between-when-conditions</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:blank-line-between-when-conditions&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>ktlint_standard_blank-line-between-when-conditions = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>ktlint_standard_blank-line-between-when-conditions = disabled
</code></pre></div></li>
</ol>
<h2 id="binary-expression-wrapping">Binary expression wrapping<a class="headerlink" href="#binary-expression-wrapping" title="Permanent link">&para;</a></h2>
<p>Wraps binary expression at the operator reference whenever the binary expression does not fit on the line. In case the binary expression is nested, the expression is evaluated from outside to inside. If the left and right hand sides of the binary expression, after wrapping, fit on a single line then the inner binary expressions will not be wrapped. If one or both inner binary expression still do not fit on a single after wrapping of the outer binary expression, then each of those inner binary expressions will be wrapped.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="3:2"><input checked="checked" id="__tabbed_3_1" name="__tabbed_3" type="radio" /><input id="__tabbed_3_2" name="__tabbed_3" type="radio" /><div class="tabbed-labels"><label for="__tabbed_3_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_3_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a><span class="w"> </span><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a><span class="w"> </span><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-10-4" name="__codelineno-10-4" href="#__codelineno-10-4"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">((</span><span class="n">leftHandSideExpression</span><span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="n">rightHandSideExpression</span><span class="p">)</span><span class="w"> </span><span class="o">||</span>
<a id="__codelineno-10-5" name="__codelineno-10-5" href="#__codelineno-10-5"></a><span class="w"> </span><span class="p">(</span>
<a id="__codelineno-10-6" name="__codelineno-10-6" href="#__codelineno-10-6"></a><span class="w"> </span><span class="n">leftHandSideLongExpression</span><span class="w"> </span><span class="o">&amp;&amp;</span>
<a id="__codelineno-10-7" name="__codelineno-10-7" href="#__codelineno-10-7"></a><span class="w"> </span><span class="n">rightHandSideExpression</span>
<a id="__codelineno-10-8" name="__codelineno-10-8" href="#__codelineno-10-8"></a><span class="w"> </span><span class="p">)</span>
<a id="__codelineno-10-9" name="__codelineno-10-9" href="#__codelineno-10-9"></a><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-10-10" name="__codelineno-10-10" href="#__codelineno-10-10"></a><span class="w"> </span><span class="c1">// do something</span>
<a id="__codelineno-10-11" name="__codelineno-10-11" href="#__codelineno-10-11"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-10-12" name="__codelineno-10-12" href="#__codelineno-10-12"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-11-2" name="__codelineno-11-2" href="#__codelineno-11-2"></a><span class="w"> </span><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-11-3" name="__codelineno-11-3" href="#__codelineno-11-3"></a><span class="w"> </span><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-11-4" name="__codelineno-11-4" href="#__codelineno-11-4"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">((</span><span class="n">leftHandSideExpression</span><span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="n">rightHandSideExpression</span><span class="p">)</span><span class="w"> </span><span class="o">||</span>
<a id="__codelineno-11-5" name="__codelineno-11-5" href="#__codelineno-11-5"></a><span class="w"> </span><span class="p">(</span><span class="n">leftHandSideLongExpression</span><span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="n">rightHandSideExpression</span><span class="p">)</span>
<a id="__codelineno-11-6" name="__codelineno-11-6" href="#__codelineno-11-6"></a><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-11-7" name="__codelineno-11-7" href="#__codelineno-11-7"></a><span class="w"> </span><span class="c1">// do something</span>
<a id="__codelineno-11-8" name="__codelineno-11-8" href="#__codelineno-11-8"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-11-9" name="__codelineno-11-9" href="#__codelineno-11-9"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>max_line_length</code><br/><i>Maximum length of a (regular) line. This property is ignored in case the <code>max-line-length</code> rule is disabled, or when using Ktlint via a third party integration that does not provide this rule.</i></td>
<td style="text-align: center;">140</td>
<td style="text-align: center;"><code>off</code></td>
<td style="text-align: center;"><code>100</code></td>
</tr>
</tbody>
</table>
<p>Rule id: <code>standard:binary-expression-wrapping</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:binary-expression-wrapping&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a>ktlint_standard_binary-expression-wrapping = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>ktlint_standard_binary-expression-wrapping = disabled
</code></pre></div></li>
</ol>
<h2 id="blank-line-before-declarations">Blank line before declarations<a class="headerlink" href="#blank-line-before-declarations" title="Permanent link">&para;</a></h2>
<p>Requires a blank line before any class or function declaration. No blank line is required between the class signature and the first declaration in the class. In a similar way, a blank line is required before any list of top level or class properties. No blank line is required before local properties or between consecutive properties.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="4:2"><input checked="checked" id="__tabbed_4_1" name="__tabbed_4" type="radio" /><input id="__tabbed_4_2" name="__tabbed_4" type="radio" /><div class="tabbed-labels"><label for="__tabbed_4_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_4_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a><span class="kd">const</span><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">FOO_1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo1&quot;</span>
<a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a>
<a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a><span class="kd">class</span><span class="w"> </span><span class="nc">FooBar</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo2&quot;</span>
<a id="__codelineno-15-5" name="__codelineno-15-5" href="#__codelineno-15-5"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo3&quot;</span>
<a id="__codelineno-15-6" name="__codelineno-15-6" href="#__codelineno-15-6"></a>
<a id="__codelineno-15-7" name="__codelineno-15-7" href="#__codelineno-15-7"></a><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">bar1</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-15-8" name="__codelineno-15-8" href="#__codelineno-15-8"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo4</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo4&quot;</span>
<a id="__codelineno-15-9" name="__codelineno-15-9" href="#__codelineno-15-9"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo5</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo5&quot;</span>
<a id="__codelineno-15-10" name="__codelineno-15-10" href="#__codelineno-15-10"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-15-11" name="__codelineno-15-11" href="#__codelineno-15-11"></a>
<a id="__codelineno-15-12" name="__codelineno-15-12" href="#__codelineno-15-12"></a><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">bar2</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;bar&quot;</span>
<a id="__codelineno-15-13" name="__codelineno-15-13" href="#__codelineno-15-13"></a>
<a id="__codelineno-15-14" name="__codelineno-15-14" href="#__codelineno-15-14"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo6</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo3&quot;</span>
<a id="__codelineno-15-15" name="__codelineno-15-15" href="#__codelineno-15-15"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo7</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo4&quot;</span>
<a id="__codelineno-15-16" name="__codelineno-15-16" href="#__codelineno-15-16"></a>
<a id="__codelineno-15-17" name="__codelineno-15-17" href="#__codelineno-15-17"></a><span class="w"> </span><span class="kd">enum</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">Foo</span>
<a id="__codelineno-15-18" name="__codelineno-15-18" href="#__codelineno-15-18"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a><span class="kd">const</span><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">FOO_1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo1&quot;</span>
<a id="__codelineno-16-2" name="__codelineno-16-2" href="#__codelineno-16-2"></a>
<a id="__codelineno-16-3" name="__codelineno-16-3" href="#__codelineno-16-3"></a><span class="kd">class</span><span class="w"> </span><span class="nc">FooBar</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-16-4" name="__codelineno-16-4" href="#__codelineno-16-4"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo2&quot;</span>
<a id="__codelineno-16-5" name="__codelineno-16-5" href="#__codelineno-16-5"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo3&quot;</span>
<a id="__codelineno-16-6" name="__codelineno-16-6" href="#__codelineno-16-6"></a><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">bar1</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-16-7" name="__codelineno-16-7" href="#__codelineno-16-7"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo4</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo4&quot;</span>
<a id="__codelineno-16-8" name="__codelineno-16-8" href="#__codelineno-16-8"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo5</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo5&quot;</span>
<a id="__codelineno-16-9" name="__codelineno-16-9" href="#__codelineno-16-9"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-16-10" name="__codelineno-16-10" href="#__codelineno-16-10"></a><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">bar2</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;bar&quot;</span>
<a id="__codelineno-16-11" name="__codelineno-16-11" href="#__codelineno-16-11"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo6</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo3&quot;</span>
<a id="__codelineno-16-12" name="__codelineno-16-12" href="#__codelineno-16-12"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo7</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo4&quot;</span>
<a id="__codelineno-16-13" name="__codelineno-16-13" href="#__codelineno-16-13"></a><span class="w"> </span><span class="kd">enum</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">Foo</span>
<a id="__codelineno-16-14" name="__codelineno-16-14" href="#__codelineno-16-14"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:blank-line-before-declaration</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:blank-line-before-declaration&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a>ktlint_standard_blank-line-before-declaration = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a>ktlint_standard_blank-line-before-declaration = disabled
</code></pre></div></li>
</ol>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This rule is only run when <code>ktlint_code_style</code> is set to <code>ktlint_official</code> or when the rule is enabled explicitly.</p>
</div>
<h2 id="block-comment-initial-star-alignment">Block comment initial star alignment<a class="headerlink" href="#block-comment-initial-star-alignment" title="Permanent link">&para;</a></h2>
<p>Lines in a block comment which (excluding the indentation) start with a <code>*</code> should have this <code>*</code> aligned with the <code>*</code> in the opening of the block comment.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="5:2"><input checked="checked" id="__tabbed_5_1" name="__tabbed_5" type="radio" /><input id="__tabbed_5_2" name="__tabbed_5" type="radio" /><div class="tabbed-labels"><label for="__tabbed_5_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_5_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a><span class="cm">/*</span>
<a id="__codelineno-20-2" name="__codelineno-20-2" href="#__codelineno-20-2"></a><span class="cm"> * This comment is formatted well.</span>
<a id="__codelineno-20-3" name="__codelineno-20-3" href="#__codelineno-20-3"></a><span class="cm"> */</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a><span class="cm">/*</span>
<a id="__codelineno-21-2" name="__codelineno-21-2" href="#__codelineno-21-2"></a><span class="cm"> * This comment is not formatted well.</span>
<a id="__codelineno-21-3" name="__codelineno-21-3" href="#__codelineno-21-3"></a><span class="cm"> */</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:block-comment-initial-star-alignment</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-22-1" name="__codelineno-22-1" href="#__codelineno-22-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:block-comment-initial-star-alignment&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-23-1" name="__codelineno-23-1" href="#__codelineno-23-1"></a>ktlint_standard_block-comment-initial-star-alignment = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-24-1" name="__codelineno-24-1" href="#__codelineno-24-1"></a>ktlint_standard_block-comment-initial-star-alignment = disabled
</code></pre></div></li>
</ol>
<h2 id="chain-method-continuation">Chain method continuation<a class="headerlink" href="#chain-method-continuation" title="Permanent link">&para;</a></h2>
<p>In a multiline method chain, the chain operators (<code>.</code> or <code>?.</code>) have to be aligned with each other.</p>
<p>Multiple chained methods on a single line are allowed as long as the maximum line length, and the maximum number of chain operators are not exceeded. Under certain conditions, it is allowed that the expression before the first and/or the expression after the last chain operator is a multiline expression.</p>
<p>The <code>.</code> in <code>java.class</code> is ignored when wrapping on chain operators.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>A binary expression for which the left and/or right operand consist of a method chain are currently being ignored by this rule. Please reach out, if you can help to determine what the best strategy is to deal with such kind of expressions.</p>
</div>
<div class="tabbed-set tabbed-alternate" data-tabs="6:2"><input checked="checked" id="__tabbed_6_1" name="__tabbed_6" type="radio" /><input id="__tabbed_6_2" name="__tabbed_6" type="radio" /><div class="tabbed-labels"><label for="__tabbed_6_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_6_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-25-1" name="__codelineno-25-1" href="#__codelineno-25-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-25-2" name="__codelineno-25-2" href="#__codelineno-25-2"></a><span class="w"> </span><span class="n">listOf</span><span class="p">(</span><span class="m">1</span><span class="p">,</span><span class="w"> </span><span class="m">2</span><span class="p">,</span><span class="w"> </span><span class="m">3</span><span class="p">)</span>
<a id="__codelineno-25-3" name="__codelineno-25-3" href="#__codelineno-25-3"></a><span class="w"> </span><span class="p">.</span><span class="na">filter</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nb">it</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="p">}</span><span class="o">!!</span>
<a id="__codelineno-25-4" name="__codelineno-25-4" href="#__codelineno-25-4"></a><span class="w"> </span><span class="p">.</span><span class="na">takeIf</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nb">it</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-25-5" name="__codelineno-25-5" href="#__codelineno-25-5"></a><span class="w"> </span><span class="p">.</span><span class="na">map</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-25-6" name="__codelineno-25-6" href="#__codelineno-25-6"></a><span class="w"> </span><span class="nb">it</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="nb">it</span>
<a id="__codelineno-25-7" name="__codelineno-25-7" href="#__codelineno-25-7"></a><span class="w"> </span><span class="p">}</span><span class="o">?.</span><span class="na">map</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-25-8" name="__codelineno-25-8" href="#__codelineno-25-8"></a><span class="w"> </span><span class="nb">it</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="nb">it</span>
<a id="__codelineno-25-9" name="__codelineno-25-9" href="#__codelineno-25-9"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-25-10" name="__codelineno-25-10" href="#__codelineno-25-10"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-25-11" name="__codelineno-25-11" href="#__codelineno-25-11"></a><span class="w"> </span><span class="n">listOf</span><span class="p">(</span><span class="m">1</span><span class="p">,</span><span class="w"> </span><span class="m">2</span><span class="p">,</span><span class="w"> </span><span class="m">3</span><span class="p">)</span>
<a id="__codelineno-25-12" name="__codelineno-25-12" href="#__codelineno-25-12"></a><span class="w"> </span><span class="p">.</span><span class="na">filter</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-25-13" name="__codelineno-25-13" href="#__codelineno-25-13"></a><span class="w"> </span><span class="nb">it</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="m">2</span>
<a id="__codelineno-25-14" name="__codelineno-25-14" href="#__codelineno-25-14"></a><span class="w"> </span><span class="p">}.</span><span class="na">map</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-25-15" name="__codelineno-25-15" href="#__codelineno-25-15"></a><span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="nb">it</span>
<a id="__codelineno-25-16" name="__codelineno-25-16" href="#__codelineno-25-16"></a><span class="w"> </span><span class="p">}</span><span class="o">?.</span><span class="na">map</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-25-17" name="__codelineno-25-17" href="#__codelineno-25-17"></a><span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="nb">it</span>
<a id="__codelineno-25-18" name="__codelineno-25-18" href="#__codelineno-25-18"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-25-19" name="__codelineno-25-19" href="#__codelineno-25-19"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo3</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-25-20" name="__codelineno-25-20" href="#__codelineno-25-20"></a><span class="w"> </span><span class="n">foo</span><span class="p">().</span><span class="na">bar</span><span class="p">().</span><span class="na">map</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-25-21" name="__codelineno-25-21" href="#__codelineno-25-21"></a><span class="w"> </span><span class="nb">it</span><span class="p">.</span><span class="na">foobar</span><span class="p">()</span>
<a id="__codelineno-25-22" name="__codelineno-25-22" href="#__codelineno-25-22"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-25-23" name="__codelineno-25-23" href="#__codelineno-25-23"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo4</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-25-24" name="__codelineno-25-24" href="#__codelineno-25-24"></a><span class="w"> </span><span class="s">&quot;&quot;&quot;</span>
<a id="__codelineno-25-25" name="__codelineno-25-25" href="#__codelineno-25-25"></a><span class="s"> Some text</span>
<a id="__codelineno-25-26" name="__codelineno-25-26" href="#__codelineno-25-26"></a><span class="s"> &quot;&quot;&quot;</span><span class="p">.</span><span class="na">trimIndent</span><span class="p">().</span><span class="na">foo</span><span class="p">().</span><span class="na">bar</span><span class="p">()</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-26-1" name="__codelineno-26-1" href="#__codelineno-26-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-26-2" name="__codelineno-26-2" href="#__codelineno-26-2"></a><span class="w"> </span><span class="n">listOf</span><span class="p">(</span><span class="m">1</span><span class="p">,</span><span class="w"> </span><span class="m">2</span><span class="p">,</span><span class="w"> </span><span class="m">3</span><span class="p">).</span>
<a id="__codelineno-26-3" name="__codelineno-26-3" href="#__codelineno-26-3"></a><span class="w"> </span><span class="n">filter</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nb">it</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="p">}</span><span class="o">!!</span><span class="p">.</span>
<a id="__codelineno-26-4" name="__codelineno-26-4" href="#__codelineno-26-4"></a><span class="w"> </span><span class="n">takeIf</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nb">it</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="p">}.</span>
<a id="__codelineno-26-5" name="__codelineno-26-5" href="#__codelineno-26-5"></a><span class="w"> </span><span class="n">map</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-26-6" name="__codelineno-26-6" href="#__codelineno-26-6"></a><span class="w"> </span><span class="nb">it</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="nb">it</span>
<a id="__codelineno-26-7" name="__codelineno-26-7" href="#__codelineno-26-7"></a><span class="w"> </span><span class="p">}</span><span class="o">?.</span>
<a id="__codelineno-26-8" name="__codelineno-26-8" href="#__codelineno-26-8"></a><span class="w"> </span><span class="n">map</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-26-9" name="__codelineno-26-9" href="#__codelineno-26-9"></a><span class="w"> </span><span class="nb">it</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="nb">it</span>
<a id="__codelineno-26-10" name="__codelineno-26-10" href="#__codelineno-26-10"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-26-11" name="__codelineno-26-11" href="#__codelineno-26-11"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-26-12" name="__codelineno-26-12" href="#__codelineno-26-12"></a><span class="w"> </span><span class="n">listOf</span><span class="p">(</span><span class="m">1</span><span class="p">,</span><span class="w"> </span><span class="m">2</span><span class="p">,</span><span class="w"> </span><span class="m">3</span><span class="p">)</span>
<a id="__codelineno-26-13" name="__codelineno-26-13" href="#__codelineno-26-13"></a><span class="w"> </span><span class="p">.</span><span class="na">filter</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-26-14" name="__codelineno-26-14" href="#__codelineno-26-14"></a><span class="w"> </span><span class="nb">it</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="m">2</span>
<a id="__codelineno-26-15" name="__codelineno-26-15" href="#__codelineno-26-15"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-26-16" name="__codelineno-26-16" href="#__codelineno-26-16"></a><span class="w"> </span><span class="p">.</span><span class="na">map</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-26-17" name="__codelineno-26-17" href="#__codelineno-26-17"></a><span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="nb">it</span>
<a id="__codelineno-26-18" name="__codelineno-26-18" href="#__codelineno-26-18"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-26-19" name="__codelineno-26-19" href="#__codelineno-26-19"></a><span class="w"> </span><span class="o">?.</span><span class="na">map</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-26-20" name="__codelineno-26-20" href="#__codelineno-26-20"></a><span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="nb">it</span>
<a id="__codelineno-26-21" name="__codelineno-26-21" href="#__codelineno-26-21"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-26-22" name="__codelineno-26-22" href="#__codelineno-26-22"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>
<a id="__codelineno-26-23" name="__codelineno-26-23" href="#__codelineno-26-23"></a><span class="w"> </span><span class="n">foo</span><span class="p">()</span>
<a id="__codelineno-26-24" name="__codelineno-26-24" href="#__codelineno-26-24"></a><span class="w"> </span><span class="p">.</span><span class="na">bar</span><span class="p">().</span><span class="na">map</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-26-25" name="__codelineno-26-25" href="#__codelineno-26-25"></a><span class="w"> </span><span class="nb">it</span><span class="p">.</span><span class="na">foobar</span><span class="p">()</span>
<a id="__codelineno-26-26" name="__codelineno-26-26" href="#__codelineno-26-26"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-26-27" name="__codelineno-26-27" href="#__codelineno-26-27"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo4</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-26-28" name="__codelineno-26-28" href="#__codelineno-26-28"></a><span class="w"> </span><span class="s">&quot;&quot;&quot;</span>
<a id="__codelineno-26-29" name="__codelineno-26-29" href="#__codelineno-26-29"></a><span class="s"> Some text</span>
<a id="__codelineno-26-30" name="__codelineno-26-30" href="#__codelineno-26-30"></a><span class="s"> &quot;&quot;&quot;</span><span class="p">.</span><span class="na">trimIndent</span><span class="p">().</span><span class="na">foo</span><span class="p">()</span>
<a id="__codelineno-26-31" name="__codelineno-26-31" href="#__codelineno-26-31"></a><span class="w"> </span><span class="p">.</span><span class="na">bar</span><span class="p">()</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>ktlint_chain_method_rule_force_multiline_when_chain_operator_count_greater_or_equal_than</code><br/><i>Force wrapping of chained methods in case an expression contains at least the specified number of chain operators. If a chained method contains nested expressions, the chain operators of the inner expression are not taken into account. Use value <code>unset</code> (default) to disable this setting.</i></td>
<td style="text-align: center;">4</td>
<td style="text-align: center;">4</td>
<td style="text-align: center;">4</td>
</tr>
<tr>
<td style="text-align: left;"><code>max_line_length</code><br/><i>Maximum length of a (regular) line. This property is ignored in case the <code>max-line-length</code> rule is disabled, or when using Ktlint via a third party integration that does not provide this rule.</i></td>
<td style="text-align: center;">140</td>
<td style="text-align: center;"><code>off</code></td>
<td style="text-align: center;"><code>100</code></td>
</tr>
</tbody>
</table>
<p>Rule id: <code>standard:chain-method-continuation</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-27-1" name="__codelineno-27-1" href="#__codelineno-27-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:chain-method-continuation&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-28-1" name="__codelineno-28-1" href="#__codelineno-28-1"></a>ktlint_standard_chain-method-continuation = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-29-1" name="__codelineno-29-1" href="#__codelineno-29-1"></a>ktlint_standard_chain-method-continuation = disabled
</code></pre></div></li>
</ol>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This rule is only run when <code>ktlint_code_style</code> is set to <code>ktlint_official</code> or when the rule is enabled explicitly.</p>
</div>
<h2 id="class-signature">Class signature<a class="headerlink" href="#class-signature" title="Permanent link">&para;</a></h2>
<p>Rewrites the class signature to a consistent format respecting the <code>.editorconfig</code> property <code>max_line_length</code> if set. In the <code>ktlint_official</code> code style all class parameters are wrapped by default. Set <code>.editorconfig</code> property <code>ktlint_class_signature_rule_force_multiline_when_parameter_count_greater_or_equal_than</code> to a value greater than 1 to allow classes with a few parameters to be placed on a single line.
The other code styles allow an infinite amount of parameters on the same line (as long as the <code>max_line_length</code> is not exceeded) unless <code>.editorconfig</code> property <code>ktlint_class_signature_rule_force_multiline_when_parameter_count_greater_or_equal_than</code> is set explicitly.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="7:4"><input checked="checked" id="__tabbed_7_1" name="__tabbed_7" type="radio" /><input id="__tabbed_7_2" name="__tabbed_7" type="radio" /><input id="__tabbed_7_3" name="__tabbed_7" type="radio" /><input id="__tabbed_7_4" name="__tabbed_7" type="radio" /><div class="tabbed-labels"><label for="__tabbed_7_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint (ktlint_official)</label><label for="__tabbed_7_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed (ktlint_official)</label><label for="__tabbed_7_3"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint (non ktlint_official)</label><label for="__tabbed_7_4"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed (non ktlint_official)</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-30-1" name="__codelineno-30-1" href="#__codelineno-30-1"></a><span class="c1">// Assume that max_line_length is not exceeded when written as single line</span>
<a id="__codelineno-30-2" name="__codelineno-30-2" href="#__codelineno-30-2"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo0</span>
<a id="__codelineno-30-3" name="__codelineno-30-3" href="#__codelineno-30-3"></a>
<a id="__codelineno-30-4" name="__codelineno-30-4" href="#__codelineno-30-4"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo1</span><span class="p">(</span>
<a id="__codelineno-30-5" name="__codelineno-30-5" href="#__codelineno-30-5"></a><span class="w"> </span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-30-6" name="__codelineno-30-6" href="#__codelineno-30-6"></a><span class="p">)</span>
<a id="__codelineno-30-7" name="__codelineno-30-7" href="#__codelineno-30-7"></a>
<a id="__codelineno-30-8" name="__codelineno-30-8" href="#__codelineno-30-8"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo2</span><span class="p">(</span>
<a id="__codelineno-30-9" name="__codelineno-30-9" href="#__codelineno-30-9"></a><span class="w"> </span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-30-10" name="__codelineno-30-10" href="#__codelineno-30-10"></a><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-30-11" name="__codelineno-30-11" href="#__codelineno-30-11"></a><span class="p">)</span>
<a id="__codelineno-30-12" name="__codelineno-30-12" href="#__codelineno-30-12"></a>
<a id="__codelineno-30-13" name="__codelineno-30-13" href="#__codelineno-30-13"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo3</span><span class="p">(</span>
<a id="__codelineno-30-14" name="__codelineno-30-14" href="#__codelineno-30-14"></a><span class="w"> </span><span class="nd">@Foo</span><span class="w"> </span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-30-15" name="__codelineno-30-15" href="#__codelineno-30-15"></a><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-30-16" name="__codelineno-30-16" href="#__codelineno-30-16"></a><span class="w"> </span><span class="n">c</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-30-17" name="__codelineno-30-17" href="#__codelineno-30-17"></a><span class="p">)</span>
<a id="__codelineno-30-18" name="__codelineno-30-18" href="#__codelineno-30-18"></a>
<a id="__codelineno-30-19" name="__codelineno-30-19" href="#__codelineno-30-19"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo4</span><span class="p">(</span>
<a id="__codelineno-30-20" name="__codelineno-30-20" href="#__codelineno-30-20"></a><span class="w"> </span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-30-21" name="__codelineno-30-21" href="#__codelineno-30-21"></a><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-30-22" name="__codelineno-30-22" href="#__codelineno-30-22"></a><span class="w"> </span><span class="n">c</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-30-23" name="__codelineno-30-23" href="#__codelineno-30-23"></a><span class="p">)</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">FooBar</span><span class="p">(</span><span class="n">a</span><span class="p">,</span><span class="w"> </span><span class="n">c</span><span class="p">)</span>
<a id="__codelineno-30-24" name="__codelineno-30-24" href="#__codelineno-30-24"></a>
<a id="__codelineno-30-25" name="__codelineno-30-25" href="#__codelineno-30-25"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo5</span><span class="w"> </span><span class="p">:</span>
<a id="__codelineno-30-26" name="__codelineno-30-26" href="#__codelineno-30-26"></a><span class="w"> </span><span class="n">FooBar</span><span class="p">(</span>
<a id="__codelineno-30-27" name="__codelineno-30-27" href="#__codelineno-30-27"></a><span class="w"> </span><span class="s">&quot;bar1&quot;</span><span class="p">,</span>
<a id="__codelineno-30-28" name="__codelineno-30-28" href="#__codelineno-30-28"></a><span class="w"> </span><span class="s">&quot;bar2&quot;</span><span class="p">,</span>
<a id="__codelineno-30-29" name="__codelineno-30-29" href="#__codelineno-30-29"></a><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-30-30" name="__codelineno-30-30" href="#__codelineno-30-30"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-30-31" name="__codelineno-30-31" href="#__codelineno-30-31"></a><span class="p">}</span>
<a id="__codelineno-30-32" name="__codelineno-30-32" href="#__codelineno-30-32"></a>
<a id="__codelineno-30-33" name="__codelineno-30-33" href="#__codelineno-30-33"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo6</span><span class="p">(</span>
<a id="__codelineno-30-34" name="__codelineno-30-34" href="#__codelineno-30-34"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">bar1</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-30-35" name="__codelineno-30-35" href="#__codelineno-30-35"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">bar2</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-30-36" name="__codelineno-30-36" href="#__codelineno-30-36"></a><span class="p">)</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">FooBar</span><span class="p">(</span>
<a id="__codelineno-30-37" name="__codelineno-30-37" href="#__codelineno-30-37"></a><span class="w"> </span><span class="n">bar1</span><span class="p">,</span>
<a id="__codelineno-30-38" name="__codelineno-30-38" href="#__codelineno-30-38"></a><span class="w"> </span><span class="n">bar2</span><span class="p">,</span>
<a id="__codelineno-30-39" name="__codelineno-30-39" href="#__codelineno-30-39"></a><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-30-40" name="__codelineno-30-40" href="#__codelineno-30-40"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-30-41" name="__codelineno-30-41" href="#__codelineno-30-41"></a><span class="p">}</span>
<a id="__codelineno-30-42" name="__codelineno-30-42" href="#__codelineno-30-42"></a>
<a id="__codelineno-30-43" name="__codelineno-30-43" href="#__codelineno-30-43"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo7</span><span class="p">(</span>
<a id="__codelineno-30-44" name="__codelineno-30-44" href="#__codelineno-30-44"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">bar1</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-30-45" name="__codelineno-30-45" href="#__codelineno-30-45"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">bar2</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-30-46" name="__codelineno-30-46" href="#__codelineno-30-46"></a><span class="p">)</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">FooBar</span><span class="p">(</span>
<a id="__codelineno-30-47" name="__codelineno-30-47" href="#__codelineno-30-47"></a><span class="w"> </span><span class="n">bar1</span><span class="p">,</span>
<a id="__codelineno-30-48" name="__codelineno-30-48" href="#__codelineno-30-48"></a><span class="w"> </span><span class="n">bar2</span><span class="p">,</span>
<a id="__codelineno-30-49" name="__codelineno-30-49" href="#__codelineno-30-49"></a><span class="w"> </span><span class="p">),</span>
<a id="__codelineno-30-50" name="__codelineno-30-50" href="#__codelineno-30-50"></a><span class="w"> </span><span class="n">BarFoo1</span><span class="p">,</span>
<a id="__codelineno-30-51" name="__codelineno-30-51" href="#__codelineno-30-51"></a><span class="w"> </span><span class="n">BarFoo2</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-30-52" name="__codelineno-30-52" href="#__codelineno-30-52"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-30-53" name="__codelineno-30-53" href="#__codelineno-30-53"></a><span class="p">}</span>
<a id="__codelineno-30-54" name="__codelineno-30-54" href="#__codelineno-30-54"></a>
<a id="__codelineno-30-55" name="__codelineno-30-55" href="#__codelineno-30-55"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo8</span>
<a id="__codelineno-30-56" name="__codelineno-30-56" href="#__codelineno-30-56"></a><span class="w"> </span><span class="k">constructor</span><span class="p">(</span>
<a id="__codelineno-30-57" name="__codelineno-30-57" href="#__codelineno-30-57"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">bar1</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-30-58" name="__codelineno-30-58" href="#__codelineno-30-58"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">bar2</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-30-59" name="__codelineno-30-59" href="#__codelineno-30-59"></a><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">FooBar</span><span class="p">(</span><span class="n">bar1</span><span class="p">,</span><span class="w"> </span><span class="n">bar2</span><span class="p">),</span>
<a id="__codelineno-30-60" name="__codelineno-30-60" href="#__codelineno-30-60"></a><span class="w"> </span><span class="n">BarFoo1</span><span class="p">,</span>
<a id="__codelineno-30-61" name="__codelineno-30-61" href="#__codelineno-30-61"></a><span class="w"> </span><span class="n">BarFoo2</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-30-62" name="__codelineno-30-62" href="#__codelineno-30-62"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-30-63" name="__codelineno-30-63" href="#__codelineno-30-63"></a><span class="w"> </span><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-31-1" name="__codelineno-31-1" href="#__codelineno-31-1"></a><span class="c1">// Assume that max_line_length is not exceeded when written as single line</span>
<a id="__codelineno-31-2" name="__codelineno-31-2" href="#__codelineno-31-2"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo0</span><span class="p">()</span>
<a id="__codelineno-31-3" name="__codelineno-31-3" href="#__codelineno-31-3"></a>
<a id="__codelineno-31-4" name="__codelineno-31-4" href="#__codelineno-31-4"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo1</span><span class="p">(</span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">)</span>
<a id="__codelineno-31-5" name="__codelineno-31-5" href="#__codelineno-31-5"></a>
<a id="__codelineno-31-6" name="__codelineno-31-6" href="#__codelineno-31-6"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo2</span><span class="p">(</span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">)</span>
<a id="__codelineno-31-7" name="__codelineno-31-7" href="#__codelineno-31-7"></a>
<a id="__codelineno-31-8" name="__codelineno-31-8" href="#__codelineno-31-8"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo3</span><span class="p">(</span><span class="nd">@Foo</span><span class="w"> </span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">c</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">)</span>
<a id="__codelineno-31-9" name="__codelineno-31-9" href="#__codelineno-31-9"></a>
<a id="__codelineno-31-10" name="__codelineno-31-10" href="#__codelineno-31-10"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo4</span><span class="p">(</span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">c</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">)</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">FooBar</span><span class="p">(</span><span class="n">a</span><span class="p">,</span><span class="w"> </span><span class="n">c</span><span class="p">)</span>
<a id="__codelineno-31-11" name="__codelineno-31-11" href="#__codelineno-31-11"></a>
<a id="__codelineno-31-12" name="__codelineno-31-12" href="#__codelineno-31-12"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo5</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">FooBar</span><span class="p">(</span>
<a id="__codelineno-31-13" name="__codelineno-31-13" href="#__codelineno-31-13"></a><span class="w"> </span><span class="s">&quot;bar1&quot;</span><span class="p">,</span>
<a id="__codelineno-31-14" name="__codelineno-31-14" href="#__codelineno-31-14"></a><span class="w"> </span><span class="s">&quot;bar2&quot;</span><span class="p">,</span>
<a id="__codelineno-31-15" name="__codelineno-31-15" href="#__codelineno-31-15"></a><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-31-16" name="__codelineno-31-16" href="#__codelineno-31-16"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-31-17" name="__codelineno-31-17" href="#__codelineno-31-17"></a><span class="p">}</span>
<a id="__codelineno-31-18" name="__codelineno-31-18" href="#__codelineno-31-18"></a>
<a id="__codelineno-31-19" name="__codelineno-31-19" href="#__codelineno-31-19"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo6</span><span class="p">(</span>
<a id="__codelineno-31-20" name="__codelineno-31-20" href="#__codelineno-31-20"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">bar1</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-31-21" name="__codelineno-31-21" href="#__codelineno-31-21"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">bar2</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-31-22" name="__codelineno-31-22" href="#__codelineno-31-22"></a><span class="p">)</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">FooBar</span><span class="p">(</span>
<a id="__codelineno-31-23" name="__codelineno-31-23" href="#__codelineno-31-23"></a><span class="w"> </span><span class="n">bar1</span><span class="p">,</span>
<a id="__codelineno-31-24" name="__codelineno-31-24" href="#__codelineno-31-24"></a><span class="w"> </span><span class="n">bar2</span><span class="p">,</span>
<a id="__codelineno-31-25" name="__codelineno-31-25" href="#__codelineno-31-25"></a><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-31-26" name="__codelineno-31-26" href="#__codelineno-31-26"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-31-27" name="__codelineno-31-27" href="#__codelineno-31-27"></a><span class="p">}</span>
<a id="__codelineno-31-28" name="__codelineno-31-28" href="#__codelineno-31-28"></a>
<a id="__codelineno-31-29" name="__codelineno-31-29" href="#__codelineno-31-29"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo7</span><span class="p">(</span>
<a id="__codelineno-31-30" name="__codelineno-31-30" href="#__codelineno-31-30"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">bar1</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-31-31" name="__codelineno-31-31" href="#__codelineno-31-31"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">bar2</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-31-32" name="__codelineno-31-32" href="#__codelineno-31-32"></a><span class="p">)</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">FooBar</span><span class="p">(</span>
<a id="__codelineno-31-33" name="__codelineno-31-33" href="#__codelineno-31-33"></a><span class="w"> </span><span class="n">bar1</span><span class="p">,</span>
<a id="__codelineno-31-34" name="__codelineno-31-34" href="#__codelineno-31-34"></a><span class="w"> </span><span class="n">bar2</span><span class="p">,</span>
<a id="__codelineno-31-35" name="__codelineno-31-35" href="#__codelineno-31-35"></a><span class="p">),</span>
<a id="__codelineno-31-36" name="__codelineno-31-36" href="#__codelineno-31-36"></a><span class="w"> </span><span class="n">BarFoo1</span><span class="p">,</span>
<a id="__codelineno-31-37" name="__codelineno-31-37" href="#__codelineno-31-37"></a><span class="w"> </span><span class="n">BarFoo2</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-31-38" name="__codelineno-31-38" href="#__codelineno-31-38"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-31-39" name="__codelineno-31-39" href="#__codelineno-31-39"></a><span class="p">}</span>
<a id="__codelineno-31-40" name="__codelineno-31-40" href="#__codelineno-31-40"></a>
<a id="__codelineno-31-41" name="__codelineno-31-41" href="#__codelineno-31-41"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo8</span>
<a id="__codelineno-31-42" name="__codelineno-31-42" href="#__codelineno-31-42"></a><span class="k">constructor</span><span class="p">(</span>
<a id="__codelineno-31-43" name="__codelineno-31-43" href="#__codelineno-31-43"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">bar1</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-31-44" name="__codelineno-31-44" href="#__codelineno-31-44"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">bar2</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-31-45" name="__codelineno-31-45" href="#__codelineno-31-45"></a><span class="p">)</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">FooBar</span><span class="p">(</span><span class="n">bar1</span><span class="p">,</span><span class="w"> </span><span class="n">bar2</span><span class="p">),</span>
<a id="__codelineno-31-46" name="__codelineno-31-46" href="#__codelineno-31-46"></a><span class="w"> </span><span class="n">BarFoo1</span><span class="p">,</span>
<a id="__codelineno-31-47" name="__codelineno-31-47" href="#__codelineno-31-47"></a><span class="w"> </span><span class="n">BarFoo2</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-31-48" name="__codelineno-31-48" href="#__codelineno-31-48"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-31-49" name="__codelineno-31-49" href="#__codelineno-31-49"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-32-1" name="__codelineno-32-1" href="#__codelineno-32-1"></a><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-32-2" name="__codelineno-32-2" href="#__codelineno-32-2"></a><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-32-3" name="__codelineno-32-3" href="#__codelineno-32-3"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo0</span>
<a id="__codelineno-32-4" name="__codelineno-32-4" href="#__codelineno-32-4"></a>
<a id="__codelineno-32-5" name="__codelineno-32-5" href="#__codelineno-32-5"></a><span class="c1">// Entire class signature does not fit on single line</span>
<a id="__codelineno-32-6" name="__codelineno-32-6" href="#__codelineno-32-6"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo1</span><span class="p">(</span>
<a id="__codelineno-32-7" name="__codelineno-32-7" href="#__codelineno-32-7"></a><span class="w"> </span><span class="n">aVeryLonggggggggggggggggggggggg</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span>
<a id="__codelineno-32-8" name="__codelineno-32-8" href="#__codelineno-32-8"></a><span class="p">)</span>
<a id="__codelineno-32-9" name="__codelineno-32-9" href="#__codelineno-32-9"></a>
<a id="__codelineno-32-10" name="__codelineno-32-10" href="#__codelineno-32-10"></a><span class="c1">// Entire class signature does fit on single line</span>
<a id="__codelineno-32-11" name="__codelineno-32-11" href="#__codelineno-32-11"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo2</span><span class="p">(</span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">)</span>
<a id="__codelineno-32-12" name="__codelineno-32-12" href="#__codelineno-32-12"></a>
<a id="__codelineno-32-13" name="__codelineno-32-13" href="#__codelineno-32-13"></a><span class="c1">// Entire class signature does not fit on single line</span>
<a id="__codelineno-32-14" name="__codelineno-32-14" href="#__codelineno-32-14"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo3</span><span class="p">(</span>
<a id="__codelineno-32-15" name="__codelineno-32-15" href="#__codelineno-32-15"></a><span class="w"> </span><span class="n">aVeryLonggggggggggggggg</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-32-16" name="__codelineno-32-16" href="#__codelineno-32-16"></a><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span>
<a id="__codelineno-32-17" name="__codelineno-32-17" href="#__codelineno-32-17"></a><span class="p">)</span>
<a id="__codelineno-32-18" name="__codelineno-32-18" href="#__codelineno-32-18"></a>
<a id="__codelineno-32-19" name="__codelineno-32-19" href="#__codelineno-32-19"></a><span class="c1">// Entire class signature does fit on single line</span>
<a id="__codelineno-32-20" name="__codelineno-32-20" href="#__codelineno-32-20"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo4</span><span class="p">(</span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">)</span>
<a id="__codelineno-32-21" name="__codelineno-32-21" href="#__codelineno-32-21"></a>
<a id="__codelineno-32-22" name="__codelineno-32-22" href="#__codelineno-32-22"></a><span class="c1">// Entire class signature does fit on single line</span>
<a id="__codelineno-32-23" name="__codelineno-32-23" href="#__codelineno-32-23"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo5</span><span class="p">(</span><span class="nd">@Foo</span><span class="w"> </span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">c</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">)</span>
<a id="__codelineno-32-24" name="__codelineno-32-24" href="#__codelineno-32-24"></a>
<a id="__codelineno-32-25" name="__codelineno-32-25" href="#__codelineno-32-25"></a><span class="c1">// Entire class signature does fit on single line</span>
<a id="__codelineno-32-26" name="__codelineno-32-26" href="#__codelineno-32-26"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo6</span><span class="p">(</span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">c</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">)</span><span class="w"> </span><span class="p">:</span>
<a id="__codelineno-32-27" name="__codelineno-32-27" href="#__codelineno-32-27"></a><span class="w"> </span><span class="n">FooBar</span><span class="p">(</span><span class="n">a</span><span class="p">,</span><span class="w"> </span><span class="n">c</span><span class="p">)</span>
<a id="__codelineno-32-28" name="__codelineno-32-28" href="#__codelineno-32-28"></a>
<a id="__codelineno-32-29" name="__codelineno-32-29" href="#__codelineno-32-29"></a><span class="c1">// Entire class signature (without constructor invocation) does fit on single line</span>
<a id="__codelineno-32-30" name="__codelineno-32-30" href="#__codelineno-32-30"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo7</span><span class="w"> </span><span class="p">:</span>
<a id="__codelineno-32-31" name="__codelineno-32-31" href="#__codelineno-32-31"></a><span class="w"> </span><span class="n">FooBar</span><span class="p">(</span>
<a id="__codelineno-32-32" name="__codelineno-32-32" href="#__codelineno-32-32"></a><span class="w"> </span><span class="s">&quot;bar1&quot;</span><span class="p">,</span>
<a id="__codelineno-32-33" name="__codelineno-32-33" href="#__codelineno-32-33"></a><span class="w"> </span><span class="s">&quot;bar2&quot;</span>
<a id="__codelineno-32-34" name="__codelineno-32-34" href="#__codelineno-32-34"></a><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-32-35" name="__codelineno-32-35" href="#__codelineno-32-35"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-32-36" name="__codelineno-32-36" href="#__codelineno-32-36"></a><span class="p">}</span>
<a id="__codelineno-32-37" name="__codelineno-32-37" href="#__codelineno-32-37"></a>
<a id="__codelineno-32-38" name="__codelineno-32-38" href="#__codelineno-32-38"></a><span class="c1">// Entire class signature (without constructor invocation) does fit on single line</span>
<a id="__codelineno-32-39" name="__codelineno-32-39" href="#__codelineno-32-39"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo8</span><span class="p">(</span><span class="kd">val</span><span class="w"> </span><span class="nv">bar1</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="p">,</span><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">bar2</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="p">)</span><span class="w"> </span><span class="p">:</span>
<a id="__codelineno-32-40" name="__codelineno-32-40" href="#__codelineno-32-40"></a><span class="w"> </span><span class="n">FooBar</span><span class="p">(</span>
<a id="__codelineno-32-41" name="__codelineno-32-41" href="#__codelineno-32-41"></a><span class="w"> </span><span class="n">bar1</span><span class="p">,</span>
<a id="__codelineno-32-42" name="__codelineno-32-42" href="#__codelineno-32-42"></a><span class="w"> </span><span class="n">bar2</span>
<a id="__codelineno-32-43" name="__codelineno-32-43" href="#__codelineno-32-43"></a><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-32-44" name="__codelineno-32-44" href="#__codelineno-32-44"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-32-45" name="__codelineno-32-45" href="#__codelineno-32-45"></a><span class="p">}</span>
<a id="__codelineno-32-46" name="__codelineno-32-46" href="#__codelineno-32-46"></a>
<a id="__codelineno-32-47" name="__codelineno-32-47" href="#__codelineno-32-47"></a><span class="c1">// Entire class signature (without constructor invocation) does not fit on single line</span>
<a id="__codelineno-32-48" name="__codelineno-32-48" href="#__codelineno-32-48"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo9</span><span class="p">(</span>
<a id="__codelineno-32-49" name="__codelineno-32-49" href="#__codelineno-32-49"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">aVeryLonggggggggggggggg</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-32-50" name="__codelineno-32-50" href="#__codelineno-32-50"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">bar2</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span>
<a id="__codelineno-32-51" name="__codelineno-32-51" href="#__codelineno-32-51"></a><span class="p">)</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">FooBar</span><span class="p">(</span>
<a id="__codelineno-32-52" name="__codelineno-32-52" href="#__codelineno-32-52"></a><span class="w"> </span><span class="n">bar1</span><span class="p">,</span>
<a id="__codelineno-32-53" name="__codelineno-32-53" href="#__codelineno-32-53"></a><span class="w"> </span><span class="n">bar2</span>
<a id="__codelineno-32-54" name="__codelineno-32-54" href="#__codelineno-32-54"></a><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-32-55" name="__codelineno-32-55" href="#__codelineno-32-55"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-32-56" name="__codelineno-32-56" href="#__codelineno-32-56"></a><span class="p">}</span>
<a id="__codelineno-32-57" name="__codelineno-32-57" href="#__codelineno-32-57"></a>
<a id="__codelineno-32-58" name="__codelineno-32-58" href="#__codelineno-32-58"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo10</span><span class="p">(</span><span class="kd">val</span><span class="w"> </span><span class="nv">bar1</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="p">,</span><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">bar2</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="p">)</span><span class="w"> </span><span class="p">:</span>
<a id="__codelineno-32-59" name="__codelineno-32-59" href="#__codelineno-32-59"></a><span class="w"> </span><span class="n">FooBar</span><span class="p">(</span>
<a id="__codelineno-32-60" name="__codelineno-32-60" href="#__codelineno-32-60"></a><span class="w"> </span><span class="n">bar1</span><span class="p">,</span>
<a id="__codelineno-32-61" name="__codelineno-32-61" href="#__codelineno-32-61"></a><span class="w"> </span><span class="n">bar2</span>
<a id="__codelineno-32-62" name="__codelineno-32-62" href="#__codelineno-32-62"></a><span class="w"> </span><span class="p">),</span>
<a id="__codelineno-32-63" name="__codelineno-32-63" href="#__codelineno-32-63"></a><span class="w"> </span><span class="n">BarFoo1</span><span class="p">,</span>
<a id="__codelineno-32-64" name="__codelineno-32-64" href="#__codelineno-32-64"></a><span class="w"> </span><span class="n">BarFoo2</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-32-65" name="__codelineno-32-65" href="#__codelineno-32-65"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-32-66" name="__codelineno-32-66" href="#__codelineno-32-66"></a><span class="p">}</span>
<a id="__codelineno-32-67" name="__codelineno-32-67" href="#__codelineno-32-67"></a>
<a id="__codelineno-32-68" name="__codelineno-32-68" href="#__codelineno-32-68"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo11</span>
<a id="__codelineno-32-69" name="__codelineno-32-69" href="#__codelineno-32-69"></a><span class="k">constructor</span><span class="p">(</span>
<a id="__codelineno-32-70" name="__codelineno-32-70" href="#__codelineno-32-70"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">bar1</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-32-71" name="__codelineno-32-71" href="#__codelineno-32-71"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">bar2</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span>
<a id="__codelineno-32-72" name="__codelineno-32-72" href="#__codelineno-32-72"></a><span class="p">)</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">FooBar</span><span class="p">(</span><span class="n">bar1</span><span class="p">,</span><span class="w"> </span><span class="n">bar2</span><span class="p">),</span>
<a id="__codelineno-32-73" name="__codelineno-32-73" href="#__codelineno-32-73"></a><span class="w"> </span><span class="n">BarFoo1</span><span class="p">,</span>
<a id="__codelineno-32-74" name="__codelineno-32-74" href="#__codelineno-32-74"></a><span class="w"> </span><span class="n">BarFoo2</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-32-75" name="__codelineno-32-75" href="#__codelineno-32-75"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-32-76" name="__codelineno-32-76" href="#__codelineno-32-76"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-33-1" name="__codelineno-33-1" href="#__codelineno-33-1"></a><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-33-2" name="__codelineno-33-2" href="#__codelineno-33-2"></a><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-33-3" name="__codelineno-33-3" href="#__codelineno-33-3"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo0</span><span class="p">()</span>
<a id="__codelineno-33-4" name="__codelineno-33-4" href="#__codelineno-33-4"></a>
<a id="__codelineno-33-5" name="__codelineno-33-5" href="#__codelineno-33-5"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo6</span><span class="p">(</span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">c</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">)</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">FooBar</span><span class="p">(</span><span class="n">a</span><span class="p">,</span><span class="w"> </span><span class="n">c</span><span class="p">)</span>
<a id="__codelineno-33-6" name="__codelineno-33-6" href="#__codelineno-33-6"></a>
<a id="__codelineno-33-7" name="__codelineno-33-7" href="#__codelineno-33-7"></a><span class="c1">// Entire class signature (without constructor invocation) does fit on single line</span>
<a id="__codelineno-33-8" name="__codelineno-33-8" href="#__codelineno-33-8"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo7</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">FooBar</span><span class="p">(</span>
<a id="__codelineno-33-9" name="__codelineno-33-9" href="#__codelineno-33-9"></a><span class="w"> </span><span class="s">&quot;bar1&quot;</span><span class="p">,</span>
<a id="__codelineno-33-10" name="__codelineno-33-10" href="#__codelineno-33-10"></a><span class="w"> </span><span class="s">&quot;bar2&quot;</span><span class="p">,</span>
<a id="__codelineno-33-11" name="__codelineno-33-11" href="#__codelineno-33-11"></a><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-33-12" name="__codelineno-33-12" href="#__codelineno-33-12"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-33-13" name="__codelineno-33-13" href="#__codelineno-33-13"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>ktlint_class_signature_rule_force_multiline_when_parameter_count_greater_or_equal_than</code><br/><i>Force wrapping of the parameters of the class signature in case it contains at least the specified number of parameters, even in case the entire class signature would fit on a single line. Use value <code>unset</code> to disable this setting.</i></td>
<td style="text-align: center;">1</td>
<td style="text-align: center;"><code>unset</code></td>
<td style="text-align: center;"><code>unset</code></td>
</tr>
<tr>
<td style="text-align: left;"><code>max_line_length</code><br/><i>Maximum length of a (regular) line. This property is ignored in case the <code>max-line-length</code> rule is disabled, or when using Ktlint via a third party integration that does not provide this rule.</i></td>
<td style="text-align: center;">140</td>
<td style="text-align: center;"><code>off</code></td>
<td style="text-align: center;"><code>100</code></td>
</tr>
</tbody>
</table>
<p>Rule id: <code>standard:class-signature</code></p>
<div class="admonition warn">
<p class="admonition-title">Warn</p>
<p>For code styles <code>android_studio</code> and <code>intellij_idea</code> this rule rewrites multiline class signature to a single line class signature in case the entire class signature fits on a single line by default. In case you want to leave it to the discretion of the developer to decider whether a single or a multiline class signature is used, please suppress or disable this rule.</p>
</div>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-34-1" name="__codelineno-34-1" href="#__codelineno-34-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:class-signature&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-35-1" name="__codelineno-35-1" href="#__codelineno-35-1"></a>ktlint_standard_class-signature = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-36-1" name="__codelineno-36-1" href="#__codelineno-36-1"></a>ktlint_standard_class-signature = disabled
</code></pre></div></li>
</ol>
<h2 id="enum-entry">Enum entry<a class="headerlink" href="#enum-entry" title="Permanent link">&para;</a></h2>
<p>Enum entry names should be uppercase underscore-separated or upper camel-case separated.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="8:2"><input checked="checked" id="__tabbed_8_1" name="__tabbed_8" type="radio" /><input id="__tabbed_8_2" name="__tabbed_8" type="radio" /><div class="tabbed-labels"><label for="__tabbed_8_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_8_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-37-1" name="__codelineno-37-1" href="#__codelineno-37-1"></a><span class="kd">enum</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">Bar</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-37-2" name="__codelineno-37-2" href="#__codelineno-37-2"></a><span class="w"> </span><span class="n">FOO</span><span class="p">,</span>
<a id="__codelineno-37-3" name="__codelineno-37-3" href="#__codelineno-37-3"></a><span class="w"> </span><span class="n">Foo</span><span class="p">,</span>
<a id="__codelineno-37-4" name="__codelineno-37-4" href="#__codelineno-37-4"></a><span class="w"> </span><span class="n">FOO_BAR</span><span class="p">,</span>
<a id="__codelineno-37-5" name="__codelineno-37-5" href="#__codelineno-37-5"></a><span class="w"> </span><span class="n">FooBar</span><span class="p">,</span>
<a id="__codelineno-37-6" name="__codelineno-37-6" href="#__codelineno-37-6"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-38-1" name="__codelineno-38-1" href="#__codelineno-38-1"></a><span class="kd">enum</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">Bar</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-38-2" name="__codelineno-38-2" href="#__codelineno-38-2"></a><span class="w"> </span><span class="n">foo</span><span class="p">,</span>
<a id="__codelineno-38-3" name="__codelineno-38-3" href="#__codelineno-38-3"></a><span class="w"> </span><span class="n">bAr</span><span class="p">,</span>
<a id="__codelineno-38-4" name="__codelineno-38-4" href="#__codelineno-38-4"></a><span class="w"> </span><span class="n">Foo_Bar</span><span class="p">,</span>
<a id="__codelineno-38-5" name="__codelineno-38-5" href="#__codelineno-38-5"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>ktlint_enum_entry_name_casing</code></br><i>Choose any of <code>upper_cases</code> (an enum entry may only contain uppercases, and underscores, and digits, and diacritics on letters and strokes), <code>camel_cases</code> (an enum entry may only contain CamelCase values, including digits, and diacritics on letters and strokes), or <code>upper_or_camel_case</code> (allows mixing of uppercase and CamelCase entries as per Kotlin Coding Conventions).</i></td>
<td style="text-align: center;"><code>upper_or_camel_cases</code></td>
<td style="text-align: center;"><code>upper_or_camel_cases</code></td>
<td style="text-align: center;"><code>upper_or_camel_cases</code></td>
</tr>
</tbody>
</table>
<p>Rule id: <code>standard:enum-entry-name-case</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-39-1" name="__codelineno-39-1" href="#__codelineno-39-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:enum-entry-name-case&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-40-1" name="__codelineno-40-1" href="#__codelineno-40-1"></a>ktlint_standard_enum-entry-name-case = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-41-1" name="__codelineno-41-1" href="#__codelineno-41-1"></a>ktlint_standard_enum-entry-name-case = disabled
</code></pre></div></li>
</ol>
<h2 id="file-name">File name<a class="headerlink" href="#file-name" title="Permanent link">&para;</a></h2>
<p>A file containing only one visible (e.g. non-private) class, and visible declarations related to that class only, should be named according to that element. The same applies if the file does not contain a visible class but exactly one type alias or one object declaration. Otherwise, the PascalCase notation should be used.</p>
<p>Rule id: <code>standard:filename</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-42-1" name="__codelineno-42-1" href="#__codelineno-42-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:filename&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-43-1" name="__codelineno-43-1" href="#__codelineno-43-1"></a>ktlint_standard_filename = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-44-1" name="__codelineno-44-1" href="#__codelineno-44-1"></a>ktlint_standard_filename = disabled
</code></pre></div></li>
</ol>
<h2 id="final-newline">Final newline<a class="headerlink" href="#final-newline" title="Permanent link">&para;</a></h2>
<p>Ensures consistent usage of a newline at the end of each file.</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>insert_final_newline</code></td>
<td style="text-align: center;"><code>true</code></td>
<td style="text-align: center;"><code>true</code></td>
<td style="text-align: center;"><code>true</code></td>
</tr>
</tbody>
</table>
<p>Rule id: <code>standard:final-newline</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-45-1" name="__codelineno-45-1" href="#__codelineno-45-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:final-newline&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-46-1" name="__codelineno-46-1" href="#__codelineno-46-1"></a>ktlint_standard_final-newline = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-47-1" name="__codelineno-47-1" href="#__codelineno-47-1"></a>ktlint_standard_final-newline = disabled
</code></pre></div></li>
</ol>
<h2 id="function-expression-body">Function expression body<a class="headerlink" href="#function-expression-body" title="Permanent link">&para;</a></h2>
<p>Rewrites a function body only containing a <code>return</code> or <code>throw</code> expression to an expression body.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If the function body contains a comment, it is not rewritten to an expression body.</p>
</div>
<div class="tabbed-set tabbed-alternate" data-tabs="9:2"><input checked="checked" id="__tabbed_9_1" name="__tabbed_9" type="radio" /><input id="__tabbed_9_2" name="__tabbed_9" type="radio" /><div class="tabbed-labels"><label for="__tabbed_9_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_9_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-48-1" name="__codelineno-48-1" href="#__codelineno-48-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo1</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo&quot;</span>
<a id="__codelineno-48-2" name="__codelineno-48-2" href="#__codelineno-48-2"></a>
<a id="__codelineno-48-3" name="__codelineno-48-3" href="#__codelineno-48-3"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo2</span><span class="p">():</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo&quot;</span>
<a id="__codelineno-48-4" name="__codelineno-48-4" href="#__codelineno-48-4"></a>
<a id="__codelineno-48-5" name="__codelineno-48-5" href="#__codelineno-48-5"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo3</span><span class="p">():</span><span class="w"> </span><span class="kt">Unit</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="n">IllegalArgumentException</span><span class="p">(</span><span class="s">&quot;some message&quot;</span><span class="p">)</span>
<a id="__codelineno-48-6" name="__codelineno-48-6" href="#__codelineno-48-6"></a>
<a id="__codelineno-48-7" name="__codelineno-48-7" href="#__codelineno-48-7"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo4</span><span class="p">():</span><span class="w"> </span><span class="n">Foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="n">IllegalArgumentException</span><span class="p">(</span><span class="s">&quot;some message&quot;</span><span class="p">)</span>
<a id="__codelineno-48-8" name="__codelineno-48-8" href="#__codelineno-48-8"></a>
<a id="__codelineno-48-9" name="__codelineno-48-9" href="#__codelineno-48-9"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo5</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-48-10" name="__codelineno-48-10" href="#__codelineno-48-10"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="s">&quot;foo&quot;</span><span class="w"> </span><span class="c1">// some comment</span>
<a id="__codelineno-48-11" name="__codelineno-48-11" href="#__codelineno-48-11"></a><span class="p">}</span>
<a id="__codelineno-48-12" name="__codelineno-48-12" href="#__codelineno-48-12"></a>
<a id="__codelineno-48-13" name="__codelineno-48-13" href="#__codelineno-48-13"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo6</span><span class="p">():</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-48-14" name="__codelineno-48-14" href="#__codelineno-48-14"></a><span class="w"> </span><span class="cm">/* some comment */</span>
<a id="__codelineno-48-15" name="__codelineno-48-15" href="#__codelineno-48-15"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="s">&quot;foo&quot;</span>
<a id="__codelineno-48-16" name="__codelineno-48-16" href="#__codelineno-48-16"></a><span class="p">}</span>
<a id="__codelineno-48-17" name="__codelineno-48-17" href="#__codelineno-48-17"></a>
<a id="__codelineno-48-18" name="__codelineno-48-18" href="#__codelineno-48-18"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo7</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-48-19" name="__codelineno-48-19" href="#__codelineno-48-19"></a><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="n">IllegalArgumentException</span><span class="p">(</span><span class="s">&quot;some message&quot;</span><span class="p">)</span>
<a id="__codelineno-48-20" name="__codelineno-48-20" href="#__codelineno-48-20"></a><span class="w"> </span><span class="cm">/* some comment */</span>
<a id="__codelineno-48-21" name="__codelineno-48-21" href="#__codelineno-48-21"></a><span class="p">}</span>
<a id="__codelineno-48-22" name="__codelineno-48-22" href="#__codelineno-48-22"></a>
<a id="__codelineno-48-23" name="__codelineno-48-23" href="#__codelineno-48-23"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo8</span><span class="p">():</span><span class="w"> </span><span class="n">Foo</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-48-24" name="__codelineno-48-24" href="#__codelineno-48-24"></a><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="n">IllegalArgumentException</span><span class="p">(</span><span class="s">&quot;some message&quot;</span><span class="p">)</span>
<a id="__codelineno-48-25" name="__codelineno-48-25" href="#__codelineno-48-25"></a><span class="w"> </span><span class="c1">// some comment</span>
<a id="__codelineno-48-26" name="__codelineno-48-26" href="#__codelineno-48-26"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-49-1" name="__codelineno-49-1" href="#__codelineno-49-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo1</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-49-2" name="__codelineno-49-2" href="#__codelineno-49-2"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="s">&quot;foo&quot;</span>
<a id="__codelineno-49-3" name="__codelineno-49-3" href="#__codelineno-49-3"></a><span class="p">}</span>
<a id="__codelineno-49-4" name="__codelineno-49-4" href="#__codelineno-49-4"></a>
<a id="__codelineno-49-5" name="__codelineno-49-5" href="#__codelineno-49-5"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo2</span><span class="p">():</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-49-6" name="__codelineno-49-6" href="#__codelineno-49-6"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="s">&quot;foo&quot;</span>
<a id="__codelineno-49-7" name="__codelineno-49-7" href="#__codelineno-49-7"></a><span class="p">}</span>
<a id="__codelineno-49-8" name="__codelineno-49-8" href="#__codelineno-49-8"></a>
<a id="__codelineno-49-9" name="__codelineno-49-9" href="#__codelineno-49-9"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo3</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-49-10" name="__codelineno-49-10" href="#__codelineno-49-10"></a><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="n">IllegalArgumentException</span><span class="p">(</span><span class="s">&quot;some message&quot;</span><span class="p">)</span>
<a id="__codelineno-49-11" name="__codelineno-49-11" href="#__codelineno-49-11"></a><span class="p">}</span>
<a id="__codelineno-49-12" name="__codelineno-49-12" href="#__codelineno-49-12"></a>
<a id="__codelineno-49-13" name="__codelineno-49-13" href="#__codelineno-49-13"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo4</span><span class="p">():</span><span class="w"> </span><span class="n">Foo</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-49-14" name="__codelineno-49-14" href="#__codelineno-49-14"></a><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="n">IllegalArgumentException</span><span class="p">(</span><span class="s">&quot;some message&quot;</span><span class="p">)</span>
<a id="__codelineno-49-15" name="__codelineno-49-15" href="#__codelineno-49-15"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:function-expression-body</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-50-1" name="__codelineno-50-1" href="#__codelineno-50-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:function-expression-body&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-51-1" name="__codelineno-51-1" href="#__codelineno-51-1"></a>ktlint_standard_function-expression-body = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-52-1" name="__codelineno-52-1" href="#__codelineno-52-1"></a>ktlint_standard_function-expression-body = disabled
</code></pre></div></li>
</ol>
<h2 id="function-literal">Function literal<a class="headerlink" href="#function-literal" title="Permanent link">&para;</a></h2>
<p>Enforces the parameters of a function literal and the arrow to be written on the same line as the opening brace if the maximum line length is not exceeded. In case the parameters are wrapped to multiple lines then this is respected.</p>
<p>If the function literal contains multiple parameters and at least one parameter other than the first parameter starts on a new line than all parameters and the arrow are wrapped to separate lines.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="10:3"><input checked="checked" id="__tabbed_10_1" name="__tabbed_10" type="radio" /><input id="__tabbed_10_2" name="__tabbed_10" type="radio" /><input id="__tabbed_10_3" name="__tabbed_10" type="radio" /><div class="tabbed-labels"><label for="__tabbed_10_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint (ktlint_official)</label><label for="__tabbed_10_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint (non ktlint_official)</label><label for="__tabbed_10_3"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-53-1" name="__codelineno-53-1" href="#__codelineno-53-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foobar1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="n">foo</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">bar</span><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-53-2" name="__codelineno-53-2" href="#__codelineno-53-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foobar2</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-53-3" name="__codelineno-53-3" href="#__codelineno-53-3"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-53-4" name="__codelineno-53-4" href="#__codelineno-53-4"></a><span class="w"> </span><span class="n">foo</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">bar</span>
<a id="__codelineno-53-5" name="__codelineno-53-5" href="#__codelineno-53-5"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-53-6" name="__codelineno-53-6" href="#__codelineno-53-6"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foobar3</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-53-7" name="__codelineno-53-7" href="#__codelineno-53-7"></a><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="n">foo</span><span class="p">:</span><span class="w"> </span><span class="n">Foo</span><span class="w"> </span><span class="o">-&gt;</span>
<a id="__codelineno-53-8" name="__codelineno-53-8" href="#__codelineno-53-8"></a><span class="w"> </span><span class="n">foo</span><span class="p">.</span><span class="na">repeat</span><span class="p">(</span><span class="m">2</span><span class="p">)</span>
<a id="__codelineno-53-9" name="__codelineno-53-9" href="#__codelineno-53-9"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-53-10" name="__codelineno-53-10" href="#__codelineno-53-10"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foobar4</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-53-11" name="__codelineno-53-11" href="#__codelineno-53-11"></a><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="n">foo</span><span class="p">:</span><span class="w"> </span><span class="n">Foo</span><span class="p">,</span><span class="w"> </span><span class="n">bar</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="w"> </span><span class="o">-&gt;</span>
<a id="__codelineno-53-12" name="__codelineno-53-12" href="#__codelineno-53-12"></a><span class="w"> </span><span class="n">foo</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">bar</span>
<a id="__codelineno-53-13" name="__codelineno-53-13" href="#__codelineno-53-13"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-53-14" name="__codelineno-53-14" href="#__codelineno-53-14"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foobar5</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="n">foo</span><span class="p">:</span><span class="w"> </span><span class="n">Foo</span><span class="p">,</span><span class="w"> </span><span class="n">bar</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">foo</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">bar</span><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-53-15" name="__codelineno-53-15" href="#__codelineno-53-15"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foobar6</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-53-16" name="__codelineno-53-16" href="#__codelineno-53-16"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-53-17" name="__codelineno-53-17" href="#__codelineno-53-17"></a><span class="w"> </span><span class="n">foo</span><span class="p">:</span><span class="w"> </span><span class="n">Foo</span><span class="p">,</span>
<a id="__codelineno-53-18" name="__codelineno-53-18" href="#__codelineno-53-18"></a><span class="w"> </span><span class="n">bar</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-53-19" name="__codelineno-53-19" href="#__codelineno-53-19"></a><span class="w"> </span><span class="o">-&gt;</span>
<a id="__codelineno-53-20" name="__codelineno-53-20" href="#__codelineno-53-20"></a><span class="w"> </span><span class="n">foo</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">bar</span>
<a id="__codelineno-53-21" name="__codelineno-53-21" href="#__codelineno-53-21"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-53-22" name="__codelineno-53-22" href="#__codelineno-53-22"></a>
<a id="__codelineno-53-23" name="__codelineno-53-23" href="#__codelineno-53-23"></a><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-53-24" name="__codelineno-53-24" href="#__codelineno-53-24"></a><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-53-25" name="__codelineno-53-25" href="#__codelineno-53-25"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foobar7</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-53-26" name="__codelineno-53-26" href="#__codelineno-53-26"></a><span class="w"> </span><span class="n">barrrrrrrrrrrrrr</span><span class="w"> </span><span class="p">{</span><span class="w"> </span>
<a id="__codelineno-53-27" name="__codelineno-53-27" href="#__codelineno-53-27"></a><span class="w"> </span><span class="n">fooooooooooooooo</span><span class="p">:</span><span class="w"> </span><span class="n">Foo</span>
<a id="__codelineno-53-28" name="__codelineno-53-28" href="#__codelineno-53-28"></a><span class="w"> </span><span class="o">-&gt;</span>
<a id="__codelineno-53-29" name="__codelineno-53-29" href="#__codelineno-53-29"></a><span class="w"> </span><span class="n">foo</span><span class="p">.</span><span class="na">repeat</span><span class="p">(</span><span class="m">2</span><span class="p">)</span>
<a id="__codelineno-53-30" name="__codelineno-53-30" href="#__codelineno-53-30"></a><span class="w"> </span><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-54-1" name="__codelineno-54-1" href="#__codelineno-54-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foobar6</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-54-2" name="__codelineno-54-2" href="#__codelineno-54-2"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-54-3" name="__codelineno-54-3" href="#__codelineno-54-3"></a><span class="w"> </span><span class="n">foo</span><span class="p">:</span><span class="w"> </span><span class="n">Foo</span><span class="p">,</span>
<a id="__codelineno-54-4" name="__codelineno-54-4" href="#__codelineno-54-4"></a><span class="w"> </span><span class="n">bar</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-54-5" name="__codelineno-54-5" href="#__codelineno-54-5"></a><span class="w"> </span><span class="o">-&gt;</span>
<a id="__codelineno-54-6" name="__codelineno-54-6" href="#__codelineno-54-6"></a><span class="w"> </span><span class="n">foo</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">bar</span>
<a id="__codelineno-54-7" name="__codelineno-54-7" href="#__codelineno-54-7"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-54-8" name="__codelineno-54-8" href="#__codelineno-54-8"></a>
<a id="__codelineno-54-9" name="__codelineno-54-9" href="#__codelineno-54-9"></a><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-54-10" name="__codelineno-54-10" href="#__codelineno-54-10"></a><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-54-11" name="__codelineno-54-11" href="#__codelineno-54-11"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foobar7</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-54-12" name="__codelineno-54-12" href="#__codelineno-54-12"></a><span class="w"> </span><span class="n">barrrrrrrrrrrrrr</span><span class="w"> </span><span class="p">{</span><span class="w"> </span>
<a id="__codelineno-54-13" name="__codelineno-54-13" href="#__codelineno-54-13"></a><span class="w"> </span><span class="n">fooooooooooooooo</span><span class="p">:</span><span class="w"> </span><span class="n">Foo</span>
<a id="__codelineno-54-14" name="__codelineno-54-14" href="#__codelineno-54-14"></a><span class="w"> </span><span class="o">-&gt;</span>
<a id="__codelineno-54-15" name="__codelineno-54-15" href="#__codelineno-54-15"></a><span class="w"> </span><span class="n">foo</span><span class="p">.</span><span class="na">repeat</span><span class="p">(</span><span class="m">2</span><span class="p">)</span>
<a id="__codelineno-54-16" name="__codelineno-54-16" href="#__codelineno-54-16"></a><span class="w"> </span><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-55-1" name="__codelineno-55-1" href="#__codelineno-55-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foobar3</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-55-2" name="__codelineno-55-2" href="#__codelineno-55-2"></a><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-55-3" name="__codelineno-55-3" href="#__codelineno-55-3"></a><span class="w"> </span><span class="n">foo</span><span class="p">:</span><span class="w"> </span><span class="n">Foo</span><span class="w"> </span><span class="o">-&gt;</span>
<a id="__codelineno-55-4" name="__codelineno-55-4" href="#__codelineno-55-4"></a><span class="w"> </span><span class="n">foo</span><span class="p">.</span><span class="na">repeat</span><span class="p">(</span><span class="m">2</span><span class="p">)</span>
<a id="__codelineno-55-5" name="__codelineno-55-5" href="#__codelineno-55-5"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-55-6" name="__codelineno-55-6" href="#__codelineno-55-6"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foobar6</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-55-7" name="__codelineno-55-7" href="#__codelineno-55-7"></a><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="n">foo</span><span class="p">:</span><span class="w"> </span><span class="n">Foo</span><span class="p">,</span>
<a id="__codelineno-55-8" name="__codelineno-55-8" href="#__codelineno-55-8"></a><span class="w"> </span><span class="n">bar</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="w"> </span><span class="o">-&gt;</span>
<a id="__codelineno-55-9" name="__codelineno-55-9" href="#__codelineno-55-9"></a><span class="w"> </span><span class="n">foo</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">bar</span>
<a id="__codelineno-55-10" name="__codelineno-55-10" href="#__codelineno-55-10"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-55-11" name="__codelineno-55-11" href="#__codelineno-55-11"></a><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-55-12" name="__codelineno-55-12" href="#__codelineno-55-12"></a><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-55-13" name="__codelineno-55-13" href="#__codelineno-55-13"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foobar7</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-55-14" name="__codelineno-55-14" href="#__codelineno-55-14"></a><span class="w"> </span><span class="n">barrrrrrrrrrrrrr</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="n">fooooooooooooooo</span><span class="p">:</span><span class="w"> </span><span class="n">Foo</span><span class="w"> </span><span class="o">-&gt;</span>
<a id="__codelineno-55-15" name="__codelineno-55-15" href="#__codelineno-55-15"></a><span class="w"> </span><span class="n">foo</span><span class="p">.</span><span class="na">repeat</span><span class="p">(</span><span class="m">2</span><span class="p">)</span>
<a id="__codelineno-55-16" name="__codelineno-55-16" href="#__codelineno-55-16"></a><span class="w"> </span><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>max_line_length</code><br/><i>Maximum length of a (regular) line. This property is ignored in case the <code>max-line-length</code> rule is disabled, or when using Ktlint via a third party integration that does not provide this rule.</i></td>
<td style="text-align: center;">140</td>
<td style="text-align: center;"><code>off</code></td>
<td style="text-align: center;"><code>100</code></td>
</tr>
</tbody>
</table>
<p>Rule id: <code>standard:function-literal</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-56-1" name="__codelineno-56-1" href="#__codelineno-56-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:function-literal&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-57-1" name="__codelineno-57-1" href="#__codelineno-57-1"></a>ktlint_standard_function-literal = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-58-1" name="__codelineno-58-1" href="#__codelineno-58-1"></a>ktlint_standard_function-literal = disabled
</code></pre></div></li>
</ol>
<h2 id="function-signature">Function signature<a class="headerlink" href="#function-signature" title="Permanent link">&para;</a></h2>
<p>Rewrites the function signature to a single line when possible (e.g. when not exceeding the <code>max_line_length</code> property) or a multiline signature otherwise.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Wrapping of parameters is also influenced by the <code>parameter-list-wrapping</code> rule.</p>
</div>
<div class="tabbed-set tabbed-alternate" data-tabs="11:2"><input checked="checked" id="__tabbed_11_1" name="__tabbed_11" type="radio" /><input id="__tabbed_11_2" name="__tabbed_11" type="radio" /><div class="tabbed-labels"><label for="__tabbed_11_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_11_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-59-1" name="__codelineno-59-1" href="#__codelineno-59-1"></a><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-59-2" name="__codelineno-59-2" href="#__codelineno-59-2"></a><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-59-3" name="__codelineno-59-3" href="#__codelineno-59-3"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foooooooo</span><span class="p">(</span>
<a id="__codelineno-59-4" name="__codelineno-59-4" href="#__codelineno-59-4"></a><span class="w"> </span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-59-5" name="__codelineno-59-5" href="#__codelineno-59-5"></a><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-59-6" name="__codelineno-59-6" href="#__codelineno-59-6"></a><span class="w"> </span><span class="n">c</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-59-7" name="__codelineno-59-7" href="#__codelineno-59-7"></a><span class="p">):</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-59-8" name="__codelineno-59-8" href="#__codelineno-59-8"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-59-9" name="__codelineno-59-9" href="#__codelineno-59-9"></a><span class="p">}</span>
<a id="__codelineno-59-10" name="__codelineno-59-10" href="#__codelineno-59-10"></a>
<a id="__codelineno-59-11" name="__codelineno-59-11" href="#__codelineno-59-11"></a><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-59-12" name="__codelineno-59-12" href="#__codelineno-59-12"></a><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-59-13" name="__codelineno-59-13" href="#__codelineno-59-13"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">bar</span><span class="p">(</span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">c</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">):</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-59-14" name="__codelineno-59-14" href="#__codelineno-59-14"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-59-15" name="__codelineno-59-15" href="#__codelineno-59-15"></a><span class="p">}</span>
<a id="__codelineno-59-16" name="__codelineno-59-16" href="#__codelineno-59-16"></a>
<a id="__codelineno-59-17" name="__codelineno-59-17" href="#__codelineno-59-17"></a><span class="c1">// When wrapping of body is set to &#39;default&#39;.</span>
<a id="__codelineno-59-18" name="__codelineno-59-18" href="#__codelineno-59-18"></a><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-59-19" name="__codelineno-59-19" href="#__codelineno-59-19"></a><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-59-20" name="__codelineno-59-20" href="#__codelineno-59-20"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">f</span><span class="p">(</span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">):</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-59-21" name="__codelineno-59-21" href="#__codelineno-59-21"></a><span class="w"> </span><span class="p">.</span><span class="na">uppercase</span><span class="p">()</span>
<a id="__codelineno-59-22" name="__codelineno-59-22" href="#__codelineno-59-22"></a>
<a id="__codelineno-59-23" name="__codelineno-59-23" href="#__codelineno-59-23"></a><span class="c1">// When wrapping of body is set to &#39;multiline&#39;</span>
<a id="__codelineno-59-24" name="__codelineno-59-24" href="#__codelineno-59-24"></a><span class="c1">// or &#39;always&#39;.</span>
<a id="__codelineno-59-25" name="__codelineno-59-25" href="#__codelineno-59-25"></a><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-59-26" name="__codelineno-59-26" href="#__codelineno-59-26"></a><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-59-27" name="__codelineno-59-27" href="#__codelineno-59-27"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">f</span><span class="p">(</span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">):</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-59-28" name="__codelineno-59-28" href="#__codelineno-59-28"></a><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-59-29" name="__codelineno-59-29" href="#__codelineno-59-29"></a><span class="w"> </span><span class="p">.</span><span class="na">uppercase</span><span class="p">()</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-60-1" name="__codelineno-60-1" href="#__codelineno-60-1"></a><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-60-2" name="__codelineno-60-2" href="#__codelineno-60-2"></a><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-60-3" name="__codelineno-60-3" href="#__codelineno-60-3"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foooooooo</span><span class="p">(</span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">c</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">):</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-60-4" name="__codelineno-60-4" href="#__codelineno-60-4"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-60-5" name="__codelineno-60-5" href="#__codelineno-60-5"></a><span class="p">}</span>
<a id="__codelineno-60-6" name="__codelineno-60-6" href="#__codelineno-60-6"></a>
<a id="__codelineno-60-7" name="__codelineno-60-7" href="#__codelineno-60-7"></a><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-60-8" name="__codelineno-60-8" href="#__codelineno-60-8"></a><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-60-9" name="__codelineno-60-9" href="#__codelineno-60-9"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">bar</span><span class="p">(</span>
<a id="__codelineno-60-10" name="__codelineno-60-10" href="#__codelineno-60-10"></a><span class="w"> </span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-60-11" name="__codelineno-60-11" href="#__codelineno-60-11"></a><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-60-12" name="__codelineno-60-12" href="#__codelineno-60-12"></a><span class="w"> </span><span class="n">c</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span>
<a id="__codelineno-60-13" name="__codelineno-60-13" href="#__codelineno-60-13"></a><span class="p">):</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-60-14" name="__codelineno-60-14" href="#__codelineno-60-14"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-60-15" name="__codelineno-60-15" href="#__codelineno-60-15"></a><span class="p">}</span>
<a id="__codelineno-60-16" name="__codelineno-60-16" href="#__codelineno-60-16"></a>
<a id="__codelineno-60-17" name="__codelineno-60-17" href="#__codelineno-60-17"></a><span class="c1">// When wrapping of body is set to &#39;default&#39;.</span>
<a id="__codelineno-60-18" name="__codelineno-60-18" href="#__codelineno-60-18"></a><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-60-19" name="__codelineno-60-19" href="#__codelineno-60-19"></a><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-60-20" name="__codelineno-60-20" href="#__codelineno-60-20"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">f</span><span class="p">(</span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">):</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-60-21" name="__codelineno-60-21" href="#__codelineno-60-21"></a><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-60-22" name="__codelineno-60-22" href="#__codelineno-60-22"></a><span class="w"> </span><span class="p">.</span><span class="na">uppercase</span><span class="p">()</span>
<a id="__codelineno-60-23" name="__codelineno-60-23" href="#__codelineno-60-23"></a>
<a id="__codelineno-60-24" name="__codelineno-60-24" href="#__codelineno-60-24"></a><span class="c1">// When wrapping of body is set to &#39;multiline&#39;</span>
<a id="__codelineno-60-25" name="__codelineno-60-25" href="#__codelineno-60-25"></a><span class="c1">// or &#39;always&#39;.</span>
<a id="__codelineno-60-26" name="__codelineno-60-26" href="#__codelineno-60-26"></a><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-60-27" name="__codelineno-60-27" href="#__codelineno-60-27"></a><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-60-28" name="__codelineno-60-28" href="#__codelineno-60-28"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">f</span><span class="p">(</span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">):</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-60-29" name="__codelineno-60-29" href="#__codelineno-60-29"></a><span class="w"> </span><span class="p">.</span><span class="na">uppercase</span><span class="p">()</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>ktlint_function_signature_body_expression_wrapping</code><br/><i>Determines how to wrap the body of function in case it is an expression. Use <code>default</code> to wrap the body expression only when the first line of the expression does not fit on the same line as the function signature. Use <code>multiline</code> to force wrapping of body expressions that consists of multiple lines. Use <code>always</code> to force wrapping of body expression always.</i></td>
<td style="text-align: center;"><code>multiline</code></td>
<td style="text-align: center;"><code>default</code></td>
<td style="text-align: center;"><code>default</code></td>
</tr>
<tr>
<td style="text-align: left;"><code>ktlint_function_signature_rule_force_multiline_when_parameter_count_greater_or_equal_than</code><br/><i>Forces a multiline function signature in case the function contains the specified minimum number of parameters even in case the function signature would fit on a single line. Use value <code>unset</code> (default) to disable this setting.</i></td>
<td style="text-align: center;">2</td>
<td style="text-align: center;"><code>unset</code></td>
<td style="text-align: center;"><code>unset</code></td>
</tr>
</tbody>
</table>
<div class="tabbed-set tabbed-alternate" data-tabs="12:3"><input checked="checked" id="__tabbed_12_1" name="__tabbed_12" type="radio" /><input id="__tabbed_12_2" name="__tabbed_12" type="radio" /><input id="__tabbed_12_3" name="__tabbed_12" type="radio" /><div class="tabbed-labels"><label for="__tabbed_12_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> default</label><label for="__tabbed_12_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> multiline</label><label for="__tabbed_12_3"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> always</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<p>When <code>ktlint_function_signature_body_expression_wrapping</code> is set to <code>default</code>, the first line of a body expression is appended to the function signature as long as the max line length is not exceeded.</p>
<div class="highlight"><span class="filename">ktlint_function_signature_body_expression_wrapping=default</span><pre><span></span><code><a id="__codelineno-61-1" name="__codelineno-61-1" href="#__codelineno-61-1"></a><span class="c1">// Given that the function signature has to be written as a single line</span>
<a id="__codelineno-61-2" name="__codelineno-61-2" href="#__codelineno-61-2"></a><span class="c1">// function signature and that the function has a multiline body expression</span>
<a id="__codelineno-61-3" name="__codelineno-61-3" href="#__codelineno-61-3"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">someFunction</span><span class="p">(</span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">):</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-61-4" name="__codelineno-61-4" href="#__codelineno-61-4"></a><span class="w"> </span><span class="p">.</span><span class="na">uppercase</span><span class="p">()</span>
<a id="__codelineno-61-5" name="__codelineno-61-5" href="#__codelineno-61-5"></a>
<a id="__codelineno-61-6" name="__codelineno-61-6" href="#__codelineno-61-6"></a><span class="c1">// Given that the function signature has to be written as a multiline</span>
<a id="__codelineno-61-7" name="__codelineno-61-7" href="#__codelineno-61-7"></a><span class="c1">// function signature and that the function has a multiline body expression</span>
<a id="__codelineno-61-8" name="__codelineno-61-8" href="#__codelineno-61-8"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">someFunction</span><span class="p">(</span>
<a id="__codelineno-61-9" name="__codelineno-61-9" href="#__codelineno-61-9"></a><span class="w"> </span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-61-10" name="__codelineno-61-10" href="#__codelineno-61-10"></a><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span>
<a id="__codelineno-61-11" name="__codelineno-61-11" href="#__codelineno-61-11"></a><span class="p">):</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-61-12" name="__codelineno-61-12" href="#__codelineno-61-12"></a><span class="w"> </span><span class="p">.</span><span class="na">uppercase</span><span class="p">()</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<p>When <code>ktlint_function_signature_body_expression_wrapping</code> is set to <code>multiline</code>, the body expression starts on a separate line in case it is a multiline expression. A single line body expression is wrapped only when it does not fit on the same line as the function signature.</p>
<div class="highlight"><span class="filename">ktlint_function_signature_body_expression_wrapping=multiline</span><pre><span></span><code><a id="__codelineno-62-1" name="__codelineno-62-1" href="#__codelineno-62-1"></a><span class="c1">// Given that the function signature has to be written as a single line</span>
<a id="__codelineno-62-2" name="__codelineno-62-2" href="#__codelineno-62-2"></a><span class="c1">// function signature and that the function has a single line body expression</span>
<a id="__codelineno-62-3" name="__codelineno-62-3" href="#__codelineno-62-3"></a><span class="c1">// that fits on the same line as the function signature.</span>
<a id="__codelineno-62-4" name="__codelineno-62-4" href="#__codelineno-62-4"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">someFunction</span><span class="p">(</span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">):</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span><span class="p">.</span><span class="na">uppercase</span><span class="p">()</span>
<a id="__codelineno-62-5" name="__codelineno-62-5" href="#__codelineno-62-5"></a>
<a id="__codelineno-62-6" name="__codelineno-62-6" href="#__codelineno-62-6"></a><span class="c1">// Given that the function signature has to be written as a multiline</span>
<a id="__codelineno-62-7" name="__codelineno-62-7" href="#__codelineno-62-7"></a><span class="c1">// function signature and that the function has a single line body expression</span>
<a id="__codelineno-62-8" name="__codelineno-62-8" href="#__codelineno-62-8"></a><span class="c1">// that fits on the same line as the function signature.</span>
<a id="__codelineno-62-9" name="__codelineno-62-9" href="#__codelineno-62-9"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">someFunction</span><span class="p">(</span>
<a id="__codelineno-62-10" name="__codelineno-62-10" href="#__codelineno-62-10"></a><span class="w"> </span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-62-11" name="__codelineno-62-11" href="#__codelineno-62-11"></a><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span>
<a id="__codelineno-62-12" name="__codelineno-62-12" href="#__codelineno-62-12"></a><span class="p">):</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span><span class="p">.</span><span class="na">uppercase</span><span class="p">()</span>
<a id="__codelineno-62-13" name="__codelineno-62-13" href="#__codelineno-62-13"></a>
<a id="__codelineno-62-14" name="__codelineno-62-14" href="#__codelineno-62-14"></a><span class="c1">// Given that the function signature has to be written as a single line</span>
<a id="__codelineno-62-15" name="__codelineno-62-15" href="#__codelineno-62-15"></a><span class="c1">// function signature and that the function has a multiline body expression</span>
<a id="__codelineno-62-16" name="__codelineno-62-16" href="#__codelineno-62-16"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">someFunction</span><span class="p">(</span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">):</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-62-17" name="__codelineno-62-17" href="#__codelineno-62-17"></a><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-62-18" name="__codelineno-62-18" href="#__codelineno-62-18"></a><span class="w"> </span><span class="p">.</span><span class="na">uppercase</span><span class="p">()</span>
<a id="__codelineno-62-19" name="__codelineno-62-19" href="#__codelineno-62-19"></a>
<a id="__codelineno-62-20" name="__codelineno-62-20" href="#__codelineno-62-20"></a><span class="c1">// Given that the function signature has to be written as a multiline</span>
<a id="__codelineno-62-21" name="__codelineno-62-21" href="#__codelineno-62-21"></a><span class="c1">// function signature and that the function has a multiline body expression</span>
<a id="__codelineno-62-22" name="__codelineno-62-22" href="#__codelineno-62-22"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">someFunction</span><span class="p">(</span>
<a id="__codelineno-62-23" name="__codelineno-62-23" href="#__codelineno-62-23"></a><span class="w"> </span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-62-24" name="__codelineno-62-24" href="#__codelineno-62-24"></a><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span>
<a id="__codelineno-62-25" name="__codelineno-62-25" href="#__codelineno-62-25"></a><span class="p">):</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-62-26" name="__codelineno-62-26" href="#__codelineno-62-26"></a><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-62-27" name="__codelineno-62-27" href="#__codelineno-62-27"></a><span class="w"> </span><span class="p">.</span><span class="na">uppercase</span><span class="p">()</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<p>When <code>ktlint_function_signature_body_expression_wrapping</code> is set to <code>always</code> the body expression is always wrapped to a separate line.</p>
<div class="highlight"><span class="filename">ktlint_function_signature_body_expression_wrapping=always</span><pre><span></span><code><a id="__codelineno-63-1" name="__codelineno-63-1" href="#__codelineno-63-1"></a><span class="c1">// Given that the function signature has to be written as a single line</span>
<a id="__codelineno-63-2" name="__codelineno-63-2" href="#__codelineno-63-2"></a><span class="c1">// function signature and that the function has a single line body expression</span>
<a id="__codelineno-63-3" name="__codelineno-63-3" href="#__codelineno-63-3"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">someFunction</span><span class="p">(</span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">):</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-63-4" name="__codelineno-63-4" href="#__codelineno-63-4"></a><span class="w"> </span><span class="s">&quot;some-result&quot;</span><span class="p">.</span><span class="na">uppercase</span><span class="p">()</span>
<a id="__codelineno-63-5" name="__codelineno-63-5" href="#__codelineno-63-5"></a>
<a id="__codelineno-63-6" name="__codelineno-63-6" href="#__codelineno-63-6"></a><span class="c1">// Given that the function signature has to be written as a multiline</span>
<a id="__codelineno-63-7" name="__codelineno-63-7" href="#__codelineno-63-7"></a><span class="c1">// function signature and that the function has a multiline body expression</span>
<a id="__codelineno-63-8" name="__codelineno-63-8" href="#__codelineno-63-8"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">functionWithAVeryLongName</span><span class="p">(</span>
<a id="__codelineno-63-9" name="__codelineno-63-9" href="#__codelineno-63-9"></a><span class="w"> </span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-63-10" name="__codelineno-63-10" href="#__codelineno-63-10"></a><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span>
<a id="__codelineno-63-11" name="__codelineno-63-11" href="#__codelineno-63-11"></a><span class="p">):</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-63-12" name="__codelineno-63-12" href="#__codelineno-63-12"></a><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-63-13" name="__codelineno-63-13" href="#__codelineno-63-13"></a><span class="w"> </span><span class="p">.</span><span class="na">uppercase</span><span class="p">()</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>max_line_length</code><br/><i>Maximum length of a (regular) line. This property is ignored in case the <code>max-line-length</code> rule is disabled, or when using Ktlint via a third party integration that does not provide this rule.</i></td>
<td style="text-align: center;">140</td>
<td style="text-align: center;"><code>off</code></td>
<td style="text-align: center;"><code>100</code></td>
</tr>
</tbody>
</table>
<p>Rule id: <code>standard:function-signature</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-64-1" name="__codelineno-64-1" href="#__codelineno-64-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:function-signature&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-65-1" name="__codelineno-65-1" href="#__codelineno-65-1"></a>ktlint_standard_function-signature = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-66-1" name="__codelineno-66-1" href="#__codelineno-66-1"></a>ktlint_standard_function-signature = disabled
</code></pre></div></li>
</ol>
<h2 id="function-type-modifier-spacing">Function type modifier spacing<a class="headerlink" href="#function-type-modifier-spacing" title="Permanent link">&para;</a></h2>
<p>Enforce a single whitespace between the modifier list and the function type.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="13:2"><input checked="checked" id="__tabbed_13_1" name="__tabbed_13" type="radio" /><input id="__tabbed_13_2" name="__tabbed_13" type="radio" /><div class="tabbed-labels"><label for="__tabbed_13_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_13_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-67-1" name="__codelineno-67-1" href="#__codelineno-67-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="p">:</span><span class="w"> </span><span class="n">suspend</span><span class="w"> </span><span class="p">()</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kt">Unit</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{}</span>
<a id="__codelineno-67-2" name="__codelineno-67-2" href="#__codelineno-67-2"></a>
<a id="__codelineno-67-3" name="__codelineno-67-3" href="#__codelineno-67-3"></a><span class="kd">suspend</span><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">bar</span><span class="p">(</span><span class="n">baz</span><span class="p">:</span><span class="w"> </span><span class="n">suspend</span><span class="w"> </span><span class="p">()</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kt">Unit</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">baz</span><span class="p">()</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-68-1" name="__codelineno-68-1" href="#__codelineno-68-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="p">:</span><span class="w"> </span><span class="n">suspend</span><span class="p">()</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kt">Unit</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{}</span>
<a id="__codelineno-68-2" name="__codelineno-68-2" href="#__codelineno-68-2"></a>
<a id="__codelineno-68-3" name="__codelineno-68-3" href="#__codelineno-68-3"></a><span class="kd">suspend</span><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">bar</span><span class="p">(</span><span class="n">baz</span><span class="p">:</span><span class="w"> </span><span class="n">suspend</span><span class="w"> </span><span class="p">()</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kt">Unit</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">baz</span><span class="p">()</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:function-type-modifier-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-69-1" name="__codelineno-69-1" href="#__codelineno-69-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:function-type-modifier-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-70-1" name="__codelineno-70-1" href="#__codelineno-70-1"></a>ktlint_standard_function-type-modifier-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-71-1" name="__codelineno-71-1" href="#__codelineno-71-1"></a>ktlint_standard_function-type-modifier-spacing = disabled
</code></pre></div></li>
</ol>
<h2 id="if-else-bracing">If else bracing<a class="headerlink" href="#if-else-bracing" title="Permanent link">&para;</a></h2>
<p>If at least one branch of an if-else statement or an if-else-if statement is wrapped between curly braces, then all branches should be wrapped between braces.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="14:2"><input checked="checked" id="__tabbed_14_1" name="__tabbed_14" type="radio" /><input id="__tabbed_14_2" name="__tabbed_14" type="radio" /><div class="tabbed-labels"><label for="__tabbed_14_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_14_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-72-1" name="__codelineno-72-1" href="#__codelineno-72-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">(</span><span class="n">value</span><span class="p">:</span><span class="w"> </span><span class="kt">Int</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-72-2" name="__codelineno-72-2" href="#__codelineno-72-2"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">value</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="m">0</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-72-3" name="__codelineno-72-3" href="#__codelineno-72-3"></a><span class="w"> </span><span class="n">doSomething</span><span class="p">()</span>
<a id="__codelineno-72-4" name="__codelineno-72-4" href="#__codelineno-72-4"></a><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">value</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="m">0</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-72-5" name="__codelineno-72-5" href="#__codelineno-72-5"></a><span class="w"> </span><span class="n">doSomethingElse</span><span class="p">()</span>
<a id="__codelineno-72-6" name="__codelineno-72-6" href="#__codelineno-72-6"></a><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-72-7" name="__codelineno-72-7" href="#__codelineno-72-7"></a><span class="w"> </span><span class="n">doSomethingElse2</span><span class="p">()</span>
<a id="__codelineno-72-8" name="__codelineno-72-8" href="#__codelineno-72-8"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-72-9" name="__codelineno-72-9" href="#__codelineno-72-9"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-73-1" name="__codelineno-73-1" href="#__codelineno-73-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">(</span><span class="n">value</span><span class="p">:</span><span class="w"> </span><span class="kt">Int</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-73-2" name="__codelineno-73-2" href="#__codelineno-73-2"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">value</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="m">0</span><span class="p">)</span>
<a id="__codelineno-73-3" name="__codelineno-73-3" href="#__codelineno-73-3"></a><span class="w"> </span><span class="n">doSomething</span><span class="p">()</span>
<a id="__codelineno-73-4" name="__codelineno-73-4" href="#__codelineno-73-4"></a><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">value</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="m">0</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-73-5" name="__codelineno-73-5" href="#__codelineno-73-5"></a><span class="w"> </span><span class="n">doSomethingElse</span><span class="p">()</span>
<a id="__codelineno-73-6" name="__codelineno-73-6" href="#__codelineno-73-6"></a><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">else</span>
<a id="__codelineno-73-7" name="__codelineno-73-7" href="#__codelineno-73-7"></a><span class="w"> </span><span class="n">doSomethingElse2</span><span class="p">()</span>
<a id="__codelineno-73-8" name="__codelineno-73-8" href="#__codelineno-73-8"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:if-else-bracing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-74-1" name="__codelineno-74-1" href="#__codelineno-74-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:if-else-bracing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-75-1" name="__codelineno-75-1" href="#__codelineno-75-1"></a>ktlint_standard_if-else-bracing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-76-1" name="__codelineno-76-1" href="#__codelineno-76-1"></a>ktlint_standard_if-else-bracing = disabled
</code></pre></div></li>
</ol>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This rule is only run when <code>ktlint_code_style</code> is set to <code>ktlint_official</code> or when the rule is enabled explicitly.</p>
</div>
<h2 id="import-ordering">Import ordering<a class="headerlink" href="#import-ordering" title="Permanent link">&para;</a></h2>
<p>Ensures that imports are ordered consistently.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="15:2"><input checked="checked" id="__tabbed_15_1" name="__tabbed_15" type="radio" /><input id="__tabbed_15_2" name="__tabbed_15" type="radio" /><div class="tabbed-labels"><label for="__tabbed_15_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_15_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-77-1" name="__codelineno-77-1" href="#__codelineno-77-1"></a><span class="k">import</span><span class="w"> </span><span class="nn">com.bar.Bar</span>
<a id="__codelineno-77-2" name="__codelineno-77-2" href="#__codelineno-77-2"></a><span class="k">import</span><span class="w"> </span><span class="nn">com.foo.Foo</span>
<a id="__codelineno-77-3" name="__codelineno-77-3" href="#__codelineno-77-3"></a><span class="k">import</span><span class="w"> </span><span class="nn">org.foo.bar.FooBar</span>
<a id="__codelineno-77-4" name="__codelineno-77-4" href="#__codelineno-77-4"></a><span class="k">import</span><span class="w"> </span><span class="nn">java.util.concurrent.ConcurrentHashMap</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-78-1" name="__codelineno-78-1" href="#__codelineno-78-1"></a><span class="k">import</span><span class="w"> </span><span class="nn">com.bar.Bar</span>
<a id="__codelineno-78-2" name="__codelineno-78-2" href="#__codelineno-78-2"></a><span class="k">import</span><span class="w"> </span><span class="nn">java.util.concurrent.ConcurrentHashMap</span>
<a id="__codelineno-78-3" name="__codelineno-78-3" href="#__codelineno-78-3"></a><span class="k">import</span><span class="w"> </span><span class="nn">org.foo.bar.FooBar</span>
<a id="__codelineno-78-4" name="__codelineno-78-4" href="#__codelineno-78-4"></a><span class="k">import</span><span class="w"> </span><span class="nn">com.foo.Foo</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>ij_kotlin_imports_layout</code></br><i>Defines imports order layout for Kotlin files</i>. For more details see below table.</td>
<td style="text-align: center;"><em>,java.</em><em>,javax.</em><em>,kotlin.</em>*,^ &lt;1&gt;</td>
<td style="text-align: center;"><em>,java.</em><em>,javax.</em><em>,kotlin.</em>*,^ &lt;1&gt;</td>
<td style="text-align: center;">* &lt;2&gt;</td>
</tr>
</tbody>
</table>
<h3 id="ij_kotlin_packages_to_use_import_on_demand">ij_kotlin_packages_to_use_import_on_demand<a class="headerlink" href="#ij_kotlin_packages_to_use_import_on_demand" title="Permanent link">&para;</a></h3>
<p>This property holds 0 or more import paths. The import path can be a full path, e.g. "java.util.List.<em>" as well as wildcard path, e.g. "kotlin.</em>*".</p>
<p>Imports can be grouped by composing the layout with symbols below:</p>
<ul>
<li><code>*</code> - wildcard. There must be at least one entry of a single wildcard to match all other imports. Matches anything after a specified symbol/import as well.</li>
<li><code>|</code> - blank line. Supports only single blank lines between imports. No blank line is allowed in the beginning or end of the layout.</li>
<li><code>^</code> - alias import, e.g. "^android.*" will match all android alias imports, "^" will match all other alias imports.</li>
</ul>
<p>Imports in the same group are sorted alphabetical with capital letters before lower case letters (e.g. Z before a).</p>
<p>Examples:
<div class="highlight"><pre><span></span><code><a id="__codelineno-79-1" name="__codelineno-79-1" href="#__codelineno-79-1"></a><span class="n">ij_kotlin_imports_layout</span><span class="o">=*</span><span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="n">alphabetical</span><span class="w"> </span><span class="n">with</span><span class="w"> </span><span class="n">capital</span><span class="w"> </span><span class="n">letters</span><span class="w"> </span><span class="n">before</span><span class="w"> </span><span class="n">lower</span><span class="w"> </span><span class="n">case</span><span class="w"> </span><span class="n">letters</span><span class="w"> </span><span class="p">(</span><span class="n">e</span><span class="p">.</span><span class="na">g</span><span class="p">.</span><span class="w"> </span><span class="n">Z</span><span class="w"> </span><span class="n">before</span><span class="w"> </span><span class="n">a</span><span class="p">),</span><span class="w"> </span><span class="n">no</span><span class="w"> </span><span class="n">blank</span><span class="w"> </span><span class="n">lines</span>
<a id="__codelineno-79-2" name="__codelineno-79-2" href="#__codelineno-79-2"></a><span class="n">ij_kotlin_imports_layout</span><span class="o">=*</span><span class="p">,</span><span class="n">java</span><span class="p">.</span><span class="o">**</span><span class="p">,</span><span class="n">javax</span><span class="p">.</span><span class="o">**</span><span class="p">,</span><span class="n">kotlin</span><span class="p">.</span><span class="o">**</span><span class="p">,</span><span class="o">^</span><span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="n">default</span><span class="w"> </span><span class="n">IntelliJ</span><span class="w"> </span><span class="n">IDEA</span><span class="w"> </span><span class="n">style</span><span class="p">,</span><span class="w"> </span><span class="n">same</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="n">alphabetical</span><span class="p">,</span><span class="w"> </span><span class="n">but</span><span class="w"> </span><span class="n">with</span><span class="w"> </span><span class="s">&quot;java&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;javax&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;kotlin&quot;</span><span class="w"> </span><span class="n">and</span><span class="w"> </span><span class="n">alias</span><span class="w"> </span><span class="n">imports</span><span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">end</span><span class="w"> </span><span class="n">of</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">imports</span><span class="w"> </span><span class="n">list</span>
<a id="__codelineno-79-3" name="__codelineno-79-3" href="#__codelineno-79-3"></a><span class="n">ij_kotlin_imports_layout</span><span class="o">=</span><span class="n">android</span><span class="p">.</span><span class="o">**</span><span class="p">,</span><span class="o">|</span><span class="p">,</span><span class="o">^</span><span class="n">org</span><span class="p">.</span><span class="na">junit</span><span class="p">.</span><span class="o">**</span><span class="p">,</span><span class="n">kotlin</span><span class="p">.</span><span class="na">io</span><span class="p">.</span><span class="na">Closeable</span><span class="p">.</span><span class="o">*</span><span class="p">,</span><span class="o">|</span><span class="p">,</span><span class="o">*</span><span class="p">,</span><span class="o">^</span><span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="n">custom</span><span class="w"> </span><span class="n">imports</span><span class="w"> </span><span class="n">layout</span>
</code></pre></div></p>
<p>Wildcard imports can be allowed for specific import paths (Comma-separated list, use "**" as wildcard for package and all subpackages). This setting overrides the no-wildcard-imports rule. This setting is best be used for allowing wildcard imports from libraries like Ktor where extension functions are used in a way that creates a lot of imports.</p>
<p>Rule id: <code>standard:import-ordering</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-80-1" name="__codelineno-80-1" href="#__codelineno-80-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:import-ordering&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-81-1" name="__codelineno-81-1" href="#__codelineno-81-1"></a>ktlint_standard_import-ordering = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-82-1" name="__codelineno-82-1" href="#__codelineno-82-1"></a>ktlint_standard_import-ordering = disabled
</code></pre></div></li>
</ol>
<h2 id="indentation">Indentation<a class="headerlink" href="#indentation" title="Permanent link">&para;</a></h2>
<p>Indentation formatting - respects <code>.editorconfig</code> <code>indent_size</code> with no continuation indent (see <a href="../configuration-ktlint/">EditorConfig</a> section for more).</p>
<div class="tabbed-set tabbed-alternate" data-tabs="16:2"><input checked="checked" id="__tabbed_16_1" name="__tabbed_16" type="radio" /><input id="__tabbed_16_2" name="__tabbed_16" type="radio" /><div class="tabbed-labels"><label for="__tabbed_16_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_16_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-83-1" name="__codelineno-83-1" href="#__codelineno-83-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">main</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-83-2" name="__codelineno-83-2" href="#__codelineno-83-2"></a><span class="w"> </span><span class="n">foobar</span><span class="p">(</span>
<a id="__codelineno-83-3" name="__codelineno-83-3" href="#__codelineno-83-3"></a><span class="w"> </span><span class="n">a</span><span class="p">,</span>
<a id="__codelineno-83-4" name="__codelineno-83-4" href="#__codelineno-83-4"></a><span class="w"> </span><span class="n">b</span><span class="p">,</span>
<a id="__codelineno-83-5" name="__codelineno-83-5" href="#__codelineno-83-5"></a><span class="w"> </span><span class="n">c</span><span class="p">,</span>
<a id="__codelineno-83-6" name="__codelineno-83-6" href="#__codelineno-83-6"></a><span class="w"> </span><span class="p">)</span>
<a id="__codelineno-83-7" name="__codelineno-83-7" href="#__codelineno-83-7"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-84-1" name="__codelineno-84-1" href="#__codelineno-84-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">main</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-84-2" name="__codelineno-84-2" href="#__codelineno-84-2"></a><span class="w"> </span><span class="n">foobar</span><span class="p">(</span>
<a id="__codelineno-84-3" name="__codelineno-84-3" href="#__codelineno-84-3"></a><span class="w"> </span><span class="n">a</span><span class="p">,</span>
<a id="__codelineno-84-4" name="__codelineno-84-4" href="#__codelineno-84-4"></a><span class="w"> </span><span class="n">b</span><span class="p">,</span>
<a id="__codelineno-84-5" name="__codelineno-84-5" href="#__codelineno-84-5"></a><span class="w"> </span><span class="n">c</span><span class="p">,</span>
<a id="__codelineno-84-6" name="__codelineno-84-6" href="#__codelineno-84-6"></a><span class="w"> </span><span class="p">)</span>
<a id="__codelineno-84-7" name="__codelineno-84-7" href="#__codelineno-84-7"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This rule handles indentation for many different language constructs which can not be summarized with a few examples. See the <a href="https://github.com/pinterest/ktlint/blob/master/ktlint-ruleset-standard/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/rules/IndentationRuleTest.kt">unit tests</a> for more details.</p>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>indent_size</code></br><i>The size of an indentation level when <code>indent_style</code> is set to <code>space</code>. Use value <code>unset</code> to ignore indentation.</i></td>
<td style="text-align: center;">4</td>
<td style="text-align: center;">4</td>
<td style="text-align: center;">4</td>
</tr>
<tr>
<td style="text-align: left;"><code>indent_style</code></br><i>Style of indentation. Set this value to <code>space</code> or <code>tab</code>.</i></td>
<td style="text-align: center;"><code>space</code></td>
<td style="text-align: center;"><code>space</code></td>
<td style="text-align: center;"><code>space</code></td>
</tr>
<tr>
<td style="text-align: left;"><code>ij_kotlin_indent_before_arrow_on_new_line</code></br><i>Indent the arrow in a when-entry if the arrow starts on a new line. Set this value to <code>true</code> or <code>false</code>. Starting from IDEA version <code>2024.2</code> or above this value needs to be set to <code>true</code> to maintain compatibility with IDEA formatting.</i></td>
<td style="text-align: center;"><code>false</code></td>
<td style="text-align: center;"><code>false</code></td>
<td style="text-align: center;"><code>false</code></td>
</tr>
</tbody>
</table>
<p>Rule id: <code>standard:indent</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-85-1" name="__codelineno-85-1" href="#__codelineno-85-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:indent&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-86-1" name="__codelineno-86-1" href="#__codelineno-86-1"></a>ktlint_standard_indent = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-87-1" name="__codelineno-87-1" href="#__codelineno-87-1"></a>ktlint_standard_indent = disabled
</code></pre></div></li>
</ol>
<h2 id="kdoc">KDoc<a class="headerlink" href="#kdoc" title="Permanent link">&para;</a></h2>
<p>KDoc's should only be used on elements for which KDoc is to be transformed to documentation. Normal block comments should be used in other cases.</p>
<p>!!! note:
Access modifiers are ignored. Strictly speaking, one could argue that private declarations should not have a KDoc as no documentation will be generated for it. However, for internal use of developers, the KDoc still serves documentation purposes.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="17:2"><input checked="checked" id="__tabbed_17_1" name="__tabbed_17" type="radio" /><input id="__tabbed_17_2" name="__tabbed_17" type="radio" /><div class="tabbed-labels"><label for="__tabbed_17_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_17_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-88-1" name="__codelineno-88-1" href="#__codelineno-88-1"></a><span class="cm">/** some KDoc */</span>
<a id="__codelineno-88-2" name="__codelineno-88-2" href="#__codelineno-88-2"></a><span class="kd">class</span><span class="w"> </span><span class="nc">FooBar</span><span class="p">(</span>
<a id="__codelineno-88-3" name="__codelineno-88-3" href="#__codelineno-88-3"></a><span class="w"> </span><span class="cm">/** some KDoc */</span>
<a id="__codelineno-88-4" name="__codelineno-88-4" href="#__codelineno-88-4"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="p">:</span><span class="w"> </span><span class="n">Foo</span>
<a id="__codelineno-88-5" name="__codelineno-88-5" href="#__codelineno-88-5"></a><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-88-6" name="__codelineno-88-6" href="#__codelineno-88-6"></a><span class="w"> </span><span class="cm">/**</span>
<a id="__codelineno-88-7" name="__codelineno-88-7" href="#__codelineno-88-7"></a><span class="cm"> * Some bar KDoc</span>
<a id="__codelineno-88-8" name="__codelineno-88-8" href="#__codelineno-88-8"></a><span class="cm"> */</span>
<a id="__codelineno-88-9" name="__codelineno-88-9" href="#__codelineno-88-9"></a><span class="w"> </span><span class="k">constructor</span><span class="p">()</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="k">this</span><span class="p">()</span>
<a id="__codelineno-88-10" name="__codelineno-88-10" href="#__codelineno-88-10"></a>
<a id="__codelineno-88-11" name="__codelineno-88-11" href="#__codelineno-88-11"></a><span class="w"> </span><span class="cm">/** some KDoc */</span>
<a id="__codelineno-88-12" name="__codelineno-88-12" href="#__codelineno-88-12"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">bar</span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span>
<a id="__codelineno-88-13" name="__codelineno-88-13" href="#__codelineno-88-13"></a><span class="p">}</span>
<a id="__codelineno-88-14" name="__codelineno-88-14" href="#__codelineno-88-14"></a>
<a id="__codelineno-88-15" name="__codelineno-88-15" href="#__codelineno-88-15"></a><span class="kd">enum</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">Foo</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-88-16" name="__codelineno-88-16" href="#__codelineno-88-16"></a><span class="w"> </span><span class="cm">/** some KDoc */</span>
<a id="__codelineno-88-17" name="__codelineno-88-17" href="#__codelineno-88-17"></a><span class="w"> </span><span class="n">BAR</span>
<a id="__codelineno-88-18" name="__codelineno-88-18" href="#__codelineno-88-18"></a><span class="p">}</span>
<a id="__codelineno-88-19" name="__codelineno-88-19" href="#__codelineno-88-19"></a>
<a id="__codelineno-88-20" name="__codelineno-88-20" href="#__codelineno-88-20"></a><span class="cm">/** some KDoc */</span>
<a id="__codelineno-88-21" name="__codelineno-88-21" href="#__codelineno-88-21"></a><span class="kd">interface</span><span class="w"> </span><span class="nc">Foo</span>
<a id="__codelineno-88-22" name="__codelineno-88-22" href="#__codelineno-88-22"></a><span class="cm">/** some KDoc */</span>
<a id="__codelineno-88-23" name="__codelineno-88-23" href="#__codelineno-88-23"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span>
<a id="__codelineno-88-24" name="__codelineno-88-24" href="#__codelineno-88-24"></a><span class="cm">/** some KDoc */</span>
<a id="__codelineno-88-25" name="__codelineno-88-25" href="#__codelineno-88-25"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="p">:</span><span class="w"> </span><span class="n">Foo</span>
<a id="__codelineno-88-26" name="__codelineno-88-26" href="#__codelineno-88-26"></a><span class="cm">/** some KDoc */</span>
<a id="__codelineno-88-27" name="__codelineno-88-27" href="#__codelineno-88-27"></a><span class="kd">object</span><span class="w"> </span><span class="nc">foo</span><span class="p">:</span><span class="w"> </span><span class="n">Foo</span>
<a id="__codelineno-88-28" name="__codelineno-88-28" href="#__codelineno-88-28"></a><span class="cm">/** some KDoc */</span>
<a id="__codelineno-88-29" name="__codelineno-88-29" href="#__codelineno-88-29"></a><span class="k">typealias</span><span class="w"> </span><span class="n">FooBar</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="n">Foo</span><span class="p">)</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">Bar</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-89-1" name="__codelineno-89-1" href="#__codelineno-89-1"></a><span class="cm">/**</span>
<a id="__codelineno-89-2" name="__codelineno-89-2" href="#__codelineno-89-2"></a><span class="cm"> * Some dangling Kdoc (e.g. not followed by a declaration)</span>
<a id="__codelineno-89-3" name="__codelineno-89-3" href="#__codelineno-89-3"></a><span class="cm"> */</span>
<a id="__codelineno-89-4" name="__codelineno-89-4" href="#__codelineno-89-4"></a>
<a id="__codelineno-89-5" name="__codelineno-89-5" href="#__codelineno-89-5"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="cm">/** Some KDoc */</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo&quot;</span>
<a id="__codelineno-89-6" name="__codelineno-89-6" href="#__codelineno-89-6"></a>
<a id="__codelineno-89-7" name="__codelineno-89-7" href="#__codelineno-89-7"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo</span><span class="p">(</span>
<a id="__codelineno-89-8" name="__codelineno-89-8" href="#__codelineno-89-8"></a><span class="w"> </span><span class="cm">/** some dangling KDoc inside a parameter list */</span>
<a id="__codelineno-89-9" name="__codelineno-89-9" href="#__codelineno-89-9"></a><span class="p">)</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:kdoc</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-90-1" name="__codelineno-90-1" href="#__codelineno-90-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:kdoc&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-91-1" name="__codelineno-91-1" href="#__codelineno-91-1"></a>ktlint_standard_kdoc = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-92-1" name="__codelineno-92-1" href="#__codelineno-92-1"></a>ktlint_standard_kdoc = disabled
</code></pre></div></li>
</ol>
<h2 id="mixed-condition-operators">Mixed condition operators<a class="headerlink" href="#mixed-condition-operators" title="Permanent link">&para;</a></h2>
<p>Conditions cannot use both <code>&amp;&amp;</code> and <code>||</code> operators between operators at the same level. By using parenthesis the expression is to be clarified.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="18:2"><input checked="checked" id="__tabbed_18_1" name="__tabbed_18" type="radio" /><input id="__tabbed_18_2" name="__tabbed_18" type="radio" /><div class="tabbed-labels"><label for="__tabbed_18_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_18_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-93-1" name="__codelineno-93-1" href="#__codelineno-93-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">bar1</span><span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="p">(</span><span class="n">bar2</span><span class="w"> </span><span class="o">||</span><span class="w"> </span><span class="n">bar3</span><span class="p">)</span><span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="n">bar4</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-94-1" name="__codelineno-94-1" href="#__codelineno-94-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">bar1</span><span class="w"> </span><span class="o">&amp;&amp;</span>
<a id="__codelineno-94-2" name="__codelineno-94-2" href="#__codelineno-94-2"></a><span class="w"> </span><span class="n">bar2</span><span class="w"> </span><span class="o">||</span>
<a id="__codelineno-94-3" name="__codelineno-94-3" href="#__codelineno-94-3"></a><span class="w"> </span><span class="n">bar3</span>
<a id="__codelineno-94-4" name="__codelineno-94-4" href="#__codelineno-94-4"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">bar1</span><span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="p">(</span><span class="n">bar2</span><span class="w"> </span><span class="o">||</span><span class="w"> </span><span class="n">bar3</span><span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="n">bar4</span><span class="p">)</span><span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="n">bar5</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:mixed-condition-operators</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-95-1" name="__codelineno-95-1" href="#__codelineno-95-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:mixed-condition-operators&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-96-1" name="__codelineno-96-1" href="#__codelineno-96-1"></a>ktlint_standard_mixed-condition-operators = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-97-1" name="__codelineno-97-1" href="#__codelineno-97-1"></a>ktlint_standard_mixed-condition-operators = disabled
</code></pre></div></li>
</ol>
<h2 id="naming">Naming<a class="headerlink" href="#naming" title="Permanent link">&para;</a></h2>
<h3 id="backing-property-naming">Backing property naming<a class="headerlink" href="#backing-property-naming" title="Permanent link">&para;</a></h3>
<p>Allows property names to start with <code>_</code> in case the property is a backing property. <code>ktlint_official</code> and <code>android_studio</code> code styles require the correlated property/function to be defined as <code>public</code>.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="19:2"><input checked="checked" id="__tabbed_19_1" name="__tabbed_19" type="radio" /><input id="__tabbed_19_2" name="__tabbed_19" type="radio" /><div class="tabbed-labels"><label for="__tabbed_19_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_19_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-98-1" name="__codelineno-98-1" href="#__codelineno-98-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Bar</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-98-2" name="__codelineno-98-2" href="#__codelineno-98-2"></a><span class="w"> </span><span class="c1">// Backing property as normal class member</span>
<a id="__codelineno-98-3" name="__codelineno-98-3" href="#__codelineno-98-3"></a><span class="w"> </span><span class="kd">private</span><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">_elementList</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">mutableListOf</span><span class="o">&lt;</span><span class="n">Element</span><span class="o">&gt;</span><span class="p">()</span>
<a id="__codelineno-98-4" name="__codelineno-98-4" href="#__codelineno-98-4"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">elementList</span><span class="p">:</span><span class="w"> </span><span class="n">List</span><span class="o">&lt;</span><span class="n">Element</span><span class="o">&gt;</span>
<a id="__codelineno-98-5" name="__codelineno-98-5" href="#__codelineno-98-5"></a><span class="w"> </span><span class="k">get</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">_elementList</span>
<a id="__codelineno-98-6" name="__codelineno-98-6" href="#__codelineno-98-6"></a>
<a id="__codelineno-98-7" name="__codelineno-98-7" href="#__codelineno-98-7"></a><span class="w"> </span><span class="c1">// Backing property defined in companion object</span>
<a id="__codelineno-98-8" name="__codelineno-98-8" href="#__codelineno-98-8"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">elementList2</span><span class="p">:</span><span class="w"> </span><span class="n">List</span><span class="o">&lt;</span><span class="n">Element</span><span class="o">&gt;</span>
<a id="__codelineno-98-9" name="__codelineno-98-9" href="#__codelineno-98-9"></a><span class="w"> </span><span class="k">get</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">_elementList2</span>
<a id="__codelineno-98-10" name="__codelineno-98-10" href="#__codelineno-98-10"></a>
<a id="__codelineno-98-11" name="__codelineno-98-11" href="#__codelineno-98-11"></a><span class="w"> </span><span class="kd">companion</span><span class="w"> </span><span class="kd">object</span><span class="w"> </span><span class="err">{</span>
<a id="__codelineno-98-12" name="__codelineno-98-12" href="#__codelineno-98-12"></a><span class="w"> </span><span class="kd">private</span><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">_elementList2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">mutableListOf</span><span class="o">&lt;</span><span class="n">Element</span><span class="o">&gt;</span><span class="p">()</span>
<a id="__codelineno-98-13" name="__codelineno-98-13" href="#__codelineno-98-13"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-98-14" name="__codelineno-98-14" href="#__codelineno-98-14"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-99-1" name="__codelineno-99-1" href="#__codelineno-99-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Bar</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-99-2" name="__codelineno-99-2" href="#__codelineno-99-2"></a><span class="w"> </span><span class="c1">// Incomplete backing property as public property &#39;elementList1&#39; is missing</span>
<a id="__codelineno-99-3" name="__codelineno-99-3" href="#__codelineno-99-3"></a><span class="w"> </span><span class="kd">private</span><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">_elementList1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">mutableListOf</span><span class="o">&lt;</span><span class="n">Element</span><span class="o">&gt;</span><span class="p">()</span>
<a id="__codelineno-99-4" name="__codelineno-99-4" href="#__codelineno-99-4"></a>
<a id="__codelineno-99-5" name="__codelineno-99-5" href="#__codelineno-99-5"></a><span class="w"> </span><span class="c1">// Invalid backing property as &#39;_elementList2&#39; is not a private property</span>
<a id="__codelineno-99-6" name="__codelineno-99-6" href="#__codelineno-99-6"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">_elementList2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">mutableListOf</span><span class="o">&lt;</span><span class="n">Element</span><span class="o">&gt;</span><span class="p">()</span>
<a id="__codelineno-99-7" name="__codelineno-99-7" href="#__codelineno-99-7"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">elementList2</span><span class="p">:</span><span class="w"> </span><span class="n">List</span><span class="o">&lt;</span><span class="n">Element</span><span class="o">&gt;</span>
<a id="__codelineno-99-8" name="__codelineno-99-8" href="#__codelineno-99-8"></a><span class="w"> </span><span class="k">get</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">_elementList2</span>
<a id="__codelineno-99-9" name="__codelineno-99-9" href="#__codelineno-99-9"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:backing-property-naming</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-100-1" name="__codelineno-100-1" href="#__codelineno-100-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:backing-property-naming&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-101-1" name="__codelineno-101-1" href="#__codelineno-101-1"></a>ktlint_standard_backing-property-naming = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-102-1" name="__codelineno-102-1" href="#__codelineno-102-1"></a>ktlint_standard_backing-property-naming = disabled
</code></pre></div></li>
</ol>
<h3 id="class-naming">Class naming<a class="headerlink" href="#class-naming" title="Permanent link">&para;</a></h3>
<p>Enforce naming of class and objects.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="20:3"><input checked="checked" id="__tabbed_20_1" name="__tabbed_20" type="radio" /><input id="__tabbed_20_2" name="__tabbed_20" type="radio" /><input id="__tabbed_20_3" name="__tabbed_20" type="radio" /><div class="tabbed-labels"><label for="__tabbed_20_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_20_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint JUnit Test</label><label for="__tabbed_20_3"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-103-1" name="__codelineno-103-1" href="#__codelineno-103-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo</span>
<a id="__codelineno-103-2" name="__codelineno-103-2" href="#__codelineno-103-2"></a>
<a id="__codelineno-103-3" name="__codelineno-103-3" href="#__codelineno-103-3"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo1</span>
<a id="__codelineno-103-4" name="__codelineno-103-4" href="#__codelineno-103-4"></a>
<a id="__codelineno-103-5" name="__codelineno-103-5" href="#__codelineno-103-5"></a><span class="kd">class</span><span class="w"> </span><span class="nc">`class`</span><span class="w"> </span><span class="c1">// Any keyword is allowed when wrapped between backticks</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-104-1" name="__codelineno-104-1" href="#__codelineno-104-1"></a><span class="nd">@Nested</span>
<a id="__codelineno-104-2" name="__codelineno-104-2" href="#__codelineno-104-2"></a><span class="kd">inner</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">`Some descriptive class name`</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-104-3" name="__codelineno-104-3" href="#__codelineno-104-3"></a><span class="w"> </span><span class="nd">@Test</span>
<a id="__codelineno-104-4" name="__codelineno-104-4" href="#__codelineno-104-4"></a><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">`Some descriptive test name`</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-104-5" name="__codelineno-104-5" href="#__codelineno-104-5"></a><span class="w"> </span><span class="c1">// do something</span>
<a id="__codelineno-104-6" name="__codelineno-104-6" href="#__codelineno-104-6"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-104-7" name="__codelineno-104-7" href="#__codelineno-104-7"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-105-1" name="__codelineno-105-1" href="#__codelineno-105-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">foo</span>
<a id="__codelineno-105-2" name="__codelineno-105-2" href="#__codelineno-105-2"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo_Bar</span>
<a id="__codelineno-105-3" name="__codelineno-105-3" href="#__codelineno-105-3"></a><span class="kd">class</span><span class="w"> </span><span class="nc">`Some class in the production code`</span>
</code></pre></div>
</div>
</div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Functions in files which import a class from package <code>org.junit.jupiter.api</code> are considered to be test functions and are allowed to have a name specified between backticks and do not need to adhere to the normal naming convention. Although, the <a href="https://kotlinlang.org/docs/coding-conventions.html">Kotlin coding conventions</a> does not allow this explicitly for class identifiers, <code>ktlint</code> does allow it.</p>
</div>
<p>This rule can also be suppressed with the IntelliJ IDEA inspection suppression <code>ClassName</code>.</p>
<p>Rule id: <code>standard:class-naming</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-106-1" name="__codelineno-106-1" href="#__codelineno-106-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:class-naming&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-107-1" name="__codelineno-107-1" href="#__codelineno-107-1"></a>ktlint_standard_class-naming = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-108-1" name="__codelineno-108-1" href="#__codelineno-108-1"></a>ktlint_standard_class-naming = disabled
</code></pre></div></li>
</ol>
<h3 id="function-naming">Function naming<a class="headerlink" href="#function-naming" title="Permanent link">&para;</a></h3>
<p>Enforce naming of function.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="21:3"><input checked="checked" id="__tabbed_21_1" name="__tabbed_21" type="radio" /><input id="__tabbed_21_2" name="__tabbed_21" type="radio" /><input id="__tabbed_21_3" name="__tabbed_21" type="radio" /><div class="tabbed-labels"><label for="__tabbed_21_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_21_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint Test</label><label for="__tabbed_21_3"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-109-1" name="__codelineno-109-1" href="#__codelineno-109-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
<a id="__codelineno-109-2" name="__codelineno-109-2" href="#__codelineno-109-2"></a>
<a id="__codelineno-109-3" name="__codelineno-109-3" href="#__codelineno-109-3"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">fooBar</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
<a id="__codelineno-109-4" name="__codelineno-109-4" href="#__codelineno-109-4"></a>
<a id="__codelineno-109-5" name="__codelineno-109-5" href="#__codelineno-109-5"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">`fun`</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span><span class="w"> </span><span class="c1">// Any keyword is allowed when wrapped between backticks</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-110-1" name="__codelineno-110-1" href="#__codelineno-110-1"></a><span class="nd">@Test</span>
<a id="__codelineno-110-2" name="__codelineno-110-2" href="#__codelineno-110-2"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">`Some name`</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
<a id="__codelineno-110-3" name="__codelineno-110-3" href="#__codelineno-110-3"></a>
<a id="__codelineno-110-4" name="__codelineno-110-4" href="#__codelineno-110-4"></a><span class="nd">@Test</span>
<a id="__codelineno-110-5" name="__codelineno-110-5" href="#__codelineno-110-5"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">do_something</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-111-1" name="__codelineno-111-1" href="#__codelineno-111-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">Foo</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
<a id="__codelineno-111-2" name="__codelineno-111-2" href="#__codelineno-111-2"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">Foo_Bar</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
<a id="__codelineno-111-3" name="__codelineno-111-3" href="#__codelineno-111-3"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">`Some name`</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
<a id="__codelineno-111-4" name="__codelineno-111-4" href="#__codelineno-111-4"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">do_something</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>ktlint_function_naming_ignore_when_annotated_with</code></br><i>Ignore functions that are annotated with values in this setting. This value is a comma separated list of names without the '@' prefix.</i></td>
<td style="text-align: center;"><code>unset</code></td>
<td style="text-align: center;"><code>unset</code></td>
<td style="text-align: center;"><code>unset</code></td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>When using Compose, you might want to configure the <code>function-naming</code> rule with <code>.editorconfig</code> property <code>ktlint_function_naming_ignore_when_annotated_with=Composable</code>. Furthermore, you can use a dedicated ktlint ruleset like <a href="https://mrmans0n.github.io/compose-rules/ktlint/">Compose Rules</a> for checking naming conventions for Composable functions. </p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Functions in files which import a class from package <code>io.kotest</code>, <code>junit.framework</code>, <code>kotlin.test</code>, <code>org.junit</code>, or <code>org.testng</code> are considered to be test functions. Functions in such classes are allowed to have underscores in the name. Also, function names enclosed between backticks do not need to adhere to the normal naming convention.</p>
</div>
<p>This rule can also be suppressed with the IntelliJ IDEA inspection suppression <code>FunctionName</code>.</p>
<p>Rule id: <code>standard:function-naming</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-112-1" name="__codelineno-112-1" href="#__codelineno-112-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:function-naming&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-113-1" name="__codelineno-113-1" href="#__codelineno-113-1"></a>ktlint_standard_function-naming = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-114-1" name="__codelineno-114-1" href="#__codelineno-114-1"></a>ktlint_standard_function-naming = disabled
</code></pre></div></li>
</ol>
<h3 id="package-name">Package name<a class="headerlink" href="#package-name" title="Permanent link">&para;</a></h3>
<p>Validates that the package name matches the regular expression <code>[a-z][a-zA-Z\d]*(\.[a-z][a-zA-Z\d]*)*</code>.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="22:2"><input checked="checked" id="__tabbed_22_1" name="__tabbed_22" type="radio" /><input id="__tabbed_22_2" name="__tabbed_22" type="radio" /><div class="tabbed-labels"><label for="__tabbed_22_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_22_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-115-1" name="__codelineno-115-1" href="#__codelineno-115-1"></a><span class="k">package</span><span class="w"> </span><span class="nn">foo</span>
<a id="__codelineno-115-2" name="__codelineno-115-2" href="#__codelineno-115-2"></a><span class="k">package</span><span class="w"> </span><span class="nn">foo.bar</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-116-1" name="__codelineno-116-1" href="#__codelineno-116-1"></a><span class="k">package</span><span class="w"> </span><span class="nn">Foo</span>
<a id="__codelineno-116-2" name="__codelineno-116-2" href="#__codelineno-116-2"></a><span class="k">package</span><span class="w"> </span><span class="nn">foo.Foo</span>
<a id="__codelineno-116-3" name="__codelineno-116-3" href="#__codelineno-116-3"></a><span class="k">package</span><span class="w"> </span><span class="nn">`foo</span><span class="w"> </span><span class="n">bar</span><span class="err">`</span>
<a id="__codelineno-116-4" name="__codelineno-116-4" href="#__codelineno-116-4"></a><span class="k">package</span><span class="w"> </span><span class="nn">foo.`foo</span><span class="w"> </span><span class="n">bar</span><span class="err">`</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:package-name</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-117-1" name="__codelineno-117-1" href="#__codelineno-117-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:package-name&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-118-1" name="__codelineno-118-1" href="#__codelineno-118-1"></a>ktlint_standard_package-name = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-119-1" name="__codelineno-119-1" href="#__codelineno-119-1"></a>ktlint_standard_package-name = disabled
</code></pre></div></li>
</ol>
<h3 id="property-naming">Property naming<a class="headerlink" href="#property-naming" title="Permanent link">&para;</a></h3>
<p>Enforce naming of property.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This rule can not reliably detect all situations in which incorrect property naming is used. So it only detects in which it is certain that naming is incorrect.</p>
</div>
<div class="tabbed-set tabbed-alternate" data-tabs="23:2"><input checked="checked" id="__tabbed_23_1" name="__tabbed_23" type="radio" /><input id="__tabbed_23_2" name="__tabbed_23" type="radio" /><div class="tabbed-labels"><label for="__tabbed_23_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_23_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-120-1" name="__codelineno-120-1" href="#__codelineno-120-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Foo</span><span class="p">()</span><span class="w"> </span><span class="c1">// In case developers want to tell that Foo is mutable</span>
<a id="__codelineno-120-2" name="__codelineno-120-2" href="#__codelineno-120-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">FOO1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Foo</span><span class="p">()</span><span class="w"> </span><span class="c1">// In case developers want to tell that Foo is deeply immutable</span>
<a id="__codelineno-120-3" name="__codelineno-120-3" href="#__codelineno-120-3"></a>
<a id="__codelineno-120-4" name="__codelineno-120-4" href="#__codelineno-120-4"></a><span class="kd">const</span><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">FOO_BAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;FOO-BAR&quot;</span><span class="w"> </span><span class="c1">// By definition deeply immutable</span>
<a id="__codelineno-120-5" name="__codelineno-120-5" href="#__codelineno-120-5"></a>
<a id="__codelineno-120-6" name="__codelineno-120-6" href="#__codelineno-120-6"></a><span class="kd">var</span><span class="w"> </span><span class="nv">foo2</span><span class="p">:</span><span class="w"> </span><span class="n">Foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Foo</span><span class="p">()</span><span class="w"> </span><span class="c1">// By definition not immutable</span>
<a id="__codelineno-120-7" name="__codelineno-120-7" href="#__codelineno-120-7"></a>
<a id="__codelineno-120-8" name="__codelineno-120-8" href="#__codelineno-120-8"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Bar</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-120-9" name="__codelineno-120-9" href="#__codelineno-120-9"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo1&quot;</span><span class="w"> </span><span class="c1">// Class properties always start with lowercase, const is not allowed</span>
<a id="__codelineno-120-10" name="__codelineno-120-10" href="#__codelineno-120-10"></a>
<a id="__codelineno-120-11" name="__codelineno-120-11" href="#__codelineno-120-11"></a><span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">FOO_BAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;FOO-BAR&quot;</span><span class="w"> </span><span class="c1">// By definition deeply immutable</span>
<a id="__codelineno-120-12" name="__codelineno-120-12" href="#__codelineno-120-12"></a>
<a id="__codelineno-120-13" name="__codelineno-120-13" href="#__codelineno-120-13"></a><span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nv">foo2</span><span class="p">:</span><span class="w"> </span><span class="n">Foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Foo</span><span class="p">()</span><span class="w"> </span><span class="c1">// By definition not immutable</span>
<a id="__codelineno-120-14" name="__codelineno-120-14" href="#__codelineno-120-14"></a>
<a id="__codelineno-120-15" name="__codelineno-120-15" href="#__codelineno-120-15"></a><span class="w"> </span><span class="c1">// Backing property</span>
<a id="__codelineno-120-16" name="__codelineno-120-16" href="#__codelineno-120-16"></a><span class="w"> </span><span class="kd">private</span><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">_elementList</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">mutableListOf</span><span class="o">&lt;</span><span class="n">Element</span><span class="o">&gt;</span><span class="p">()</span>
<a id="__codelineno-120-17" name="__codelineno-120-17" href="#__codelineno-120-17"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">elementList</span><span class="p">:</span><span class="w"> </span><span class="n">List</span><span class="o">&lt;</span><span class="n">Element</span><span class="o">&gt;</span>
<a id="__codelineno-120-18" name="__codelineno-120-18" href="#__codelineno-120-18"></a><span class="w"> </span><span class="k">get</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">_elementList</span>
<a id="__codelineno-120-19" name="__codelineno-120-19" href="#__codelineno-120-19"></a>
<a id="__codelineno-120-20" name="__codelineno-120-20" href="#__codelineno-120-20"></a><span class="w"> </span><span class="kd">companion</span><span class="w"> </span><span class="kd">object</span><span class="w"> </span><span class="err">{</span>
<a id="__codelineno-120-21" name="__codelineno-120-21" href="#__codelineno-120-21"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Foo</span><span class="p">()</span><span class="w"> </span><span class="c1">// In case developer want to communicate that Foo is mutable</span>
<a id="__codelineno-120-22" name="__codelineno-120-22" href="#__codelineno-120-22"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">FOO1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Foo</span><span class="p">()</span><span class="w"> </span><span class="c1">// In case developer want to communicate that Foo is deeply immutable</span>
<a id="__codelineno-120-23" name="__codelineno-120-23" href="#__codelineno-120-23"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-120-24" name="__codelineno-120-24" href="#__codelineno-120-24"></a><span class="p">}</span>
<a id="__codelineno-120-25" name="__codelineno-120-25" href="#__codelineno-120-25"></a>
<a id="__codelineno-120-26" name="__codelineno-120-26" href="#__codelineno-120-26"></a><span class="kd">var</span><span class="w"> </span><span class="nv">`package`</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo&quot;</span><span class="w"> </span><span class="c1">// Any keyword is allowed when wrapped between backticks</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-121-1" name="__codelineno-121-1" href="#__codelineno-121-1"></a><span class="kd">const</span><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">fooBar</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;FOO-BAR&quot;</span><span class="w"> </span><span class="c1">// By definition deeply immutable</span>
<a id="__codelineno-121-2" name="__codelineno-121-2" href="#__codelineno-121-2"></a>
<a id="__codelineno-121-3" name="__codelineno-121-3" href="#__codelineno-121-3"></a><span class="kd">var</span><span class="w"> </span><span class="nv">FOO2</span><span class="p">:</span><span class="w"> </span><span class="n">Foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Foo</span><span class="p">()</span><span class="w"> </span><span class="c1">// By definition not immutable</span>
<a id="__codelineno-121-4" name="__codelineno-121-4" href="#__codelineno-121-4"></a>
<a id="__codelineno-121-5" name="__codelineno-121-5" href="#__codelineno-121-5"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Bar</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-121-6" name="__codelineno-121-6" href="#__codelineno-121-6"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">FOO_BAR</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;FOO-BAR&quot;</span><span class="w"> </span><span class="c1">// Class properties always start with lowercase, const is not allowed</span>
<a id="__codelineno-121-7" name="__codelineno-121-7" href="#__codelineno-121-7"></a>
<a id="__codelineno-121-8" name="__codelineno-121-8" href="#__codelineno-121-8"></a><span class="w"> </span><span class="c1">// Incomplete backing property as public property &#39;elementList1&#39; is missing</span>
<a id="__codelineno-121-9" name="__codelineno-121-9" href="#__codelineno-121-9"></a><span class="w"> </span><span class="kd">private</span><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">_elementList1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">mutableListOf</span><span class="o">&lt;</span><span class="n">Element</span><span class="o">&gt;</span><span class="p">()</span>
<a id="__codelineno-121-10" name="__codelineno-121-10" href="#__codelineno-121-10"></a>
<a id="__codelineno-121-11" name="__codelineno-121-11" href="#__codelineno-121-11"></a><span class="w"> </span><span class="c1">// Invalid backing property as &#39;_elementList2&#39; is not a private property</span>
<a id="__codelineno-121-12" name="__codelineno-121-12" href="#__codelineno-121-12"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">_elementList2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">mutableListOf</span><span class="o">&lt;</span><span class="n">Element</span><span class="o">&gt;</span><span class="p">()</span>
<a id="__codelineno-121-13" name="__codelineno-121-13" href="#__codelineno-121-13"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">elementList2</span><span class="p">:</span><span class="w"> </span><span class="n">List</span><span class="o">&lt;</span><span class="n">Element</span><span class="o">&gt;</span>
<a id="__codelineno-121-14" name="__codelineno-121-14" href="#__codelineno-121-14"></a><span class="w"> </span><span class="k">get</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">_elementList2</span>
<a id="__codelineno-121-15" name="__codelineno-121-15" href="#__codelineno-121-15"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>This rule is suppressed whenever the IntelliJ IDEA inspection suppression <code>PropertyName</code>, <code>ConstPropertyName</code>, <code>ObjectPropertyName</code> or <code>PrivatePropertyName</code> is used.</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>ktlint_property_naming_constant_naming</code><br/><i>The naming style ('screaming_snake_case', or 'pascal_case') to be applied on constant properties.</i></td>
<td style="text-align: center;"><code>screaming_snake_case</code></td>
<td style="text-align: center;"><code>screaming_snake_case</code></td>
<td style="text-align: center;"><code>screaming_snake_case</code></td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>When using Compose, you might want to configure the <code>property-naming</code> rule with <code>.editorconfig</code> property <code>ktlint_property_naming_constant_naming = pascal_case</code>.</p>
</div>
<p>Rule id: <code>standard:property-naming</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-122-1" name="__codelineno-122-1" href="#__codelineno-122-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:property-naming&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-123-1" name="__codelineno-123-1" href="#__codelineno-123-1"></a>ktlint_standard_property-naming = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-124-1" name="__codelineno-124-1" href="#__codelineno-124-1"></a>ktlint_standard_property-naming = disabled
</code></pre></div></li>
</ol>
<h2 id="no-blank-lines-in-list">No blank lines in list<a class="headerlink" href="#no-blank-lines-in-list" title="Permanent link">&para;</a></h2>
<p>Disallow blank lines to be used in lists before the first element, between elements, and after the last element.</p>
<p><em>Super type</em></p>
<div class="tabbed-set tabbed-alternate" data-tabs="24:2"><input checked="checked" id="__tabbed_24_1" name="__tabbed_24" type="radio" /><input id="__tabbed_24_2" name="__tabbed_24" type="radio" /><div class="tabbed-labels"><label for="__tabbed_24_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_24_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-125-1" name="__codelineno-125-1" href="#__codelineno-125-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">FooBar</span><span class="w"> </span><span class="p">:</span>
<a id="__codelineno-125-2" name="__codelineno-125-2" href="#__codelineno-125-2"></a><span class="w"> </span><span class="n">Foo</span><span class="p">,</span>
<a id="__codelineno-125-3" name="__codelineno-125-3" href="#__codelineno-125-3"></a><span class="w"> </span><span class="n">Bar</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-125-4" name="__codelineno-125-4" href="#__codelineno-125-4"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-125-5" name="__codelineno-125-5" href="#__codelineno-125-5"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-126-1" name="__codelineno-126-1" href="#__codelineno-126-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">FooBar</span><span class="w"> </span><span class="p">:</span>
<a id="__codelineno-126-2" name="__codelineno-126-2" href="#__codelineno-126-2"></a>
<a id="__codelineno-126-3" name="__codelineno-126-3" href="#__codelineno-126-3"></a><span class="w"> </span><span class="n">Foo</span><span class="p">,</span>
<a id="__codelineno-126-4" name="__codelineno-126-4" href="#__codelineno-126-4"></a>
<a id="__codelineno-126-5" name="__codelineno-126-5" href="#__codelineno-126-5"></a><span class="w"> </span><span class="n">Bar</span>
<a id="__codelineno-126-6" name="__codelineno-126-6" href="#__codelineno-126-6"></a>
<a id="__codelineno-126-7" name="__codelineno-126-7" href="#__codelineno-126-7"></a><span class="p">{</span>
<a id="__codelineno-126-8" name="__codelineno-126-8" href="#__codelineno-126-8"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-126-9" name="__codelineno-126-9" href="#__codelineno-126-9"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p><em>Type argument list</em></p>
<div class="tabbed-set tabbed-alternate" data-tabs="25:2"><input checked="checked" id="__tabbed_25_1" name="__tabbed_25" type="radio" /><input id="__tabbed_25_2" name="__tabbed_25" type="radio" /><div class="tabbed-labels"><label for="__tabbed_25_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_25_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-127-1" name="__codelineno-127-1" href="#__codelineno-127-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foobar</span><span class="p">:</span><span class="w"> </span><span class="n">FooBar</span><span class="o">&lt;</span>
<a id="__codelineno-127-2" name="__codelineno-127-2" href="#__codelineno-127-2"></a><span class="w"> </span><span class="n">Foo</span><span class="p">,</span>
<a id="__codelineno-127-3" name="__codelineno-127-3" href="#__codelineno-127-3"></a><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-127-4" name="__codelineno-127-4" href="#__codelineno-127-4"></a><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">FooBar</span><span class="p">(</span><span class="n">Foo</span><span class="p">(),</span><span class="w"> </span><span class="n">Bar</span><span class="p">())</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-128-1" name="__codelineno-128-1" href="#__codelineno-128-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foobar</span><span class="p">:</span><span class="w"> </span><span class="n">FooBar</span><span class="o">&lt;</span>
<a id="__codelineno-128-2" name="__codelineno-128-2" href="#__codelineno-128-2"></a>
<a id="__codelineno-128-3" name="__codelineno-128-3" href="#__codelineno-128-3"></a><span class="w"> </span><span class="n">Foo</span><span class="p">,</span>
<a id="__codelineno-128-4" name="__codelineno-128-4" href="#__codelineno-128-4"></a>
<a id="__codelineno-128-5" name="__codelineno-128-5" href="#__codelineno-128-5"></a><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-128-6" name="__codelineno-128-6" href="#__codelineno-128-6"></a>
<a id="__codelineno-128-7" name="__codelineno-128-7" href="#__codelineno-128-7"></a><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">FooBar</span><span class="p">(</span><span class="n">Foo</span><span class="p">(),</span><span class="w"> </span><span class="n">Bar</span><span class="p">())</span>
</code></pre></div>
</div>
</div>
</div>
<p><em>Type constraint list</em></p>
<div class="tabbed-set tabbed-alternate" data-tabs="26:2"><input checked="checked" id="__tabbed_26_1" name="__tabbed_26" type="radio" /><input id="__tabbed_26_2" name="__tabbed_26" type="radio" /><div class="tabbed-labels"><label for="__tabbed_26_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_26_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-129-1" name="__codelineno-129-1" href="#__codelineno-129-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">BiAdapter</span><span class="o">&lt;</span><span class="n">C</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">RecyclerView</span><span class="p">.</span><span class="na">ViewHolder</span><span class="p">,</span><span class="w"> </span><span class="n">V1</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">C</span><span class="p">,</span><span class="w"> </span><span class="n">V2</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">C</span><span class="p">,</span><span class="w"> </span><span class="k">out</span><span class="w"> </span><span class="n">A1</span><span class="p">,</span><span class="w"> </span><span class="k">out</span><span class="w"> </span><span class="n">A2</span><span class="o">&gt;</span><span class="p">(</span>
<a id="__codelineno-129-2" name="__codelineno-129-2" href="#__codelineno-129-2"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">adapter1</span><span class="p">:</span><span class="w"> </span><span class="n">A1</span><span class="p">,</span>
<a id="__codelineno-129-3" name="__codelineno-129-3" href="#__codelineno-129-3"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">adapter2</span><span class="p">:</span><span class="w"> </span><span class="n">A2</span><span class="p">,</span>
<a id="__codelineno-129-4" name="__codelineno-129-4" href="#__codelineno-129-4"></a><span class="p">)</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">RecyclerView</span><span class="p">.</span><span class="na">Adapter</span><span class="o">&lt;</span><span class="n">C</span><span class="o">&gt;</span><span class="p">()</span>
<a id="__codelineno-129-5" name="__codelineno-129-5" href="#__codelineno-129-5"></a><span class="w"> </span><span class="k">where</span><span class="w"> </span><span class="n">A1</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">RecyclerView</span><span class="p">.</span><span class="na">Adapter</span><span class="o">&lt;</span><span class="n">V1</span><span class="o">&gt;</span><span class="p">,</span><span class="w"> </span><span class="n">A1</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">ComposableAdapter</span><span class="p">.</span><span class="na">ViewTypeProvider</span><span class="p">,</span>
<a id="__codelineno-129-6" name="__codelineno-129-6" href="#__codelineno-129-6"></a><span class="w"> </span><span class="n">A2</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">RecyclerView</span><span class="p">.</span><span class="na">Adapter</span><span class="o">&lt;</span><span class="n">V2</span><span class="o">&gt;</span><span class="p">,</span><span class="w"> </span><span class="n">A2</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">ComposableAdapter</span><span class="p">.</span><span class="na">ViewTypeProvider</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-129-7" name="__codelineno-129-7" href="#__codelineno-129-7"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-129-8" name="__codelineno-129-8" href="#__codelineno-129-8"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-130-1" name="__codelineno-130-1" href="#__codelineno-130-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">BiAdapter</span><span class="o">&lt;</span><span class="n">C</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">RecyclerView</span><span class="p">.</span><span class="na">ViewHolder</span><span class="p">,</span><span class="w"> </span><span class="n">V1</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">C</span><span class="p">,</span><span class="w"> </span><span class="n">V2</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">C</span><span class="p">,</span><span class="w"> </span><span class="k">out</span><span class="w"> </span><span class="n">A1</span><span class="p">,</span><span class="w"> </span><span class="k">out</span><span class="w"> </span><span class="n">A2</span><span class="o">&gt;</span><span class="p">(</span>
<a id="__codelineno-130-2" name="__codelineno-130-2" href="#__codelineno-130-2"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">adapter1</span><span class="p">:</span><span class="w"> </span><span class="n">A1</span><span class="p">,</span>
<a id="__codelineno-130-3" name="__codelineno-130-3" href="#__codelineno-130-3"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">adapter2</span><span class="p">:</span><span class="w"> </span><span class="n">A2</span>
<a id="__codelineno-130-4" name="__codelineno-130-4" href="#__codelineno-130-4"></a><span class="p">)</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">RecyclerView</span><span class="p">.</span><span class="na">Adapter</span><span class="o">&lt;</span><span class="n">C</span><span class="o">&gt;</span><span class="p">()</span>
<a id="__codelineno-130-5" name="__codelineno-130-5" href="#__codelineno-130-5"></a><span class="w"> </span><span class="k">where</span>
<a id="__codelineno-130-6" name="__codelineno-130-6" href="#__codelineno-130-6"></a><span class="w"> </span><span class="n">A1</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">RecyclerView</span><span class="p">.</span><span class="na">Adapter</span><span class="o">&lt;</span><span class="n">V1</span><span class="o">&gt;</span><span class="p">,</span><span class="w"> </span><span class="n">A1</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">ComposableAdapter</span><span class="p">.</span><span class="na">ViewTypeProvider</span><span class="p">,</span>
<a id="__codelineno-130-7" name="__codelineno-130-7" href="#__codelineno-130-7"></a>
<a id="__codelineno-130-8" name="__codelineno-130-8" href="#__codelineno-130-8"></a><span class="w"> </span><span class="n">A2</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">RecyclerView</span><span class="p">.</span><span class="na">Adapter</span><span class="o">&lt;</span><span class="n">V2</span><span class="o">&gt;</span><span class="p">,</span><span class="w"> </span><span class="n">A2</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">ComposableAdapter</span><span class="p">.</span><span class="na">ViewTypeProvider</span>
<a id="__codelineno-130-9" name="__codelineno-130-9" href="#__codelineno-130-9"></a><span class="p">{</span>
<a id="__codelineno-130-10" name="__codelineno-130-10" href="#__codelineno-130-10"></a><span class="w"> </span><span class="c1">// body</span>
<a id="__codelineno-130-11" name="__codelineno-130-11" href="#__codelineno-130-11"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p><em>Type parameter list</em></p>
<div class="tabbed-set tabbed-alternate" data-tabs="27:2"><input checked="checked" id="__tabbed_27_1" name="__tabbed_27" type="radio" /><input id="__tabbed_27_2" name="__tabbed_27" type="radio" /><div class="tabbed-labels"><label for="__tabbed_27_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_27_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-131-1" name="__codelineno-131-1" href="#__codelineno-131-1"></a><span class="kd">fun</span><span class="w"> </span><span class="o">&lt;</span>
<a id="__codelineno-131-2" name="__codelineno-131-2" href="#__codelineno-131-2"></a><span class="w"> </span><span class="n">Foo</span><span class="p">,</span>
<a id="__codelineno-131-3" name="__codelineno-131-3" href="#__codelineno-131-3"></a><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-131-4" name="__codelineno-131-4" href="#__codelineno-131-4"></a><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="nf">foobar</span><span class="p">()</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-132-1" name="__codelineno-132-1" href="#__codelineno-132-1"></a><span class="kd">fun</span><span class="w"> </span><span class="o">&lt;</span>
<a id="__codelineno-132-2" name="__codelineno-132-2" href="#__codelineno-132-2"></a>
<a id="__codelineno-132-3" name="__codelineno-132-3" href="#__codelineno-132-3"></a><span class="w"> </span><span class="n">Foo</span><span class="p">,</span>
<a id="__codelineno-132-4" name="__codelineno-132-4" href="#__codelineno-132-4"></a>
<a id="__codelineno-132-5" name="__codelineno-132-5" href="#__codelineno-132-5"></a><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-132-6" name="__codelineno-132-6" href="#__codelineno-132-6"></a>
<a id="__codelineno-132-7" name="__codelineno-132-7" href="#__codelineno-132-7"></a><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="nf">foobar</span><span class="p">()</span>
</code></pre></div>
</div>
</div>
</div>
<p><em>Value argument list</em></p>
<div class="tabbed-set tabbed-alternate" data-tabs="28:2"><input checked="checked" id="__tabbed_28_1" name="__tabbed_28" type="radio" /><input id="__tabbed_28_2" name="__tabbed_28" type="radio" /><div class="tabbed-labels"><label for="__tabbed_28_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_28_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-133-1" name="__codelineno-133-1" href="#__codelineno-133-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foobar</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-133-2" name="__codelineno-133-2" href="#__codelineno-133-2"></a><span class="w"> </span><span class="n">foobar</span><span class="p">(</span>
<a id="__codelineno-133-3" name="__codelineno-133-3" href="#__codelineno-133-3"></a><span class="w"> </span><span class="s">&quot;foo&quot;</span><span class="p">,</span>
<a id="__codelineno-133-4" name="__codelineno-133-4" href="#__codelineno-133-4"></a><span class="w"> </span><span class="s">&quot;bar&quot;</span><span class="p">,</span>
<a id="__codelineno-133-5" name="__codelineno-133-5" href="#__codelineno-133-5"></a><span class="w"> </span><span class="p">)</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-134-1" name="__codelineno-134-1" href="#__codelineno-134-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foobar</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>
<a id="__codelineno-134-2" name="__codelineno-134-2" href="#__codelineno-134-2"></a><span class="w"> </span><span class="n">foobar</span><span class="p">(</span>
<a id="__codelineno-134-3" name="__codelineno-134-3" href="#__codelineno-134-3"></a>
<a id="__codelineno-134-4" name="__codelineno-134-4" href="#__codelineno-134-4"></a><span class="w"> </span><span class="s">&quot;foo&quot;</span><span class="p">,</span>
<a id="__codelineno-134-5" name="__codelineno-134-5" href="#__codelineno-134-5"></a>
<a id="__codelineno-134-6" name="__codelineno-134-6" href="#__codelineno-134-6"></a><span class="w"> </span><span class="s">&quot;bar&quot;</span><span class="p">,</span>
<a id="__codelineno-134-7" name="__codelineno-134-7" href="#__codelineno-134-7"></a>
<a id="__codelineno-134-8" name="__codelineno-134-8" href="#__codelineno-134-8"></a><span class="w"> </span><span class="p">)</span>
</code></pre></div>
</div>
</div>
</div>
<p><em>Value parameter list</em></p>
<div class="tabbed-set tabbed-alternate" data-tabs="29:2"><input checked="checked" id="__tabbed_29_1" name="__tabbed_29" type="radio" /><input id="__tabbed_29_2" name="__tabbed_29" type="radio" /><div class="tabbed-labels"><label for="__tabbed_29_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_29_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-135-1" name="__codelineno-135-1" href="#__codelineno-135-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foobar</span><span class="p">(</span>
<a id="__codelineno-135-2" name="__codelineno-135-2" href="#__codelineno-135-2"></a><span class="w"> </span><span class="n">foo</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="p">,</span>
<a id="__codelineno-135-3" name="__codelineno-135-3" href="#__codelineno-135-3"></a><span class="w"> </span><span class="n">bar</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="p">,</span>
<a id="__codelineno-135-4" name="__codelineno-135-4" href="#__codelineno-135-4"></a><span class="p">)</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-136-1" name="__codelineno-136-1" href="#__codelineno-136-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foobar</span><span class="p">(</span>
<a id="__codelineno-136-2" name="__codelineno-136-2" href="#__codelineno-136-2"></a>
<a id="__codelineno-136-3" name="__codelineno-136-3" href="#__codelineno-136-3"></a><span class="w"> </span><span class="n">foo</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="p">,</span>
<a id="__codelineno-136-4" name="__codelineno-136-4" href="#__codelineno-136-4"></a>
<a id="__codelineno-136-5" name="__codelineno-136-5" href="#__codelineno-136-5"></a><span class="w"> </span><span class="n">bar</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="p">,</span>
<a id="__codelineno-136-6" name="__codelineno-136-6" href="#__codelineno-136-6"></a>
<a id="__codelineno-136-7" name="__codelineno-136-7" href="#__codelineno-136-7"></a><span class="p">)</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:no-blank-line-in-list</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-137-1" name="__codelineno-137-1" href="#__codelineno-137-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:no-blank-line-in-list&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-138-1" name="__codelineno-138-1" href="#__codelineno-138-1"></a>ktlint_standard_no-blank-line-in-list = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-139-1" name="__codelineno-139-1" href="#__codelineno-139-1"></a>ktlint_standard_no-blank-line-in-list = disabled
</code></pre></div></li>
</ol>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This rule is only run when <code>ktlint_code_style</code> is set to <code>ktlint_official</code> or when the rule is enabled explicitly.</p>
</div>
<h2 id="no-consecutive-comments">No consecutive comments<a class="headerlink" href="#no-consecutive-comments" title="Permanent link">&para;</a></h2>
<p>Consecutive comments are disallowed in following cases:</p>
<ul>
<li>
<p>Any mix of a consecutive kdoc, a block comment or an EOL comment unless separated by a blank line in between</p>
</li>
<li>
<p>Consecutive KDocs (even when separated by a blank line)</p>
</li>
<li>
<p>Consecutive block comments (even when separated by a blank line)</p>
</li>
</ul>
<p>Consecutive EOL comments are always allowed as they are often used instead of a block comment.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="30:2"><input checked="checked" id="__tabbed_30_1" name="__tabbed_30" type="radio" /><input id="__tabbed_30_2" name="__tabbed_30" type="radio" /><div class="tabbed-labels"><label for="__tabbed_30_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_30_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-140-1" name="__codelineno-140-1" href="#__codelineno-140-1"></a><span class="c1">// An EOL comment</span>
<a id="__codelineno-140-2" name="__codelineno-140-2" href="#__codelineno-140-2"></a><span class="c1">// may be followed by another EOL comment</span>
<a id="__codelineno-140-3" name="__codelineno-140-3" href="#__codelineno-140-3"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo&quot;</span>
<a id="__codelineno-140-4" name="__codelineno-140-4" href="#__codelineno-140-4"></a>
<a id="__codelineno-140-5" name="__codelineno-140-5" href="#__codelineno-140-5"></a><span class="c1">// Different comment types (including KDoc) may be consecutive ..</span>
<a id="__codelineno-140-6" name="__codelineno-140-6" href="#__codelineno-140-6"></a>
<a id="__codelineno-140-7" name="__codelineno-140-7" href="#__codelineno-140-7"></a><span class="cm">/*</span>
<a id="__codelineno-140-8" name="__codelineno-140-8" href="#__codelineno-140-8"></a><span class="cm"> * ... but do need to be separated by a blank line ...</span>
<a id="__codelineno-140-9" name="__codelineno-140-9" href="#__codelineno-140-9"></a><span class="cm"> */</span>
<a id="__codelineno-140-10" name="__codelineno-140-10" href="#__codelineno-140-10"></a>
<a id="__codelineno-140-11" name="__codelineno-140-11" href="#__codelineno-140-11"></a><span class="cm">/**</span>
<a id="__codelineno-140-12" name="__codelineno-140-12" href="#__codelineno-140-12"></a><span class="cm"> * ... but a KDoc can not be followed by an EOL or a block comment or another KDoc</span>
<a id="__codelineno-140-13" name="__codelineno-140-13" href="#__codelineno-140-13"></a><span class="cm"> */</span>
<a id="__codelineno-140-14" name="__codelineno-140-14" href="#__codelineno-140-14"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">bar</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;bar&quot;</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-141-1" name="__codelineno-141-1" href="#__codelineno-141-1"></a><span class="cm">/*</span>
<a id="__codelineno-141-2" name="__codelineno-141-2" href="#__codelineno-141-2"></a><span class="cm"> * Block comments can not be consecutive ...</span>
<a id="__codelineno-141-3" name="__codelineno-141-3" href="#__codelineno-141-3"></a><span class="cm"> */</span>
<a id="__codelineno-141-4" name="__codelineno-141-4" href="#__codelineno-141-4"></a><span class="cm">/*</span>
<a id="__codelineno-141-5" name="__codelineno-141-5" href="#__codelineno-141-5"></a><span class="cm"> * ... even not when separated by a new line.</span>
<a id="__codelineno-141-6" name="__codelineno-141-6" href="#__codelineno-141-6"></a><span class="cm"> */</span>
<a id="__codelineno-141-7" name="__codelineno-141-7" href="#__codelineno-141-7"></a><span class="kd">val</span><span class="w"> </span><span class="nv">bar</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;bar&quot;</span><span class="w"> </span>
<a id="__codelineno-141-8" name="__codelineno-141-8" href="#__codelineno-141-8"></a>
<a id="__codelineno-141-9" name="__codelineno-141-9" href="#__codelineno-141-9"></a><span class="cm">/**</span>
<a id="__codelineno-141-10" name="__codelineno-141-10" href="#__codelineno-141-10"></a><span class="cm"> * A KDoc can not be followed by a block comment or an EOL comment or another KDOC</span>
<a id="__codelineno-141-11" name="__codelineno-141-11" href="#__codelineno-141-11"></a><span class="cm"> */</span>
<a id="__codelineno-141-12" name="__codelineno-141-12" href="#__codelineno-141-12"></a>
<a id="__codelineno-141-13" name="__codelineno-141-13" href="#__codelineno-141-13"></a><span class="c1">// ... even not when separated by a new line.</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:no-consecutive-comments</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-142-1" name="__codelineno-142-1" href="#__codelineno-142-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:no-consecutive-comments&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-143-1" name="__codelineno-143-1" href="#__codelineno-143-1"></a>ktlint_standard_no-consecutive-comments = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-144-1" name="__codelineno-144-1" href="#__codelineno-144-1"></a>ktlint_standard_no-consecutive-comments = disabled
</code></pre></div></li>
</ol>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This rule is only run when <code>ktlint_code_style</code> is set to <code>ktlint_official</code> or when the rule is enabled explicitly.</p>
</div>
<h2 id="no-empty-file">No empty file<a class="headerlink" href="#no-empty-file" title="Permanent link">&para;</a></h2>
<p>A kotlin (script) file should not be empty. It needs to contain at least one declaration. Files only contain a package and/or import statements are as of that disallowed.</p>
<p>Rule id: <code>standard:no-empty-file</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-145-1" name="__codelineno-145-1" href="#__codelineno-145-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:no-empty-file&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-146-1" name="__codelineno-146-1" href="#__codelineno-146-1"></a>ktlint_standard_no-empty-file = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-147-1" name="__codelineno-147-1" href="#__codelineno-147-1"></a>ktlint_standard_no-empty-file = disabled
</code></pre></div></li>
</ol>
<h2 id="no-empty-first-line-at-start-in-class-body">No empty first line at start in class body<a class="headerlink" href="#no-empty-first-line-at-start-in-class-body" title="Permanent link">&para;</a></h2>
<p>Detect blank lines at the start of a class body.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="31:2"><input checked="checked" id="__tabbed_31_1" name="__tabbed_31" type="radio" /><input id="__tabbed_31_2" name="__tabbed_31" type="radio" /><div class="tabbed-labels"><label for="__tabbed_31_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_31_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-148-1" name="__codelineno-148-1" href="#__codelineno-148-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-148-2" name="__codelineno-148-2" href="#__codelineno-148-2"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo&quot;</span>
<a id="__codelineno-148-3" name="__codelineno-148-3" href="#__codelineno-148-3"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-149-1" name="__codelineno-149-1" href="#__codelineno-149-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-149-2" name="__codelineno-149-2" href="#__codelineno-149-2"></a>
<a id="__codelineno-149-3" name="__codelineno-149-3" href="#__codelineno-149-3"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo&quot;</span>
<a id="__codelineno-149-4" name="__codelineno-149-4" href="#__codelineno-149-4"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:no-empty-first-line-in-class-body</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-150-1" name="__codelineno-150-1" href="#__codelineno-150-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:no-empty-first-line-in-class-body&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-151-1" name="__codelineno-151-1" href="#__codelineno-151-1"></a>ktlint_standard_no-empty-first-line-in-class-body = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-152-1" name="__codelineno-152-1" href="#__codelineno-152-1"></a>ktlint_standard_no-empty-first-line-in-class-body = disabled
</code></pre></div></li>
</ol>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This rule is only run when <code>ktlint_code_style</code> is set to <code>ktlint_official</code> or when the rule is enabled explicitly.</p>
</div>
<h2 id="no-single-line-block-comment">No single line block comment<a class="headerlink" href="#no-single-line-block-comment" title="Permanent link">&para;</a></h2>
<p>A single line block comment should be replaced with an EOL comment when possible.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="32:2"><input checked="checked" id="__tabbed_32_1" name="__tabbed_32" type="radio" /><input id="__tabbed_32_2" name="__tabbed_32" type="radio" /><div class="tabbed-labels"><label for="__tabbed_32_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_32_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-153-1" name="__codelineno-153-1" href="#__codelineno-153-1"></a><span class="cm">/*</span>
<a id="__codelineno-153-2" name="__codelineno-153-2" href="#__codelineno-153-2"></a><span class="cm"> * Some comment</span>
<a id="__codelineno-153-3" name="__codelineno-153-3" href="#__codelineno-153-3"></a><span class="cm"> */</span>
<a id="__codelineno-153-4" name="__codelineno-153-4" href="#__codelineno-153-4"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo&quot;</span><span class="w"> </span><span class="c1">// Some comment</span>
<a id="__codelineno-153-5" name="__codelineno-153-5" href="#__codelineno-153-5"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="cm">/* no-op */</span><span class="w"> </span><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-154-1" name="__codelineno-154-1" href="#__codelineno-154-1"></a><span class="cm">/* Some comment */</span>
<a id="__codelineno-154-2" name="__codelineno-154-2" href="#__codelineno-154-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo&quot;</span><span class="w"> </span><span class="cm">/* Some comment */</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:no-single-line-block-comment</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-155-1" name="__codelineno-155-1" href="#__codelineno-155-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:no-single-line-block-comment&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-156-1" name="__codelineno-156-1" href="#__codelineno-156-1"></a>ktlint_standard_no-single-line-block-comment = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-157-1" name="__codelineno-157-1" href="#__codelineno-157-1"></a>ktlint_standard_no-single-line-block-comment = disabled
</code></pre></div></li>
</ol>
<h2 id="ktlint-suppression-rule">Ktlint-suppression rule<a class="headerlink" href="#ktlint-suppression-rule" title="Permanent link">&para;</a></h2>
<p>The <code>ktlint-disable</code> and <code>ktlint-enable</code> directives are no longer supported as of ktlint version <code>0.50.0</code>. This rule migrates the directives to Suppress or SuppressWarnings annotations.</p>
<p>Identifiers in the @Suppress and @SuppressWarnings annotations to suppress ktlint rules are checked for validity and autocorrected when possible.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="33:2"><input checked="checked" id="__tabbed_33_1" name="__tabbed_33" type="radio" /><input id="__tabbed_33_2" name="__tabbed_33" type="radio" /><div class="tabbed-labels"><label for="__tabbed_33_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_33_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-158-1" name="__codelineno-158-1" href="#__codelineno-158-1"></a><span class="nd">@file</span><span class="p">:</span><span class="n">Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:no-wildcard-imports&quot;</span><span class="p">)</span>
<a id="__codelineno-158-2" name="__codelineno-158-2" href="#__codelineno-158-2"></a>
<a id="__codelineno-158-3" name="__codelineno-158-3" href="#__codelineno-158-3"></a><span class="kd">class</span><span class="w"> </span><span class="nc">FooBar</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-158-4" name="__codelineno-158-4" href="#__codelineno-158-4"></a><span class="w"> </span><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:max-line-length&quot;</span><span class="p">)</span>
<a id="__codelineno-158-5" name="__codelineno-158-5" href="#__codelineno-158-5"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some longggggggggggggggggggg text&quot;</span>
<a id="__codelineno-158-6" name="__codelineno-158-6" href="#__codelineno-158-6"></a>
<a id="__codelineno-158-7" name="__codelineno-158-7" href="#__codelineno-158-7"></a><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">bar</span><span class="p">()</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-158-8" name="__codelineno-158-8" href="#__codelineno-158-8"></a><span class="w"> </span><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:no-multi-spaces&quot;</span><span class="p">)</span>
<a id="__codelineno-158-9" name="__codelineno-158-9" href="#__codelineno-158-9"></a><span class="w"> </span><span class="n">listOf</span><span class="p">(</span>
<a id="__codelineno-158-10" name="__codelineno-158-10" href="#__codelineno-158-10"></a><span class="w"> </span><span class="s">&quot;1 One&quot;</span><span class="p">,</span><span class="w"> </span>
<a id="__codelineno-158-11" name="__codelineno-158-11" href="#__codelineno-158-11"></a><span class="w"> </span><span class="s">&quot;10 Ten&quot;</span><span class="p">,</span><span class="w"> </span>
<a id="__codelineno-158-12" name="__codelineno-158-12" href="#__codelineno-158-12"></a><span class="w"> </span><span class="s">&quot;100 Hundred&quot;</span><span class="p">,</span><span class="w"> </span>
<a id="__codelineno-158-13" name="__codelineno-158-13" href="#__codelineno-158-13"></a><span class="w"> </span><span class="p">)</span>
<a id="__codelineno-158-14" name="__codelineno-158-14" href="#__codelineno-158-14"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-159-1" name="__codelineno-159-1" href="#__codelineno-159-1"></a><span class="cm">/* ktlint-disable standard:no-wildcard-imports */</span>
<a id="__codelineno-159-2" name="__codelineno-159-2" href="#__codelineno-159-2"></a>
<a id="__codelineno-159-3" name="__codelineno-159-3" href="#__codelineno-159-3"></a><span class="kd">class</span><span class="w"> </span><span class="nc">FooBar</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-159-4" name="__codelineno-159-4" href="#__codelineno-159-4"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some longggggggggggggggggggg text&quot;</span><span class="w"> </span><span class="c1">// ktlint-disable standard:max-line-length</span>
<a id="__codelineno-159-5" name="__codelineno-159-5" href="#__codelineno-159-5"></a>
<a id="__codelineno-159-6" name="__codelineno-159-6" href="#__codelineno-159-6"></a><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">bar</span><span class="p">()</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-159-7" name="__codelineno-159-7" href="#__codelineno-159-7"></a><span class="w"> </span><span class="n">listOf</span><span class="p">(</span>
<a id="__codelineno-159-8" name="__codelineno-159-8" href="#__codelineno-159-8"></a><span class="w"> </span><span class="cm">/* ktlint-disable standard:no-multi-spaces */</span>
<a id="__codelineno-159-9" name="__codelineno-159-9" href="#__codelineno-159-9"></a><span class="w"> </span><span class="s">&quot;1 One&quot;</span><span class="p">,</span><span class="w"> </span>
<a id="__codelineno-159-10" name="__codelineno-159-10" href="#__codelineno-159-10"></a><span class="w"> </span><span class="s">&quot;10 Ten&quot;</span><span class="p">,</span><span class="w"> </span>
<a id="__codelineno-159-11" name="__codelineno-159-11" href="#__codelineno-159-11"></a><span class="w"> </span><span class="s">&quot;100 Hundred&quot;</span><span class="p">,</span><span class="w"> </span>
<a id="__codelineno-159-12" name="__codelineno-159-12" href="#__codelineno-159-12"></a><span class="w"> </span><span class="cm">/* ktlint-enable standard:no-multi-spaces */</span>
<a id="__codelineno-159-13" name="__codelineno-159-13" href="#__codelineno-159-13"></a><span class="w"> </span><span class="p">)</span>
<a id="__codelineno-159-14" name="__codelineno-159-14" href="#__codelineno-159-14"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:ktlint-suppression</code></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This rule cannot be suppressed via <code>@Suppress</code> or be disabled in the <code>.editorconfig</code>.</p>
</div>
<h2 id="max-line-length">Max line length<a class="headerlink" href="#max-line-length" title="Permanent link">&para;</a></h2>
<p>Ensures that lines do not exceed the maximum length of a line as specified in <code>.editorconfig</code> property <code>max_line_length</code>.</p>
<p>This rule does not apply in a number of situations. The <code>.editorconfig</code> property <code>ktlint_ignore_back_ticked_identifier</code> can be set to ignore identifiers which are enclosed in backticks, which for example is very useful when you want to allow longer names for unit tests.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="34:2"><input checked="checked" id="__tabbed_34_1" name="__tabbed_34" type="radio" /><input id="__tabbed_34_2" name="__tabbed_34" type="radio" /><div class="tabbed-labels"><label for="__tabbed_34_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_34_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-160-1" name="__codelineno-160-1" href="#__codelineno-160-1"></a><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-160-2" name="__codelineno-160-2" href="#__codelineno-160-2"></a><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-160-3" name="__codelineno-160-3" href="#__codelineno-160-3"></a><span class="c1">// Lines below are accepted although the max</span>
<a id="__codelineno-160-4" name="__codelineno-160-4" href="#__codelineno-160-4"></a><span class="c1">// line length is exceeded.</span>
<a id="__codelineno-160-5" name="__codelineno-160-5" href="#__codelineno-160-5"></a><span class="k">package</span><span class="w"> </span><span class="nn">com.toooooooooooooooooooooooooooo.long</span>
<a id="__codelineno-160-6" name="__codelineno-160-6" href="#__codelineno-160-6"></a><span class="k">import</span><span class="w"> </span><span class="nn">com.tooooooooooooooooooooooooooooo.long</span>
<a id="__codelineno-160-7" name="__codelineno-160-7" href="#__codelineno-160-7"></a>
<a id="__codelineno-160-8" name="__codelineno-160-8" href="#__codelineno-160-8"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-160-9" name="__codelineno-160-9" href="#__codelineno-160-9"></a><span class="w"> </span><span class="s">&quot;&quot;&quot;</span>
<a id="__codelineno-160-10" name="__codelineno-160-10" href="#__codelineno-160-10"></a><span class="s"> fooooooooooooooooooooooooooooooooooooooooo</span>
<a id="__codelineno-160-11" name="__codelineno-160-11" href="#__codelineno-160-11"></a><span class="s"> &quot;&quot;&quot;</span>
<a id="__codelineno-160-12" name="__codelineno-160-12" href="#__codelineno-160-12"></a>
<a id="__codelineno-160-13" name="__codelineno-160-13" href="#__codelineno-160-13"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-160-14" name="__codelineno-160-14" href="#__codelineno-160-14"></a><span class="w"> </span><span class="s">&quot;fooooooooooooooooooooooooooooooooooooooo&quot;</span>
<a id="__codelineno-160-15" name="__codelineno-160-15" href="#__codelineno-160-15"></a>
<a id="__codelineno-160-16" name="__codelineno-160-16" href="#__codelineno-160-16"></a><span class="nd">@Test</span>
<a id="__codelineno-160-17" name="__codelineno-160-17" href="#__codelineno-160-17"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">`Test description which is toooooooooooo long`</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-160-18" name="__codelineno-160-18" href="#__codelineno-160-18"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-161-1" name="__codelineno-161-1" href="#__codelineno-161-1"></a><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-161-2" name="__codelineno-161-2" href="#__codelineno-161-2"></a><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-161-3" name="__codelineno-161-3" href="#__codelineno-161-3"></a><span class="kd">val</span><span class="w"> </span><span class="nv">fooooooooooooooo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;fooooooooooooooooooooo&quot;</span>
<a id="__codelineno-161-4" name="__codelineno-161-4" href="#__codelineno-161-4"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo&quot;</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="s">&quot;ooooooooooooooooooooooooooo&quot;</span>
<a id="__codelineno-161-5" name="__codelineno-161-5" href="#__codelineno-161-5"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foooooooooooooo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foooooooooooooooooooo&quot;</span><span class="w"> </span><span class="c1">// some comment</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>ktlint_ignore_back_ticked_identifier</code><br/><i>Defines whether the backticked identifier (``) should be ignored.</i></td>
<td style="text-align: center;"><code>false</code></td>
<td style="text-align: center;"><code>false</code></td>
<td style="text-align: center;"><code>false</code></td>
</tr>
<tr>
<td style="text-align: left;"><code>max_line_length</code><br/><i>Maximum length of a (regular) line. This property is ignored in case the <code>max-line-length</code> rule is disabled, or when using Ktlint via a third party integration that does not provide this rule.</i></td>
<td style="text-align: center;">140</td>
<td style="text-align: center;"><code>off</code></td>
<td style="text-align: center;"><code>100</code></td>
</tr>
</tbody>
</table>
<p>Rule id: <code>standard:max-line-length</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-162-1" name="__codelineno-162-1" href="#__codelineno-162-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:max-line-length&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-163-1" name="__codelineno-163-1" href="#__codelineno-163-1"></a>ktlint_standard_max-line-length = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-164-1" name="__codelineno-164-1" href="#__codelineno-164-1"></a>ktlint_standard_max-line-length = disabled
</code></pre></div></li>
</ol>
<h2 id="modifier-order">Modifier order<a class="headerlink" href="#modifier-order" title="Permanent link">&para;</a></h2>
<p>Requires consistent order of modifiers.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="35:2"><input checked="checked" id="__tabbed_35_1" name="__tabbed_35" type="radio" /><input id="__tabbed_35_2" name="__tabbed_35" type="radio" /><div class="tabbed-labels"><label for="__tabbed_35_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_35_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-165-1" name="__codelineno-165-1" href="#__codelineno-165-1"></a><span class="kd">abstract</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">A</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-165-2" name="__codelineno-165-2" href="#__codelineno-165-2"></a><span class="w"> </span><span class="kd">protected</span><span class="w"> </span><span class="kd">open</span><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">v</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;&quot;</span>
<a id="__codelineno-165-3" name="__codelineno-165-3" href="#__codelineno-165-3"></a>
<a id="__codelineno-165-4" name="__codelineno-165-4" href="#__codelineno-165-4"></a><span class="w"> </span><span class="kd">internal</span><span class="w"> </span><span class="kd">open</span><span class="w"> </span><span class="kd">suspend</span><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">f</span><span class="p">(</span><span class="n">v</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">):</span><span class="w"> </span><span class="kt">Any</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;&quot;</span>
<a id="__codelineno-165-5" name="__codelineno-165-5" href="#__codelineno-165-5"></a>
<a id="__codelineno-165-6" name="__codelineno-165-6" href="#__codelineno-165-6"></a><span class="w"> </span><span class="kd">protected</span><span class="w"> </span><span class="kd">lateinit</span><span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nv">lv</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span>
<a id="__codelineno-165-7" name="__codelineno-165-7" href="#__codelineno-165-7"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-166-1" name="__codelineno-166-1" href="#__codelineno-166-1"></a><span class="kd">abstract</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">A</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-166-2" name="__codelineno-166-2" href="#__codelineno-166-2"></a><span class="w"> </span><span class="kd">open</span><span class="w"> </span><span class="kd">protected</span><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">v</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;&quot;</span>
<a id="__codelineno-166-3" name="__codelineno-166-3" href="#__codelineno-166-3"></a>
<a id="__codelineno-166-4" name="__codelineno-166-4" href="#__codelineno-166-4"></a><span class="w"> </span><span class="kd">open</span><span class="w"> </span><span class="kd">suspend</span><span class="w"> </span><span class="kd">internal</span><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">f</span><span class="p">(</span><span class="n">v</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">):</span><span class="w"> </span><span class="kt">Any</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;&quot;</span>
<a id="__codelineno-166-5" name="__codelineno-166-5" href="#__codelineno-166-5"></a>
<a id="__codelineno-166-6" name="__codelineno-166-6" href="#__codelineno-166-6"></a><span class="w"> </span><span class="kd">lateinit</span><span class="w"> </span><span class="kd">protected</span><span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nv">lv</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span>
<a id="__codelineno-166-7" name="__codelineno-166-7" href="#__codelineno-166-7"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:modifier-order</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-167-1" name="__codelineno-167-1" href="#__codelineno-167-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:modifier-order&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-168-1" name="__codelineno-168-1" href="#__codelineno-168-1"></a>ktlint_standard_modifier-order = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-169-1" name="__codelineno-169-1" href="#__codelineno-169-1"></a>ktlint_standard_modifier-order = disabled
</code></pre></div></li>
</ol>
<h2 id="multiline-if-else">Multiline if-else<a class="headerlink" href="#multiline-if-else" title="Permanent link">&para;</a></h2>
<p>Braces required for multiline if/else statements.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="36:2"><input checked="checked" id="__tabbed_36_1" name="__tabbed_36" type="radio" /><input id="__tabbed_36_2" name="__tabbed_36" type="radio" /><div class="tabbed-labels"><label for="__tabbed_36_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_36_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-170-1" name="__codelineno-170-1" href="#__codelineno-170-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-170-2" name="__codelineno-170-2" href="#__codelineno-170-2"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kc">true</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-170-3" name="__codelineno-170-3" href="#__codelineno-170-3"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="m">0</span>
<a id="__codelineno-170-4" name="__codelineno-170-4" href="#__codelineno-170-4"></a><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-170-5" name="__codelineno-170-5" href="#__codelineno-170-5"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="m">1</span>
<a id="__codelineno-170-6" name="__codelineno-170-6" href="#__codelineno-170-6"></a><span class="w"> </span><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-171-1" name="__codelineno-171-1" href="#__codelineno-171-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-171-2" name="__codelineno-171-2" href="#__codelineno-171-2"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kc">true</span><span class="p">)</span>
<a id="__codelineno-171-3" name="__codelineno-171-3" href="#__codelineno-171-3"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="m">0</span>
<a id="__codelineno-171-4" name="__codelineno-171-4" href="#__codelineno-171-4"></a><span class="w"> </span><span class="k">else</span>
<a id="__codelineno-171-5" name="__codelineno-171-5" href="#__codelineno-171-5"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="m">1</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:multiline-if-else</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-172-1" name="__codelineno-172-1" href="#__codelineno-172-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:multiline-if-else&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-173-1" name="__codelineno-173-1" href="#__codelineno-173-1"></a>ktlint_standard_multiline-if-else = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-174-1" name="__codelineno-174-1" href="#__codelineno-174-1"></a>ktlint_standard_multiline-if-else = disabled
</code></pre></div></li>
</ol>
<h2 id="multiline-loop">Multiline loop<a class="headerlink" href="#multiline-loop" title="Permanent link">&para;</a></h2>
<p>Braces required for multiline for, while, and do statements.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="37:2"><input checked="checked" id="__tabbed_37_1" name="__tabbed_37" type="radio" /><input id="__tabbed_37_2" name="__tabbed_37" type="radio" /><div class="tabbed-labels"><label for="__tabbed_37_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_37_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-175-1" name="__codelineno-175-1" href="#__codelineno-175-1"></a><span class="k">for</span><span class="w"> </span><span class="p">(</span><span class="n">i</span><span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="m">1.</span><span class="p">.</span><span class="m">10</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-175-2" name="__codelineno-175-2" href="#__codelineno-175-2"></a><span class="w"> </span><span class="n">println</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
<a id="__codelineno-175-3" name="__codelineno-175-3" href="#__codelineno-175-3"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-176-1" name="__codelineno-176-1" href="#__codelineno-176-1"></a><span class="k">for</span><span class="w"> </span><span class="p">(</span><span class="n">i</span><span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="m">1.</span><span class="p">.</span><span class="m">10</span><span class="p">)</span>
<a id="__codelineno-176-2" name="__codelineno-176-2" href="#__codelineno-176-2"></a><span class="w"> </span><span class="n">println</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:multiline-loop</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-177-1" name="__codelineno-177-1" href="#__codelineno-177-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:multiline-loop&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-178-1" name="__codelineno-178-1" href="#__codelineno-178-1"></a>ktlint_standard_multiline-loop = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-179-1" name="__codelineno-179-1" href="#__codelineno-179-1"></a>ktlint_standard_multiline-loop = disabled
</code></pre></div></li>
</ol>
<h2 id="no-blank-lines-before">No blank lines before <code>}</code><a class="headerlink" href="#no-blank-lines-before" title="Permanent link">&para;</a></h2>
<p>No blank lines before <code>}</code>.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="38:2"><input checked="checked" id="__tabbed_38_1" name="__tabbed_38" type="radio" /><input id="__tabbed_38_2" name="__tabbed_38" type="radio" /><div class="tabbed-labels"><label for="__tabbed_38_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_38_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-180-1" name="__codelineno-180-1" href="#__codelineno-180-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">main</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-180-2" name="__codelineno-180-2" href="#__codelineno-180-2"></a><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">a</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-180-3" name="__codelineno-180-3" href="#__codelineno-180-3"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-180-4" name="__codelineno-180-4" href="#__codelineno-180-4"></a>
<a id="__codelineno-180-5" name="__codelineno-180-5" href="#__codelineno-180-5"></a><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">b</span><span class="p">()</span>
<a id="__codelineno-180-6" name="__codelineno-180-6" href="#__codelineno-180-6"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-181-1" name="__codelineno-181-1" href="#__codelineno-181-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">main</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-181-2" name="__codelineno-181-2" href="#__codelineno-181-2"></a><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">a</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-181-3" name="__codelineno-181-3" href="#__codelineno-181-3"></a>
<a id="__codelineno-181-4" name="__codelineno-181-4" href="#__codelineno-181-4"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-181-5" name="__codelineno-181-5" href="#__codelineno-181-5"></a><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">b</span><span class="p">()</span>
<a id="__codelineno-181-6" name="__codelineno-181-6" href="#__codelineno-181-6"></a>
<a id="__codelineno-181-7" name="__codelineno-181-7" href="#__codelineno-181-7"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:no-blank-line-before-rbrace</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-182-1" name="__codelineno-182-1" href="#__codelineno-182-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:no-blank-line-before-rbrace&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-183-1" name="__codelineno-183-1" href="#__codelineno-183-1"></a>ktlint_standard_no-blank-line-before-rbrace = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-184-1" name="__codelineno-184-1" href="#__codelineno-184-1"></a>ktlint_standard_no-blank-line-before-rbrace = disabled
</code></pre></div></li>
</ol>
<h2 id="no-blank-lines-in-chained-method-calls">No blank lines in chained method calls<a class="headerlink" href="#no-blank-lines-in-chained-method-calls" title="Permanent link">&para;</a></h2>
<div class="tabbed-set tabbed-alternate" data-tabs="39:2"><input checked="checked" id="__tabbed_39_1" name="__tabbed_39" type="radio" /><input id="__tabbed_39_2" name="__tabbed_39" type="radio" /><div class="tabbed-labels"><label for="__tabbed_39_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_39_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-185-1" name="__codelineno-185-1" href="#__codelineno-185-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">(</span><span class="n">inputText</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-185-2" name="__codelineno-185-2" href="#__codelineno-185-2"></a><span class="w"> </span><span class="n">inputText</span>
<a id="__codelineno-185-3" name="__codelineno-185-3" href="#__codelineno-185-3"></a><span class="w"> </span><span class="p">.</span><span class="na">lowercase</span><span class="p">(</span><span class="n">Locale</span><span class="p">.</span><span class="na">getDefault</span><span class="p">())</span>
<a id="__codelineno-185-4" name="__codelineno-185-4" href="#__codelineno-185-4"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-186-1" name="__codelineno-186-1" href="#__codelineno-186-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">(</span><span class="n">inputText</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-186-2" name="__codelineno-186-2" href="#__codelineno-186-2"></a><span class="w"> </span><span class="n">inputText</span>
<a id="__codelineno-186-3" name="__codelineno-186-3" href="#__codelineno-186-3"></a>
<a id="__codelineno-186-4" name="__codelineno-186-4" href="#__codelineno-186-4"></a><span class="w"> </span><span class="p">.</span><span class="na">lowercase</span><span class="p">(</span><span class="n">Locale</span><span class="p">.</span><span class="na">getDefault</span><span class="p">())</span>
<a id="__codelineno-186-5" name="__codelineno-186-5" href="#__codelineno-186-5"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:no-blank-lines-in-chained-method-calls</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-187-1" name="__codelineno-187-1" href="#__codelineno-187-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:no-blank-lines-in-chained-method-calls&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-188-1" name="__codelineno-188-1" href="#__codelineno-188-1"></a>ktlint_standard_no-blank-lines-in-chained-method-calls = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-189-1" name="__codelineno-189-1" href="#__codelineno-189-1"></a>ktlint_standard_no-blank-lines-in-chained-method-calls = disabled
</code></pre></div></li>
</ol>
<h2 id="no-consecutive-blank-lines">No consecutive blank lines<a class="headerlink" href="#no-consecutive-blank-lines" title="Permanent link">&para;</a></h2>
<div class="tabbed-set tabbed-alternate" data-tabs="40:2"><input checked="checked" id="__tabbed_40_1" name="__tabbed_40" type="radio" /><input id="__tabbed_40_2" name="__tabbed_40" type="radio" /><div class="tabbed-labels"><label for="__tabbed_40_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_40_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-190-1" name="__codelineno-190-1" href="#__codelineno-190-1"></a><span class="k">package</span><span class="w"> </span><span class="nn">com.test</span>
<a id="__codelineno-190-2" name="__codelineno-190-2" href="#__codelineno-190-2"></a>
<a id="__codelineno-190-3" name="__codelineno-190-3" href="#__codelineno-190-3"></a><span class="k">import</span><span class="w"> </span><span class="nn">com.test.util</span>
<a id="__codelineno-190-4" name="__codelineno-190-4" href="#__codelineno-190-4"></a>
<a id="__codelineno-190-5" name="__codelineno-190-5" href="#__codelineno-190-5"></a><span class="kd">val</span><span class="w"> </span><span class="nv">a</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;a&quot;</span>
<a id="__codelineno-190-6" name="__codelineno-190-6" href="#__codelineno-190-6"></a>
<a id="__codelineno-190-7" name="__codelineno-190-7" href="#__codelineno-190-7"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">b</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-190-8" name="__codelineno-190-8" href="#__codelineno-190-8"></a><span class="p">}</span>
<a id="__codelineno-190-9" name="__codelineno-190-9" href="#__codelineno-190-9"></a>
<a id="__codelineno-190-10" name="__codelineno-190-10" href="#__codelineno-190-10"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">c</span><span class="p">()</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-191-1" name="__codelineno-191-1" href="#__codelineno-191-1"></a><span class="k">package</span><span class="w"> </span><span class="nn">com.test</span>
<a id="__codelineno-191-2" name="__codelineno-191-2" href="#__codelineno-191-2"></a>
<a id="__codelineno-191-3" name="__codelineno-191-3" href="#__codelineno-191-3"></a>
<a id="__codelineno-191-4" name="__codelineno-191-4" href="#__codelineno-191-4"></a><span class="k">import</span><span class="w"> </span><span class="nn">com.test.util</span>
<a id="__codelineno-191-5" name="__codelineno-191-5" href="#__codelineno-191-5"></a>
<a id="__codelineno-191-6" name="__codelineno-191-6" href="#__codelineno-191-6"></a>
<a id="__codelineno-191-7" name="__codelineno-191-7" href="#__codelineno-191-7"></a><span class="kd">val</span><span class="w"> </span><span class="nv">a</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;a&quot;</span>
<a id="__codelineno-191-8" name="__codelineno-191-8" href="#__codelineno-191-8"></a>
<a id="__codelineno-191-9" name="__codelineno-191-9" href="#__codelineno-191-9"></a>
<a id="__codelineno-191-10" name="__codelineno-191-10" href="#__codelineno-191-10"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">b</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-191-11" name="__codelineno-191-11" href="#__codelineno-191-11"></a><span class="p">}</span>
<a id="__codelineno-191-12" name="__codelineno-191-12" href="#__codelineno-191-12"></a>
<a id="__codelineno-191-13" name="__codelineno-191-13" href="#__codelineno-191-13"></a>
<a id="__codelineno-191-14" name="__codelineno-191-14" href="#__codelineno-191-14"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">c</span><span class="p">()</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:no-consecutive-blank-lines</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-192-1" name="__codelineno-192-1" href="#__codelineno-192-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:no-consecutive-blank-lines&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-193-1" name="__codelineno-193-1" href="#__codelineno-193-1"></a>ktlint_standard_no-consecutive-blank-lines = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-194-1" name="__codelineno-194-1" href="#__codelineno-194-1"></a>ktlint_standard_no-consecutive-blank-lines = disabled
</code></pre></div></li>
</ol>
<h2 id="no-empty-class-bodies">No empty (<code>{}</code>) class bodies<a class="headerlink" href="#no-empty-class-bodies" title="Permanent link">&para;</a></h2>
<div class="tabbed-set tabbed-alternate" data-tabs="41:2"><input checked="checked" id="__tabbed_41_1" name="__tabbed_41" type="radio" /><input id="__tabbed_41_2" name="__tabbed_41" type="radio" /><div class="tabbed-labels"><label for="__tabbed_41_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_41_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-195-1" name="__codelineno-195-1" href="#__codelineno-195-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">C</span>
<a id="__codelineno-195-2" name="__codelineno-195-2" href="#__codelineno-195-2"></a>
<a id="__codelineno-195-3" name="__codelineno-195-3" href="#__codelineno-195-3"></a><span class="kd">data</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">DC</span><span class="p">(</span><span class="kd">val</span><span class="w"> </span><span class="nv">v</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">)</span>
<a id="__codelineno-195-4" name="__codelineno-195-4" href="#__codelineno-195-4"></a>
<a id="__codelineno-195-5" name="__codelineno-195-5" href="#__codelineno-195-5"></a><span class="kd">interface</span><span class="w"> </span><span class="nc">I</span>
<a id="__codelineno-195-6" name="__codelineno-195-6" href="#__codelineno-195-6"></a>
<a id="__codelineno-195-7" name="__codelineno-195-7" href="#__codelineno-195-7"></a><span class="kd">object</span><span class="w"> </span><span class="nc">O</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-196-1" name="__codelineno-196-1" href="#__codelineno-196-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">C</span><span class="w"> </span><span class="p">{}</span>
<a id="__codelineno-196-2" name="__codelineno-196-2" href="#__codelineno-196-2"></a>
<a id="__codelineno-196-3" name="__codelineno-196-3" href="#__codelineno-196-3"></a><span class="kd">data</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">DC</span><span class="p">(</span><span class="kd">val</span><span class="w"> </span><span class="nv">v</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-196-4" name="__codelineno-196-4" href="#__codelineno-196-4"></a>
<a id="__codelineno-196-5" name="__codelineno-196-5" href="#__codelineno-196-5"></a><span class="kd">interface</span><span class="w"> </span><span class="nc">I</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-196-6" name="__codelineno-196-6" href="#__codelineno-196-6"></a><span class="p">}</span>
<a id="__codelineno-196-7" name="__codelineno-196-7" href="#__codelineno-196-7"></a>
<a id="__codelineno-196-8" name="__codelineno-196-8" href="#__codelineno-196-8"></a><span class="kd">object</span><span class="w"> </span><span class="nc">O</span><span class="p">{}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:no-empty-class-body</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-197-1" name="__codelineno-197-1" href="#__codelineno-197-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:no-empty-class-body&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-198-1" name="__codelineno-198-1" href="#__codelineno-198-1"></a>ktlint_standard_no-empty-class-body = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-199-1" name="__codelineno-199-1" href="#__codelineno-199-1"></a>ktlint_standard_no-empty-class-body = disabled
</code></pre></div></li>
</ol>
<h2 id="no-leading-empty-lines-in-method-blocks">No leading empty lines in method blocks<a class="headerlink" href="#no-leading-empty-lines-in-method-blocks" title="Permanent link">&para;</a></h2>
<div class="tabbed-set tabbed-alternate" data-tabs="42:2"><input checked="checked" id="__tabbed_42_1" name="__tabbed_42" type="radio" /><input id="__tabbed_42_2" name="__tabbed_42" type="radio" /><div class="tabbed-labels"><label for="__tabbed_42_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_42_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-200-1" name="__codelineno-200-1" href="#__codelineno-200-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">bar</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-200-2" name="__codelineno-200-2" href="#__codelineno-200-2"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">a</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">2</span>
<a id="__codelineno-200-3" name="__codelineno-200-3" href="#__codelineno-200-3"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-201-1" name="__codelineno-201-1" href="#__codelineno-201-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">bar</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-201-2" name="__codelineno-201-2" href="#__codelineno-201-2"></a>
<a id="__codelineno-201-3" name="__codelineno-201-3" href="#__codelineno-201-3"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">a</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">2</span>
<a id="__codelineno-201-4" name="__codelineno-201-4" href="#__codelineno-201-4"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:no-empty-first-line-in-method-block</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-202-1" name="__codelineno-202-1" href="#__codelineno-202-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:no-empty-first-line-in-method-block&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-203-1" name="__codelineno-203-1" href="#__codelineno-203-1"></a>ktlint_standard_no-empty-first-line-in-method-block = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-204-1" name="__codelineno-204-1" href="#__codelineno-204-1"></a>ktlint_standard_no-empty-first-line-in-method-block = disabled
</code></pre></div></li>
</ol>
<h2 id="no-line-break-after-else">No line break after else<a class="headerlink" href="#no-line-break-after-else" title="Permanent link">&para;</a></h2>
<p>Disallows line breaks after the else keyword if that could lead to confusion, for example:</p>
<div class="tabbed-set tabbed-alternate" data-tabs="43:2"><input checked="checked" id="__tabbed_43_1" name="__tabbed_43" type="radio" /><input id="__tabbed_43_2" name="__tabbed_43" type="radio" /><div class="tabbed-labels"><label for="__tabbed_43_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_43_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-205-1" name="__codelineno-205-1" href="#__codelineno-205-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">funA</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-205-2" name="__codelineno-205-2" href="#__codelineno-205-2"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">conditionA</span><span class="p">())</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-205-3" name="__codelineno-205-3" href="#__codelineno-205-3"></a><span class="w"> </span><span class="n">doSomething</span><span class="p">()</span>
<a id="__codelineno-205-4" name="__codelineno-205-4" href="#__codelineno-205-4"></a><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">conditionB</span><span class="p">())</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-205-5" name="__codelineno-205-5" href="#__codelineno-205-5"></a><span class="w"> </span><span class="n">doAnotherThing</span><span class="p">()</span>
<a id="__codelineno-205-6" name="__codelineno-205-6" href="#__codelineno-205-6"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-205-7" name="__codelineno-205-7" href="#__codelineno-205-7"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-206-1" name="__codelineno-206-1" href="#__codelineno-206-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">funA</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-206-2" name="__codelineno-206-2" href="#__codelineno-206-2"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">conditionA</span><span class="p">())</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-206-3" name="__codelineno-206-3" href="#__codelineno-206-3"></a><span class="w"> </span><span class="n">doSomething</span><span class="p">()</span>
<a id="__codelineno-206-4" name="__codelineno-206-4" href="#__codelineno-206-4"></a><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">else</span>
<a id="__codelineno-206-5" name="__codelineno-206-5" href="#__codelineno-206-5"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">conditionB</span><span class="p">())</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-206-6" name="__codelineno-206-6" href="#__codelineno-206-6"></a><span class="w"> </span><span class="n">doAnotherThing</span><span class="p">()</span>
<a id="__codelineno-206-7" name="__codelineno-206-7" href="#__codelineno-206-7"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-206-8" name="__codelineno-206-8" href="#__codelineno-206-8"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:no-line-break-after-else</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-207-1" name="__codelineno-207-1" href="#__codelineno-207-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:no-line-break-after-else&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-208-1" name="__codelineno-208-1" href="#__codelineno-208-1"></a>ktlint_standard_no-line-break-after-else = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-209-1" name="__codelineno-209-1" href="#__codelineno-209-1"></a>ktlint_standard_no-line-break-after-else = disabled
</code></pre></div></li>
</ol>
<h2 id="no-line-break-before-assignment">No line break before assignment<a class="headerlink" href="#no-line-break-before-assignment" title="Permanent link">&para;</a></h2>
<p>When a line is broken at an assignment (<code>=</code>) operator the break comes after the symbol.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="44:2"><input checked="checked" id="__tabbed_44_1" name="__tabbed_44" type="radio" /><input id="__tabbed_44_2" name="__tabbed_44" type="radio" /><div class="tabbed-labels"><label for="__tabbed_44_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_44_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-210-1" name="__codelineno-210-1" href="#__codelineno-210-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">valA</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-210-2" name="__codelineno-210-2" href="#__codelineno-210-2"></a><span class="w"> </span><span class="s">&quot;&quot;</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-211-1" name="__codelineno-211-1" href="#__codelineno-211-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">valA</span>
<a id="__codelineno-211-2" name="__codelineno-211-2" href="#__codelineno-211-2"></a><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;&quot;</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:no-line-break-before-assignment</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-212-1" name="__codelineno-212-1" href="#__codelineno-212-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:no-line-break-before-assignment&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-213-1" name="__codelineno-213-1" href="#__codelineno-213-1"></a>ktlint_standard_no-line-break-before-assignment = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-214-1" name="__codelineno-214-1" href="#__codelineno-214-1"></a>ktlint_standard_no-line-break-before-assignment = disabled
</code></pre></div></li>
</ol>
<h2 id="no-multi-spaces">No multi spaces<a class="headerlink" href="#no-multi-spaces" title="Permanent link">&para;</a></h2>
<p>Except in indentation and in KDoc's it is not allowed to have multiple consecutive spaces.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="45:2"><input checked="checked" id="__tabbed_45_1" name="__tabbed_45" type="radio" /><input id="__tabbed_45_2" name="__tabbed_45" type="radio" /><div class="tabbed-labels"><label for="__tabbed_45_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_45_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-215-1" name="__codelineno-215-1" href="#__codelineno-215-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">main</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-215-2" name="__codelineno-215-2" href="#__codelineno-215-2"></a><span class="w"> </span><span class="n">x</span><span class="p">(</span><span class="m">1</span><span class="p">,</span><span class="w"> </span><span class="m">3</span><span class="p">)</span>
<a id="__codelineno-215-3" name="__codelineno-215-3" href="#__codelineno-215-3"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-216-1" name="__codelineno-216-1" href="#__codelineno-216-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">main</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-216-2" name="__codelineno-216-2" href="#__codelineno-216-2"></a><span class="w"> </span><span class="n">x</span><span class="p">(</span><span class="m">1</span><span class="p">,</span><span class="w"> </span><span class="m">3</span><span class="p">)</span>
<a id="__codelineno-216-3" name="__codelineno-216-3" href="#__codelineno-216-3"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:no-multi-spaces</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-217-1" name="__codelineno-217-1" href="#__codelineno-217-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:no-multi-spaces&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-218-1" name="__codelineno-218-1" href="#__codelineno-218-1"></a>ktlint_standard_no-multi-spaces = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-219-1" name="__codelineno-219-1" href="#__codelineno-219-1"></a>ktlint_standard_no-multi-spaces = disabled
</code></pre></div></li>
</ol>
<h2 id="no-semicolons">No semicolons<a class="headerlink" href="#no-semicolons" title="Permanent link">&para;</a></h2>
<p>Avoid using unnecessary semicolons.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="46:2"><input checked="checked" id="__tabbed_46_1" name="__tabbed_46" type="radio" /><input id="__tabbed_46_2" name="__tabbed_46" type="radio" /><div class="tabbed-labels"><label for="__tabbed_46_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_46_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-220-1" name="__codelineno-220-1" href="#__codelineno-220-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-220-2" name="__codelineno-220-2" href="#__codelineno-220-2"></a><span class="w"> </span><span class="n">bar</span><span class="p">()</span>
<a id="__codelineno-220-3" name="__codelineno-220-3" href="#__codelineno-220-3"></a>
<a id="__codelineno-220-4" name="__codelineno-220-4" href="#__codelineno-220-4"></a><span class="w"> </span><span class="n">bar</span><span class="p">()</span>
<a id="__codelineno-220-5" name="__codelineno-220-5" href="#__codelineno-220-5"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-221-1" name="__codelineno-221-1" href="#__codelineno-221-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-221-2" name="__codelineno-221-2" href="#__codelineno-221-2"></a><span class="w"> </span><span class="p">;</span>
<a id="__codelineno-221-3" name="__codelineno-221-3" href="#__codelineno-221-3"></a><span class="w"> </span><span class="n">bar</span><span class="p">()</span>
<a id="__codelineno-221-4" name="__codelineno-221-4" href="#__codelineno-221-4"></a><span class="w"> </span><span class="p">;</span>
<a id="__codelineno-221-5" name="__codelineno-221-5" href="#__codelineno-221-5"></a>
<a id="__codelineno-221-6" name="__codelineno-221-6" href="#__codelineno-221-6"></a><span class="w"> </span><span class="n">bar</span><span class="p">()</span>
<a id="__codelineno-221-7" name="__codelineno-221-7" href="#__codelineno-221-7"></a>
<a id="__codelineno-221-8" name="__codelineno-221-8" href="#__codelineno-221-8"></a><span class="w"> </span><span class="p">;</span>
<a id="__codelineno-221-9" name="__codelineno-221-9" href="#__codelineno-221-9"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:no-semi</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-222-1" name="__codelineno-222-1" href="#__codelineno-222-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:no-semi&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-223-1" name="__codelineno-223-1" href="#__codelineno-223-1"></a>ktlint_standard_no-semi = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-224-1" name="__codelineno-224-1" href="#__codelineno-224-1"></a>ktlint_standard_no-semi = disabled
</code></pre></div></li>
</ol>
<h2 id="no-trailing-whitespaces">No trailing whitespaces<a class="headerlink" href="#no-trailing-whitespaces" title="Permanent link">&para;</a></h2>
<p>Rule id: <code>standard:no-trailing-spaces</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-225-1" name="__codelineno-225-1" href="#__codelineno-225-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:no-trailing-spaces&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-226-1" name="__codelineno-226-1" href="#__codelineno-226-1"></a>ktlint_standard_no-trailing-spaces = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-227-1" name="__codelineno-227-1" href="#__codelineno-227-1"></a>ktlint_standard_no-trailing-spaces = disabled
</code></pre></div></li>
</ol>
<h2 id="no-unit-as-return-type">No <code>Unit</code> as return type<a class="headerlink" href="#no-unit-as-return-type" title="Permanent link">&para;</a></h2>
<p>The <code>Unit</code> type is not allowed as return-type of a function.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="47:2"><input checked="checked" id="__tabbed_47_1" name="__tabbed_47" type="radio" /><input id="__tabbed_47_2" name="__tabbed_47" type="radio" /><div class="tabbed-labels"><label for="__tabbed_47_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_47_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-228-1" name="__codelineno-228-1" href="#__codelineno-228-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">fn</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-229-1" name="__codelineno-229-1" href="#__codelineno-229-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">fn</span><span class="p">():</span><span class="w"> </span><span class="kt">Unit</span><span class="w"> </span><span class="p">{}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:no-unit-return</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-230-1" name="__codelineno-230-1" href="#__codelineno-230-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:no-unit-return&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-231-1" name="__codelineno-231-1" href="#__codelineno-231-1"></a>ktlint_standard_no-unit-return = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-232-1" name="__codelineno-232-1" href="#__codelineno-232-1"></a>ktlint_standard_no-unit-return = disabled
</code></pre></div></li>
</ol>
<h2 id="no-unused-imports">No unused imports<a class="headerlink" href="#no-unused-imports" title="Permanent link">&para;</a></h2>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>Starting from KtLint <code>1.7.0</code> this rule no longer runs by default. In some cases the rule marks imports as unused, while after removal of the import the code no longer compiles.
If you insist on running the rule despite its <a href="https://github.com/pinterest/ktlint/issues/3038">shortcomings</a>, you need to enable the rule in the <code>.editorconfig</code> by adding:
<div class="highlight"><pre><span></span><code><a id="__codelineno-233-1" name="__codelineno-233-1" href="#__codelineno-233-1"></a>ktlint_standard_no-unused-imports = enabled
</code></pre></div>
Newly reported shortcomings to this rule are not guaranteed to be fixed by maintainers of KtLint.</p>
</div>
<p>Rule id: <code>standard:no-unused-imports</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-234-1" name="__codelineno-234-1" href="#__codelineno-234-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:no-unused-imports&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-235-1" name="__codelineno-235-1" href="#__codelineno-235-1"></a>ktlint_standard_no-unused-imports = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-236-1" name="__codelineno-236-1" href="#__codelineno-236-1"></a>ktlint_standard_no-unused-imports = disabled
</code></pre></div></li>
</ol>
<h2 id="no-wildcard-imports">No wildcard imports<a class="headerlink" href="#no-wildcard-imports" title="Permanent link">&para;</a></h2>
<p>No wildcard imports except whitelisted imports.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="48:2"><input checked="checked" id="__tabbed_48_1" name="__tabbed_48" type="radio" /><input id="__tabbed_48_2" name="__tabbed_48" type="radio" /><div class="tabbed-labels"><label for="__tabbed_48_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_48_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-237-1" name="__codelineno-237-1" href="#__codelineno-237-1"></a><span class="k">import</span><span class="w"> </span><span class="nn">foobar.Bar</span>
<a id="__codelineno-237-2" name="__codelineno-237-2" href="#__codelineno-237-2"></a><span class="k">import</span><span class="w"> </span><span class="nn">foobar.Foo</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-238-1" name="__codelineno-238-1" href="#__codelineno-238-1"></a><span class="k">import</span><span class="w"> </span><span class="nn">foobar.*</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>ij_kotlin_packages_to_use_import_on_demand</code><br/><i>Defines allowed wildcard imports as a comma separated list.</i></td>
<td style="text-align: center;">-</td>
<td style="text-align: center;"><code>java.util.*,</code><br/><code>kotlinx.android.synthetic.**</code></td>
<td style="text-align: center;"><code>java.util.*,</code><br/><code>kotlinx.android.synthetic.**</code></td>
</tr>
</tbody>
</table>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>In case property <code>ij_kotlin_packages_to_use_import_on_demand</code> is not explicitly set, Intellij IDEA allows wildcards imports like <code>java.util.*</code> which lead to conflicts with the <code>no-wildcard-imports</code> rule. See <a href="../configuration-intellij-idea/">Intellij IDEA configuration</a> to prevent such conflicts.</p>
</div>
<p>Rule id: <code>standard:no-wildcard-imports</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-239-1" name="__codelineno-239-1" href="#__codelineno-239-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:no-wildcard-imports&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-240-1" name="__codelineno-240-1" href="#__codelineno-240-1"></a>ktlint_standard_no-wildcard-imports = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-241-1" name="__codelineno-241-1" href="#__codelineno-241-1"></a>ktlint_standard_no-wildcard-imports = disabled
</code></pre></div></li>
</ol>
<h2 id="spacing">Spacing<a class="headerlink" href="#spacing" title="Permanent link">&para;</a></h2>
<h3 id="angle-bracket-spacing">Angle bracket spacing<a class="headerlink" href="#angle-bracket-spacing" title="Permanent link">&para;</a></h3>
<p>No spaces around angle brackets when used for typing.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="49:2"><input checked="checked" id="__tabbed_49_1" name="__tabbed_49" type="radio" /><input id="__tabbed_49_2" name="__tabbed_49" type="radio" /><div class="tabbed-labels"><label for="__tabbed_49_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_49_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-242-1" name="__codelineno-242-1" href="#__codelineno-242-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">a</span><span class="p">:</span><span class="w"> </span><span class="n">Map</span><span class="o">&lt;</span><span class="kt">Int</span><span class="p">,</span><span class="w"> </span><span class="kt">String</span><span class="o">&gt;</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">mapOf</span><span class="p">()</span>
<a id="__codelineno-242-2" name="__codelineno-242-2" href="#__codelineno-242-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">b</span><span class="p">:</span><span class="w"> </span><span class="n">Map</span><span class="o">&lt;</span><span class="kt">Int</span><span class="p">,</span><span class="w"> </span><span class="kt">String</span><span class="o">&gt;</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">mapOf</span><span class="p">()</span>
<a id="__codelineno-242-3" name="__codelineno-242-3" href="#__codelineno-242-3"></a><span class="kd">val</span><span class="w"> </span><span class="nv">c</span><span class="p">:</span><span class="w"> </span><span class="n">Map</span><span class="o">&lt;</span><span class="kt">Int</span><span class="p">,</span><span class="w"> </span><span class="kt">String</span><span class="o">&gt;</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">mapOf</span><span class="p">()</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-243-1" name="__codelineno-243-1" href="#__codelineno-243-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">a</span><span class="p">:</span><span class="w"> </span><span class="n">Map</span><span class="o">&lt;</span><span class="w"> </span><span class="kt">Int</span><span class="p">,</span><span class="w"> </span><span class="kt">String</span><span class="o">&gt;</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">mapOf</span><span class="p">()</span>
<a id="__codelineno-243-2" name="__codelineno-243-2" href="#__codelineno-243-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">b</span><span class="p">:</span><span class="w"> </span><span class="n">Map</span><span class="o">&lt;</span><span class="kt">Int</span><span class="p">,</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">mapOf</span><span class="p">()</span>
<a id="__codelineno-243-3" name="__codelineno-243-3" href="#__codelineno-243-3"></a><span class="kd">val</span><span class="w"> </span><span class="nv">c</span><span class="p">:</span><span class="w"> </span><span class="n">Map</span><span class="w"> </span><span class="o">&lt;</span><span class="kt">Int</span><span class="p">,</span><span class="w"> </span><span class="kt">String</span><span class="o">&gt;</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">mapOf</span><span class="p">()</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:spacing-around-angle-brackets</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-244-1" name="__codelineno-244-1" href="#__codelineno-244-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:spacing-around-angle-brackets&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-245-1" name="__codelineno-245-1" href="#__codelineno-245-1"></a>ktlint_standard_spacing-around-angle-brackets = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-246-1" name="__codelineno-246-1" href="#__codelineno-246-1"></a>ktlint_standard_spacing-around-angle-brackets = disabled
</code></pre></div></li>
</ol>
<h3 id="annotation-spacing">Annotation spacing<a class="headerlink" href="#annotation-spacing" title="Permanent link">&para;</a></h3>
<p>Annotations should be separated by a single line break.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="50:2"><input checked="checked" id="__tabbed_50_1" name="__tabbed_50" type="radio" /><input id="__tabbed_50_2" name="__tabbed_50" type="radio" /><div class="tabbed-labels"><label for="__tabbed_50_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_50_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-247-1" name="__codelineno-247-1" href="#__codelineno-247-1"></a><span class="nd">@JvmField</span>
<a id="__codelineno-247-2" name="__codelineno-247-2" href="#__codelineno-247-2"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
<a id="__codelineno-247-3" name="__codelineno-247-3" href="#__codelineno-247-3"></a>
<a id="__codelineno-247-4" name="__codelineno-247-4" href="#__codelineno-247-4"></a><span class="cm">/**</span>
<a id="__codelineno-247-5" name="__codelineno-247-5" href="#__codelineno-247-5"></a><span class="cm"> * block comment</span>
<a id="__codelineno-247-6" name="__codelineno-247-6" href="#__codelineno-247-6"></a><span class="cm"> */</span>
<a id="__codelineno-247-7" name="__codelineno-247-7" href="#__codelineno-247-7"></a><span class="nd">@Foo</span><span class="w"> </span><span class="nd">@Bar</span>
<a id="__codelineno-247-8" name="__codelineno-247-8" href="#__codelineno-247-8"></a><span class="kd">class</span><span class="w"> </span><span class="nc">FooBar</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-247-9" name="__codelineno-247-9" href="#__codelineno-247-9"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-248-1" name="__codelineno-248-1" href="#__codelineno-248-1"></a><span class="nd">@JvmField</span>
<a id="__codelineno-248-2" name="__codelineno-248-2" href="#__codelineno-248-2"></a>
<a id="__codelineno-248-3" name="__codelineno-248-3" href="#__codelineno-248-3"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
<a id="__codelineno-248-4" name="__codelineno-248-4" href="#__codelineno-248-4"></a>
<a id="__codelineno-248-5" name="__codelineno-248-5" href="#__codelineno-248-5"></a><span class="nd">@Foo</span><span class="w"> </span><span class="nd">@Bar</span>
<a id="__codelineno-248-6" name="__codelineno-248-6" href="#__codelineno-248-6"></a><span class="cm">/**</span>
<a id="__codelineno-248-7" name="__codelineno-248-7" href="#__codelineno-248-7"></a><span class="cm"> * block comment</span>
<a id="__codelineno-248-8" name="__codelineno-248-8" href="#__codelineno-248-8"></a><span class="cm"> */</span>
<a id="__codelineno-248-9" name="__codelineno-248-9" href="#__codelineno-248-9"></a><span class="kd">class</span><span class="w"> </span><span class="nc">FooBar</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-248-10" name="__codelineno-248-10" href="#__codelineno-248-10"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:annotation-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-249-1" name="__codelineno-249-1" href="#__codelineno-249-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:annotation-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-250-1" name="__codelineno-250-1" href="#__codelineno-250-1"></a>ktlint_standard_annotation-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-251-1" name="__codelineno-251-1" href="#__codelineno-251-1"></a>ktlint_standard_annotation-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="blank-line-between-declarations-with-annotations">Blank line between declarations with annotations<a class="headerlink" href="#blank-line-between-declarations-with-annotations" title="Permanent link">&para;</a></h3>
<p>Declarations with annotations should be separated by a blank line.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="51:2"><input checked="checked" id="__tabbed_51_1" name="__tabbed_51" type="radio" /><input id="__tabbed_51_2" name="__tabbed_51" type="radio" /><div class="tabbed-labels"><label for="__tabbed_51_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_51_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-252-1" name="__codelineno-252-1" href="#__codelineno-252-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">a</span><span class="p">()</span>
<a id="__codelineno-252-2" name="__codelineno-252-2" href="#__codelineno-252-2"></a>
<a id="__codelineno-252-3" name="__codelineno-252-3" href="#__codelineno-252-3"></a><span class="nd">@Bar</span>
<a id="__codelineno-252-4" name="__codelineno-252-4" href="#__codelineno-252-4"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">b</span><span class="p">()</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-253-1" name="__codelineno-253-1" href="#__codelineno-253-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">a</span><span class="p">()</span>
<a id="__codelineno-253-2" name="__codelineno-253-2" href="#__codelineno-253-2"></a><span class="nd">@Bar</span>
<a id="__codelineno-253-3" name="__codelineno-253-3" href="#__codelineno-253-3"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">b</span><span class="p">()</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:spacing-between-declarations-with-annotations</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-254-1" name="__codelineno-254-1" href="#__codelineno-254-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:spacing-between-declarations-with-annotations&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-255-1" name="__codelineno-255-1" href="#__codelineno-255-1"></a>ktlint_standard_spacing-between-declarations-with-annotations = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-256-1" name="__codelineno-256-1" href="#__codelineno-256-1"></a>ktlint_standard_spacing-between-declarations-with-annotations = disabled
</code></pre></div></li>
</ol>
<h3 id="blank-line-between-declaration-with-comments">Blank line between declaration with comments<a class="headerlink" href="#blank-line-between-declaration-with-comments" title="Permanent link">&para;</a></h3>
<p>Declarations with comments should be separated by a blank line.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="52:2"><input checked="checked" id="__tabbed_52_1" name="__tabbed_52" type="radio" /><input id="__tabbed_52_2" name="__tabbed_52" type="radio" /><div class="tabbed-labels"><label for="__tabbed_52_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_52_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-257-1" name="__codelineno-257-1" href="#__codelineno-257-1"></a><span class="c1">// some comment 1</span>
<a id="__codelineno-257-2" name="__codelineno-257-2" href="#__codelineno-257-2"></a><span class="n">bar</span><span class="p">()</span>
<a id="__codelineno-257-3" name="__codelineno-257-3" href="#__codelineno-257-3"></a>
<a id="__codelineno-257-4" name="__codelineno-257-4" href="#__codelineno-257-4"></a><span class="cm">/*</span>
<a id="__codelineno-257-5" name="__codelineno-257-5" href="#__codelineno-257-5"></a><span class="cm"> * some comment 2</span>
<a id="__codelineno-257-6" name="__codelineno-257-6" href="#__codelineno-257-6"></a><span class="cm"> */</span>
<a id="__codelineno-257-7" name="__codelineno-257-7" href="#__codelineno-257-7"></a><span class="n">foo</span><span class="p">()</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-258-1" name="__codelineno-258-1" href="#__codelineno-258-1"></a><span class="c1">// some comment 1</span>
<a id="__codelineno-258-2" name="__codelineno-258-2" href="#__codelineno-258-2"></a><span class="n">bar</span><span class="p">()</span>
<a id="__codelineno-258-3" name="__codelineno-258-3" href="#__codelineno-258-3"></a><span class="cm">/*</span>
<a id="__codelineno-258-4" name="__codelineno-258-4" href="#__codelineno-258-4"></a><span class="cm"> * some comment 2</span>
<a id="__codelineno-258-5" name="__codelineno-258-5" href="#__codelineno-258-5"></a><span class="cm"> */</span>
<a id="__codelineno-258-6" name="__codelineno-258-6" href="#__codelineno-258-6"></a><span class="n">foo</span><span class="p">()</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:spacing-between-declarations-with-comments</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-259-1" name="__codelineno-259-1" href="#__codelineno-259-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:spacing-between-declarations-with-comments&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-260-1" name="__codelineno-260-1" href="#__codelineno-260-1"></a>ktlint_standard_spacing-between-declarations-with-comments = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-261-1" name="__codelineno-261-1" href="#__codelineno-261-1"></a>ktlint_standard_spacing-between-declarations-with-comments = disabled
</code></pre></div></li>
</ol>
<h3 id="colon-spacing">Colon spacing<a class="headerlink" href="#colon-spacing" title="Permanent link">&para;</a></h3>
<p>Consistent spacing around colon.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="53:2"><input checked="checked" id="__tabbed_53_1" name="__tabbed_53" type="radio" /><input id="__tabbed_53_2" name="__tabbed_53" type="radio" /><div class="tabbed-labels"><label for="__tabbed_53_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_53_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-262-1" name="__codelineno-262-1" href="#__codelineno-262-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">A</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">B</span>
<a id="__codelineno-262-2" name="__codelineno-262-2" href="#__codelineno-262-2"></a>
<a id="__codelineno-262-3" name="__codelineno-262-3" href="#__codelineno-262-3"></a><span class="kd">class</span><span class="w"> </span><span class="nc">A2</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">B2</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-263-1" name="__codelineno-263-1" href="#__codelineno-263-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">A</span><span class="p">:</span><span class="n">B</span>
<a id="__codelineno-263-2" name="__codelineno-263-2" href="#__codelineno-263-2"></a>
<a id="__codelineno-263-3" name="__codelineno-263-3" href="#__codelineno-263-3"></a><span class="kd">class</span><span class="w"> </span><span class="nc">A2</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">B2</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:colon-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-264-1" name="__codelineno-264-1" href="#__codelineno-264-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:colon-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-265-1" name="__codelineno-265-1" href="#__codelineno-265-1"></a>ktlint_standard_colon-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-266-1" name="__codelineno-266-1" href="#__codelineno-266-1"></a>ktlint_standard_colon-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="comma-spacing">Comma spacing<a class="headerlink" href="#comma-spacing" title="Permanent link">&para;</a></h3>
<p>Consistent spacing around comma.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="54:2"><input checked="checked" id="__tabbed_54_1" name="__tabbed_54" type="radio" /><input id="__tabbed_54_2" name="__tabbed_54" type="radio" /><div class="tabbed-labels"><label for="__tabbed_54_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_54_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-267-1" name="__codelineno-267-1" href="#__codelineno-267-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Foo</span><span class="p">(</span><span class="m">1</span><span class="p">,</span><span class="w"> </span><span class="m">3</span><span class="p">)</span>
<a id="__codelineno-267-2" name="__codelineno-267-2" href="#__codelineno-267-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Foo</span><span class="p">(</span><span class="m">1</span><span class="p">,</span><span class="w"> </span><span class="m">3</span><span class="p">)</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-268-1" name="__codelineno-268-1" href="#__codelineno-268-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Foo</span><span class="p">(</span><span class="m">1</span><span class="w"> </span><span class="p">,</span><span class="m">3</span><span class="p">)</span>
<a id="__codelineno-268-2" name="__codelineno-268-2" href="#__codelineno-268-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Foo</span><span class="p">(</span><span class="m">1</span><span class="p">,</span><span class="m">3</span><span class="p">)</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:comma-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-269-1" name="__codelineno-269-1" href="#__codelineno-269-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:comma-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-270-1" name="__codelineno-270-1" href="#__codelineno-270-1"></a>ktlint_standard_comma-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-271-1" name="__codelineno-271-1" href="#__codelineno-271-1"></a>ktlint_standard_comma-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="comment-spacing">Comment spacing<a class="headerlink" href="#comment-spacing" title="Permanent link">&para;</a></h3>
<p>The end of line comment sign <code>//</code> should be preceded and followed by exactly a space.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="55:2"><input checked="checked" id="__tabbed_55_1" name="__tabbed_55" type="radio" /><input id="__tabbed_55_2" name="__tabbed_55" type="radio" /><div class="tabbed-labels"><label for="__tabbed_55_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_55_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-272-1" name="__codelineno-272-1" href="#__codelineno-272-1"></a><span class="c1">// comment</span>
<a id="__codelineno-272-2" name="__codelineno-272-2" href="#__codelineno-272-2"></a><span class="kd">var</span><span class="w"> </span><span class="nv">debugging</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">false</span><span class="w"> </span><span class="c1">// comment</span>
<a id="__codelineno-272-3" name="__codelineno-272-3" href="#__codelineno-272-3"></a><span class="kd">var</span><span class="w"> </span><span class="nv">debugging</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">false</span><span class="w"> </span><span class="c1">// comment</span>
<a id="__codelineno-272-4" name="__codelineno-272-4" href="#__codelineno-272-4"></a><span class="kd">var</span><span class="w"> </span><span class="nv">debugging</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">false</span><span class="w"> </span><span class="c1">// comment</span>
<a id="__codelineno-272-5" name="__codelineno-272-5" href="#__codelineno-272-5"></a>
<a id="__codelineno-272-6" name="__codelineno-272-6" href="#__codelineno-272-6"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">main</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-272-7" name="__codelineno-272-7" href="#__codelineno-272-7"></a><span class="w"> </span><span class="n">System</span><span class="p">.</span><span class="na">out</span><span class="p">.</span><span class="na">println</span><span class="p">(</span>
<a id="__codelineno-272-8" name="__codelineno-272-8" href="#__codelineno-272-8"></a><span class="w"> </span><span class="c1">// comment</span>
<a id="__codelineno-272-9" name="__codelineno-272-9" href="#__codelineno-272-9"></a><span class="w"> </span><span class="s">&quot;test&quot;</span><span class="p">,</span>
<a id="__codelineno-272-10" name="__codelineno-272-10" href="#__codelineno-272-10"></a><span class="w"> </span><span class="p">)</span>
<a id="__codelineno-272-11" name="__codelineno-272-11" href="#__codelineno-272-11"></a><span class="p">}</span><span class="w"> </span><span class="c1">// comment</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-273-1" name="__codelineno-273-1" href="#__codelineno-273-1"></a><span class="c1">//comment</span>
<a id="__codelineno-273-2" name="__codelineno-273-2" href="#__codelineno-273-2"></a><span class="kd">var</span><span class="w"> </span><span class="nv">debugging</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">false</span><span class="c1">// comment</span>
<a id="__codelineno-273-3" name="__codelineno-273-3" href="#__codelineno-273-3"></a><span class="kd">var</span><span class="w"> </span><span class="nv">debugging</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">false</span><span class="w"> </span><span class="c1">//comment</span>
<a id="__codelineno-273-4" name="__codelineno-273-4" href="#__codelineno-273-4"></a><span class="kd">var</span><span class="w"> </span><span class="nv">debugging</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">false</span><span class="c1">//comment</span>
<a id="__codelineno-273-5" name="__codelineno-273-5" href="#__codelineno-273-5"></a>
<a id="__codelineno-273-6" name="__codelineno-273-6" href="#__codelineno-273-6"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">main</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-273-7" name="__codelineno-273-7" href="#__codelineno-273-7"></a><span class="w"> </span><span class="n">System</span><span class="p">.</span><span class="na">out</span><span class="p">.</span><span class="na">println</span><span class="p">(</span>
<a id="__codelineno-273-8" name="__codelineno-273-8" href="#__codelineno-273-8"></a><span class="w"> </span><span class="c1">//123</span>
<a id="__codelineno-273-9" name="__codelineno-273-9" href="#__codelineno-273-9"></a><span class="w"> </span><span class="s">&quot;test&quot;</span>
<a id="__codelineno-273-10" name="__codelineno-273-10" href="#__codelineno-273-10"></a><span class="w"> </span><span class="p">)</span>
<a id="__codelineno-273-11" name="__codelineno-273-11" href="#__codelineno-273-11"></a><span class="p">}</span><span class="c1">//comment</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:comment-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-274-1" name="__codelineno-274-1" href="#__codelineno-274-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:comment-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-275-1" name="__codelineno-275-1" href="#__codelineno-275-1"></a>ktlint_standard_comment-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-276-1" name="__codelineno-276-1" href="#__codelineno-276-1"></a>ktlint_standard_comment-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="curly-spacing">Curly spacing<a class="headerlink" href="#curly-spacing" title="Permanent link">&para;</a></h3>
<p>Consistent spacing around curly braces.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="56:2"><input checked="checked" id="__tabbed_56_1" name="__tabbed_56" type="radio" /><input id="__tabbed_56_2" name="__tabbed_56" type="radio" /><div class="tabbed-labels"><label for="__tabbed_56_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_56_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-277-1" name="__codelineno-277-1" href="#__codelineno-277-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">bar</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="n">foo</span><span class="p">()</span><span class="w"> </span><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-278-1" name="__codelineno-278-1" href="#__codelineno-278-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">bar</span><span class="p">{</span><span class="n">foo</span><span class="p">()}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:curly-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-279-1" name="__codelineno-279-1" href="#__codelineno-279-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:curly-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-280-1" name="__codelineno-280-1" href="#__codelineno-280-1"></a>ktlint_standard_curly-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-281-1" name="__codelineno-281-1" href="#__codelineno-281-1"></a>ktlint_standard_curly-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="dot-spacing">Dot spacing<a class="headerlink" href="#dot-spacing" title="Permanent link">&para;</a></h3>
<p>Consistent spacing around dots.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="57:2"><input checked="checked" id="__tabbed_57_1" name="__tabbed_57" type="radio" /><input id="__tabbed_57_2" name="__tabbed_57" type="radio" /><div class="tabbed-labels"><label for="__tabbed_57_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_57_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-282-1" name="__codelineno-282-1" href="#__codelineno-282-1"></a><span class="kd">fun</span><span class="w"> </span><span class="n">String</span><span class="p">.</span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo&quot;</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-283-1" name="__codelineno-283-1" href="#__codelineno-283-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">String</span><span class="w"> </span><span class="p">.</span><span class="w"> </span><span class="n">foo</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo&quot;</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:dot-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-284-1" name="__codelineno-284-1" href="#__codelineno-284-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:dot-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-285-1" name="__codelineno-285-1" href="#__codelineno-285-1"></a>ktlint_standard_dot-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-286-1" name="__codelineno-286-1" href="#__codelineno-286-1"></a>ktlint_standard_dot-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="double-colon-spacing">Double colon spacing<a class="headerlink" href="#double-colon-spacing" title="Permanent link">&para;</a></h3>
<p>No spaces around <code>::</code>.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="58:2"><input checked="checked" id="__tabbed_58_1" name="__tabbed_58" type="radio" /><input id="__tabbed_58_2" name="__tabbed_58" type="radio" /><div class="tabbed-labels"><label for="__tabbed_58_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_58_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-287-1" name="__codelineno-287-1" href="#__codelineno-287-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Foo</span><span class="o">::</span><span class="kd">class</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-288-1" name="__codelineno-288-1" href="#__codelineno-288-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Foo</span><span class="w"> </span><span class="o">::</span><span class="kd">class</span>
<a id="__codelineno-288-2" name="__codelineno-288-2" href="#__codelineno-288-2"></a><span class="nc">val</span><span class="w"> </span><span class="n">foo2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Foo</span><span class="o">::</span><span class="w"> </span><span class="kd">class</span>
<a id="__codelineno-288-3" name="__codelineno-288-3" href="#__codelineno-288-3"></a><span class="nc">val</span><span class="w"> </span><span class="n">foo3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Foo</span><span class="w"> </span><span class="o">::</span><span class="w"> </span><span class="kd">class</span>
<a id="__codelineno-288-4" name="__codelineno-288-4" href="#__codelineno-288-4"></a><span class="nc">val</span><span class="w"> </span><span class="n">foo4</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Foo</span><span class="o">::</span>
<a id="__codelineno-288-5" name="__codelineno-288-5" href="#__codelineno-288-5"></a><span class="w"> </span><span class="kd">class</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:double-colon-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-289-1" name="__codelineno-289-1" href="#__codelineno-289-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:double-colon-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-290-1" name="__codelineno-290-1" href="#__codelineno-290-1"></a>ktlint_standard_double-colon-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-291-1" name="__codelineno-291-1" href="#__codelineno-291-1"></a>ktlint_standard_double-colon-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="function-return-type-spacing">Function return type spacing<a class="headerlink" href="#function-return-type-spacing" title="Permanent link">&para;</a></h3>
<p>Consistent spacing around the function return type.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="59:2"><input checked="checked" id="__tabbed_59_1" name="__tabbed_59" type="radio" /><input id="__tabbed_59_2" name="__tabbed_59" type="radio" /><div class="tabbed-labels"><label for="__tabbed_59_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_59_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-292-1" name="__codelineno-292-1" href="#__codelineno-292-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">():</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-293-1" name="__codelineno-293-1" href="#__codelineno-293-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo1</span><span class="p">()</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-293-2" name="__codelineno-293-2" href="#__codelineno-293-2"></a>
<a id="__codelineno-293-3" name="__codelineno-293-3" href="#__codelineno-293-3"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo2</span><span class="p">():</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-293-4" name="__codelineno-293-4" href="#__codelineno-293-4"></a>
<a id="__codelineno-293-5" name="__codelineno-293-5" href="#__codelineno-293-5"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo3</span><span class="p">():</span><span class="kt">String</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-293-6" name="__codelineno-293-6" href="#__codelineno-293-6"></a>
<a id="__codelineno-293-7" name="__codelineno-293-7" href="#__codelineno-293-7"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo4</span><span class="p">():</span>
<a id="__codelineno-293-8" name="__codelineno-293-8" href="#__codelineno-293-8"></a><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>max_line_length</code><br/><i>Maximum length of a (regular) line. This property is ignored in case the <code>max-line-length</code> rule is disabled, or when using Ktlint via a third party integration that does not provide this rule.</i></td>
<td style="text-align: center;">140</td>
<td style="text-align: center;"><code>off</code></td>
<td style="text-align: center;"><code>100</code></td>
</tr>
</tbody>
</table>
<p>Rule id: <code>standard:function-return-type-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-294-1" name="__codelineno-294-1" href="#__codelineno-294-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:function-return-type-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-295-1" name="__codelineno-295-1" href="#__codelineno-295-1"></a>ktlint_standard_function-return-type-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-296-1" name="__codelineno-296-1" href="#__codelineno-296-1"></a>ktlint_standard_function-return-type-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="function-start-of-body-spacing">Function start of body spacing<a class="headerlink" href="#function-start-of-body-spacing" title="Permanent link">&para;</a></h3>
<p>Consistent spacing before start of function body.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="60:2"><input checked="checked" id="__tabbed_60_1" name="__tabbed_60" type="radio" /><input id="__tabbed_60_2" name="__tabbed_60" type="radio" /><div class="tabbed-labels"><label for="__tabbed_60_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_60_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-297-1" name="__codelineno-297-1" href="#__codelineno-297-1"></a><span class="c1">// In case `ktlint_function_signature_body_expression_wrapping` is set to `default` or `multiline`</span>
<a id="__codelineno-297-2" name="__codelineno-297-2" href="#__codelineno-297-2"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo1</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-297-3" name="__codelineno-297-3" href="#__codelineno-297-3"></a>
<a id="__codelineno-297-4" name="__codelineno-297-4" href="#__codelineno-297-4"></a><span class="c1">// In case `ktlint_function_signature_body_expression_wrapping` is set to `always`</span>
<a id="__codelineno-297-5" name="__codelineno-297-5" href="#__codelineno-297-5"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo2</span><span class="p">()</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-297-6" name="__codelineno-297-6" href="#__codelineno-297-6"></a><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-297-7" name="__codelineno-297-7" href="#__codelineno-297-7"></a>
<a id="__codelineno-297-8" name="__codelineno-297-8" href="#__codelineno-297-8"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo3</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-297-9" name="__codelineno-297-9" href="#__codelineno-297-9"></a><span class="w"> </span><span class="c1">// do something</span>
<a id="__codelineno-297-10" name="__codelineno-297-10" href="#__codelineno-297-10"></a><span class="p">}</span>
<a id="__codelineno-297-11" name="__codelineno-297-11" href="#__codelineno-297-11"></a>
<a id="__codelineno-297-12" name="__codelineno-297-12" href="#__codelineno-297-12"></a><span class="c1">// In case `ktlint_function_signature_body_expression_wrapping` is set to `default` or `multiline`</span>
<a id="__codelineno-297-13" name="__codelineno-297-13" href="#__codelineno-297-13"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">bar1</span><span class="p">():</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-297-14" name="__codelineno-297-14" href="#__codelineno-297-14"></a>
<a id="__codelineno-297-15" name="__codelineno-297-15" href="#__codelineno-297-15"></a><span class="c1">// In case `ktlint_function_signature_body_expression_wrapping` is set to `always`</span>
<a id="__codelineno-297-16" name="__codelineno-297-16" href="#__codelineno-297-16"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">bar2</span><span class="p">():</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-297-17" name="__codelineno-297-17" href="#__codelineno-297-17"></a><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-297-18" name="__codelineno-297-18" href="#__codelineno-297-18"></a>
<a id="__codelineno-297-19" name="__codelineno-297-19" href="#__codelineno-297-19"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">bar3</span><span class="p">():</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-297-20" name="__codelineno-297-20" href="#__codelineno-297-20"></a><span class="w"> </span><span class="n">doSomething</span><span class="p">()</span>
<a id="__codelineno-297-21" name="__codelineno-297-21" href="#__codelineno-297-21"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-297-22" name="__codelineno-297-22" href="#__codelineno-297-22"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-298-1" name="__codelineno-298-1" href="#__codelineno-298-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo1</span><span class="p">()</span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-298-2" name="__codelineno-298-2" href="#__codelineno-298-2"></a>
<a id="__codelineno-298-3" name="__codelineno-298-3" href="#__codelineno-298-3"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo2</span><span class="p">()</span>
<a id="__codelineno-298-4" name="__codelineno-298-4" href="#__codelineno-298-4"></a><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-298-5" name="__codelineno-298-5" href="#__codelineno-298-5"></a>
<a id="__codelineno-298-6" name="__codelineno-298-6" href="#__codelineno-298-6"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo3</span><span class="p">()</span>
<a id="__codelineno-298-7" name="__codelineno-298-7" href="#__codelineno-298-7"></a><span class="p">{</span>
<a id="__codelineno-298-8" name="__codelineno-298-8" href="#__codelineno-298-8"></a><span class="w"> </span><span class="c1">// do something</span>
<a id="__codelineno-298-9" name="__codelineno-298-9" href="#__codelineno-298-9"></a><span class="p">}</span>
<a id="__codelineno-298-10" name="__codelineno-298-10" href="#__codelineno-298-10"></a>
<a id="__codelineno-298-11" name="__codelineno-298-11" href="#__codelineno-298-11"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">bar1</span><span class="p">():</span><span class="w"> </span><span class="kt">String</span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-298-12" name="__codelineno-298-12" href="#__codelineno-298-12"></a>
<a id="__codelineno-298-13" name="__codelineno-298-13" href="#__codelineno-298-13"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">bar2</span><span class="p">():</span><span class="w"> </span><span class="kt">String</span>
<a id="__codelineno-298-14" name="__codelineno-298-14" href="#__codelineno-298-14"></a><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-298-15" name="__codelineno-298-15" href="#__codelineno-298-15"></a>
<a id="__codelineno-298-16" name="__codelineno-298-16" href="#__codelineno-298-16"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">bar3</span><span class="p">():</span><span class="w"> </span><span class="kt">String</span>
<a id="__codelineno-298-17" name="__codelineno-298-17" href="#__codelineno-298-17"></a><span class="p">{</span>
<a id="__codelineno-298-18" name="__codelineno-298-18" href="#__codelineno-298-18"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-298-19" name="__codelineno-298-19" href="#__codelineno-298-19"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:function-start-of-body-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-299-1" name="__codelineno-299-1" href="#__codelineno-299-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:function-start-of-body-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-300-1" name="__codelineno-300-1" href="#__codelineno-300-1"></a>ktlint_standard_function-start-of-body-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-301-1" name="__codelineno-301-1" href="#__codelineno-301-1"></a>ktlint_standard_function-start-of-body-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="function-type-reference-spacing">Function type reference spacing<a class="headerlink" href="#function-type-reference-spacing" title="Permanent link">&para;</a></h3>
<p>Consistent spacing in the type reference before a function.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="61:2"><input checked="checked" id="__tabbed_61_1" name="__tabbed_61" type="radio" /><input id="__tabbed_61_2" name="__tabbed_61" type="radio" /><div class="tabbed-labels"><label for="__tabbed_61_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_61_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-302-1" name="__codelineno-302-1" href="#__codelineno-302-1"></a><span class="kd">fun</span><span class="w"> </span><span class="n">String</span><span class="p">.</span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-303-1" name="__codelineno-303-1" href="#__codelineno-303-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">String</span><span class="w"> </span><span class="p">.</span><span class="na">foo</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-303-2" name="__codelineno-303-2" href="#__codelineno-303-2"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">String</span>
<a id="__codelineno-303-3" name="__codelineno-303-3" href="#__codelineno-303-3"></a><span class="w"> </span><span class="p">.</span><span class="na">foo</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-303-4" name="__codelineno-303-4" href="#__codelineno-303-4"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">String</span><span class="o">?</span><span class="w"> </span><span class="p">.</span><span class="na">foo</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-303-5" name="__codelineno-303-5" href="#__codelineno-303-5"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">String</span><span class="o">?</span>
<a id="__codelineno-303-6" name="__codelineno-303-6" href="#__codelineno-303-6"></a><span class="w"> </span><span class="p">.</span><span class="na">foo</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:function-type-reference-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-304-1" name="__codelineno-304-1" href="#__codelineno-304-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:function-type-reference-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-305-1" name="__codelineno-305-1" href="#__codelineno-305-1"></a>ktlint_standard_function-type-reference-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-306-1" name="__codelineno-306-1" href="#__codelineno-306-1"></a>ktlint_standard_function-type-reference-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="fun-keyword-spacing">Fun keyword spacing<a class="headerlink" href="#fun-keyword-spacing" title="Permanent link">&para;</a></h3>
<p>Consistent spacing after the fun keyword.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="62:2"><input checked="checked" id="__tabbed_62_1" name="__tabbed_62" type="radio" /><input id="__tabbed_62_2" name="__tabbed_62" type="radio" /><div class="tabbed-labels"><label for="__tabbed_62_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_62_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-307-1" name="__codelineno-307-1" href="#__codelineno-307-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-308-1" name="__codelineno-308-1" href="#__codelineno-308-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-308-2" name="__codelineno-308-2" href="#__codelineno-308-2"></a><span class="kd">fun</span>
<a id="__codelineno-308-3" name="__codelineno-308-3" href="#__codelineno-308-3"></a><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:fun-keyword-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-309-1" name="__codelineno-309-1" href="#__codelineno-309-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:fun-keyword-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-310-1" name="__codelineno-310-1" href="#__codelineno-310-1"></a>ktlint_standard_fun-keyword-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-311-1" name="__codelineno-311-1" href="#__codelineno-311-1"></a>ktlint_standard_fun-keyword-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="kdoc-wrapping">Kdoc wrapping<a class="headerlink" href="#kdoc-wrapping" title="Permanent link">&para;</a></h3>
<p>A KDoc comment should start and end on a line that does not contain any other element.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="63:2"><input checked="checked" id="__tabbed_63_1" name="__tabbed_63" type="radio" /><input id="__tabbed_63_2" name="__tabbed_63" type="radio" /><div class="tabbed-labels"><label for="__tabbed_63_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_63_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-312-1" name="__codelineno-312-1" href="#__codelineno-312-1"></a><span class="cm">/** Some KDoc comment 1 */</span>
<a id="__codelineno-312-2" name="__codelineno-312-2" href="#__codelineno-312-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo1&quot;</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-313-1" name="__codelineno-313-1" href="#__codelineno-313-1"></a><span class="cm">/** Some KDoc comment 1 */</span><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo1&quot;</span>
<a id="__codelineno-313-2" name="__codelineno-313-2" href="#__codelineno-313-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo2&quot;</span><span class="w"> </span><span class="cm">/** Some KDoc comment</span>
<a id="__codelineno-313-3" name="__codelineno-313-3" href="#__codelineno-313-3"></a><span class="cm"> * with a newline</span>
<a id="__codelineno-313-4" name="__codelineno-313-4" href="#__codelineno-313-4"></a><span class="cm"> */</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:kdoc-wrapping</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-314-1" name="__codelineno-314-1" href="#__codelineno-314-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:kdoc-wrapping&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-315-1" name="__codelineno-315-1" href="#__codelineno-315-1"></a>ktlint_standard_kdoc-wrapping = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-316-1" name="__codelineno-316-1" href="#__codelineno-316-1"></a>ktlint_standard_kdoc-wrapping = disabled
</code></pre></div></li>
</ol>
<h3 id="keyword-spacing">Keyword spacing<a class="headerlink" href="#keyword-spacing" title="Permanent link">&para;</a></h3>
<p>Requires consistent spacing around keywords.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="64:2"><input checked="checked" id="__tabbed_64_1" name="__tabbed_64" type="radio" /><input id="__tabbed_64_2" name="__tabbed_64" type="radio" /><div class="tabbed-labels"><label for="__tabbed_64_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_64_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-317-1" name="__codelineno-317-1" href="#__codelineno-317-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">main</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-317-2" name="__codelineno-317-2" href="#__codelineno-317-2"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kc">true</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-317-3" name="__codelineno-317-3" href="#__codelineno-317-3"></a><span class="w"> </span><span class="n">doSomething</span><span class="p">()</span>
<a id="__codelineno-317-4" name="__codelineno-317-4" href="#__codelineno-317-4"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-317-5" name="__codelineno-317-5" href="#__codelineno-317-5"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-318-1" name="__codelineno-318-1" href="#__codelineno-318-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">main</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-318-2" name="__codelineno-318-2" href="#__codelineno-318-2"></a><span class="w"> </span><span class="k">if</span><span class="p">(</span><span class="kc">true</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-318-3" name="__codelineno-318-3" href="#__codelineno-318-3"></a><span class="w"> </span><span class="n">doSomething</span><span class="p">()</span>
<a id="__codelineno-318-4" name="__codelineno-318-4" href="#__codelineno-318-4"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-318-5" name="__codelineno-318-5" href="#__codelineno-318-5"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:keyword-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-319-1" name="__codelineno-319-1" href="#__codelineno-319-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:keyword-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-320-1" name="__codelineno-320-1" href="#__codelineno-320-1"></a>ktlint_standard_keyword-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-321-1" name="__codelineno-321-1" href="#__codelineno-321-1"></a>ktlint_standard_keyword-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="modifier-list-spacing">Modifier list spacing<a class="headerlink" href="#modifier-list-spacing" title="Permanent link">&para;</a></h3>
<p>Requires consistent spacing between modifiers in and after the last modifier in a modifier list.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="65:2"><input checked="checked" id="__tabbed_65_1" name="__tabbed_65" type="radio" /><input id="__tabbed_65_2" name="__tabbed_65" type="radio" /><div class="tabbed-labels"><label for="__tabbed_65_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_65_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-322-1" name="__codelineno-322-1" href="#__codelineno-322-1"></a><span class="kd">abstract</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">Foo</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-322-2" name="__codelineno-322-2" href="#__codelineno-322-2"></a><span class="w"> </span><span class="kd">protected</span><span class="w"> </span><span class="kd">abstract</span><span class="w"> </span><span class="kd">suspend</span><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">execute</span><span class="p">()</span>
<a id="__codelineno-322-3" name="__codelineno-322-3" href="#__codelineno-322-3"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-323-1" name="__codelineno-323-1" href="#__codelineno-323-1"></a><span class="kd">abstract</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">Foo</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-323-2" name="__codelineno-323-2" href="#__codelineno-323-2"></a><span class="w"> </span><span class="kd">protected</span><span class="w"> </span><span class="kd">abstract</span><span class="w"> </span><span class="kd">suspend</span><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">execute</span><span class="p">()</span>
<a id="__codelineno-323-3" name="__codelineno-323-3" href="#__codelineno-323-3"></a><span class="p">}</span>
<a id="__codelineno-323-4" name="__codelineno-323-4" href="#__codelineno-323-4"></a><span class="kd">abstract</span>
<a id="__codelineno-323-5" name="__codelineno-323-5" href="#__codelineno-323-5"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-323-6" name="__codelineno-323-6" href="#__codelineno-323-6"></a><span class="w"> </span><span class="kd">protected</span>
<a id="__codelineno-323-7" name="__codelineno-323-7" href="#__codelineno-323-7"></a><span class="w"> </span><span class="kd">abstract</span>
<a id="__codelineno-323-8" name="__codelineno-323-8" href="#__codelineno-323-8"></a><span class="w"> </span><span class="kd">suspend</span>
<a id="__codelineno-323-9" name="__codelineno-323-9" href="#__codelineno-323-9"></a><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">execute</span><span class="p">()</span>
<a id="__codelineno-323-10" name="__codelineno-323-10" href="#__codelineno-323-10"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:modifier-list-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-324-1" name="__codelineno-324-1" href="#__codelineno-324-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:modifier-list-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-325-1" name="__codelineno-325-1" href="#__codelineno-325-1"></a>ktlint_standard_modifier-list-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-326-1" name="__codelineno-326-1" href="#__codelineno-326-1"></a>ktlint_standard_modifier-list-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="nullable-type-spacing">Nullable type spacing<a class="headerlink" href="#nullable-type-spacing" title="Permanent link">&para;</a></h3>
<p>Disallows spaces in a nullable type.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="66:2"><input checked="checked" id="__tabbed_66_1" name="__tabbed_66" type="radio" /><input id="__tabbed_66_2" name="__tabbed_66" type="radio" /><div class="tabbed-labels"><label for="__tabbed_66_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_66_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-327-1" name="__codelineno-327-1" href="#__codelineno-327-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="p">:</span><span class="w"> </span><span class="kt">String?</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">null</span>
<a id="__codelineno-327-2" name="__codelineno-327-2" href="#__codelineno-327-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="p">:</span><span class="w"> </span><span class="n">List</span><span class="o">&lt;</span><span class="kt">String?</span><span class="o">&gt;</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">listOf</span><span class="p">(</span><span class="kc">null</span><span class="p">)</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-328-1" name="__codelineno-328-1" href="#__codelineno-328-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="w"> </span><span class="o">?</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">null</span>
<a id="__codelineno-328-2" name="__codelineno-328-2" href="#__codelineno-328-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="p">:</span><span class="w"> </span><span class="n">List</span><span class="o">&lt;</span><span class="kt">String</span><span class="w"> </span><span class="o">?&gt;</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">listOf</span><span class="p">(</span><span class="kc">null</span><span class="p">)</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:nullable-type-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-329-1" name="__codelineno-329-1" href="#__codelineno-329-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:nullable-type-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-330-1" name="__codelineno-330-1" href="#__codelineno-330-1"></a>ktlint_standard_nullable-type-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-331-1" name="__codelineno-331-1" href="#__codelineno-331-1"></a>ktlint_standard_nullable-type-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="operator-spacing">Operator spacing<a class="headerlink" href="#operator-spacing" title="Permanent link">&para;</a></h3>
<p>Requires consistent spacing around operators.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="67:2"><input checked="checked" id="__tabbed_67_1" name="__tabbed_67" type="radio" /><input id="__tabbed_67_2" name="__tabbed_67" type="radio" /><div class="tabbed-labels"><label for="__tabbed_67_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_67_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-332-1" name="__codelineno-332-1" href="#__codelineno-332-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="m">2</span>
<a id="__codelineno-332-2" name="__codelineno-332-2" href="#__codelineno-332-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="m">2</span>
<a id="__codelineno-332-3" name="__codelineno-332-3" href="#__codelineno-332-3"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="m">2</span>
<a id="__codelineno-332-4" name="__codelineno-332-4" href="#__codelineno-332-4"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo4</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="o">/</span><span class="w"> </span><span class="m">2</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-333-1" name="__codelineno-333-1" href="#__codelineno-333-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span><span class="o">+</span><span class="m">2</span>
<a id="__codelineno-333-2" name="__codelineno-333-2" href="#__codelineno-333-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span><span class="o">-</span><span class="w"> </span><span class="m">2</span>
<a id="__codelineno-333-3" name="__codelineno-333-3" href="#__codelineno-333-3"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="o">*</span><span class="m">2</span>
<a id="__codelineno-333-4" name="__codelineno-333-4" href="#__codelineno-333-4"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo4</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="o">/</span><span class="w"> </span><span class="m">2</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:op-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-334-1" name="__codelineno-334-1" href="#__codelineno-334-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:op-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-335-1" name="__codelineno-335-1" href="#__codelineno-335-1"></a>ktlint_standard_op-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-336-1" name="__codelineno-336-1" href="#__codelineno-336-1"></a>ktlint_standard_op-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="parameter-list-spacing">Parameter list spacing<a class="headerlink" href="#parameter-list-spacing" title="Permanent link">&para;</a></h3>
<p>Requires consistent spacing inside the parameter list.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="68:2"><input checked="checked" id="__tabbed_68_1" name="__tabbed_68" type="radio" /><input id="__tabbed_68_2" name="__tabbed_68" type="radio" /><div class="tabbed-labels"><label for="__tabbed_68_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_68_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-337-1" name="__codelineno-337-1" href="#__codelineno-337-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">(</span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-337-2" name="__codelineno-337-2" href="#__codelineno-337-2"></a>
<a id="__codelineno-337-3" name="__codelineno-337-3" href="#__codelineno-337-3"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-338-1" name="__codelineno-338-1" href="#__codelineno-338-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">(</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-338-2" name="__codelineno-338-2" href="#__codelineno-338-2"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">(</span>
<a id="__codelineno-338-3" name="__codelineno-338-3" href="#__codelineno-338-3"></a><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>max_line_length</code><br/><i>Maximum length of a (regular) line. This property is ignored in case the <code>max-line-length</code> rule is disabled, or when using Ktlint via a third party integration that does not provide this rule.</i></td>
<td style="text-align: center;">140</td>
<td style="text-align: center;"><code>off</code></td>
<td style="text-align: center;"><code>100</code></td>
</tr>
</tbody>
</table>
<p>Rule id: <code>standard:parameter-list-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-339-1" name="__codelineno-339-1" href="#__codelineno-339-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:parameter-list-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-340-1" name="__codelineno-340-1" href="#__codelineno-340-1"></a>ktlint_standard_parameter-list-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-341-1" name="__codelineno-341-1" href="#__codelineno-341-1"></a>ktlint_standard_parameter-list-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="parenthesis-spacing">Parenthesis spacing<a class="headerlink" href="#parenthesis-spacing" title="Permanent link">&para;</a></h3>
<p>Requires consistent spacing around parenthesis.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="69:2"><input checked="checked" id="__tabbed_69_1" name="__tabbed_69" type="radio" /><input id="__tabbed_69_2" name="__tabbed_69" type="radio" /><div class="tabbed-labels"><label for="__tabbed_69_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_69_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-342-1" name="__codelineno-342-1" href="#__codelineno-342-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-342-2" name="__codelineno-342-2" href="#__codelineno-342-2"></a><span class="w"> </span><span class="k">constructor</span><span class="p">(</span><span class="n">string</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="p">)</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="k">super</span><span class="p">()</span>
<a id="__codelineno-342-3" name="__codelineno-342-3" href="#__codelineno-342-3"></a><span class="p">}</span>
<a id="__codelineno-342-4" name="__codelineno-342-4" href="#__codelineno-342-4"></a>
<a id="__codelineno-342-5" name="__codelineno-342-5" href="#__codelineno-342-5"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">((</span><span class="m">1</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="m">2</span><span class="p">)</span><span class="w"> </span><span class="o">/</span><span class="w"> </span><span class="m">3</span><span class="p">)</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-343-1" name="__codelineno-343-1" href="#__codelineno-343-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">Bar</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-343-2" name="__codelineno-343-2" href="#__codelineno-343-2"></a><span class="w"> </span><span class="k">constructor</span><span class="p">(</span><span class="n">string</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="p">)</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="k">super</span><span class="w"> </span><span class="p">()</span>
<a id="__codelineno-343-3" name="__codelineno-343-3" href="#__codelineno-343-3"></a><span class="p">}</span>
<a id="__codelineno-343-4" name="__codelineno-343-4" href="#__codelineno-343-4"></a>
<a id="__codelineno-343-5" name="__codelineno-343-5" href="#__codelineno-343-5"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="w"> </span><span class="p">(</span><span class="m">1</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="o">/</span><span class="w"> </span><span class="m">3</span><span class="p">)</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:paren-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-344-1" name="__codelineno-344-1" href="#__codelineno-344-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:paren-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-345-1" name="__codelineno-345-1" href="#__codelineno-345-1"></a>ktlint_standard_paren-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-346-1" name="__codelineno-346-1" href="#__codelineno-346-1"></a>ktlint_standard_paren-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="range-spacing">Range spacing<a class="headerlink" href="#range-spacing" title="Permanent link">&para;</a></h3>
<p>Requires consistent spacing around range operators.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="70:2"><input checked="checked" id="__tabbed_70_1" name="__tabbed_70" type="radio" /><input id="__tabbed_70_2" name="__tabbed_70" type="radio" /><div class="tabbed-labels"><label for="__tabbed_70_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_70_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-347-1" name="__codelineno-347-1" href="#__codelineno-347-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="m">1.</span><span class="p">.</span><span class="m">12</span><span class="w"> </span><span class="n">step</span><span class="w"> </span><span class="m">2</span><span class="p">).</span><span class="na">last</span>
<a id="__codelineno-347-2" name="__codelineno-347-2" href="#__codelineno-347-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="m">1.</span><span class="p">.</span><span class="m">12</span><span class="w"> </span><span class="n">step</span><span class="w"> </span><span class="m">2</span><span class="p">).</span><span class="na">last</span>
<a id="__codelineno-347-3" name="__codelineno-347-3" href="#__codelineno-347-3"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="m">1.</span><span class="p">.</span><span class="m">12</span><span class="w"> </span><span class="n">step</span><span class="w"> </span><span class="m">2</span><span class="p">).</span><span class="na">last</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-348-1" name="__codelineno-348-1" href="#__codelineno-348-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="m">1.</span><span class="p">.</span><span class="w"> </span><span class="m">12</span><span class="w"> </span><span class="n">step</span><span class="w"> </span><span class="m">2</span><span class="p">).</span><span class="na">last</span>
<a id="__codelineno-348-2" name="__codelineno-348-2" href="#__codelineno-348-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="m">1</span><span class="w"> </span><span class="p">..</span><span class="w"> </span><span class="m">12</span><span class="w"> </span><span class="n">step</span><span class="w"> </span><span class="m">2</span><span class="p">).</span><span class="na">last</span>
<a id="__codelineno-348-3" name="__codelineno-348-3" href="#__codelineno-348-3"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="m">1</span><span class="w"> </span><span class="p">..</span><span class="m">12</span><span class="w"> </span><span class="n">step</span><span class="w"> </span><span class="m">2</span><span class="p">).</span><span class="na">last</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:range-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-349-1" name="__codelineno-349-1" href="#__codelineno-349-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:range-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-350-1" name="__codelineno-350-1" href="#__codelineno-350-1"></a>ktlint_standard_range-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-351-1" name="__codelineno-351-1" href="#__codelineno-351-1"></a>ktlint_standard_range-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="spacing-between-function-name-and-opening-parenthesis">Spacing between function name and opening parenthesis<a class="headerlink" href="#spacing-between-function-name-and-opening-parenthesis" title="Permanent link">&para;</a></h3>
<p>Requires consistent spacing between function name and opening parenthesis.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="71:2"><input checked="checked" id="__tabbed_71_1" name="__tabbed_71" type="radio" /><input id="__tabbed_71_2" name="__tabbed_71" type="radio" /><div class="tabbed-labels"><label for="__tabbed_71_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_71_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-352-1" name="__codelineno-352-1" href="#__codelineno-352-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo&quot;</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-353-1" name="__codelineno-353-1" href="#__codelineno-353-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="w"> </span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo&quot;</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:spacing-between-function-name-and-opening-parenthesis</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-354-1" name="__codelineno-354-1" href="#__codelineno-354-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:spacing-between-function-name-and-opening-parenthesis&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-355-1" name="__codelineno-355-1" href="#__codelineno-355-1"></a>ktlint_standard_spacing-between-function-name-and-opening-parenthesis = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-356-1" name="__codelineno-356-1" href="#__codelineno-356-1"></a>ktlint_standard_spacing-between-function-name-and-opening-parenthesis = disabled
</code></pre></div></li>
</ol>
<h3 id="square-brackets-spacing">Square brackets spacing<a class="headerlink" href="#square-brackets-spacing" title="Permanent link">&para;</a></h3>
<p>Checks for spacing around square brackets.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="72:2"><input checked="checked" id="__tabbed_72_1" name="__tabbed_72" type="radio" /><input id="__tabbed_72_2" name="__tabbed_72" type="radio" /><div class="tabbed-labels"><label for="__tabbed_72_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_72_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-357-1" name="__codelineno-357-1" href="#__codelineno-357-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">bar</span><span class="o">[</span><span class="m">1</span><span class="o">]</span>
<a id="__codelineno-357-2" name="__codelineno-357-2" href="#__codelineno-357-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-357-3" name="__codelineno-357-3" href="#__codelineno-357-3"></a><span class="w"> </span><span class="n">bar</span><span class="o">[</span>
<a id="__codelineno-357-4" name="__codelineno-357-4" href="#__codelineno-357-4"></a><span class="w"> </span><span class="m">1</span><span class="p">,</span>
<a id="__codelineno-357-5" name="__codelineno-357-5" href="#__codelineno-357-5"></a><span class="w"> </span><span class="m">2</span><span class="p">,</span>
<a id="__codelineno-357-6" name="__codelineno-357-6" href="#__codelineno-357-6"></a><span class="w"> </span><span class="o">]</span>
<a id="__codelineno-357-7" name="__codelineno-357-7" href="#__codelineno-357-7"></a>
<a id="__codelineno-357-8" name="__codelineno-357-8" href="#__codelineno-357-8"></a><span class="nd">@Foo</span><span class="p">(</span>
<a id="__codelineno-357-9" name="__codelineno-357-9" href="#__codelineno-357-9"></a><span class="w"> </span><span class="n">fooBar</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[</span><span class="s">&quot;foo&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;bar&quot;</span><span class="o">]</span><span class="p">,</span>
<a id="__codelineno-357-10" name="__codelineno-357-10" href="#__codelineno-357-10"></a><span class="w"> </span><span class="n">fooBaz</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[</span>
<a id="__codelineno-357-11" name="__codelineno-357-11" href="#__codelineno-357-11"></a><span class="w"> </span><span class="s">&quot;foo&quot;</span><span class="p">,</span>
<a id="__codelineno-357-12" name="__codelineno-357-12" href="#__codelineno-357-12"></a><span class="w"> </span><span class="s">&quot;baz&quot;</span><span class="p">,</span>
<a id="__codelineno-357-13" name="__codelineno-357-13" href="#__codelineno-357-13"></a><span class="w"> </span><span class="o">]</span><span class="p">,</span>
<a id="__codelineno-357-14" name="__codelineno-357-14" href="#__codelineno-357-14"></a><span class="p">)</span>
<a id="__codelineno-357-15" name="__codelineno-357-15" href="#__codelineno-357-15"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-358-1" name="__codelineno-358-1" href="#__codelineno-358-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">bar</span><span class="w"> </span><span class="o">[</span><span class="m">1</span><span class="o">]</span>
<a id="__codelineno-358-2" name="__codelineno-358-2" href="#__codelineno-358-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">bar</span><span class="o">[</span><span class="w"> </span><span class="m">1</span><span class="o">]</span>
<a id="__codelineno-358-3" name="__codelineno-358-3" href="#__codelineno-358-3"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">bar</span><span class="o">[</span><span class="m">1</span><span class="w"> </span><span class="o">]</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:square-brackets-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-359-1" name="__codelineno-359-1" href="#__codelineno-359-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:square-brackets-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-360-1" name="__codelineno-360-1" href="#__codelineno-360-1"></a>ktlint_standard_square-brackets-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-361-1" name="__codelineno-361-1" href="#__codelineno-361-1"></a>ktlint_standard_square-brackets-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="then-spacing">Then spacing<a class="headerlink" href="#then-spacing" title="Permanent link">&para;</a></h3>
<p>Enforces consistent spacing around the <code>then</code> block in an <code>if</code>-statement.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="73:2"><input checked="checked" id="__tabbed_73_1" name="__tabbed_73" type="radio" /><input id="__tabbed_73_2" name="__tabbed_73" type="radio" /><div class="tabbed-labels"><label for="__tabbed_73_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_73_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-362-1" name="__codelineno-362-1" href="#__codelineno-362-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-362-2" name="__codelineno-362-2" href="#__codelineno-362-2"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kc">true</span><span class="p">)</span><span class="w"> </span><span class="kc">true</span>
<a id="__codelineno-362-3" name="__codelineno-362-3" href="#__codelineno-362-3"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kc">true</span><span class="p">)</span><span class="w"> </span><span class="p">(</span><span class="m">0</span><span class="p">)</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="p">(</span><span class="m">1</span><span class="p">)</span>
<a id="__codelineno-362-4" name="__codelineno-362-4" href="#__codelineno-362-4"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kc">true</span><span class="p">)</span><span class="w"> </span><span class="n">print</span><span class="p">(</span><span class="m">0</span><span class="p">)</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="p">(</span><span class="m">1</span><span class="p">)</span>
<a id="__codelineno-362-5" name="__codelineno-362-5" href="#__codelineno-362-5"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-363-1" name="__codelineno-363-1" href="#__codelineno-363-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-363-2" name="__codelineno-363-2" href="#__codelineno-363-2"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kc">true</span><span class="p">)</span><span class="kc">true</span>
<a id="__codelineno-363-3" name="__codelineno-363-3" href="#__codelineno-363-3"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kc">true</span><span class="p">)(</span><span class="m">0</span><span class="p">)</span><span class="k">else</span><span class="w"> </span><span class="p">(</span><span class="m">1</span><span class="p">)</span>
<a id="__codelineno-363-4" name="__codelineno-363-4" href="#__codelineno-363-4"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kc">true</span><span class="p">)</span><span class="n">print</span><span class="p">(</span><span class="m">0</span><span class="p">)</span><span class="k">else</span><span class="w"> </span><span class="p">(</span><span class="m">1</span><span class="p">)</span>
<a id="__codelineno-363-5" name="__codelineno-363-5" href="#__codelineno-363-5"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:then-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-364-1" name="__codelineno-364-1" href="#__codelineno-364-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:then-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-365-1" name="__codelineno-365-1" href="#__codelineno-365-1"></a>ktlint_standard_then-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-366-1" name="__codelineno-366-1" href="#__codelineno-366-1"></a>ktlint_standard_then-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="try-catch-finally-spacing">Try catch finally spacing<a class="headerlink" href="#try-catch-finally-spacing" title="Permanent link">&para;</a></h3>
<p>Enforces consistent spacing in <code>try { .. } catch { .. } finally { .. }</code>.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="74:2"><input checked="checked" id="__tabbed_74_1" name="__tabbed_74" type="radio" /><input id="__tabbed_74_2" name="__tabbed_74" type="radio" /><div class="tabbed-labels"><label for="__tabbed_74_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_74_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-367-1" name="__codelineno-367-1" href="#__codelineno-367-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-367-2" name="__codelineno-367-2" href="#__codelineno-367-2"></a><span class="w"> </span><span class="k">try</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-367-3" name="__codelineno-367-3" href="#__codelineno-367-3"></a><span class="w"> </span><span class="c1">// do something</span>
<a id="__codelineno-367-4" name="__codelineno-367-4" href="#__codelineno-367-4"></a><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">catch</span><span class="w"> </span><span class="p">(</span><span class="n">exception</span><span class="p">:</span><span class="w"> </span><span class="n">Exception</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-367-5" name="__codelineno-367-5" href="#__codelineno-367-5"></a><span class="w"> </span><span class="c1">// handle exception</span>
<a id="__codelineno-367-6" name="__codelineno-367-6" href="#__codelineno-367-6"></a><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">finally</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-367-7" name="__codelineno-367-7" href="#__codelineno-367-7"></a><span class="w"> </span><span class="c1">// clean up</span>
<a id="__codelineno-367-8" name="__codelineno-367-8" href="#__codelineno-367-8"></a><span class="w"> </span><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-368-1" name="__codelineno-368-1" href="#__codelineno-368-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo1</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">try</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="cm">/* ... */</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">catch</span><span class="w"> </span><span class="p">(</span><span class="n">exception</span><span class="p">:</span><span class="w"> </span><span class="n">Exception</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="cm">/* ... */</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">finally</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="cm">/* ... */</span><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-368-2" name="__codelineno-368-2" href="#__codelineno-368-2"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo2</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>
<a id="__codelineno-368-3" name="__codelineno-368-3" href="#__codelineno-368-3"></a><span class="w"> </span><span class="k">try</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-368-4" name="__codelineno-368-4" href="#__codelineno-368-4"></a><span class="w"> </span><span class="c1">// do something</span>
<a id="__codelineno-368-5" name="__codelineno-368-5" href="#__codelineno-368-5"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-368-6" name="__codelineno-368-6" href="#__codelineno-368-6"></a><span class="w"> </span><span class="k">catch</span><span class="w"> </span><span class="p">(</span><span class="n">exception</span><span class="p">:</span><span class="w"> </span><span class="n">Exception</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-368-7" name="__codelineno-368-7" href="#__codelineno-368-7"></a><span class="w"> </span><span class="c1">// handle exception</span>
<a id="__codelineno-368-8" name="__codelineno-368-8" href="#__codelineno-368-8"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-368-9" name="__codelineno-368-9" href="#__codelineno-368-9"></a><span class="w"> </span><span class="k">finally</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-368-10" name="__codelineno-368-10" href="#__codelineno-368-10"></a><span class="w"> </span><span class="c1">// clean up</span>
<a id="__codelineno-368-11" name="__codelineno-368-11" href="#__codelineno-368-11"></a><span class="w"> </span><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:try-catch-finally-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-369-1" name="__codelineno-369-1" href="#__codelineno-369-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:try-catch-finally-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-370-1" name="__codelineno-370-1" href="#__codelineno-370-1"></a>ktlint_standard_try-catch-finally-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-371-1" name="__codelineno-371-1" href="#__codelineno-371-1"></a>ktlint_standard_try-catch-finally-spacing = disabled
</code></pre></div></li>
</ol>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This rule is only run when <code>ktlint_code_style</code> is set to <code>ktlint_official</code> or when the rule is enabled explicitly.</p>
</div>
<h3 id="type-argument-list-spacing">Type argument list spacing<a class="headerlink" href="#type-argument-list-spacing" title="Permanent link">&para;</a></h3>
<p>Disallows spacing before and after the angle brackets of a type argument list.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="75:2"><input checked="checked" id="__tabbed_75_1" name="__tabbed_75" type="radio" /><input id="__tabbed_75_2" name="__tabbed_75" type="radio" /><div class="tabbed-labels"><label for="__tabbed_75_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_75_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-372-1" name="__codelineno-372-1" href="#__codelineno-372-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">res</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">ArrayList</span><span class="o">&lt;</span><span class="n">LintError</span><span class="o">&gt;</span><span class="p">()</span>
<a id="__codelineno-372-2" name="__codelineno-372-2" href="#__codelineno-372-2"></a>
<a id="__codelineno-372-3" name="__codelineno-372-3" href="#__codelineno-372-3"></a><span class="kd">class</span><span class="w"> </span><span class="nc">B</span><span class="o">&lt;</span><span class="n">T</span><span class="o">&gt;</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">A</span><span class="o">&lt;</span><span class="n">T</span><span class="o">&gt;</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-372-4" name="__codelineno-372-4" href="#__codelineno-372-4"></a><span class="w"> </span><span class="kd">override</span><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">x</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">super</span><span class="o">&lt;</span><span class="n">A</span><span class="o">&gt;</span><span class="p">.</span><span class="na">x</span><span class="p">()</span>
<a id="__codelineno-372-5" name="__codelineno-372-5" href="#__codelineno-372-5"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-373-1" name="__codelineno-373-1" href="#__codelineno-373-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">res</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">ArrayList</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="n">LintError</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="p">()</span>
<a id="__codelineno-373-2" name="__codelineno-373-2" href="#__codelineno-373-2"></a>
<a id="__codelineno-373-3" name="__codelineno-373-3" href="#__codelineno-373-3"></a><span class="kd">class</span><span class="w"> </span><span class="nc">B</span><span class="o">&lt;</span><span class="n">T</span><span class="o">&gt;</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">A</span><span class="o">&lt;</span><span class="w"> </span><span class="n">T</span><span class="w"> </span><span class="o">&gt;</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-373-4" name="__codelineno-373-4" href="#__codelineno-373-4"></a><span class="w"> </span><span class="kd">override</span><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">x</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">super</span><span class="o">&lt;</span><span class="w"> </span><span class="n">A</span><span class="w"> </span><span class="o">&gt;</span><span class="p">.</span><span class="na">x</span><span class="p">()</span>
<a id="__codelineno-373-5" name="__codelineno-373-5" href="#__codelineno-373-5"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:type-argument-list-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-374-1" name="__codelineno-374-1" href="#__codelineno-374-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:type-argument-list-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-375-1" name="__codelineno-375-1" href="#__codelineno-375-1"></a>ktlint_standard_type-argument-list-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-376-1" name="__codelineno-376-1" href="#__codelineno-376-1"></a>ktlint_standard_type-argument-list-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="type-parameter-list-spacing">Type parameter list spacing<a class="headerlink" href="#type-parameter-list-spacing" title="Permanent link">&para;</a></h3>
<p>Disallows spacing after a type parameter list in function and class declarations.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="76:2"><input checked="checked" id="__tabbed_76_1" name="__tabbed_76" type="radio" /><input id="__tabbed_76_2" name="__tabbed_76" type="radio" /><div class="tabbed-labels"><label for="__tabbed_76_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_76_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-377-1" name="__codelineno-377-1" href="#__codelineno-377-1"></a><span class="kd">fun</span><span class="w"> </span><span class="o">&lt;</span><span class="n">T</span><span class="o">&gt;</span><span class="w"> </span><span class="nf">foo1</span><span class="p">(</span><span class="n">t</span><span class="p">:</span><span class="w"> </span><span class="n">T</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-377-2" name="__codelineno-377-2" href="#__codelineno-377-2"></a>
<a id="__codelineno-377-3" name="__codelineno-377-3" href="#__codelineno-377-3"></a><span class="kd">fun</span><span class="w"> </span><span class="o">&lt;</span><span class="n">T</span><span class="o">&gt;</span><span class="w"> </span><span class="nf">foo2</span><span class="p">(</span><span class="n">t</span><span class="p">:</span><span class="w"> </span><span class="n">T</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-377-4" name="__codelineno-377-4" href="#__codelineno-377-4"></a>
<a id="__codelineno-377-5" name="__codelineno-377-5" href="#__codelineno-377-5"></a><span class="kd">fun</span><span class="w"> </span><span class="o">&lt;</span><span class="n">T</span><span class="o">&gt;</span><span class="w"> </span><span class="nf">foo3</span><span class="p">(</span><span class="n">t</span><span class="p">:</span><span class="w"> </span><span class="n">T</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-378-1" name="__codelineno-378-1" href="#__codelineno-378-1"></a><span class="n">fun</span><span class="o">&lt;</span><span class="n">T</span><span class="o">&gt;</span><span class="w"> </span><span class="n">foo1</span><span class="p">(</span><span class="n">t</span><span class="p">:</span><span class="w"> </span><span class="n">T</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-378-2" name="__codelineno-378-2" href="#__codelineno-378-2"></a>
<a id="__codelineno-378-3" name="__codelineno-378-3" href="#__codelineno-378-3"></a><span class="kd">fun</span><span class="w"> </span><span class="o">&lt;</span><span class="n">T</span><span class="o">&gt;</span><span class="nf">foo2</span><span class="p">(</span><span class="n">t</span><span class="p">:</span><span class="w"> </span><span class="n">T</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
<a id="__codelineno-378-4" name="__codelineno-378-4" href="#__codelineno-378-4"></a>
<a id="__codelineno-378-5" name="__codelineno-378-5" href="#__codelineno-378-5"></a><span class="n">fun</span><span class="o">&lt;</span><span class="n">T</span><span class="o">&gt;</span><span class="n">foo3</span><span class="p">(</span><span class="n">t</span><span class="p">:</span><span class="w"> </span><span class="n">T</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-result&quot;</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:type-parameter-list-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-379-1" name="__codelineno-379-1" href="#__codelineno-379-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:type-parameter-list-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-380-1" name="__codelineno-380-1" href="#__codelineno-380-1"></a>ktlint_standard_type-parameter-list-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-381-1" name="__codelineno-381-1" href="#__codelineno-381-1"></a>ktlint_standard_type-parameter-list-spacing = disabled
</code></pre></div></li>
</ol>
<h3 id="unary-operator-spacing">Unary operator spacing<a class="headerlink" href="#unary-operator-spacing" title="Permanent link">&para;</a></h3>
<p>Disallows spaces around unary operators.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="77:2"><input checked="checked" id="__tabbed_77_1" name="__tabbed_77" type="radio" /><input id="__tabbed_77_2" name="__tabbed_77" type="radio" /><div class="tabbed-labels"><label for="__tabbed_77_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_77_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-382-1" name="__codelineno-382-1" href="#__codelineno-382-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo1</span><span class="p">(</span><span class="n">i</span><span class="p">:</span><span class="w"> </span><span class="kt">Int</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">i</span><span class="o">++</span>
<a id="__codelineno-382-2" name="__codelineno-382-2" href="#__codelineno-382-2"></a>
<a id="__codelineno-382-3" name="__codelineno-382-3" href="#__codelineno-382-3"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo2</span><span class="p">(</span><span class="n">i</span><span class="p">:</span><span class="w"> </span><span class="kt">Int</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">++</span><span class="n">i</span>
<a id="__codelineno-382-4" name="__codelineno-382-4" href="#__codelineno-382-4"></a>
<a id="__codelineno-382-5" name="__codelineno-382-5" href="#__codelineno-382-5"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo3</span><span class="p">(</span><span class="n">i</span><span class="p">:</span><span class="w"> </span><span class="kt">Int</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">++</span><span class="n">i</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-383-1" name="__codelineno-383-1" href="#__codelineno-383-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo1</span><span class="p">(</span><span class="n">i</span><span class="p">:</span><span class="w"> </span><span class="kt">Int</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">i</span><span class="w"> </span><span class="o">++</span>
<a id="__codelineno-383-2" name="__codelineno-383-2" href="#__codelineno-383-2"></a>
<a id="__codelineno-383-3" name="__codelineno-383-3" href="#__codelineno-383-3"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo2</span><span class="p">(</span><span class="n">i</span><span class="p">:</span><span class="w"> </span><span class="kt">Int</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">++</span><span class="w"> </span><span class="n">i</span>
<a id="__codelineno-383-4" name="__codelineno-383-4" href="#__codelineno-383-4"></a>
<a id="__codelineno-383-5" name="__codelineno-383-5" href="#__codelineno-383-5"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo3</span><span class="p">(</span><span class="n">i</span><span class="p">:</span><span class="w"> </span><span class="kt">Int</span><span class="p">)</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">++</span>
<a id="__codelineno-383-6" name="__codelineno-383-6" href="#__codelineno-383-6"></a><span class="w"> </span><span class="n">i</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:unary-op-spacing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-384-1" name="__codelineno-384-1" href="#__codelineno-384-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:unary-op-spacing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-385-1" name="__codelineno-385-1" href="#__codelineno-385-1"></a>ktlint_standard_unary-op-spacing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-386-1" name="__codelineno-386-1" href="#__codelineno-386-1"></a>ktlint_standard_unary-op-spacing = disabled
</code></pre></div></li>
</ol>
<h2 id="string-template">String template<a class="headerlink" href="#string-template" title="Permanent link">&para;</a></h2>
<p>Enforces consistent string templates (<code>$v</code> instead of <code>${v}</code>, <code>${p.v}</code> instead of <code>${p.v.toString()}</code>)</p>
<div class="tabbed-set tabbed-alternate" data-tabs="78:2"><input checked="checked" id="__tabbed_78_1" name="__tabbed_78" type="radio" /><input id="__tabbed_78_2" name="__tabbed_78" type="radio" /><div class="tabbed-labels"><label for="__tabbed_78_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_78_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-387-1" name="__codelineno-387-1" href="#__codelineno-387-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;</span><span class="si">$</span><span class="n">foo</span><span class="s"> hello&quot;</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-388-1" name="__codelineno-388-1" href="#__codelineno-388-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;</span><span class="si">${</span><span class="n">foo</span><span class="si">}</span><span class="s"> hello&quot;</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:string-template</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-389-1" name="__codelineno-389-1" href="#__codelineno-389-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:string-template&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-390-1" name="__codelineno-390-1" href="#__codelineno-390-1"></a>ktlint_standard_string-template = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-391-1" name="__codelineno-391-1" href="#__codelineno-391-1"></a>ktlint_standard_string-template = disabled
</code></pre></div></li>
</ol>
<h2 id="string-template-indent">String template indent<a class="headerlink" href="#string-template-indent" title="Permanent link">&para;</a></h2>
<p>Enforces consistent string template indentation for multiline string templates which are post-fixed with <code>.trimIndent()</code>. The opening and closing <code>"""</code> are placed on separate lines and the indentation of the content of the template is aligned with the <code>"""</code>.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="79:2"><input checked="checked" id="__tabbed_79_1" name="__tabbed_79" type="radio" /><input id="__tabbed_79_2" name="__tabbed_79" type="radio" /><div class="tabbed-labels"><label for="__tabbed_79_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_79_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-392-1" name="__codelineno-392-1" href="#__codelineno-392-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-392-2" name="__codelineno-392-2" href="#__codelineno-392-2"></a><span class="w"> </span><span class="s">&quot;&quot;&quot;</span>
<a id="__codelineno-392-3" name="__codelineno-392-3" href="#__codelineno-392-3"></a><span class="s"> line1</span>
<a id="__codelineno-392-4" name="__codelineno-392-4" href="#__codelineno-392-4"></a><span class="s"> line2</span>
<a id="__codelineno-392-5" name="__codelineno-392-5" href="#__codelineno-392-5"></a><span class="s"> &quot;&quot;&quot;</span><span class="p">.</span><span class="na">trimIndent</span><span class="p">()</span>
<a id="__codelineno-392-6" name="__codelineno-392-6" href="#__codelineno-392-6"></a>
<a id="__codelineno-392-7" name="__codelineno-392-7" href="#__codelineno-392-7"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-392-8" name="__codelineno-392-8" href="#__codelineno-392-8"></a><span class="w"> </span><span class="c1">// The opening &quot;&quot;&quot; can not be wrapped to next line as that would result in a compilation error</span>
<a id="__codelineno-392-9" name="__codelineno-392-9" href="#__codelineno-392-9"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="s">&quot;&quot;&quot;</span>
<a id="__codelineno-392-10" name="__codelineno-392-10" href="#__codelineno-392-10"></a><span class="s"> line1</span>
<a id="__codelineno-392-11" name="__codelineno-392-11" href="#__codelineno-392-11"></a><span class="s"> line2</span>
<a id="__codelineno-392-12" name="__codelineno-392-12" href="#__codelineno-392-12"></a><span class="s"> &quot;&quot;&quot;</span><span class="p">.</span><span class="na">trimIndent</span><span class="p">()</span>
<a id="__codelineno-392-13" name="__codelineno-392-13" href="#__codelineno-392-13"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-393-1" name="__codelineno-393-1" href="#__codelineno-393-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;&quot;&quot;</span>
<a id="__codelineno-393-2" name="__codelineno-393-2" href="#__codelineno-393-2"></a><span class="s"> line1</span>
<a id="__codelineno-393-3" name="__codelineno-393-3" href="#__codelineno-393-3"></a><span class="s"> line2</span>
<a id="__codelineno-393-4" name="__codelineno-393-4" href="#__codelineno-393-4"></a><span class="s"> &quot;&quot;&quot;</span><span class="p">.</span><span class="na">trimIndent</span><span class="p">()</span>
<a id="__codelineno-393-5" name="__codelineno-393-5" href="#__codelineno-393-5"></a>
<a id="__codelineno-393-6" name="__codelineno-393-6" href="#__codelineno-393-6"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-393-7" name="__codelineno-393-7" href="#__codelineno-393-7"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="s">&quot;&quot;&quot;</span>
<a id="__codelineno-393-8" name="__codelineno-393-8" href="#__codelineno-393-8"></a><span class="s"> line1</span>
<a id="__codelineno-393-9" name="__codelineno-393-9" href="#__codelineno-393-9"></a><span class="s"> line2</span>
<a id="__codelineno-393-10" name="__codelineno-393-10" href="#__codelineno-393-10"></a><span class="s"> &quot;&quot;&quot;</span><span class="p">.</span><span class="na">trimIndent</span><span class="p">()</span>
<a id="__codelineno-393-11" name="__codelineno-393-11" href="#__codelineno-393-11"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:string-template-indent</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-394-1" name="__codelineno-394-1" href="#__codelineno-394-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:string-template-indent&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-395-1" name="__codelineno-395-1" href="#__codelineno-395-1"></a>ktlint_standard_string-template-indent = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-396-1" name="__codelineno-396-1" href="#__codelineno-396-1"></a>ktlint_standard_string-template-indent = disabled
</code></pre></div></li>
</ol>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This rule is only run when <code>ktlint_code_style</code> is set to <code>ktlint_official</code> or when the rule is enabled explicitly.</p>
</div>
<h2 id="trailing-comma-on-call-site">Trailing comma on call site<a class="headerlink" href="#trailing-comma-on-call-site" title="Permanent link">&para;</a></h2>
<p>Enforces consistent removal (default) or adding of trailing commas on call site.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="80:2"><input checked="checked" id="__tabbed_80_1" name="__tabbed_80" type="radio" /><input id="__tabbed_80_2" name="__tabbed_80" type="radio" /><div class="tabbed-labels"><label for="__tabbed_80_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_80_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-397-1" name="__codelineno-397-1" href="#__codelineno-397-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-397-2" name="__codelineno-397-2" href="#__codelineno-397-2"></a><span class="w"> </span><span class="n">FooWrapper</span><span class="p">(</span>
<a id="__codelineno-397-3" name="__codelineno-397-3" href="#__codelineno-397-3"></a><span class="w"> </span><span class="n">Foo</span><span class="p">(</span>
<a id="__codelineno-397-4" name="__codelineno-397-4" href="#__codelineno-397-4"></a><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">3</span><span class="p">,</span>
<a id="__codelineno-397-5" name="__codelineno-397-5" href="#__codelineno-397-5"></a><span class="w"> </span><span class="n">b</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">4</span><span class="p">,</span>
<a id="__codelineno-397-6" name="__codelineno-397-6" href="#__codelineno-397-6"></a><span class="w"> </span><span class="p">),</span>
<a id="__codelineno-397-7" name="__codelineno-397-7" href="#__codelineno-397-7"></a><span class="w"> </span><span class="p">)</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-398-1" name="__codelineno-398-1" href="#__codelineno-398-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-398-2" name="__codelineno-398-2" href="#__codelineno-398-2"></a><span class="w"> </span><span class="n">FooWrapper</span><span class="p">(</span><span class="n">Foo</span><span class="p">(</span>
<a id="__codelineno-398-3" name="__codelineno-398-3" href="#__codelineno-398-3"></a><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">3</span><span class="p">,</span>
<a id="__codelineno-398-4" name="__codelineno-398-4" href="#__codelineno-398-4"></a><span class="w"> </span><span class="n">b</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">4</span><span class="p">,</span>
<a id="__codelineno-398-5" name="__codelineno-398-5" href="#__codelineno-398-5"></a><span class="w"> </span><span class="p">),)</span><span class="w"> </span><span class="c1">// it&#39;s weird to insert &quot;,&quot; between unwrapped (continued) parenthesis</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>ij_kotlin_allow_trailing_comma_on_call_site</code><br/><i>Defines whether a trailing comma (or no trailing comma) should be enforced on the calling site, e.g. argument-list, when-entries, lambda-arguments, indices, etc. When set, IntelliJ IDEA uses this property to <b>allow</b> usage of a trailing comma by discretion of the developer. KtLint however uses this setting to <b>enforce</b> consistent usage of the trailing comma when set.</i></td>
<td style="text-align: center;"><code>true</code></td>
<td style="text-align: center;"><code>true</code></td>
<td style="text-align: center;"><code>false</code></td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Although the <a href="https://kotlinlang.org/docs/reference/coding-conventions.html#trailing-commas">Kotlin coding conventions</a> leaves it to the developer's discretion to use trailing commas on the call site, it also states that usage of trailing commas has several benefits:</p>
<ul>
<li>It makes version-control diffs cleaner – as all the focus is on the changed value.</li>
<li>It makes it easy to add and reorder elements – there is no need to add or delete the comma if you manipulate elements.</li>
<li>It simplifies code generation, for example, for object initializers. The last element can also have a comma.</li>
</ul>
<p>KtLint values <em>consistent</em> formatting more than a per-situation decision, and therefore uses this setting to <em>enforce/disallow</em> usage of trailing comma's on the calling site.</p>
</div>
<p>Rule id: <code>standard:trailing-comma-on-call-site</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-399-1" name="__codelineno-399-1" href="#__codelineno-399-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:trailing-comma-on-call-site&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-400-1" name="__codelineno-400-1" href="#__codelineno-400-1"></a>ktlint_standard_trailing-comma-on-call-site = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-401-1" name="__codelineno-401-1" href="#__codelineno-401-1"></a>ktlint_standard_trailing-comma-on-call-site = disabled
</code></pre></div></li>
</ol>
<h2 id="trailing-comma-on-declaration-site">Trailing comma on declaration site<a class="headerlink" href="#trailing-comma-on-declaration-site" title="Permanent link">&para;</a></h2>
<p>Enforces consistent removal (default) or adding of trailing commas on declaration site.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="81:2"><input checked="checked" id="__tabbed_81_1" name="__tabbed_81" type="radio" /><input id="__tabbed_81_2" name="__tabbed_81" type="radio" /><div class="tabbed-labels"><label for="__tabbed_81_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_81_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-402-1" name="__codelineno-402-1" href="#__codelineno-402-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">FooWrapper</span><span class="p">(</span>
<a id="__codelineno-402-2" name="__codelineno-402-2" href="#__codelineno-402-2"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Foo</span><span class="p">(</span>
<a id="__codelineno-402-3" name="__codelineno-402-3" href="#__codelineno-402-3"></a><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">3</span><span class="p">,</span>
<a id="__codelineno-402-4" name="__codelineno-402-4" href="#__codelineno-402-4"></a><span class="w"> </span><span class="n">b</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">4</span><span class="p">,</span>
<a id="__codelineno-402-5" name="__codelineno-402-5" href="#__codelineno-402-5"></a><span class="w"> </span><span class="p">),</span>
<a id="__codelineno-402-6" name="__codelineno-402-6" href="#__codelineno-402-6"></a><span class="p">)</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-403-1" name="__codelineno-403-1" href="#__codelineno-403-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">FooWrapper</span><span class="p">(</span><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Foo</span><span class="p">(</span>
<a id="__codelineno-403-2" name="__codelineno-403-2" href="#__codelineno-403-2"></a><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">3</span><span class="p">,</span>
<a id="__codelineno-403-3" name="__codelineno-403-3" href="#__codelineno-403-3"></a><span class="w"> </span><span class="n">b</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">4</span><span class="p">,</span>
<a id="__codelineno-403-4" name="__codelineno-403-4" href="#__codelineno-403-4"></a><span class="p">),)</span><span class="w"> </span><span class="c1">// it&#39;s weird to insert &quot;,&quot; between unwrapped (continued) parenthesis</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>ij_kotlin_allow_trailing_comma</code><br/><i>Defines whether a trailing comma (or no trailing comma) should be enforced on the defining site, e.g. parameter-list, type-argument-list, lambda-value-parameters, enum-entries, etc. When set, IntelliJ IDEA uses this property to <b>allow</b> usage of a trailing comma by discretion of the developer. KtLint however uses this setting to <b>enforce</b> consistent usage of the trailing comma when set.</i></td>
<td style="text-align: center;"><code>true</code></td>
<td style="text-align: center;"><code>true</code></td>
<td style="text-align: center;"><code>false</code></td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The <a href="https://kotlinlang.org/docs/reference/coding-conventions.html#trailing-commas">Kotlin coding conventions</a> encourages the usage of trailing commas on the declaration site, but leaves it to the developer's discretion to use trailing commas on the call site. But next to this, it also states that usage of trailing commas has several benefits:</p>
<ul>
<li>It makes version-control diffs cleaner – as all the focus is on the changed value.</li>
<li>It makes it easy to add and reorder elements – there is no need to add or delete the comma if you manipulate elements.</li>
<li>It simplifies code generation, for example, for object initializers. The last element can also have a comma.</li>
</ul>
</div>
<p>KtLint values <em>consistent</em> formatting more than a per-situation decision, and therefore uses this setting to <em>enforce/disallow</em> usage of trailing comma's in declarations.</p>
<p>Rule id: <code>standard:trailing-comma-on-declaration-site</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-404-1" name="__codelineno-404-1" href="#__codelineno-404-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:trailing-comma-on-declaration-site&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-405-1" name="__codelineno-405-1" href="#__codelineno-405-1"></a>ktlint_standard_trailing-comma-on-declaration-site = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-406-1" name="__codelineno-406-1" href="#__codelineno-406-1"></a>ktlint_standard_trailing-comma-on-declaration-site = disabled
</code></pre></div></li>
</ol>
<h2 id="type-argument-comment">Type argument comment<a class="headerlink" href="#type-argument-comment" title="Permanent link">&para;</a></h2>
<p>Disallows comments to be placed at certain locations inside a type argument.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="82:2"><input checked="checked" id="__tabbed_82_1" name="__tabbed_82" type="radio" /><input id="__tabbed_82_2" name="__tabbed_82" type="radio" /><div class="tabbed-labels"><label for="__tabbed_82_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_82_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-407-1" name="__codelineno-407-1" href="#__codelineno-407-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">Foo</span><span class="o">&lt;</span>
<a id="__codelineno-407-2" name="__codelineno-407-2" href="#__codelineno-407-2"></a><span class="w"> </span><span class="cm">/* some comment */</span><span class="w"> </span>
<a id="__codelineno-407-3" name="__codelineno-407-3" href="#__codelineno-407-3"></a><span class="w"> </span><span class="k">out</span><span class="w"> </span><span class="kt">Any</span>
<a id="__codelineno-407-4" name="__codelineno-407-4" href="#__codelineno-407-4"></a><span class="w"> </span><span class="o">&gt;</span><span class="p">.</span><span class="na">foo</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
<a id="__codelineno-407-5" name="__codelineno-407-5" href="#__codelineno-407-5"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">Foo</span><span class="o">&lt;</span>
<a id="__codelineno-407-6" name="__codelineno-407-6" href="#__codelineno-407-6"></a><span class="w"> </span><span class="c1">// some comment </span>
<a id="__codelineno-407-7" name="__codelineno-407-7" href="#__codelineno-407-7"></a><span class="w"> </span><span class="k">out</span><span class="w"> </span><span class="kt">Any</span>
<a id="__codelineno-407-8" name="__codelineno-407-8" href="#__codelineno-407-8"></a><span class="w"> </span><span class="o">&gt;</span><span class="p">.</span><span class="na">foo</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-408-1" name="__codelineno-408-1" href="#__codelineno-408-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">Foo</span><span class="o">&lt;</span><span class="k">out</span><span class="w"> </span><span class="cm">/* some comment */</span><span class="w"> </span><span class="kt">Any</span><span class="o">&gt;</span><span class="p">.</span><span class="na">foo</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
<a id="__codelineno-408-2" name="__codelineno-408-2" href="#__codelineno-408-2"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">Foo</span><span class="o">&lt;</span>
<a id="__codelineno-408-3" name="__codelineno-408-3" href="#__codelineno-408-3"></a><span class="w"> </span><span class="k">out</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="c1">// some comment</span>
<a id="__codelineno-408-4" name="__codelineno-408-4" href="#__codelineno-408-4"></a><span class="w"> </span><span class="o">&gt;</span><span class="p">.</span><span class="na">foo</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
</code></pre></div>
</div>
</div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>In some projects it is an accepted practice to use EOL comments to document the parameter <em>before</em> the comma as is shown below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-409-1" name="__codelineno-409-1" href="#__codelineno-409-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">Foo</span><span class="o">&lt;</span>
<a id="__codelineno-409-2" name="__codelineno-409-2" href="#__codelineno-409-2"></a><span class="w"> </span><span class="k">out</span><span class="w"> </span><span class="n">Bar1</span><span class="p">,</span><span class="w"> </span><span class="c1">// some comment</span>
<a id="__codelineno-409-3" name="__codelineno-409-3" href="#__codelineno-409-3"></a><span class="w"> </span><span class="k">out</span><span class="w"> </span><span class="n">Bar2</span><span class="p">,</span><span class="w"> </span><span class="c1">// some other comment</span>
<a id="__codelineno-409-4" name="__codelineno-409-4" href="#__codelineno-409-4"></a><span class="o">&gt;</span><span class="p">.</span><span class="na">foo</span><span class="p">()</span><span class="w"> </span><span class="p">{}</span>
</code></pre></div>
Although this code sample might look ok, it is semantically and programmatically unclear to which type <code>some comment</code> refers. From the developer perspective it might be clear that it belongs to type <code>Bar1</code>. From the parsers perspective, it does belong to type <code>Bar2</code>.</p>
</div>
<p>Rule id: <code>standard:type-argument-comment</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-410-1" name="__codelineno-410-1" href="#__codelineno-410-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:type-argument-comment&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-411-1" name="__codelineno-411-1" href="#__codelineno-411-1"></a>ktlint_standard_type-argument-comment = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-412-1" name="__codelineno-412-1" href="#__codelineno-412-1"></a>ktlint_standard_type-argument-comment = disabled
</code></pre></div></li>
</ol>
<h2 id="type-parameter-comment">Type parameter comment<a class="headerlink" href="#type-parameter-comment" title="Permanent link">&para;</a></h2>
<p>Disallows comments to be placed at certain locations inside a type parameter.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="83:2"><input checked="checked" id="__tabbed_83_1" name="__tabbed_83" type="radio" /><input id="__tabbed_83_2" name="__tabbed_83" type="radio" /><div class="tabbed-labels"><label for="__tabbed_83_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_83_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-413-1" name="__codelineno-413-1" href="#__codelineno-413-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo1</span><span class="o">&lt;</span>
<a id="__codelineno-413-2" name="__codelineno-413-2" href="#__codelineno-413-2"></a><span class="w"> </span><span class="cm">/* some comment */</span><span class="w"> </span>
<a id="__codelineno-413-3" name="__codelineno-413-3" href="#__codelineno-413-3"></a><span class="w"> </span><span class="k">out</span><span class="w"> </span><span class="n">Bar</span>
<a id="__codelineno-413-4" name="__codelineno-413-4" href="#__codelineno-413-4"></a><span class="w"> </span><span class="o">&gt;</span>
<a id="__codelineno-413-5" name="__codelineno-413-5" href="#__codelineno-413-5"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo2</span><span class="o">&lt;</span>
<a id="__codelineno-413-6" name="__codelineno-413-6" href="#__codelineno-413-6"></a><span class="w"> </span><span class="c1">// some comment </span>
<a id="__codelineno-413-7" name="__codelineno-413-7" href="#__codelineno-413-7"></a><span class="w"> </span><span class="k">out</span><span class="w"> </span><span class="n">Bar</span>
<a id="__codelineno-413-8" name="__codelineno-413-8" href="#__codelineno-413-8"></a><span class="w"> </span><span class="o">&gt;</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-414-1" name="__codelineno-414-1" href="#__codelineno-414-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo1</span><span class="o">&lt;</span><span class="k">in</span><span class="w"> </span><span class="cm">/* some comment */</span><span class="w"> </span><span class="n">Bar</span><span class="o">&gt;</span>
<a id="__codelineno-414-2" name="__codelineno-414-2" href="#__codelineno-414-2"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo2</span><span class="o">&lt;</span>
<a id="__codelineno-414-3" name="__codelineno-414-3" href="#__codelineno-414-3"></a><span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="n">Bar</span><span class="p">,</span><span class="w"> </span><span class="c1">// some comment</span>
<a id="__codelineno-414-4" name="__codelineno-414-4" href="#__codelineno-414-4"></a><span class="w"> </span><span class="o">&gt;</span>
</code></pre></div>
</div>
</div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>In some projects, it is an accepted practice to use EOL comments to document the parameter <em>before</em> the comma as is shown below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-415-1" name="__codelineno-415-1" href="#__codelineno-415-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo</span><span class="o">&lt;</span>
<a id="__codelineno-415-2" name="__codelineno-415-2" href="#__codelineno-415-2"></a><span class="w"> </span><span class="k">out</span><span class="w"> </span><span class="n">Bar1</span><span class="p">,</span><span class="w"> </span><span class="c1">// some comment</span>
<a id="__codelineno-415-3" name="__codelineno-415-3" href="#__codelineno-415-3"></a><span class="w"> </span><span class="k">out</span><span class="w"> </span><span class="n">Bar2</span><span class="p">,</span><span class="w"> </span><span class="c1">// some other comment</span>
<a id="__codelineno-415-4" name="__codelineno-415-4" href="#__codelineno-415-4"></a><span class="o">&gt;</span>
</code></pre></div></p>
</div>
<p>Although this code sample might look ok, it is semantically and programmatically unclear on which parameter <code>some comment</code> refers. From the developer perspective, it might be clear that it belongs to type <code>Bar1</code>. From the parsers perspective, it does belong to type <code>Bar2</code>.</p>
<p>Rule id: <code>standard:type-parameter-comment</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-416-1" name="__codelineno-416-1" href="#__codelineno-416-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:type-parameter-comment&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-417-1" name="__codelineno-417-1" href="#__codelineno-417-1"></a>ktlint_standard_type-parameter-comment = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-418-1" name="__codelineno-418-1" href="#__codelineno-418-1"></a>ktlint_standard_type-parameter-comment = disabled
</code></pre></div></li>
</ol>
<h2 id="unnecessary-parenthesis-before-trailing-lambda">Unnecessary parenthesis before trailing lambda<a class="headerlink" href="#unnecessary-parenthesis-before-trailing-lambda" title="Permanent link">&para;</a></h2>
<p>An empty parentheses block before a lambda is redundant.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="84:2"><input checked="checked" id="__tabbed_84_1" name="__tabbed_84" type="radio" /><input id="__tabbed_84_2" name="__tabbed_84" type="radio" /><div class="tabbed-labels"><label for="__tabbed_84_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_84_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-419-1" name="__codelineno-419-1" href="#__codelineno-419-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-string&quot;</span><span class="p">.</span><span class="na">count</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nb">it</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="sc">&#39;-&#39;</span><span class="w"> </span><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-420-1" name="__codelineno-420-1" href="#__codelineno-420-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;some-string&quot;</span><span class="p">.</span><span class="na">count</span><span class="p">()</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nb">it</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="sc">&#39;-&#39;</span><span class="w"> </span><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:unnecessary-parentheses-before-trailing-lambda</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-421-1" name="__codelineno-421-1" href="#__codelineno-421-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:unnecessary-parentheses-before-trailing-lambda&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-422-1" name="__codelineno-422-1" href="#__codelineno-422-1"></a>ktlint_standard_unnecessary-parentheses-before-trailing-lambda = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-423-1" name="__codelineno-423-1" href="#__codelineno-423-1"></a>ktlint_standard_unnecessary-parentheses-before-trailing-lambda = disabled
</code></pre></div></li>
</ol>
<h2 id="value-argument-comment">Value argument comment<a class="headerlink" href="#value-argument-comment" title="Permanent link">&para;</a></h2>
<p>Disallows comments to be placed at certain locations inside a value argument.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="85:2"><input checked="checked" id="__tabbed_85_1" name="__tabbed_85" type="radio" /><input id="__tabbed_85_2" name="__tabbed_85" type="radio" /><div class="tabbed-labels"><label for="__tabbed_85_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_85_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-424-1" name="__codelineno-424-1" href="#__codelineno-424-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-424-2" name="__codelineno-424-2" href="#__codelineno-424-2"></a><span class="w"> </span><span class="n">foo</span><span class="p">(</span>
<a id="__codelineno-424-3" name="__codelineno-424-3" href="#__codelineno-424-3"></a><span class="w"> </span><span class="cm">/* some comment */</span>
<a id="__codelineno-424-4" name="__codelineno-424-4" href="#__codelineno-424-4"></a><span class="w"> </span><span class="n">bar</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;bar&quot;</span>
<a id="__codelineno-424-5" name="__codelineno-424-5" href="#__codelineno-424-5"></a><span class="w"> </span><span class="p">)</span>
<a id="__codelineno-424-6" name="__codelineno-424-6" href="#__codelineno-424-6"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-424-7" name="__codelineno-424-7" href="#__codelineno-424-7"></a><span class="w"> </span><span class="n">foo</span><span class="p">(</span>
<a id="__codelineno-424-8" name="__codelineno-424-8" href="#__codelineno-424-8"></a><span class="w"> </span><span class="c1">// some comment</span>
<a id="__codelineno-424-9" name="__codelineno-424-9" href="#__codelineno-424-9"></a><span class="w"> </span><span class="n">bar</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;bar&quot;</span>
<a id="__codelineno-424-10" name="__codelineno-424-10" href="#__codelineno-424-10"></a><span class="w"> </span><span class="p">)</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-425-1" name="__codelineno-425-1" href="#__codelineno-425-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">foo</span><span class="p">(</span><span class="n">bar</span><span class="w"> </span><span class="cm">/* some comment */</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;bar&quot;</span><span class="p">)</span>
<a id="__codelineno-425-2" name="__codelineno-425-2" href="#__codelineno-425-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span>
<a id="__codelineno-425-3" name="__codelineno-425-3" href="#__codelineno-425-3"></a><span class="w"> </span><span class="n">foo</span><span class="p">(</span>
<a id="__codelineno-425-4" name="__codelineno-425-4" href="#__codelineno-425-4"></a><span class="w"> </span><span class="n">bar</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="c1">// some comment</span>
<a id="__codelineno-425-5" name="__codelineno-425-5" href="#__codelineno-425-5"></a><span class="w"> </span><span class="s">&quot;bar&quot;</span>
<a id="__codelineno-425-6" name="__codelineno-425-6" href="#__codelineno-425-6"></a><span class="w"> </span><span class="p">)</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:value-argument-comment</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-426-1" name="__codelineno-426-1" href="#__codelineno-426-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:value-argument-comment&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-427-1" name="__codelineno-427-1" href="#__codelineno-427-1"></a>ktlint_standard_value-argument-comment = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-428-1" name="__codelineno-428-1" href="#__codelineno-428-1"></a>ktlint_standard_value-argument-comment = disabled
</code></pre></div></li>
</ol>
<h2 id="value-parameter-comment">Value parameter comment<a class="headerlink" href="#value-parameter-comment" title="Permanent link">&para;</a></h2>
<p>Disallows comments to be placed at certain locations inside a value argument.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="86:2"><input checked="checked" id="__tabbed_86_1" name="__tabbed_86" type="radio" /><input id="__tabbed_86_2" name="__tabbed_86" type="radio" /><div class="tabbed-labels"><label for="__tabbed_86_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_86_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-429-1" name="__codelineno-429-1" href="#__codelineno-429-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo1</span><span class="p">(</span>
<a id="__codelineno-429-2" name="__codelineno-429-2" href="#__codelineno-429-2"></a><span class="w"> </span><span class="cm">/** some kdoc */</span>
<a id="__codelineno-429-3" name="__codelineno-429-3" href="#__codelineno-429-3"></a><span class="w"> </span><span class="n">bar</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;bar&quot;</span>
<a id="__codelineno-429-4" name="__codelineno-429-4" href="#__codelineno-429-4"></a><span class="p">)</span>
<a id="__codelineno-429-5" name="__codelineno-429-5" href="#__codelineno-429-5"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo2</span><span class="p">(</span>
<a id="__codelineno-429-6" name="__codelineno-429-6" href="#__codelineno-429-6"></a><span class="w"> </span><span class="cm">/* some comment */</span>
<a id="__codelineno-429-7" name="__codelineno-429-7" href="#__codelineno-429-7"></a><span class="w"> </span><span class="n">bar</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;bar&quot;</span>
<a id="__codelineno-429-8" name="__codelineno-429-8" href="#__codelineno-429-8"></a><span class="p">)</span>
<a id="__codelineno-429-9" name="__codelineno-429-9" href="#__codelineno-429-9"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo3</span><span class="p">(</span>
<a id="__codelineno-429-10" name="__codelineno-429-10" href="#__codelineno-429-10"></a><span class="w"> </span><span class="c1">// some comment</span>
<a id="__codelineno-429-11" name="__codelineno-429-11" href="#__codelineno-429-11"></a><span class="w"> </span><span class="n">bar</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;bar&quot;</span>
<a id="__codelineno-429-12" name="__codelineno-429-12" href="#__codelineno-429-12"></a><span class="p">)</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-430-1" name="__codelineno-430-1" href="#__codelineno-430-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo1</span><span class="p">(</span>
<a id="__codelineno-430-2" name="__codelineno-430-2" href="#__codelineno-430-2"></a><span class="w"> </span><span class="n">bar</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="cm">/** some kdoc */</span><span class="w"> </span><span class="s">&quot;bar&quot;</span>
<a id="__codelineno-430-3" name="__codelineno-430-3" href="#__codelineno-430-3"></a><span class="p">)</span>
<a id="__codelineno-430-4" name="__codelineno-430-4" href="#__codelineno-430-4"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo2</span><span class="p">(</span>
<a id="__codelineno-430-5" name="__codelineno-430-5" href="#__codelineno-430-5"></a><span class="w"> </span><span class="n">bar</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="cm">/* some comment */</span><span class="w"> </span><span class="s">&quot;bar&quot;</span>
<a id="__codelineno-430-6" name="__codelineno-430-6" href="#__codelineno-430-6"></a><span class="p">)</span>
<a id="__codelineno-430-7" name="__codelineno-430-7" href="#__codelineno-430-7"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Foo3</span><span class="p">(</span>
<a id="__codelineno-430-8" name="__codelineno-430-8" href="#__codelineno-430-8"></a><span class="w"> </span><span class="n">bar</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-430-9" name="__codelineno-430-9" href="#__codelineno-430-9"></a><span class="w"> </span><span class="c1">// some comment</span>
<a id="__codelineno-430-10" name="__codelineno-430-10" href="#__codelineno-430-10"></a><span class="w"> </span><span class="s">&quot;bar&quot;</span>
<a id="__codelineno-430-11" name="__codelineno-430-11" href="#__codelineno-430-11"></a><span class="p">)</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:value-parameter-comment</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-431-1" name="__codelineno-431-1" href="#__codelineno-431-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:value-parameter-comment&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-432-1" name="__codelineno-432-1" href="#__codelineno-432-1"></a>ktlint_standard_value-parameter-comment = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-433-1" name="__codelineno-433-1" href="#__codelineno-433-1"></a>ktlint_standard_value-parameter-comment = disabled
</code></pre></div></li>
</ol>
<h2 id="when-entry-bracing">When-entry bracing<a class="headerlink" href="#when-entry-bracing" title="Permanent link">&para;</a></h2>
<p>Enforces consistent usages of braces inside the when-statement. All when-entries in the when-statement should use braces around their bodies in case at least one when-entry has a multiline body, or when the body is surrounded by braces.</p>
<p>Braces are helpful for following reasons:</p>
<ul>
<li>Bodies of the when-conditions are all aligned at same column position</li>
<li>Closing braces helps in separating the when-conditions</li>
</ul>
<p>This rule is not incorporated in the Kotlin Coding conventions, nor in the Android Kotlin Styleguide. It is based on similar behavior in enforcing consistent use of braces in if-else statements. As of that the rule is only enabled automatically for code style <code>ktlint_official</code>. It can be enabled explicitly for other code styles.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="87:2"><input checked="checked" id="__tabbed_87_1" name="__tabbed_87" type="radio" /><input id="__tabbed_87_2" name="__tabbed_87" type="radio" /><div class="tabbed-labels"><label for="__tabbed_87_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_87_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-434-1" name="__codelineno-434-1" href="#__codelineno-434-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-434-2" name="__codelineno-434-2" href="#__codelineno-434-2"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="p">(</span><span class="n">bar</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-434-3" name="__codelineno-434-3" href="#__codelineno-434-3"></a><span class="w"> </span><span class="n">BAR1</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="s">&quot;bar1&quot;</span>
<a id="__codelineno-434-4" name="__codelineno-434-4" href="#__codelineno-434-4"></a><span class="w"> </span><span class="n">BAR2</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="s">&quot;bar2&quot;</span>
<a id="__codelineno-434-5" name="__codelineno-434-5" href="#__codelineno-434-5"></a><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kc">null</span>
<a id="__codelineno-434-6" name="__codelineno-434-6" href="#__codelineno-434-6"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-434-7" name="__codelineno-434-7" href="#__codelineno-434-7"></a>
<a id="__codelineno-434-8" name="__codelineno-434-8" href="#__codelineno-434-8"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-434-9" name="__codelineno-434-9" href="#__codelineno-434-9"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="p">(</span><span class="n">bar</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-434-10" name="__codelineno-434-10" href="#__codelineno-434-10"></a><span class="w"> </span><span class="n">BAR1</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-434-11" name="__codelineno-434-11" href="#__codelineno-434-11"></a><span class="w"> </span><span class="s">&quot;bar1&quot;</span>
<a id="__codelineno-434-12" name="__codelineno-434-12" href="#__codelineno-434-12"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-434-13" name="__codelineno-434-13" href="#__codelineno-434-13"></a><span class="w"> </span><span class="n">BAR2</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-434-14" name="__codelineno-434-14" href="#__codelineno-434-14"></a><span class="w"> </span><span class="s">&quot;bar2&quot;</span>
<a id="__codelineno-434-15" name="__codelineno-434-15" href="#__codelineno-434-15"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-434-16" name="__codelineno-434-16" href="#__codelineno-434-16"></a><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-434-17" name="__codelineno-434-17" href="#__codelineno-434-17"></a><span class="w"> </span><span class="kc">null</span>
<a id="__codelineno-434-18" name="__codelineno-434-18" href="#__codelineno-434-18"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-434-19" name="__codelineno-434-19" href="#__codelineno-434-19"></a><span class="w"> </span><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-435-1" name="__codelineno-435-1" href="#__codelineno-435-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo3</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-435-2" name="__codelineno-435-2" href="#__codelineno-435-2"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="p">(</span><span class="n">bar</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-435-3" name="__codelineno-435-3" href="#__codelineno-435-3"></a><span class="w"> </span><span class="n">BAR1</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="s">&quot;bar1&quot;</span>
<a id="__codelineno-435-4" name="__codelineno-435-4" href="#__codelineno-435-4"></a><span class="w"> </span><span class="n">BAR2</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-435-5" name="__codelineno-435-5" href="#__codelineno-435-5"></a><span class="w"> </span><span class="s">&quot;bar2&quot;</span>
<a id="__codelineno-435-6" name="__codelineno-435-6" href="#__codelineno-435-6"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-435-7" name="__codelineno-435-7" href="#__codelineno-435-7"></a><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kc">null</span>
<a id="__codelineno-435-8" name="__codelineno-435-8" href="#__codelineno-435-8"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-435-9" name="__codelineno-435-9" href="#__codelineno-435-9"></a>
<a id="__codelineno-435-10" name="__codelineno-435-10" href="#__codelineno-435-10"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo4</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-435-11" name="__codelineno-435-11" href="#__codelineno-435-11"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="p">(</span><span class="n">bar</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-435-12" name="__codelineno-435-12" href="#__codelineno-435-12"></a><span class="w"> </span><span class="n">BAR1</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="s">&quot;bar1&quot;</span>
<a id="__codelineno-435-13" name="__codelineno-435-13" href="#__codelineno-435-13"></a><span class="w"> </span><span class="n">BAR2</span><span class="w"> </span><span class="o">-&gt;</span>
<a id="__codelineno-435-14" name="__codelineno-435-14" href="#__codelineno-435-14"></a><span class="w"> </span><span class="s">&quot;bar2&quot;</span>
<a id="__codelineno-435-15" name="__codelineno-435-15" href="#__codelineno-435-15"></a><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kc">null</span>
<a id="__codelineno-435-16" name="__codelineno-435-16" href="#__codelineno-435-16"></a><span class="w"> </span><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:when-entry-bracing</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-436-1" name="__codelineno-436-1" href="#__codelineno-436-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:when-entry-bracing&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-437-1" name="__codelineno-437-1" href="#__codelineno-437-1"></a>ktlint_standard_when-entry-bracing = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-438-1" name="__codelineno-438-1" href="#__codelineno-438-1"></a>ktlint_standard_when-entry-bracing = disabled
</code></pre></div></li>
</ol>
<h2 id="wrapping">Wrapping<a class="headerlink" href="#wrapping" title="Permanent link">&para;</a></h2>
<h3 id="argument-list-wrapping">Argument list wrapping<a class="headerlink" href="#argument-list-wrapping" title="Permanent link">&para;</a></h3>
<p>All arguments should either be on the same line, or on a separate line.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="88:2"><input checked="checked" id="__tabbed_88_1" name="__tabbed_88" type="radio" /><input id="__tabbed_88_2" name="__tabbed_88" type="radio" /><div class="tabbed-labels"><label for="__tabbed_88_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_88_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-439-1" name="__codelineno-439-1" href="#__codelineno-439-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-439-2" name="__codelineno-439-2" href="#__codelineno-439-2"></a><span class="w"> </span><span class="n">foo</span><span class="p">(</span>
<a id="__codelineno-439-3" name="__codelineno-439-3" href="#__codelineno-439-3"></a><span class="w"> </span><span class="n">a</span><span class="p">,</span>
<a id="__codelineno-439-4" name="__codelineno-439-4" href="#__codelineno-439-4"></a><span class="w"> </span><span class="n">b</span><span class="p">,</span>
<a id="__codelineno-439-5" name="__codelineno-439-5" href="#__codelineno-439-5"></a><span class="w"> </span><span class="n">c</span><span class="p">,</span>
<a id="__codelineno-439-6" name="__codelineno-439-6" href="#__codelineno-439-6"></a><span class="w"> </span><span class="p">)</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-440-1" name="__codelineno-440-1" href="#__codelineno-440-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-440-2" name="__codelineno-440-2" href="#__codelineno-440-2"></a><span class="w"> </span><span class="n">foo</span><span class="p">(</span>
<a id="__codelineno-440-3" name="__codelineno-440-3" href="#__codelineno-440-3"></a><span class="w"> </span><span class="n">a</span><span class="p">,</span>
<a id="__codelineno-440-4" name="__codelineno-440-4" href="#__codelineno-440-4"></a><span class="w"> </span><span class="n">b</span><span class="p">,</span><span class="w"> </span><span class="n">c</span><span class="p">,</span>
<a id="__codelineno-440-5" name="__codelineno-440-5" href="#__codelineno-440-5"></a><span class="w"> </span><span class="p">)</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>ktlint_argument_list_wrapping_ignore_when_parameter_count_greater_or_equal_than</code></td>
<td style="text-align: center;"><code>unset</code></td>
<td style="text-align: center;">8</td>
<td style="text-align: center;">8</td>
</tr>
<tr>
<td style="text-align: left;"><code>max_line_length</code><br/><i>Maximum length of a (regular) line. This property is ignored in case the <code>max-line-length</code> rule is disabled, or when using Ktlint via a third party integration that does not provide this rule.</i></td>
<td style="text-align: center;">140</td>
<td style="text-align: center;"><code>off</code></td>
<td style="text-align: center;"><code>100</code></td>
</tr>
</tbody>
</table>
<p>Rule id: <code>standard:argument-list-wrapping</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-441-1" name="__codelineno-441-1" href="#__codelineno-441-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:argument-list-wrapping&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-442-1" name="__codelineno-442-1" href="#__codelineno-442-1"></a>ktlint_standard_argument-list-wrapping = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-443-1" name="__codelineno-443-1" href="#__codelineno-443-1"></a>ktlint_standard_argument-list-wrapping = disabled
</code></pre></div></li>
</ol>
<h3 id="chain-wrapping">Chain wrapping<a class="headerlink" href="#chain-wrapping" title="Permanent link">&para;</a></h3>
<p>When wrapping chained calls <code>.</code>, <code>?.</code> and <code>?:</code> should be placed on the next line</p>
<div class="tabbed-set tabbed-alternate" data-tabs="89:2"><input checked="checked" id="__tabbed_89_1" name="__tabbed_89" type="radio" /><input id="__tabbed_89_2" name="__tabbed_89" type="radio" /><div class="tabbed-labels"><label for="__tabbed_89_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_89_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-444-1" name="__codelineno-444-1" href="#__codelineno-444-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-444-2" name="__codelineno-444-2" href="#__codelineno-444-2"></a><span class="w"> </span><span class="n">listOf</span><span class="p">(</span><span class="m">1</span><span class="p">,</span><span class="w"> </span><span class="m">2</span><span class="p">,</span><span class="w"> </span><span class="m">3</span><span class="p">)</span>
<a id="__codelineno-444-3" name="__codelineno-444-3" href="#__codelineno-444-3"></a><span class="w"> </span><span class="p">.</span><span class="na">filter</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nb">it</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="p">}</span><span class="o">!!</span>
<a id="__codelineno-444-4" name="__codelineno-444-4" href="#__codelineno-444-4"></a><span class="w"> </span><span class="p">.</span><span class="na">takeIf</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nb">it</span><span class="p">.</span><span class="na">count</span><span class="p">()</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="m">100</span><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-444-5" name="__codelineno-444-5" href="#__codelineno-444-5"></a><span class="w"> </span><span class="o">?.</span><span class="na">sum</span><span class="p">()</span>
<a id="__codelineno-444-6" name="__codelineno-444-6" href="#__codelineno-444-6"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foobar</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-444-7" name="__codelineno-444-7" href="#__codelineno-444-7"></a><span class="w"> </span><span class="n">foo</span><span class="p">()</span>
<a id="__codelineno-444-8" name="__codelineno-444-8" href="#__codelineno-444-8"></a><span class="w"> </span><span class="o">?:</span><span class="w"> </span><span class="n">bar</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-445-1" name="__codelineno-445-1" href="#__codelineno-445-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-445-2" name="__codelineno-445-2" href="#__codelineno-445-2"></a><span class="w"> </span><span class="n">listOf</span><span class="p">(</span><span class="m">1</span><span class="p">,</span><span class="w"> </span><span class="m">2</span><span class="p">,</span><span class="w"> </span><span class="m">3</span><span class="p">).</span>
<a id="__codelineno-445-3" name="__codelineno-445-3" href="#__codelineno-445-3"></a><span class="w"> </span><span class="n">filter</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nb">it</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="p">}</span><span class="o">!!</span><span class="p">.</span>
<a id="__codelineno-445-4" name="__codelineno-445-4" href="#__codelineno-445-4"></a><span class="w"> </span><span class="n">takeIf</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nb">it</span><span class="p">.</span><span class="na">count</span><span class="p">()</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="m">100</span><span class="w"> </span><span class="p">}</span><span class="o">?.</span>
<a id="__codelineno-445-5" name="__codelineno-445-5" href="#__codelineno-445-5"></a><span class="w"> </span><span class="n">sum</span><span class="p">()</span>
<a id="__codelineno-445-6" name="__codelineno-445-6" href="#__codelineno-445-6"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foobar</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-445-7" name="__codelineno-445-7" href="#__codelineno-445-7"></a><span class="w"> </span><span class="n">foo</span><span class="p">()</span><span class="w"> </span><span class="o">?:</span>
<a id="__codelineno-445-8" name="__codelineno-445-8" href="#__codelineno-445-8"></a><span class="w"> </span><span class="n">bar</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:chain-wrapping</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-446-1" name="__codelineno-446-1" href="#__codelineno-446-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:chain-wrapping&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-447-1" name="__codelineno-447-1" href="#__codelineno-447-1"></a>ktlint_standard_chain-wrapping = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-448-1" name="__codelineno-448-1" href="#__codelineno-448-1"></a>ktlint_standard_chain-wrapping = disabled
</code></pre></div></li>
</ol>
<h3 id="comment-wrapping">Comment wrapping<a class="headerlink" href="#comment-wrapping" title="Permanent link">&para;</a></h3>
<p>A block comment must start and end on a line that does not contain any other element.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="90:2"><input checked="checked" id="__tabbed_90_1" name="__tabbed_90" type="radio" /><input id="__tabbed_90_2" name="__tabbed_90" type="radio" /><div class="tabbed-labels"><label for="__tabbed_90_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_90_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-449-1" name="__codelineno-449-1" href="#__codelineno-449-1"></a><span class="c1">// Some comment 1</span>
<a id="__codelineno-449-2" name="__codelineno-449-2" href="#__codelineno-449-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo1&quot;</span>
<a id="__codelineno-449-3" name="__codelineno-449-3" href="#__codelineno-449-3"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo&quot;</span><span class="w"> </span><span class="c1">// Some comment</span>
<a id="__codelineno-449-4" name="__codelineno-449-4" href="#__codelineno-449-4"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="cm">/* no-op */</span><span class="w"> </span><span class="p">}</span><span class="w"> </span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-450-1" name="__codelineno-450-1" href="#__codelineno-450-1"></a><span class="cm">/* Some comment 1 */</span><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">foo1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo1&quot;</span>
<a id="__codelineno-450-2" name="__codelineno-450-2" href="#__codelineno-450-2"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo&quot;</span><span class="w"> </span><span class="cm">/* Block comment instead of end-of-line comment */</span>
<a id="__codelineno-450-3" name="__codelineno-450-3" href="#__codelineno-450-3"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo3</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo&quot;</span><span class="w"> </span><span class="cm">/* Some comment</span>
<a id="__codelineno-450-4" name="__codelineno-450-4" href="#__codelineno-450-4"></a><span class="cm"> * with a newline</span>
<a id="__codelineno-450-5" name="__codelineno-450-5" href="#__codelineno-450-5"></a><span class="cm"> */</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:comment-wrapping</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-451-1" name="__codelineno-451-1" href="#__codelineno-451-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:comment-wrapping&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-452-1" name="__codelineno-452-1" href="#__codelineno-452-1"></a>ktlint_standard_comment-wrapping = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-453-1" name="__codelineno-453-1" href="#__codelineno-453-1"></a>ktlint_standard_comment-wrapping = disabled
</code></pre></div></li>
</ol>
<h3 id="context-receiver-wrapping">Context receiver wrapping<a class="headerlink" href="#context-receiver-wrapping" title="Permanent link">&para;</a></h3>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>Context receivers are deprecated starting from Kotlin 2.2.0 and will be removed in a future version. Once KtLint is upgraded to a Kotlin version that no longer supports context receivers, then you will not be able to use that KtLint version as long as your code still contains context receiver.</p>
</div>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>This rule does not affect context parameters. See rule <code>context-receiver-list-wrapping</code> for wrapping of context parameters.</p>
</div>
<p>Wraps the context receiver list containing a context receiver to a separate line regardless of maximum line length. If the maximum line length is configured and is exceeded, wrap the context receivers and if needed its projection types to separate lines.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="91:2"><input checked="checked" id="__tabbed_91_1" name="__tabbed_91" type="radio" /><input id="__tabbed_91_2" name="__tabbed_91" type="radio" /><div class="tabbed-labels"><label for="__tabbed_91_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_91_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-454-1" name="__codelineno-454-1" href="#__codelineno-454-1"></a><span class="c1">// Always wrap regardless of whether max line length is set</span>
<a id="__codelineno-454-2" name="__codelineno-454-2" href="#__codelineno-454-2"></a><span class="n">context</span><span class="p">(</span><span class="n">Foo</span><span class="p">)</span>
<a id="__codelineno-454-3" name="__codelineno-454-3" href="#__codelineno-454-3"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">fooBar</span><span class="p">()</span>
<a id="__codelineno-454-4" name="__codelineno-454-4" href="#__codelineno-454-4"></a>
<a id="__codelineno-454-5" name="__codelineno-454-5" href="#__codelineno-454-5"></a><span class="c1">// Wrap each context receiver to a separate line when the</span>
<a id="__codelineno-454-6" name="__codelineno-454-6" href="#__codelineno-454-6"></a><span class="c1">// entire context receiver list does not fit on a single line</span>
<a id="__codelineno-454-7" name="__codelineno-454-7" href="#__codelineno-454-7"></a><span class="n">context</span><span class="p">(</span>
<a id="__codelineno-454-8" name="__codelineno-454-8" href="#__codelineno-454-8"></a><span class="w"> </span><span class="n">Fooooooooooooooooooo1</span><span class="p">,</span>
<a id="__codelineno-454-9" name="__codelineno-454-9" href="#__codelineno-454-9"></a><span class="w"> </span><span class="n">Foooooooooooooooooooooooooooooo2</span>
<a id="__codelineno-454-10" name="__codelineno-454-10" href="#__codelineno-454-10"></a><span class="p">)</span>
<a id="__codelineno-454-11" name="__codelineno-454-11" href="#__codelineno-454-11"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">fooBar</span><span class="p">()</span>
<a id="__codelineno-454-12" name="__codelineno-454-12" href="#__codelineno-454-12"></a>
<a id="__codelineno-454-13" name="__codelineno-454-13" href="#__codelineno-454-13"></a><span class="c1">// Wrap each context receiver to a separate line when the</span>
<a id="__codelineno-454-14" name="__codelineno-454-14" href="#__codelineno-454-14"></a><span class="c1">// entire context receiver list does not fit on a single line.</span>
<a id="__codelineno-454-15" name="__codelineno-454-15" href="#__codelineno-454-15"></a><span class="c1">// Also, wrap each of it projection types in case a context</span>
<a id="__codelineno-454-16" name="__codelineno-454-16" href="#__codelineno-454-16"></a><span class="c1">// receiver does not fit on a single line after it has been</span>
<a id="__codelineno-454-17" name="__codelineno-454-17" href="#__codelineno-454-17"></a><span class="c1">// wrapped.</span>
<a id="__codelineno-454-18" name="__codelineno-454-18" href="#__codelineno-454-18"></a><span class="n">context</span><span class="p">(</span>
<a id="__codelineno-454-19" name="__codelineno-454-19" href="#__codelineno-454-19"></a><span class="w"> </span><span class="n">Foooooooooooooooo</span><span class="o">&lt;</span>
<a id="__codelineno-454-20" name="__codelineno-454-20" href="#__codelineno-454-20"></a><span class="w"> </span><span class="n">Foo</span><span class="p">,</span>
<a id="__codelineno-454-21" name="__codelineno-454-21" href="#__codelineno-454-21"></a><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-454-22" name="__codelineno-454-22" href="#__codelineno-454-22"></a><span class="w"> </span><span class="o">&gt;</span>
<a id="__codelineno-454-23" name="__codelineno-454-23" href="#__codelineno-454-23"></a><span class="p">)</span>
<a id="__codelineno-454-24" name="__codelineno-454-24" href="#__codelineno-454-24"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">fooBar</span><span class="p">()</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-455-1" name="__codelineno-455-1" href="#__codelineno-455-1"></a><span class="c1">// Should be wrapped regardless of whether max line length is set</span>
<a id="__codelineno-455-2" name="__codelineno-455-2" href="#__codelineno-455-2"></a><span class="n">context</span><span class="p">(</span><span class="n">Foo</span><span class="p">)</span><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">fooBar</span><span class="p">()</span>
<a id="__codelineno-455-3" name="__codelineno-455-3" href="#__codelineno-455-3"></a>
<a id="__codelineno-455-4" name="__codelineno-455-4" href="#__codelineno-455-4"></a><span class="c1">// Should be wrapped when the entire context receiver list does not</span>
<a id="__codelineno-455-5" name="__codelineno-455-5" href="#__codelineno-455-5"></a><span class="c1">// fit on a single line</span>
<a id="__codelineno-455-6" name="__codelineno-455-6" href="#__codelineno-455-6"></a><span class="n">context</span><span class="p">(</span><span class="n">Fooooooooooooooooooo1</span><span class="p">,</span><span class="w"> </span><span class="n">Foooooooooooooooooooooooooooooo2</span><span class="p">)</span>
<a id="__codelineno-455-7" name="__codelineno-455-7" href="#__codelineno-455-7"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">fooBar</span><span class="p">()</span>
<a id="__codelineno-455-8" name="__codelineno-455-8" href="#__codelineno-455-8"></a>
<a id="__codelineno-455-9" name="__codelineno-455-9" href="#__codelineno-455-9"></a><span class="c1">// Should be wrapped when the entire context receiver list does not</span>
<a id="__codelineno-455-10" name="__codelineno-455-10" href="#__codelineno-455-10"></a><span class="c1">// fit on a single line. Also, it should wrap each of it projection</span>
<a id="__codelineno-455-11" name="__codelineno-455-11" href="#__codelineno-455-11"></a><span class="c1">// type in case a context receiver does not fit on a single line </span>
<a id="__codelineno-455-12" name="__codelineno-455-12" href="#__codelineno-455-12"></a><span class="c1">// after it has been wrapped.</span>
<a id="__codelineno-455-13" name="__codelineno-455-13" href="#__codelineno-455-13"></a><span class="n">context</span><span class="p">(</span><span class="n">Foooooooooooooooo</span><span class="o">&lt;</span><span class="n">Foo</span><span class="p">,</span><span class="w"> </span><span class="n">Bar</span><span class="o">&gt;</span><span class="p">)</span>
<a id="__codelineno-455-14" name="__codelineno-455-14" href="#__codelineno-455-14"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">fooBar</span><span class="p">()</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>max_line_length</code><br/><i>Maximum length of a (regular) line. This property is ignored in case the <code>max-line-length</code> rule is disabled, or when using Ktlint via a third party integration that does not provide this rule.</i></td>
<td style="text-align: center;">140</td>
<td style="text-align: center;"><code>off</code></td>
<td style="text-align: center;"><code>100</code></td>
</tr>
</tbody>
</table>
<p>Rule id: <code>standard:context-receiver-wrapping</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-456-1" name="__codelineno-456-1" href="#__codelineno-456-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:context-receiver-wrapping&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-457-1" name="__codelineno-457-1" href="#__codelineno-457-1"></a>ktlint_standard_context-receiver-wrapping = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-458-1" name="__codelineno-458-1" href="#__codelineno-458-1"></a>ktlint_standard_context-receiver-wrapping = disabled
</code></pre></div></li>
</ol>
<h3 id="context-receiver-list-wrapping">Context receiver list wrapping<a class="headerlink" href="#context-receiver-list-wrapping" title="Permanent link">&para;</a></h3>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>This rule does not affect context receivers. See rule <code>context-receiver-wrapping</code> for wrapping of context receivers.</p>
</div>
<p>Wraps the context receiver list containing a context parameter to a separate line regardless of maximum line length. If the maximum line length is configured and is exceeded, wrap the context receivers and if needed its projection types to separate lines.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="92:2"><input checked="checked" id="__tabbed_92_1" name="__tabbed_92" type="radio" /><input id="__tabbed_92_2" name="__tabbed_92" type="radio" /><div class="tabbed-labels"><label for="__tabbed_92_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_92_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-459-1" name="__codelineno-459-1" href="#__codelineno-459-1"></a><span class="c1">// Always wrap regardless of whether max line length is set</span>
<a id="__codelineno-459-2" name="__codelineno-459-2" href="#__codelineno-459-2"></a><span class="n">context</span><span class="p">(</span><span class="n">_</span><span class="p">:</span><span class="w"> </span><span class="n">Foo</span><span class="p">)</span>
<a id="__codelineno-459-3" name="__codelineno-459-3" href="#__codelineno-459-3"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">fooBar</span><span class="p">()</span>
<a id="__codelineno-459-4" name="__codelineno-459-4" href="#__codelineno-459-4"></a>
<a id="__codelineno-459-5" name="__codelineno-459-5" href="#__codelineno-459-5"></a><span class="c1">// Wrap each context receiver to a separate line when the</span>
<a id="__codelineno-459-6" name="__codelineno-459-6" href="#__codelineno-459-6"></a><span class="c1">// entire context receiver list does not fit on a single line</span>
<a id="__codelineno-459-7" name="__codelineno-459-7" href="#__codelineno-459-7"></a><span class="n">context</span><span class="p">(</span>
<a id="__codelineno-459-8" name="__codelineno-459-8" href="#__codelineno-459-8"></a><span class="w"> </span><span class="n">foo1</span><span class="p">:</span><span class="w"> </span><span class="n">Fooooooooooooooooooo1</span><span class="p">,</span>
<a id="__codelineno-459-9" name="__codelineno-459-9" href="#__codelineno-459-9"></a><span class="w"> </span><span class="n">foo2</span><span class="p">:</span><span class="w"> </span><span class="n">Foooooooooooooooooooooooooooooo2</span>
<a id="__codelineno-459-10" name="__codelineno-459-10" href="#__codelineno-459-10"></a><span class="p">)</span>
<a id="__codelineno-459-11" name="__codelineno-459-11" href="#__codelineno-459-11"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">fooBar</span><span class="p">()</span>
<a id="__codelineno-459-12" name="__codelineno-459-12" href="#__codelineno-459-12"></a>
<a id="__codelineno-459-13" name="__codelineno-459-13" href="#__codelineno-459-13"></a><span class="c1">// Wrap each context receiver to a separate line when the</span>
<a id="__codelineno-459-14" name="__codelineno-459-14" href="#__codelineno-459-14"></a><span class="c1">// entire context receiver list does not fit on a single line.</span>
<a id="__codelineno-459-15" name="__codelineno-459-15" href="#__codelineno-459-15"></a><span class="c1">// Also, wrap each of it projection types in case a context</span>
<a id="__codelineno-459-16" name="__codelineno-459-16" href="#__codelineno-459-16"></a><span class="c1">// receiver does not fit on a single line after it has been</span>
<a id="__codelineno-459-17" name="__codelineno-459-17" href="#__codelineno-459-17"></a><span class="c1">// wrapped.</span>
<a id="__codelineno-459-18" name="__codelineno-459-18" href="#__codelineno-459-18"></a><span class="n">context</span><span class="p">(</span>
<a id="__codelineno-459-19" name="__codelineno-459-19" href="#__codelineno-459-19"></a><span class="w"> </span><span class="n">_</span><span class="p">:</span><span class="w"> </span><span class="n">Foooooooooooooooo</span><span class="o">&lt;</span>
<a id="__codelineno-459-20" name="__codelineno-459-20" href="#__codelineno-459-20"></a><span class="w"> </span><span class="n">Foo</span><span class="p">,</span>
<a id="__codelineno-459-21" name="__codelineno-459-21" href="#__codelineno-459-21"></a><span class="w"> </span><span class="n">Bar</span><span class="p">,</span>
<a id="__codelineno-459-22" name="__codelineno-459-22" href="#__codelineno-459-22"></a><span class="w"> </span><span class="o">&gt;</span>
<a id="__codelineno-459-23" name="__codelineno-459-23" href="#__codelineno-459-23"></a><span class="p">)</span>
<a id="__codelineno-459-24" name="__codelineno-459-24" href="#__codelineno-459-24"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">fooBar</span><span class="p">()</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-460-1" name="__codelineno-460-1" href="#__codelineno-460-1"></a><span class="c1">// Should be wrapped regardless of whether max line length is set</span>
<a id="__codelineno-460-2" name="__codelineno-460-2" href="#__codelineno-460-2"></a><span class="n">context</span><span class="p">(</span><span class="n">_</span><span class="p">:</span><span class="w"> </span><span class="n">Foo</span><span class="p">)</span><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">fooBar</span><span class="p">()</span>
<a id="__codelineno-460-3" name="__codelineno-460-3" href="#__codelineno-460-3"></a>
<a id="__codelineno-460-4" name="__codelineno-460-4" href="#__codelineno-460-4"></a><span class="c1">// Should be wrapped when the entire context receiver list does not</span>
<a id="__codelineno-460-5" name="__codelineno-460-5" href="#__codelineno-460-5"></a><span class="c1">// fit on a single line</span>
<a id="__codelineno-460-6" name="__codelineno-460-6" href="#__codelineno-460-6"></a><span class="n">context</span><span class="p">(</span><span class="n">foo1</span><span class="p">:</span><span class="w"> </span><span class="n">Fooooooooooooooooooo1</span><span class="p">,</span><span class="w"> </span><span class="n">foo2</span><span class="p">:</span><span class="w"> </span><span class="n">Foooooooooooooooooooooooooooooo2</span><span class="p">)</span>
<a id="__codelineno-460-7" name="__codelineno-460-7" href="#__codelineno-460-7"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">fooBar</span><span class="p">()</span>
<a id="__codelineno-460-8" name="__codelineno-460-8" href="#__codelineno-460-8"></a>
<a id="__codelineno-460-9" name="__codelineno-460-9" href="#__codelineno-460-9"></a><span class="c1">// Should be wrapped when the entire context receiver list does not</span>
<a id="__codelineno-460-10" name="__codelineno-460-10" href="#__codelineno-460-10"></a><span class="c1">// fit on a single line. Also, it should wrap each of it projection</span>
<a id="__codelineno-460-11" name="__codelineno-460-11" href="#__codelineno-460-11"></a><span class="c1">// type in case a context receiver does not fit on a single line </span>
<a id="__codelineno-460-12" name="__codelineno-460-12" href="#__codelineno-460-12"></a><span class="c1">// after it has been wrapped.</span>
<a id="__codelineno-460-13" name="__codelineno-460-13" href="#__codelineno-460-13"></a><span class="n">context</span><span class="p">(</span><span class="n">_</span><span class="p">:</span><span class="w"> </span><span class="n">Foooooooooooooooo</span><span class="o">&lt;</span><span class="n">Foo</span><span class="p">,</span><span class="w"> </span><span class="n">Bar</span><span class="o">&gt;</span><span class="p">)</span>
<a id="__codelineno-460-14" name="__codelineno-460-14" href="#__codelineno-460-14"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">fooBar</span><span class="p">()</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>max_line_length</code><br/><i>Maximum length of a (regular) line. This property is ignored in case the <code>max-line-length</code> rule is disabled, or when using Ktlint via a third party integration that does not provide this rule.</i></td>
<td style="text-align: center;">140</td>
<td style="text-align: center;"><code>off</code></td>
<td style="text-align: center;"><code>100</code></td>
</tr>
</tbody>
</table>
<p>Rule id: <code>standard:context-receiver-list-wrapping</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-461-1" name="__codelineno-461-1" href="#__codelineno-461-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:context-receiver-list-wrapping&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-462-1" name="__codelineno-462-1" href="#__codelineno-462-1"></a>ktlint_standard_context-receiver-list-wrapping = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-463-1" name="__codelineno-463-1" href="#__codelineno-463-1"></a>ktlint_standard_context-receiver-list-wrapping = disabled
</code></pre></div></li>
</ol>
<h3 id="enum-wrapping">Enum wrapping<a class="headerlink" href="#enum-wrapping" title="Permanent link">&para;</a></h3>
<p>Each individual enum entry should be on a separate line. Multiple enums cannot be on the same line. In case the enumeration contains enum entries and declarations, those are to be separated by a blank line.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="93:2"><input checked="checked" id="__tabbed_93_1" name="__tabbed_93" type="radio" /><input id="__tabbed_93_2" name="__tabbed_93" type="radio" /><div class="tabbed-labels"><label for="__tabbed_93_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_93_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-464-1" name="__codelineno-464-1" href="#__codelineno-464-1"></a><span class="kd">enum</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">Foo</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="n">A</span><span class="p">,</span><span class="w"> </span><span class="n">B</span><span class="p">,</span><span class="w"> </span><span class="n">C</span><span class="p">,</span><span class="w"> </span><span class="n">D</span><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-464-2" name="__codelineno-464-2" href="#__codelineno-464-2"></a>
<a id="__codelineno-464-3" name="__codelineno-464-3" href="#__codelineno-464-3"></a><span class="kd">enum</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">Foo</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-464-4" name="__codelineno-464-4" href="#__codelineno-464-4"></a><span class="w"> </span><span class="n">A</span><span class="p">,</span>
<a id="__codelineno-464-5" name="__codelineno-464-5" href="#__codelineno-464-5"></a><span class="w"> </span><span class="n">B</span><span class="p">,</span>
<a id="__codelineno-464-6" name="__codelineno-464-6" href="#__codelineno-464-6"></a><span class="w"> </span><span class="n">C</span><span class="p">,</span>
<a id="__codelineno-464-7" name="__codelineno-464-7" href="#__codelineno-464-7"></a><span class="w"> </span><span class="n">D</span><span class="p">,</span>
<a id="__codelineno-464-8" name="__codelineno-464-8" href="#__codelineno-464-8"></a><span class="w"> </span><span class="p">;</span>
<a id="__codelineno-464-9" name="__codelineno-464-9" href="#__codelineno-464-9"></a>
<a id="__codelineno-464-10" name="__codelineno-464-10" href="#__codelineno-464-10"></a><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo&quot;</span>
<a id="__codelineno-464-11" name="__codelineno-464-11" href="#__codelineno-464-11"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-465-1" name="__codelineno-465-1" href="#__codelineno-465-1"></a><span class="kd">enum</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">Foo</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-465-2" name="__codelineno-465-2" href="#__codelineno-465-2"></a><span class="w"> </span><span class="n">A</span><span class="p">,</span>
<a id="__codelineno-465-3" name="__codelineno-465-3" href="#__codelineno-465-3"></a><span class="w"> </span><span class="n">B</span><span class="p">,</span><span class="w"> </span><span class="n">C</span><span class="p">,</span>
<a id="__codelineno-465-4" name="__codelineno-465-4" href="#__codelineno-465-4"></a><span class="w"> </span><span class="n">D</span>
<a id="__codelineno-465-5" name="__codelineno-465-5" href="#__codelineno-465-5"></a><span class="p">}</span>
<a id="__codelineno-465-6" name="__codelineno-465-6" href="#__codelineno-465-6"></a>
<a id="__codelineno-465-7" name="__codelineno-465-7" href="#__codelineno-465-7"></a><span class="kd">enum</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">Foo</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-465-8" name="__codelineno-465-8" href="#__codelineno-465-8"></a><span class="w"> </span><span class="n">A</span><span class="p">;</span>
<a id="__codelineno-465-9" name="__codelineno-465-9" href="#__codelineno-465-9"></a><span class="w"> </span><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;foo&quot;</span>
<a id="__codelineno-465-10" name="__codelineno-465-10" href="#__codelineno-465-10"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:enum-wrapping</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-466-1" name="__codelineno-466-1" href="#__codelineno-466-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:enum-wrapping&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-467-1" name="__codelineno-467-1" href="#__codelineno-467-1"></a>ktlint_standard_enum-wrapping = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-468-1" name="__codelineno-468-1" href="#__codelineno-468-1"></a>ktlint_standard_enum-wrapping = disabled
</code></pre></div></li>
</ol>
<h3 id="if-else-wrapping">If else wrapping<a class="headerlink" href="#if-else-wrapping" title="Permanent link">&para;</a></h3>
<p>A single line if-statement should be kept simple. It may contain no more than one else-branch. The branches may not be wrapped in a block.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="94:2"><input checked="checked" id="__tabbed_94_1" name="__tabbed_94" type="radio" /><input id="__tabbed_94_2" name="__tabbed_94" type="radio" /><div class="tabbed-labels"><label for="__tabbed_94_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_94_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-469-1" name="__codelineno-469-1" href="#__codelineno-469-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foobar</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-469-2" name="__codelineno-469-2" href="#__codelineno-469-2"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kc">true</span><span class="p">)</span><span class="w"> </span><span class="n">foo</span><span class="p">()</span>
<a id="__codelineno-469-3" name="__codelineno-469-3" href="#__codelineno-469-3"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kc">true</span><span class="p">)</span><span class="w"> </span><span class="n">foo</span><span class="p">()</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="n">bar</span><span class="p">()</span>
<a id="__codelineno-469-4" name="__codelineno-469-4" href="#__codelineno-469-4"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-470-1" name="__codelineno-470-1" href="#__codelineno-470-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foobar</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-470-2" name="__codelineno-470-2" href="#__codelineno-470-2"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kc">true</span><span class="p">)</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kc">false</span><span class="p">)</span><span class="w"> </span><span class="n">foo</span><span class="p">()</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="n">bar</span><span class="p">()</span>
<a id="__codelineno-470-3" name="__codelineno-470-3" href="#__codelineno-470-3"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kc">true</span><span class="p">)</span><span class="w"> </span><span class="n">bar</span><span class="p">()</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kc">false</span><span class="p">)</span><span class="w"> </span><span class="n">foo</span><span class="p">()</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="n">bar</span><span class="p">()</span>
<a id="__codelineno-470-4" name="__codelineno-470-4" href="#__codelineno-470-4"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kc">true</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="n">foo</span><span class="p">()</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="n">bar</span><span class="p">()</span>
<a id="__codelineno-470-5" name="__codelineno-470-5" href="#__codelineno-470-5"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kc">true</span><span class="p">)</span><span class="w"> </span><span class="n">bar</span><span class="p">()</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kc">false</span><span class="p">)</span><span class="w"> </span><span class="n">foo</span><span class="p">()</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="n">bar</span><span class="p">()</span><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-470-6" name="__codelineno-470-6" href="#__codelineno-470-6"></a><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:if-else-wrapping</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-471-1" name="__codelineno-471-1" href="#__codelineno-471-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:if-else-wrapping&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-472-1" name="__codelineno-472-1" href="#__codelineno-472-1"></a>ktlint_standard_if-else-wrapping = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-473-1" name="__codelineno-473-1" href="#__codelineno-473-1"></a>ktlint_standard_if-else-wrapping = disabled
</code></pre></div></li>
</ol>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This rule is only run when <code>ktlint_code_style</code> is set to <code>ktlint_official</code> or when the rule is enabled explicitly.</p>
</div>
<h3 id="multiline-expression-wrapping">Multiline expression wrapping<a class="headerlink" href="#multiline-expression-wrapping" title="Permanent link">&para;</a></h3>
<p>Multiline expressions on the right hand side of an expression are forced to start on a separate line. Expressions in return statement are excluded as that would result in a compilation error.</p>
<p>Setting <code>ktlint_function_signature_body_expression_wrapping</code> of the <code>function-signature</code> rule takes precedence when set to <code>default</code>. This setting keeps the first line of a multiline expression body on the same line as the end of function signature as long as the max line length is not exceeded. In that case, this rule does not wrap the multiline expression. </p>
<div class="tabbed-set tabbed-alternate" data-tabs="95:2"><input checked="checked" id="__tabbed_95_1" name="__tabbed_95" type="radio" /><input id="__tabbed_95_2" name="__tabbed_95" type="radio" /><div class="tabbed-labels"><label for="__tabbed_95_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_95_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-474-1" name="__codelineno-474-1" href="#__codelineno-474-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-474-2" name="__codelineno-474-2" href="#__codelineno-474-2"></a><span class="w"> </span><span class="n">foo</span><span class="p">(</span>
<a id="__codelineno-474-3" name="__codelineno-474-3" href="#__codelineno-474-3"></a><span class="w"> </span><span class="n">parameterName</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-474-4" name="__codelineno-474-4" href="#__codelineno-474-4"></a><span class="w"> </span><span class="s">&quot;The quick brown fox &quot;</span>
<a id="__codelineno-474-5" name="__codelineno-474-5" href="#__codelineno-474-5"></a><span class="w"> </span><span class="p">.</span><span class="na">plus</span><span class="p">(</span><span class="s">&quot;jumps &quot;</span><span class="p">)</span>
<a id="__codelineno-474-6" name="__codelineno-474-6" href="#__codelineno-474-6"></a><span class="w"> </span><span class="p">.</span><span class="na">plus</span><span class="p">(</span><span class="s">&quot;over the lazy dog&quot;</span><span class="p">),</span>
<a id="__codelineno-474-7" name="__codelineno-474-7" href="#__codelineno-474-7"></a><span class="w"> </span><span class="p">)</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-475-1" name="__codelineno-475-1" href="#__codelineno-475-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">foo</span><span class="p">(</span>
<a id="__codelineno-475-2" name="__codelineno-475-2" href="#__codelineno-475-2"></a><span class="w"> </span><span class="n">parameterName</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;The quick brown fox &quot;</span>
<a id="__codelineno-475-3" name="__codelineno-475-3" href="#__codelineno-475-3"></a><span class="w"> </span><span class="p">.</span><span class="na">plus</span><span class="p">(</span><span class="s">&quot;jumps &quot;</span><span class="p">)</span>
<a id="__codelineno-475-4" name="__codelineno-475-4" href="#__codelineno-475-4"></a><span class="w"> </span><span class="p">.</span><span class="na">plus</span><span class="p">(</span><span class="s">&quot;over the lazy dog&quot;</span><span class="p">),</span>
<a id="__codelineno-475-5" name="__codelineno-475-5" href="#__codelineno-475-5"></a><span class="p">)</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:multiline-expression-wrapping</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-476-1" name="__codelineno-476-1" href="#__codelineno-476-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:multiline-expression-wrapping&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-477-1" name="__codelineno-477-1" href="#__codelineno-477-1"></a>ktlint_standard_multiline-expression-wrapping = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-478-1" name="__codelineno-478-1" href="#__codelineno-478-1"></a>ktlint_standard_multiline-expression-wrapping = disabled
</code></pre></div></li>
</ol>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This rule is only run when <code>ktlint_code_style</code> is set to <code>ktlint_official</code> or when the rule is enabled explicitly.</p>
</div>
<h3 id="parameter-list-wrapping">Parameter list wrapping<a class="headerlink" href="#parameter-list-wrapping" title="Permanent link">&para;</a></h3>
<p>When class/function signature doesn't fit on a single line, each parameter must be on a separate line.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Wrapping of parameters is also influenced by the <code>function-signature</code> rule.</p>
</div>
<div class="tabbed-set tabbed-alternate" data-tabs="96:3"><input checked="checked" id="__tabbed_96_1" name="__tabbed_96" type="radio" /><input id="__tabbed_96_2" name="__tabbed_96" type="radio" /><input id="__tabbed_96_3" name="__tabbed_96" type="radio" /><div class="tabbed-labels"><label for="__tabbed_96_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_96_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed (ktlint_official)</label><label for="__tabbed_96_3"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed (non ktlint_official)</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-479-1" name="__codelineno-479-1" href="#__codelineno-479-1"></a><span class="c1">// If `ktlint_class_signature_rule_force_multiline_when_parameter_count_greater_or_equal_than` equals</span>
<a id="__codelineno-479-2" name="__codelineno-479-2" href="#__codelineno-479-2"></a><span class="c1">// `unset` the parameters are not wrapped as long as they fit on a single line</span>
<a id="__codelineno-479-3" name="__codelineno-479-3" href="#__codelineno-479-3"></a><span class="kd">class</span><span class="w"> </span><span class="nc">ClassA</span><span class="p">(</span><span class="n">paramA</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="p">,</span><span class="w"> </span><span class="n">paramB</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="p">,</span><span class="w"> </span><span class="n">paramC</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="p">)</span>
<a id="__codelineno-479-4" name="__codelineno-479-4" href="#__codelineno-479-4"></a>
<a id="__codelineno-479-5" name="__codelineno-479-5" href="#__codelineno-479-5"></a><span class="kd">class</span><span class="w"> </span><span class="nc">ClassA</span><span class="p">(</span>
<a id="__codelineno-479-6" name="__codelineno-479-6" href="#__codelineno-479-6"></a><span class="w"> </span><span class="n">paramA</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="p">,</span>
<a id="__codelineno-479-7" name="__codelineno-479-7" href="#__codelineno-479-7"></a><span class="w"> </span><span class="n">paramB</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="p">,</span>
<a id="__codelineno-479-8" name="__codelineno-479-8" href="#__codelineno-479-8"></a><span class="w"> </span><span class="n">paramC</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span>
<a id="__codelineno-479-9" name="__codelineno-479-9" href="#__codelineno-479-9"></a><span class="p">)</span>
<a id="__codelineno-479-10" name="__codelineno-479-10" href="#__codelineno-479-10"></a>
<a id="__codelineno-479-11" name="__codelineno-479-11" href="#__codelineno-479-11"></a><span class="c1">// If `ktlint_function_signature_rule_force_multiline_when_parameter_count_greater_or_equal_than` equals</span>
<a id="__codelineno-479-12" name="__codelineno-479-12" href="#__codelineno-479-12"></a><span class="c1">// `unset` the parameters are not wrapped as long as they fit on a single line</span>
<a id="__codelineno-479-13" name="__codelineno-479-13" href="#__codelineno-479-13"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">f</span><span class="p">(</span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">c</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">)</span>
<a id="__codelineno-479-14" name="__codelineno-479-14" href="#__codelineno-479-14"></a>
<a id="__codelineno-479-15" name="__codelineno-479-15" href="#__codelineno-479-15"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">f</span><span class="p">(</span>
<a id="__codelineno-479-16" name="__codelineno-479-16" href="#__codelineno-479-16"></a><span class="w"> </span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-479-17" name="__codelineno-479-17" href="#__codelineno-479-17"></a><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-479-18" name="__codelineno-479-18" href="#__codelineno-479-18"></a><span class="w"> </span><span class="n">c</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span>
<a id="__codelineno-479-19" name="__codelineno-479-19" href="#__codelineno-479-19"></a><span class="p">)</span>
<a id="__codelineno-479-20" name="__codelineno-479-20" href="#__codelineno-479-20"></a>
<a id="__codelineno-479-21" name="__codelineno-479-21" href="#__codelineno-479-21"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">(</span>
<a id="__codelineno-479-22" name="__codelineno-479-22" href="#__codelineno-479-22"></a><span class="w"> </span><span class="nd">@Bar</span><span class="w"> </span><span class="n">fooBar</span><span class="p">:</span><span class="w"> </span><span class="n">FooBar</span>
<a id="__codelineno-479-23" name="__codelineno-479-23" href="#__codelineno-479-23"></a><span class="p">)</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-480-1" name="__codelineno-480-1" href="#__codelineno-480-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">ClassA</span><span class="p">(</span>
<a id="__codelineno-480-2" name="__codelineno-480-2" href="#__codelineno-480-2"></a><span class="w"> </span><span class="n">paramA</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="p">,</span><span class="w"> </span><span class="n">paramB</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="p">,</span>
<a id="__codelineno-480-3" name="__codelineno-480-3" href="#__codelineno-480-3"></a><span class="w"> </span><span class="n">paramC</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span>
<a id="__codelineno-480-4" name="__codelineno-480-4" href="#__codelineno-480-4"></a><span class="p">)</span>
<a id="__codelineno-480-5" name="__codelineno-480-5" href="#__codelineno-480-5"></a>
<a id="__codelineno-480-6" name="__codelineno-480-6" href="#__codelineno-480-6"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">f</span><span class="p">(</span>
<a id="__codelineno-480-7" name="__codelineno-480-7" href="#__codelineno-480-7"></a><span class="w"> </span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-480-8" name="__codelineno-480-8" href="#__codelineno-480-8"></a><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">c</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span>
<a id="__codelineno-480-9" name="__codelineno-480-9" href="#__codelineno-480-9"></a><span class="p">)</span>
<a id="__codelineno-480-10" name="__codelineno-480-10" href="#__codelineno-480-10"></a>
<a id="__codelineno-480-11" name="__codelineno-480-11" href="#__codelineno-480-11"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">(</span><span class="nd">@Bar</span><span class="w"> </span><span class="n">fooBar</span><span class="p">:</span><span class="w"> </span><span class="n">FooBar</span><span class="p">)</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-481-1" name="__codelineno-481-1" href="#__codelineno-481-1"></a><span class="kd">class</span><span class="w"> </span><span class="nc">ClassA</span><span class="p">(</span>
<a id="__codelineno-481-2" name="__codelineno-481-2" href="#__codelineno-481-2"></a><span class="w"> </span><span class="n">paramA</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="p">,</span><span class="w"> </span><span class="n">paramB</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span><span class="p">,</span>
<a id="__codelineno-481-3" name="__codelineno-481-3" href="#__codelineno-481-3"></a><span class="w"> </span><span class="n">paramC</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span>
<a id="__codelineno-481-4" name="__codelineno-481-4" href="#__codelineno-481-4"></a><span class="p">)</span>
<a id="__codelineno-481-5" name="__codelineno-481-5" href="#__codelineno-481-5"></a>
<a id="__codelineno-481-6" name="__codelineno-481-6" href="#__codelineno-481-6"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">f</span><span class="p">(</span>
<a id="__codelineno-481-7" name="__codelineno-481-7" href="#__codelineno-481-7"></a><span class="w"> </span><span class="n">a</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span>
<a id="__codelineno-481-8" name="__codelineno-481-8" href="#__codelineno-481-8"></a><span class="w"> </span><span class="n">b</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span><span class="p">,</span><span class="w"> </span><span class="n">c</span><span class="p">:</span><span class="w"> </span><span class="kt">Any</span>
<a id="__codelineno-481-9" name="__codelineno-481-9" href="#__codelineno-481-9"></a><span class="p">)</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>max_line_length</code><br/><i>Maximum length of a (regular) line. This property is ignored in case the <code>max-line-length</code> rule is disabled, or when using Ktlint via a third party integration that does not provide this rule.</i></td>
<td style="text-align: center;">140</td>
<td style="text-align: center;"><code>off</code></td>
<td style="text-align: center;"><code>100</code></td>
</tr>
</tbody>
</table>
<p>Rule id: <code>standard:parameter-list-wrapping</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-482-1" name="__codelineno-482-1" href="#__codelineno-482-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:parameter-list-wrapping&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-483-1" name="__codelineno-483-1" href="#__codelineno-483-1"></a>ktlint_standard_parameter-list-wrapping = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-484-1" name="__codelineno-484-1" href="#__codelineno-484-1"></a>ktlint_standard_parameter-list-wrapping = disabled
</code></pre></div></li>
</ol>
<h3 id="parameter-wrapping">Parameter wrapping<a class="headerlink" href="#parameter-wrapping" title="Permanent link">&para;</a></h3>
<p>When a function or class parameter doesn't fit on a single line, wrap the type or value to a separate line.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="97:3"><input checked="checked" id="__tabbed_97_1" name="__tabbed_97" type="radio" /><input id="__tabbed_97_2" name="__tabbed_97" type="radio" /><input id="__tabbed_97_3" name="__tabbed_97" type="radio" /><div class="tabbed-labels"><label for="__tabbed_97_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint (ktlint_official)</label><label for="__tabbed_97_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint (non ktlint_official)</label><label for="__tabbed_97_3"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-485-1" name="__codelineno-485-1" href="#__codelineno-485-1"></a><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-485-2" name="__codelineno-485-2" href="#__codelineno-485-2"></a><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-485-3" name="__codelineno-485-3" href="#__codelineno-485-3"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Bar</span><span class="p">(</span>
<a id="__codelineno-485-4" name="__codelineno-485-4" href="#__codelineno-485-4"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">fooooooooooooooooooooooooTooLong</span><span class="p">:</span>
<a id="__codelineno-485-5" name="__codelineno-485-5" href="#__codelineno-485-5"></a><span class="w"> </span><span class="n">Foo</span><span class="p">,</span>
<a id="__codelineno-485-6" name="__codelineno-485-6" href="#__codelineno-485-6"></a><span class="p">)</span>
<a id="__codelineno-485-7" name="__codelineno-485-7" href="#__codelineno-485-7"></a>
<a id="__codelineno-485-8" name="__codelineno-485-8" href="#__codelineno-485-8"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">bar</span><span class="p">(</span>
<a id="__codelineno-485-9" name="__codelineno-485-9" href="#__codelineno-485-9"></a><span class="w"> </span><span class="n">fooooooooooooooooooooooooTooLong</span><span class="p">:</span>
<a id="__codelineno-485-10" name="__codelineno-485-10" href="#__codelineno-485-10"></a><span class="w"> </span><span class="n">Foo</span><span class="p">,</span>
<a id="__codelineno-485-11" name="__codelineno-485-11" href="#__codelineno-485-11"></a><span class="p">)</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-486-1" name="__codelineno-486-1" href="#__codelineno-486-1"></a><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-486-2" name="__codelineno-486-2" href="#__codelineno-486-2"></a><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-486-3" name="__codelineno-486-3" href="#__codelineno-486-3"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Bar</span><span class="p">(</span>
<a id="__codelineno-486-4" name="__codelineno-486-4" href="#__codelineno-486-4"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">fooooooooooooooooooooooooTooLong</span><span class="p">:</span>
<a id="__codelineno-486-5" name="__codelineno-486-5" href="#__codelineno-486-5"></a><span class="w"> </span><span class="n">Foo</span><span class="p">,</span>
<a id="__codelineno-486-6" name="__codelineno-486-6" href="#__codelineno-486-6"></a><span class="p">)</span>
<a id="__codelineno-486-7" name="__codelineno-486-7" href="#__codelineno-486-7"></a>
<a id="__codelineno-486-8" name="__codelineno-486-8" href="#__codelineno-486-8"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">bar</span><span class="p">(</span>
<a id="__codelineno-486-9" name="__codelineno-486-9" href="#__codelineno-486-9"></a><span class="w"> </span><span class="n">fooooooooooooooooooooooooTooLong</span><span class="p">:</span>
<a id="__codelineno-486-10" name="__codelineno-486-10" href="#__codelineno-486-10"></a><span class="w"> </span><span class="n">Foo</span><span class="p">,</span>
<a id="__codelineno-486-11" name="__codelineno-486-11" href="#__codelineno-486-11"></a><span class="p">)</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-487-1" name="__codelineno-487-1" href="#__codelineno-487-1"></a><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-487-2" name="__codelineno-487-2" href="#__codelineno-487-2"></a><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-487-3" name="__codelineno-487-3" href="#__codelineno-487-3"></a><span class="kd">class</span><span class="w"> </span><span class="nc">Bar</span><span class="p">(</span>
<a id="__codelineno-487-4" name="__codelineno-487-4" href="#__codelineno-487-4"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">fooooooooooooooooooooooooTooLong</span><span class="p">:</span><span class="w"> </span><span class="n">Foo</span><span class="p">,</span>
<a id="__codelineno-487-5" name="__codelineno-487-5" href="#__codelineno-487-5"></a><span class="p">)</span>
<a id="__codelineno-487-6" name="__codelineno-487-6" href="#__codelineno-487-6"></a>
<a id="__codelineno-487-7" name="__codelineno-487-7" href="#__codelineno-487-7"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">bar</span><span class="p">(</span>
<a id="__codelineno-487-8" name="__codelineno-487-8" href="#__codelineno-487-8"></a><span class="w"> </span><span class="n">fooooooooooooooooooooooooooooTooLong</span><span class="p">:</span><span class="w"> </span><span class="n">Foo</span><span class="p">,</span>
<a id="__codelineno-487-9" name="__codelineno-487-9" href="#__codelineno-487-9"></a><span class="p">)</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>max_line_length</code><br/><i>Maximum length of a (regular) line. This property is ignored in case the <code>max-line-length</code> rule is disabled, or when using Ktlint via a third party integration that does not provide this rule.</i></td>
<td style="text-align: center;">140</td>
<td style="text-align: center;"><code>off</code></td>
<td style="text-align: center;"><code>100</code></td>
</tr>
</tbody>
</table>
<p>Rule id: <code>standard:parameter-wrapping</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-488-1" name="__codelineno-488-1" href="#__codelineno-488-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:parameter-wrapping&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-489-1" name="__codelineno-489-1" href="#__codelineno-489-1"></a>ktlint_standard_parameter-wrapping = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-490-1" name="__codelineno-490-1" href="#__codelineno-490-1"></a>ktlint_standard_parameter-wrapping = disabled
</code></pre></div></li>
</ol>
<h3 id="property-wrapping">Property wrapping<a class="headerlink" href="#property-wrapping" title="Permanent link">&para;</a></h3>
<p>When a property doesn't fit on a single line, wrap the type or value to a separate line.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="98:2"><input checked="checked" id="__tabbed_98_1" name="__tabbed_98" type="radio" /><input id="__tabbed_98_2" name="__tabbed_98" type="radio" /><div class="tabbed-labels"><label for="__tabbed_98_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_98_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-491-1" name="__codelineno-491-1" href="#__codelineno-491-1"></a><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-491-2" name="__codelineno-491-2" href="#__codelineno-491-2"></a><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-491-3" name="__codelineno-491-3" href="#__codelineno-491-3"></a><span class="kd">val</span><span class="w"> </span><span class="nv">aVariableWithALooooooooooooongName</span><span class="p">:</span>
<a id="__codelineno-491-4" name="__codelineno-491-4" href="#__codelineno-491-4"></a><span class="w"> </span><span class="kt">String</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-492-1" name="__codelineno-492-1" href="#__codelineno-492-1"></a><span class="c1">// Assume that the last allowed character is</span>
<a id="__codelineno-492-2" name="__codelineno-492-2" href="#__codelineno-492-2"></a><span class="c1">// at the X character on the right X</span>
<a id="__codelineno-492-3" name="__codelineno-492-3" href="#__codelineno-492-3"></a><span class="kd">val</span><span class="w"> </span><span class="nv">aVariableWithALooooooooooooongName</span><span class="p">:</span><span class="w"> </span><span class="kt">String</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>max_line_length</code><br/><i>Maximum length of a (regular) line. This property is ignored in case the <code>max-line-length</code> rule is disabled, or when using Ktlint via a third party integration that does not provide this rule.</i></td>
<td style="text-align: center;">140</td>
<td style="text-align: center;"><code>off</code></td>
<td style="text-align: center;"><code>100</code></td>
</tr>
</tbody>
</table>
<p>Rule id: <code>standard:property-wrapping</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-493-1" name="__codelineno-493-1" href="#__codelineno-493-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:property-wrapping&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-494-1" name="__codelineno-494-1" href="#__codelineno-494-1"></a>ktlint_standard_property-wrapping = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-495-1" name="__codelineno-495-1" href="#__codelineno-495-1"></a>ktlint_standard_property-wrapping = disabled
</code></pre></div></li>
</ol>
<h3 id="statement-wrapping">Statement wrapping<a class="headerlink" href="#statement-wrapping" title="Permanent link">&para;</a></h3>
<p>A function, class/object body or other block body statement has to be placed on different line than the braces of the body block.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="99:2"><input checked="checked" id="__tabbed_99_1" name="__tabbed_99" type="radio" /><input id="__tabbed_99_2" name="__tabbed_99" type="radio" /><div class="tabbed-labels"><label for="__tabbed_99_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_99_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-496-1" name="__codelineno-496-1" href="#__codelineno-496-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-496-2" name="__codelineno-496-2" href="#__codelineno-496-2"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kc">true</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-496-3" name="__codelineno-496-3" href="#__codelineno-496-3"></a><span class="w"> </span><span class="c1">// do something</span>
<a id="__codelineno-496-4" name="__codelineno-496-4" href="#__codelineno-496-4"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-496-5" name="__codelineno-496-5" href="#__codelineno-496-5"></a><span class="p">}</span>
<a id="__codelineno-496-6" name="__codelineno-496-6" href="#__codelineno-496-6"></a>
<a id="__codelineno-496-7" name="__codelineno-496-7" href="#__codelineno-496-7"></a><span class="kd">class</span><span class="w"> </span><span class="nc">A</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-496-8" name="__codelineno-496-8" href="#__codelineno-496-8"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">a</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">0</span>
<a id="__codelineno-496-9" name="__codelineno-496-9" href="#__codelineno-496-9"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">b</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span>
<a id="__codelineno-496-10" name="__codelineno-496-10" href="#__codelineno-496-10"></a><span class="p">}</span>
<a id="__codelineno-496-11" name="__codelineno-496-11" href="#__codelineno-496-11"></a>
<a id="__codelineno-496-12" name="__codelineno-496-12" href="#__codelineno-496-12"></a><span class="kd">enum</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">FooBar1</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="n">FOO</span><span class="p">,</span><span class="w"> </span><span class="n">BAR</span><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-496-13" name="__codelineno-496-13" href="#__codelineno-496-13"></a>
<a id="__codelineno-496-14" name="__codelineno-496-14" href="#__codelineno-496-14"></a><span class="kd">enum</span><span class="w"> </span><span class="kd">class</span><span class="w"> </span><span class="nc">FooBar2</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-496-15" name="__codelineno-496-15" href="#__codelineno-496-15"></a><span class="w"> </span><span class="n">FOO</span><span class="p">,</span>
<a id="__codelineno-496-16" name="__codelineno-496-16" href="#__codelineno-496-16"></a><span class="w"> </span><span class="n">BAR</span><span class="p">,</span>
<a id="__codelineno-496-17" name="__codelineno-496-17" href="#__codelineno-496-17"></a><span class="p">}</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-497-1" name="__codelineno-497-1" href="#__codelineno-497-1"></a><span class="kd">fun</span><span class="w"> </span><span class="nf">foo</span><span class="p">()</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="kc">true</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-497-2" name="__codelineno-497-2" href="#__codelineno-497-2"></a><span class="w"> </span><span class="c1">// do something</span>
<a id="__codelineno-497-3" name="__codelineno-497-3" href="#__codelineno-497-3"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-497-4" name="__codelineno-497-4" href="#__codelineno-497-4"></a><span class="p">}</span>
<a id="__codelineno-497-5" name="__codelineno-497-5" href="#__codelineno-497-5"></a>
<a id="__codelineno-497-6" name="__codelineno-497-6" href="#__codelineno-497-6"></a><span class="kd">class</span><span class="w"> </span><span class="nc">A</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">a</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">0</span>
<a id="__codelineno-497-7" name="__codelineno-497-7" href="#__codelineno-497-7"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">b</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="p">}</span>
</code></pre></div>
</div>
</div>
</div>
<p>Rule id: <code>standard:statement-wrapping</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-498-1" name="__codelineno-498-1" href="#__codelineno-498-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:statement-wrapping&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-499-1" name="__codelineno-499-1" href="#__codelineno-499-1"></a>ktlint_standard_statement-wrapping = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-500-1" name="__codelineno-500-1" href="#__codelineno-500-1"></a>ktlint_standard_statement-wrapping = disabled
</code></pre></div></li>
</ol>
<h3 id="wrapping_1">Wrapping<a class="headerlink" href="#wrapping_1" title="Permanent link">&para;</a></h3>
<p>Inserts missing newlines (for example, between parentheses of a multi-line function call).</p>
<div class="tabbed-set tabbed-alternate" data-tabs="100:2"><input checked="checked" id="__tabbed_100_1" name="__tabbed_100" type="radio" /><input id="__tabbed_100_2" name="__tabbed_100" type="radio" /><div class="tabbed-labels"><label for="__tabbed_100_1"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m12 21.35-1.45-1.32C5.4 15.36 2 12.27 2 8.5 2 5.41 4.42 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 3.77-3.4 6.86-8.55 11.53z"/></svg></span></a> Ktlint</label><label for="__tabbed_100_2"><a href="#"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M2.39 1.73 1.11 3l2.08 2.08C2.45 6 2 7.19 2 8.5c0 3.77 3.4 6.86 8.55 11.53L12 21.35l1.45-1.32c.87-.79 1.69-1.53 2.45-2.24L20 22l1.27-1.27m-9.17-2.18-.1.1-.11-.1C7.14 14.24 4 11.39 4 8.5c0-.76.22-1.44.61-2l9.89 9.87c-.76.69-1.55 1.41-2.4 2.18M8.3 5.1 6.33 3.13C6.7 3.05 7.1 3 7.5 3c1.74 0 3.41.81 4.5 2.08C13.09 3.81 14.76 3 16.5 3 19.58 3 22 5.41 22 8.5c0 2.34-1.31 4.42-3.53 6.77l-1.41-1.41C18.91 11.88 20 10.2 20 8.5c0-2-1.5-3.5-3.5-3.5-1.4 0-2.76.83-3.39 2h-2.22c-.51-.94-1.5-1.66-2.59-1.9"/></svg></span></a> Disallowed</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-501-1" name="__codelineno-501-1" href="#__codelineno-501-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span>
<a id="__codelineno-501-2" name="__codelineno-501-2" href="#__codelineno-501-2"></a><span class="w"> </span><span class="n">foo</span><span class="p">(</span>
<a id="__codelineno-501-3" name="__codelineno-501-3" href="#__codelineno-501-3"></a><span class="w"> </span><span class="n">a</span><span class="p">,</span>
<a id="__codelineno-501-4" name="__codelineno-501-4" href="#__codelineno-501-4"></a><span class="w"> </span><span class="n">b</span><span class="p">,</span>
<a id="__codelineno-501-5" name="__codelineno-501-5" href="#__codelineno-501-5"></a><span class="w"> </span><span class="n">c</span><span class="p">,</span>
<a id="__codelineno-501-6" name="__codelineno-501-6" href="#__codelineno-501-6"></a><span class="w"> </span><span class="p">)</span>
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-502-1" name="__codelineno-502-1" href="#__codelineno-502-1"></a><span class="kd">val</span><span class="w"> </span><span class="nv">foo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">foo</span><span class="p">(</span>
<a id="__codelineno-502-2" name="__codelineno-502-2" href="#__codelineno-502-2"></a><span class="w"> </span><span class="n">a</span><span class="p">,</span>
<a id="__codelineno-502-3" name="__codelineno-502-3" href="#__codelineno-502-3"></a><span class="w"> </span><span class="n">b</span><span class="p">,</span>
<a id="__codelineno-502-4" name="__codelineno-502-4" href="#__codelineno-502-4"></a><span class="w"> </span><span class="n">c</span><span class="p">)</span>
</code></pre></div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align: left;">Configuration setting</th>
<th style="text-align: center;">ktlint_official</th>
<th style="text-align: center;">intellij_idea</th>
<th style="text-align: center;">android_studio</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>max_line_length</code><br/><i>Maximum length of a (regular) line. This property is ignored in case the <code>max-line-length</code> rule is disabled, or when using Ktlint via a third party integration that does not provide this rule.</i></td>
<td style="text-align: center;">140</td>
<td style="text-align: center;"><code>off</code></td>
<td style="text-align: center;"><code>100</code></td>
</tr>
</tbody>
</table>
<p>Rule id: <code>standard:wrapping</code></p>
<p class="annotate">Suppress or disable rule (1)</p>
<ol>
<li>Suppress rule in code with annotation below:
<div class="highlight"><pre><span></span><code><a id="__codelineno-503-1" name="__codelineno-503-1" href="#__codelineno-503-1"></a><span class="nd">@Suppress</span><span class="p">(</span><span class="s">&quot;ktlint:standard:wrapping&quot;</span><span class="p">)</span>
</code></pre></div>
Enable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-504-1" name="__codelineno-504-1" href="#__codelineno-504-1"></a>ktlint_standard_wrapping = enabled
</code></pre></div>
Disable rule via <code>.editorconfig</code>
<div class="highlight"><pre><span></span><code><a id="__codelineno-505-1" name="__codelineno-505-1" href="#__codelineno-505-1"></a>ktlint_standard_wrapping = disabled
</code></pre></div></li>
</ol>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.tabs.sticky", "navigation.sections", "navigation.expand", "search.suggest", "search.share", "content.code.copy"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
</body>
</html>