Skip to content

Commit

Permalink
Enable formerly experimental rules by default
Browse files Browse the repository at this point in the history
These were promoted to running by default in pinterest/ktlint#2218
  • Loading branch information
3flex committed Oct 13, 2023
1 parent 9f1e02c commit 803cea6
Show file tree
Hide file tree
Showing 20 changed files with 90 additions and 54 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -119,30 +119,42 @@ class FormattingProvider : RuleSetProvider {
AnnotationOnSeparateLine(config),
AnnotationSpacing(config),
ArgumentListWrapping(config),
BlankLineBeforeDeclaration(config),
BlockCommentInitialStarAlignment(config),
ChainWrapping(config),
ClassName(config),
CommentSpacing(config),
CommentWrapping(config),
ContextReceiverMapping(config),
DiscouragedCommentLocation(config),
EnumEntryNameCase(config),
EnumWrapping(config),
Filename(config),
FinalNewline(config),
FunctionName(config),
FunKeywordSpacing(config),
FunctionReturnTypeSpacing(config),
FunctionSignature(config),
FunctionStartOfBodySpacing(config),
FunctionTypeReferenceSpacing(config),
IfElseBracing(config),
IfElseWrapping(config),
ImportOrdering(config),
Indentation(config),
KdocWrapping(config),
MaximumLineLength(config),
ModifierListSpacing(config),
ModifierOrdering(config),
MultiLineIfElse(config),
MultilineExpressionWrapping(config),
NoBlankLineBeforeRbrace(config),
NoBlankLineInList(config),
NoBlankLinesInChainedMethodCalls(config),
NoConsecutiveBlankLines(config),
NoConsecutiveComments(config),
NoEmptyClassBody(config),
NoEmptyFile(config),
NoEmptyFirstLineInClassBody(config),
NoEmptyFirstLineInMethodBlock(config),
NoLineBreakAfterElse(config),
NoLineBreakBeforeAssignment(config),
Expand All @@ -155,6 +167,7 @@ class FormattingProvider : RuleSetProvider {
NoWildcardImports(config),
NullableTypeSpacing(config),
PackageName(config),
ParameterListSpacing(config),
ParameterListWrapping(config),
ParameterWrapping(config),
PropertyName(config),
Expand All @@ -173,37 +186,24 @@ class FormattingProvider : RuleSetProvider {
SpacingBetweenDeclarationsWithAnnotations(config),
SpacingBetweenDeclarationsWithComments(config),
SpacingBetweenFunctionNameAndOpeningParenthesis(config),
StatementWrapping(config),
StringTemplate(config),
StringTemplateIndent(config),
TrailingCommaOnCallSite(config), // in standard ruleset but not enabled by default
TrailingCommaOnDeclarationSite(config), // in standard ruleset but not enabled by default
TryCatchFinallySpacing(config),
TypeArgumentListSpacing(config),
TypeParameterListSpacing(config),
UnnecessaryParenthesesBeforeTrailingLambda(config),
Wrapping(config),

// Wrappers for ktlint-ruleset-experimental rules. Disabled by default.
BinaryExpressionWrapping(config),
BlankLineBeforeDeclaration(config),
ChainMethodContinuation(config),
ClassSignature(config),
ContextReceiverMapping(config),
DiscouragedCommentLocation(config),
EnumWrapping(config),
FunctionExpressionBody(config),
FunctionLiteral(config),
FunctionSignature(config),
FunctionTypeModifierSpacing(config),
IfElseBracing(config),
IfElseWrapping(config),
MultilineExpressionWrapping(config),
NoBlankLineInList(config),
NoConsecutiveComments(config),
NoEmptyFile(config),
NoEmptyFirstLineInClassBody(config),
ParameterListSpacing(config),
StatementWrapping(config),
StringTemplateIndent(config),
TryCatchFinallySpacing(config),
TypeArgumentListSpacing(config),
TypeParameterListSpacing(config),
).sorted()
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@ package io.gitlab.arturbosch.detekt.formatting.wrappers

import com.pinterest.ktlint.ruleset.standard.rules.BlankLineBeforeDeclarationRule
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/experimental/#blank-line-before-declarations) for
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/standard/#blank-line-before-declarations) for
* documentation.
*/
@ActiveByDefault(since = "2.0.0")
@AutoCorrectable(since = "2.0.0")
class BlankLineBeforeDeclaration(config: Config) : FormattingRule(config) {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@ import com.pinterest.ktlint.ruleset.standard.rules.ContextReceiverWrappingRule
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.config
import io.gitlab.arturbosch.detekt.api.configWithAndroidVariants
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/experimental/#content-receiver-wrapping) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/standard/#content-receiver-wrapping) for documentation.
*/
@ActiveByDefault(since = "2.0.0")
@AutoCorrectable(since = "1.23.0")
class ContextReceiverMapping(config: Config) : FormattingRule(config) {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@ package io.gitlab.arturbosch.detekt.formatting.wrappers

import com.pinterest.ktlint.ruleset.standard.rules.DiscouragedCommentLocationRule
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/experimental/#discouraged-comment-location) for
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/standard/#discouraged-comment-location) for
* documentation.
*/
@ActiveByDefault(since = "2.0.0")
@AutoCorrectable(since = "1.20.0")
class DiscouragedCommentLocation(config: Config) : FormattingRule(config) {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@ import com.pinterest.ktlint.rule.engine.core.api.editorconfig.INDENT_SIZE_PROPER
import com.pinterest.ktlint.ruleset.standard.rules.EnumWrappingRule
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.config
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/experimental/#enum-wrapping) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/standard/#enum-wrapping) for documentation.
*/
@ActiveByDefault(since = "2.0.0")
@AutoCorrectable(since = "1.23.0")
class EnumWrapping(config: Config) : FormattingRule(config) {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,16 @@ import com.pinterest.ktlint.ruleset.standard.rules.FunctionSignatureRule
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.config
import io.gitlab.arturbosch.detekt.api.configWithAndroidVariants
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/experimental/#function-signature) for
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/standard/#function-signature) for
* documentation.
*/
@ActiveByDefault(since = "2.0.0")
@AutoCorrectable(since = "1.22.0")
class FunctionSignature(config: Config) : FormattingRule(config) {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@ import com.pinterest.ktlint.rule.engine.core.api.editorconfig.INDENT_SIZE_PROPER
import com.pinterest.ktlint.ruleset.standard.rules.IfElseBracingRule
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.config
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/experimental/#if-else-bracing) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/standard/#if-else-bracing) for documentation.
*/
@ActiveByDefault(since = "2.0.0")
@AutoCorrectable(since = "1.23.0")
class IfElseBracing(config: Config) : FormattingRule(config) {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@ import com.pinterest.ktlint.rule.engine.core.api.editorconfig.INDENT_SIZE_PROPER
import com.pinterest.ktlint.ruleset.standard.rules.IfElseWrappingRule
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.config
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/experimental/#if-else-wrapping) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/standard/#if-else-wrapping) for documentation.
*/
@ActiveByDefault(since = "2.0.0")
@AutoCorrectable(since = "1.23.0")
class IfElseWrapping(config: Config) : FormattingRule(config) {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@ import com.pinterest.ktlint.rule.engine.core.api.editorconfig.INDENT_SIZE_PROPER
import com.pinterest.ktlint.ruleset.standard.rules.MultilineExpressionWrappingRule
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.config
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/experimental/#multiline-expression-wrapping) for
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/standard/#multiline-expression-wrapping) for
* documentation.
*/
@ActiveByDefault(since = "2.0.0")
@AutoCorrectable(since = "1.23.0")
class MultilineExpressionWrapping(config: Config) : FormattingRule(config) {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@ package io.gitlab.arturbosch.detekt.formatting.wrappers

import com.pinterest.ktlint.ruleset.standard.rules.NoBlankLineInListRule
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/experimental/#no-blank-lines-in-list) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/standard/#no-blank-lines-in-list) for documentation.
*/
@ActiveByDefault(since = "2.0.0")
@AutoCorrectable(since = "1.23.0")
class NoBlankLineInList(config: Config) : FormattingRule(config) {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@ package io.gitlab.arturbosch.detekt.formatting.wrappers

import com.pinterest.ktlint.ruleset.standard.rules.NoConsecutiveCommentsRule
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/experimental/#disallow-consecutive-comments) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/standard/#disallow-consecutive-comments) for documentation.
*/
@ActiveByDefault(since = "2.0.0")
class NoConsecutiveComments(config: Config) : FormattingRule(config) {

override val wrapping = NoConsecutiveCommentsRule()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@ package io.gitlab.arturbosch.detekt.formatting.wrappers

import com.pinterest.ktlint.ruleset.standard.rules.NoEmptyFileRule
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/experimental/#no-empty-file) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/standard/#no-empty-file) for documentation.
*/
@ActiveByDefault(since = "2.0.0")
class NoEmptyFile(config: Config) : FormattingRule(config) {

override val wrapping = NoEmptyFileRule()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@ import com.pinterest.ktlint.rule.engine.core.api.editorconfig.INDENT_SIZE_PROPER
import com.pinterest.ktlint.ruleset.standard.rules.NoEmptyFirstLineInClassBodyRule
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.config
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/experimental/#disallow-empty-lines-at-start-of-class-body)
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/standard/#disallow-empty-lines-at-start-of-class-body)
* for documentation.
*/
@ActiveByDefault(since = "2.0.0")
@AutoCorrectable(since = "1.23.0")
class NoEmptyFirstLineInClassBody(config: Config) : FormattingRule(config) {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@ package io.gitlab.arturbosch.detekt.formatting.wrappers

import com.pinterest.ktlint.ruleset.standard.rules.ParameterListSpacingRule
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/experimental/#parameter-list-spacing) for
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/standard/#parameter-list-spacing) for
* documentation.
*/
@ActiveByDefault(since = "2.0.0")
@AutoCorrectable(since = "1.22.0")
class ParameterListSpacing(config: Config) : FormattingRule(config) {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@ import com.pinterest.ktlint.rule.engine.core.api.editorconfig.INDENT_SIZE_PROPER
import com.pinterest.ktlint.ruleset.standard.rules.StatementWrappingRule
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.config
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/experimental/#statement-wrapping) for
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/standard/#statement-wrapping) for
* documentation.
*/
@ActiveByDefault(since = "2.0.0")
@AutoCorrectable(since = "2.0.0")
class StatementWrapping(config: Config) : FormattingRule(config) {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@ import com.pinterest.ktlint.rule.engine.core.api.editorconfig.INDENT_SIZE_PROPER
import com.pinterest.ktlint.ruleset.standard.rules.StringTemplateIndentRule
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.config
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/experimental/#string-template-indent) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/standard/#string-template-indent) for documentation.
*/
@ActiveByDefault(since = "2.0.0")
@AutoCorrectable(since = "1.23.0")
class StringTemplateIndent(config: Config) : FormattingRule(config) {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@ import com.pinterest.ktlint.rule.engine.core.api.editorconfig.INDENT_SIZE_PROPER
import com.pinterest.ktlint.ruleset.standard.rules.TryCatchFinallySpacingRule
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.config
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/experimental/#try-catch-finally-spacing) for
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/standard/#try-catch-finally-spacing) for
* documentation.
*/
@ActiveByDefault(since = "2.0.0")
@AutoCorrectable(since = "1.23.0")
class TryCatchFinallySpacing(config: Config) : FormattingRule(config) {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@ import com.pinterest.ktlint.rule.engine.core.api.editorconfig.INDENT_SIZE_PROPER
import com.pinterest.ktlint.ruleset.standard.rules.TypeArgumentListSpacingRule
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.config
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/experimental/#type-argument-list-spacing) for
* See [ktlint docs](https://pinterest.github.io/ktlint/<ktlintVersion/>/rules/standard/#type-argument-list-spacing) for
* documentation.
*/
@ActiveByDefault(since = "2.0.0")
@AutoCorrectable(since = "1.20.0")
class TypeArgumentListSpacing(config: Config) : FormattingRule(config) {

Expand Down
Loading

0 comments on commit 803cea6

Please sign in to comment.