website/versioned_docs/version-1.23.0/rules/formatting.md
This rule set provides wrappers for rules implemented by ktlint - https://ktlint.github.io/.
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.
Note: Issues reported by this rule set can only be suppressed on file level (@file:Suppress("detekt.rule")).
See ktlint docs for documentation.
Active by default: Yes - Since v1.22.0
indentSize (default: 4)
indentation size
See ktlint docs for documentation.
Active by default: Yes - Since v1.22.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.22.0
indentSize (default: 4)
indentation size
maxLineLength (default: 120) (android default: 100)
maximum line length
See ktlint docs for documentation.
Active by default: Yes - Since v1.23.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
indentSize (default: 4)
indentation size
See ktlint docs for documentation.
Active by default: No
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.23.0
indentSize (default: 4)
indentation size
See ktlint docs for documentation.
Active by default: No
maxLineLength (default: 120) (android default: 100)
maximum line length
indentSize (default: 4)
indentation size
See ktlint docs for documentation.
Active by default: No
See ktlint docs for documentation.
Active by default: Yes - Since v1.22.0
See ktlint docs for documentation.
Active by default: No
indentSize (default: 4)
indentation size
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
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
insertFinalNewLine (default: true)
report absence or presence of a newline
See ktlint docs for documentation.
Active by default: Yes - Since v1.23.0
See ktlint docs for documentation.
Active by default: No
See ktlint docs for documentation.
Active by default: Yes - Since v1.23.0
maxLineLength (default: 120) (android default: 100)
maximum line length
See ktlint docs for documentation.
Active by default: No
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
See ktlint docs for documentation.
Active by default: Yes - Since v1.23.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.23.0
See ktlint docs for documentation.
Active by default: No
indentSize (default: 4)
indentation size
See ktlint docs for documentation.
Active by default: No
indentSize (default: 4)
indentation size
See ktlint docs for documentation.
For defining import layout patterns see the KtLint Source Code
Active by default: Yes - Since v1.19.0
layout (default: '*,java.**,javax.**,kotlin.**,^') (android default: '*')
the import ordering layout
See ktlint docs for documentation.
Active by default: Yes - Since v1.19.0
indentSize (default: 4)
indentation size
continuationIndentSize4)
Deprecated: continuationIndentSize is ignored by KtLint and will have no effect
continuation indentation size
See ktlint docs for documentation.
Active by default: Yes - Since v1.23.0
indentSize (default: 4)
indentation size
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
maxLineLength (default: 120) (android default: 100)
maximum line length
ignoreBackTickedIdentifier (default: false)
ignore back ticked identifier
See ktlint docs for documentation.
Active by default: Yes - Since v1.23.0
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
See ktlint docs for documentation.
Active by default: Yes - Since v1.22.0
indentSize (default: 4)
indentation size
See ktlint docs for documentation.
Active by default: No
indentSize (default: 4)
indentation size
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
See ktlint docs for documentation.
Active by default: No
See ktlint docs for documentation.
Active by default: Yes - Since v1.22.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
See ktlint docs for documentation.
Active by default: No
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
See ktlint docs for documentation.
Active by default: No
indentSize (default: 4)
indentation size
See ktlint docs for documentation.
Active by default: Yes - Since v1.22.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
See ktlint docs for documentation.
Active by default: No
indentSize (default: 4)
indentation size
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
packagesToUseImportOnDemandProperty (default: 'java.util.*,kotlinx.android.synthetic.**')
Defines allowed wildcard imports
See ktlint docs for documentation.
Active by default: Yes - Since v1.23.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.22.0
See ktlint docs for documentation.
Active by default: No
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
maxLineLength (default: 120) (android default: 100)
maximum line length
indentSize (default: 4)
indentation size
See ktlint docs for documentation.
Active by default: Yes - Since v1.23.0
indentSize (default: 4)
indentation size
maxLineLength (default: 120) (android default: 100)
maximum line length
See ktlint docs for documentation.
Active by default: No
See ktlint docs for documentation.
Active by default: Yes - Since v1.23.0
indentSize (default: 4)
indentation size
maxLineLength (default: 120) (android default: 100)
maximum line length
See ktlint docs for documentation.
Active by default: Yes - Since v1.22.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.22.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.22.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.22.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.22.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.23.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.0.0
See ktlint docs for documentation.
Active by default: No
indentSize (default: 4)
indentation size
See ktlint docs for documentation.
The default config comes from ktlint and follows these conventions:
Active by default: No
useTrailingCommaOnCallSite (default: true) (android default: false)
Defines whether trailing commas are required (true) or forbidden (false) at call sites
See ktlint docs for documentation.
The default config comes from ktlint and follows these conventions:
Active by default: No
useTrailingCommaOnDeclarationSite (default: true) (android default: false)
Defines whether trailing commas are required (true) or forbidden (false) at declaration sites
See ktlint docs for documentation.
Active by default: No
indentSize (default: 4)
indentation size
See ktlint docs for documentation.
Active by default: No
indentSize (default: 4)
indentation size
See ktlint docs for documentation.
Active by default: No
indentSize (default: 4)
indentation size
See ktlint docs for documentation.
Active by default: Yes - Since v1.23.0
See ktlint docs for documentation.
Active by default: Yes - Since v1.20.0
indentSize (default: 4)
indentation size
maxLineLength (default: 120) (android default: 100)
maximum line length