Formatting Rule Set

This rule set provides wrappers for rules implemented by ktlint - https://ktlint.github.io/.

Note: Issues reported by this rule set can only be suppressed on file level (@file:Suppress("detekt.rule")). Note: The formatting rule set is not included in the detekt-cli or gradle plugin.

To enable this rule set, add detektPlugins "io.gitlab.arturbosch.detekt:detekt-formatting:$version" to your gradle dependencies or reference the detekt-formatting-jar with the --plugins option in the command line interface.

AnnotationOnSeparateLine

See ktlint docs for documentation.

Active by default: Yes - Since v1.22.0

AnnotationSpacing

See ktlint docs for documentation.

Active by default: Yes - Since v1.22.0

ArgumentListWrapping

See ktlint docs for documentation.

Active by default: Yes - Since v1.22.0

Configuration options:

• indentSize (default: 4)

  indentation size

• maxLineLength (default: 120) (android default: 100)

  maximum line length

BlockCommentInitialStarAlignment

See ktlint docs for documentation.

Active by default: No

ChainWrapping

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

CommentSpacing

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

CommentWrapping

See ktlint docs for documentation.

Active by default: No

Configuration options:

• indentSize (default: 4)

  indentation size

DiscouragedCommentLocation

See ktlint docs for documentation.

Active by default: No

EnumEntryNameCase

See ktlint docs for documentation.

Active by default: Yes - Since v1.22.0

Filename

See ktlint docs for documentation.

This rules overlaps with naming>MatchingDeclarationName from the standard rules, make sure to enable just one.

Active by default: Yes - Since v1.0.0

FinalNewline

See ktlint docs for documentation.

This rules overlaps with style>NewLineAtEndOfFile from the standard rules, make sure to enable just one. The pro of this rule is that it can auto-correct the issue.

Active by default: Yes - Since v1.0.0

Configuration options:

• insertFinalNewLine (default: true)

  report absence or presence of a newline

FunKeywordSpacing

See ktlint docs for documentation.

Active by default: No

FunctionReturnTypeSpacing

See ktlint docs for documentation.

Active by default: No

FunctionSignature

See ktlint docs for documentation.

Active by default: No

Configuration options:

• forceMultilineWhenParameterCountGreaterOrEqualThan (default: 2147483647)

  parameter count means multiline threshold

• functionBodyExpressionWrapping (default: 'default')

  indentation size

• maxLineLength (default: 120) (android default: 100)

  maximum line length

• indentSize (default: 4)

  indentation size

FunctionStartOfBodySpacing

See ktlint docs for documentation.

Active by default: No

FunctionTypeReferenceSpacing

See ktlint docs for documentation.

Active by default: No

ImportOrdering

See ktlint docs for documentation.

For defining import layout patterns see the KtLint Source Code

Active by default: Yes - Since v1.19.0

Configuration options:

• layout (default: '*,java.**,javax.**,kotlin.**,^') (android default: '*')

  the import ordering layout

Indentation

See ktlint docs for documentation.

Active by default: Yes - Since v1.19.0

Configuration options:

• indentSize (default: 4)

  indentation size

• continuationIndentSize (default: 4)

  Deprecated: continuationIndentSize is ignored by KtLint and will have no effect

  continuation indentation size

KdocWrapping

See ktlint docs for documentation.

Active by default: No

Configuration options:

• indentSize (default: 4)

  indentation size

MaximumLineLength

See ktlint docs for documentation.

This rules overlaps with style>MaxLineLength from the standard rules, make sure to enable just one or keep them aligned. The pro of this rule is that it can auto-correct the issue.

Active by default: Yes - Since v1.0.0

Configuration options:

• maxLineLength (default: 120) (android default: 100)

  maximum line length

• ignoreBackTickedIdentifier (default: false)

  ignore back ticked identifier

ModifierListSpacing

See ktlint docs for documentation.

Active by default: No

ModifierOrdering

See ktlint docs for documentation.

