Bump ktlint to version 0.45.1 and implement new rules #4645
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| package io.gitlab.arturbosch.detekt.formatting.wrappers | ||
|
|
||
| import com.pinterest.ktlint.ruleset.experimental.BlockCommentInitialStarAlignmentRule | ||
| import io.gitlab.arturbosch.detekt.api.Config | ||
| import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable | ||
| import io.gitlab.arturbosch.detekt.formatting.FormattingRule | ||
|
|
||
| /** | ||
| * See <a href="https://ktlint.github.io/#rule-spacing">ktlint-website</a> for documentation. | ||
| */ | ||
| @AutoCorrectable(since = "1.20.0") | ||
| class BlockCommentInitialStarAlignment(config: Config) : FormattingRule(config) { | ||
|
|
||
| override val wrapping = BlockCommentInitialStarAlignmentRule() | ||
| override val issue = issueFor("Detect the alignment of the initial star in a block comment.") | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| package io.gitlab.arturbosch.detekt.formatting.wrappers | ||
|
|
||
| import com.pinterest.ktlint.core.api.DefaultEditorConfigProperties | ||
| import com.pinterest.ktlint.core.api.FeatureInAlphaState | ||
| import com.pinterest.ktlint.core.api.UsesEditorConfigProperties | ||
| import com.pinterest.ktlint.ruleset.experimental.CommentWrappingRule | ||
| import io.gitlab.arturbosch.detekt.api.Config | ||
| import io.gitlab.arturbosch.detekt.api.config | ||
| import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable | ||
| import io.gitlab.arturbosch.detekt.api.internal.Configuration | ||
| import io.gitlab.arturbosch.detekt.formatting.FormattingRule | ||
|
|
||
| /** | ||
| * See <a href="https://ktlint.github.io/#rule-indentation">ktlint-website</a> for documentation. | ||
| */ | ||
| @AutoCorrectable(since = "1.20.0") | ||
| class CommentWrapping(config: Config) : FormattingRule(config) { | ||
|
|
||
| override val wrapping = CommentWrappingRule() | ||
| override val issue = issueFor("Reports mis-indented code") | ||
|
|
||
| @Configuration("indentation size") | ||
| private val indentSize by config(4) | ||
|
|
||
| @OptIn(FeatureInAlphaState::class) | ||
| override fun overrideEditorConfigProperties(): Map<UsesEditorConfigProperties.EditorConfigProperty<*>, String> = | ||
| mapOf( | ||
| DefaultEditorConfigProperties.indentSizeProperty to indentSize.toString(), | ||
| ) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| package io.gitlab.arturbosch.detekt.formatting.wrappers | ||
|
|
||
| import com.pinterest.ktlint.ruleset.experimental.DiscouragedCommentLocationRule | ||
| import io.gitlab.arturbosch.detekt.api.Config | ||
| import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable | ||
| import io.gitlab.arturbosch.detekt.formatting.FormattingRule | ||
|
|
||
| /** | ||
| * See <a href="https://ktlint.github.io/#rule-spacing">ktlint-website</a> for documentation. | ||
| */ | ||
| @AutoCorrectable(since = "1.20.0") | ||
| class DiscouragedCommentLocation(config: Config) : FormattingRule(config) { | ||
|
|
||
| override val wrapping = DiscouragedCommentLocationRule() | ||
| override val issue = issueFor("Detect discouraged comment locations.") | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| package io.gitlab.arturbosch.detekt.formatting.wrappers | ||
|
|
||
| import com.pinterest.ktlint.ruleset.experimental.FunKeywordSpacingRule | ||
| import io.gitlab.arturbosch.detekt.api.Config | ||
| import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable | ||
| import io.gitlab.arturbosch.detekt.formatting.FormattingRule | ||
|
|
||
| /** | ||
| * See <a href="https://ktlint.github.io/#rule-spacing">ktlint-website</a> for documentation. | ||
| */ | ||
| @AutoCorrectable(since = "1.20.0") | ||
| class FunKeywordSpacing(config: Config) : FormattingRule(config) { | ||
|
|
||
| override val wrapping = FunKeywordSpacingRule() | ||
| override val issue = issueFor("Checks the spacing after the fun keyword.") | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| package io.gitlab.arturbosch.detekt.formatting.wrappers | ||
|
|
||
| import com.pinterest.ktlint.ruleset.experimental.FunctionTypeReferenceSpacingRule | ||
| import io.gitlab.arturbosch.detekt.api.Config | ||
| import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable | ||
| import io.gitlab.arturbosch.detekt.formatting.FormattingRule | ||
|
|
||
| /** | ||
| * See <a href="https://ktlint.github.io/#rule-spacing">ktlint-website</a> for documentation. | ||
| */ | ||
| @AutoCorrectable(since = "1.20.0") | ||
| class FunctionTypeReferenceSpacing(config: Config) : FormattingRule(config) { | ||
|
|
||
| override val wrapping = FunctionTypeReferenceSpacingRule() | ||
| override val issue = | ||
| issueFor("Checks the spacing before and after the angle brackets of a type argument list.") | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| package io.gitlab.arturbosch.detekt.formatting.wrappers | ||
|
|
||
| import com.pinterest.ktlint.core.api.DefaultEditorConfigProperties | ||
| import com.pinterest.ktlint.core.api.FeatureInAlphaState | ||
| import com.pinterest.ktlint.core.api.UsesEditorConfigProperties | ||
| import com.pinterest.ktlint.ruleset.experimental.KdocWrappingRule | ||
| import io.gitlab.arturbosch.detekt.api.Config | ||
| import io.gitlab.arturbosch.detekt.api.config | ||
| import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable | ||
| import io.gitlab.arturbosch.detekt.api.internal.Configuration | ||
| import io.gitlab.arturbosch.detekt.formatting.FormattingRule | ||
|
|
||
| /** | ||
| * See <a href="https://ktlint.github.io/#rule-indentation">ktlint-website</a> for documentation. | ||
| */ | ||
| @AutoCorrectable(since = "1.20.0") | ||
| class KdocWrapping(config: Config) : FormattingRule(config) { | ||
|
|
||
| override val wrapping = KdocWrappingRule() | ||
| override val issue = issueFor("Reports mis-indented code") | ||
|
|
||
| @Configuration("indentation size") | ||
| private val indentSize by config(4) | ||
|
|
||
| @OptIn(FeatureInAlphaState::class) | ||
| override fun overrideEditorConfigProperties(): Map<UsesEditorConfigProperties.EditorConfigProperty<*>, String> = | ||
| mapOf( | ||
| DefaultEditorConfigProperties.indentSizeProperty to indentSize.toString(), | ||
| ) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To be honest, I'm not really happy with this solution. Also I wanted to declare the ´overrideEditorConfig()` method as deprecated. But sadly each of deprecation will lead to a warning which is handled as error in the ci pipeline so I was forced to suppress this warning (without this code snippet the build will not succeed).