Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document the overlapping rules from formatting #4473

Merged
merged 1 commit into from Jan 8, 2022
Merged

Document the overlapping rules from formatting #4473

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions ...kt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/Filename.kt
View file
Open in desktop
Expand Up @@ -7,6 +7,9 @@ import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
*
* This rules overlaps with [`naming>MatchingDeclarationName`](https://detekt.github.io/detekt/naming.html#matchingdeclarationname)
* from the standard rules, make sure to enable just one.
*/
@ActiveByDefault(since = "1.0.0")
class Filename(config: Config) : FormattingRule(config) {
Expand Down
3 changes: 3 additions & 0 deletions ...ormatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/FinalNewline.kt
View file
Open in desktop
Expand Up @@ -12,6 +12,9 @@ import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
*
* This rules overlaps with [`style>NewLineAtEndOfFile`](https://detekt.github.io/detekt/style.html#newlineatendoffile)
* from the standard rules, make sure to enable just one. The pro of this rule is that it can auto-correct the issue.
*/
@OptIn(FeatureInAlphaState::class)
@ActiveByDefault(since = "1.0.0")
Expand Down
4 changes: 3 additions & 1 deletion ...ting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/MaximumLineLength.kt
View file
Open in desktop
Expand Up @@ -14,7 +14,9 @@ import io.gitlab.arturbosch.detekt.formatting.MAX_LINE_LENGTH_KEY
/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
*
* This rules overlaps with [`MaxLineLength`](https://detekt.github.io/detekt/style.html#maxlinelength) from the standard rules, make sure to enable just one or keep them aligned.
* This rules overlaps with [`style>MaxLineLength`](https://detekt.github.io/detekt/style.html#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.
*/
@ActiveByDefault(since = "1.0.0")
@OptIn(FeatureInAlphaState::class)
Expand Down
3 changes: 3 additions & 0 deletions ...tting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/ModifierOrdering.kt
View file
Open in desktop
Expand Up @@ -8,6 +8,9 @@ import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io/#rule-modifier-order">ktlint-website</a> for documentation.
*
* This rules overlaps with [`style>ModifierOrder`](https://detekt.github.io/detekt/style.html#modifierorder)
* from the standard rules, make sure to enable just one. The pro of this rule is that it can auto-correct the issue.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down