This rules overlaps with style>ModifierOrder from the standard rules, make sure to enable just one. The pro of this rule is that it can auto-correct the issue.

Active by default: Yes - Since v1.0.0

MultiLineIfElse

See ktlint docs for documentation.

Active by default: Yes - Since v1.22.0

NoBlankLineBeforeRbrace

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

NoBlankLinesInChainedMethodCalls

See ktlint docs for documentation.

Active by default: Yes - Since v1.22.0

NoConsecutiveBlankLines

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

NoEmptyClassBody

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

NoEmptyFirstLineInMethodBlock

See ktlint docs for documentation.

Active by default: Yes - Since v1.22.0

NoLineBreakAfterElse

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

NoLineBreakBeforeAssignment

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

NoMultipleSpaces

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

NoSemicolons

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

NoTrailingSpaces

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

NoUnitReturn

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

NoUnusedImports

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

NoWildcardImports

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

Configuration options:

• packagesToUseImportOnDemandProperty (default: 'java.util.*,kotlinx.android.synthetic.**')

  Defines allowed wildcard imports

NullableTypeSpacing

See ktlint docs for documentation.

Active by default: No

PackageName

See ktlint docs for documentation.

Active by default: Yes - Since v1.22.0

ParameterListSpacing

See ktlint docs for documentation.

Active by default: No

ParameterListWrapping

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

Configuration options:

• maxLineLength (default: 120) (android default: 100)

  maximum line length

• indentSize (default: 4)

  Deprecated: indentSize is ignored by KtLint and will have no effect

  indentation size

SpacingAroundAngleBrackets

See ktlint docs for documentation.

Active by default: Yes - Since v1.22.0

SpacingAroundColon

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

SpacingAroundComma

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

SpacingAroundCurly

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

SpacingAroundDot

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

SpacingAroundDoubleColon

See ktlint docs for documentation.

Active by default: Yes - Since v1.22.0

SpacingAroundKeyword

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

SpacingAroundOperators

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

SpacingAroundParens

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

SpacingAroundRangeOperator

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

SpacingAroundUnaryOperator

See ktlint docs for documentation.

Active by default: Yes - Since v1.22.0

SpacingBetweenDeclarationsWithAnnotations

See ktlint docs for documentation.

Active by default: Yes - Since v1.22.0

SpacingBetweenDeclarationsWithComments

See ktlint docs for documentation.

Active by default: Yes - Since v1.22.0

SpacingBetweenFunctionNameAndOpeningParenthesis

See ktlint docs for documentation.

Active by default: No

StringTemplate

See ktlint docs for documentation.

Active by default: Yes - Since v1.0.0

TrailingCommaOnCallSite

See ktlint docs for documentation.

The default config comes from ktlint and follows these conventions:

• Kotlin coding convention recommends trailing comma encourage the use of trailing commas at the declaration site and leaves it at your discretion for the call site.
• Android Kotlin style guide does not include trailing comma usage yet.

Active by default: No

Configuration options:

• useTrailingCommaOnCallSite (default: true) (android default: false)

  Defines whether trailing commas are required (true) or forbidden (false) at call sites

TrailingCommaOnDeclarationSite

See ktlint docs for documentation.

The default config comes from ktlint and follows these conventions:

• Kotlin coding convention recommends trailing comma encourage the use of trailing commas at the declaration site and leaves it at your discretion for the call site.
• Android Kotlin style guide does not include trailing comma usage yet.

Active by default: No

Configuration options:

• useTrailingCommaOnDeclarationSite (default: true) (android default: false)

  Defines whether trailing commas are required (true) or forbidden (false) at declaration sites

TypeArgumentListSpacing

See ktlint docs for documentation.

Active by default: No

TypeParameterListSpacing

See ktlint docs for documentation.

Active by default: No

UnnecessaryParenthesesBeforeTrailingLambda

See ktlint docs for documentation.

Active by default: No

Wrapping

See ktlint docs for documentation.

Active by default: Yes - Since v1.20.0

Configuration options:

• indentSize (default: 4)

  indentation size