Skip to content

Commit

Permalink
Fix various rendering problem on the formatting ruleset (#4911)
Browse files Browse the repository at this point in the history
  • Loading branch information
cortinico committed Jun 4, 2022
1 parent 4b30c6b commit 9146e4d
Show file tree
Hide file tree
Showing 53 changed files with 59 additions and 60 deletions.
Expand Up @@ -10,10 +10,10 @@ import io.gitlab.arturbosch.detekt.api.internal.ruleSetConfig
/**
* 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: 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 <i>detektPlugins "io.gitlab.arturbosch.detekt:detekt-formatting:$version"</i>
* 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.
*/
Expand Down
Expand Up @@ -6,7 +6,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io) for documentation.
*/
@AutoCorrectable(since = "1.0.0")
class AnnotationOnSeparateLine(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -6,7 +6,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io) for documentation.
*/
@AutoCorrectable(since = "1.0.0")
class AnnotationSpacing(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -12,7 +12,7 @@ import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io) for documentation.
*/
@OptIn(FeatureInAlphaState::class)
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -6,7 +6,7 @@ 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.
* See [ktlint-website](https://ktlint.github.io#rule-spacing) for documentation.
*/
@AutoCorrectable(since = "1.20.0")
class BlockCommentInitialStarAlignment(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -7,7 +7,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -7,7 +7,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -11,7 +11,7 @@ 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.
* See [ktlint-website](https://ktlint.github.io#rule-indentation) for documentation.
*/
@AutoCorrectable(since = "1.20.0")
class CommentWrapping(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -6,7 +6,7 @@ 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.
* See [ktlint-website](https://ktlint.github.io#rule-spacing) for documentation.
*/
@AutoCorrectable(since = "1.20.0")
class DiscouragedCommentLocation(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -6,7 +6,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io) for documentation.
*/
@AutoCorrectable(since = "1.4.0")
class EnumEntryNameCase(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -6,9 +6,9 @@ import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io) for documentation.
*
* This rules overlaps with [`naming>MatchingDeclarationName`](https://detekt.dev/naming.html#matchingdeclarationname)
* This rules overlaps with [naming>MatchingDeclarationName](https://detekt.dev/naming.html#matchingdeclarationname)
* from the standard rules, make sure to enable just one.
*/
@ActiveByDefault(since = "1.0.0")
Expand Down
Expand Up @@ -12,9 +12,9 @@ import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io) for documentation.
*
* This rules overlaps with [`style>NewLineAtEndOfFile`](https://detekt.dev/style.html#newlineatendoffile)
* This rules overlaps with [style>NewLineAtEndOfFile](https://detekt.dev/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.
*/
@ActiveByDefault(since = "1.0.0")
Expand Down
Expand Up @@ -6,7 +6,7 @@ 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.
* See [ktlint-website](https://ktlint.github.io#rule-spacing) for documentation.
*/
@AutoCorrectable(since = "1.20.0")
class FunKeywordSpacing(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -6,7 +6,7 @@ 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.
* See [ktlint-website](https://ktlint.github.io#rule-spacing) for documentation.
*/
@AutoCorrectable(since = "1.20.0")
class FunctionTypeReferenceSpacing(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -11,10 +11,9 @@ import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io) for documentation.
*
* For defining import layout patterns see:
* https://github.com/pinterest/ktlint/blob/a6ca5b2edf95cc70a138a9470cfb6c4fd5d9d3ce/ktlint-ruleset-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/ImportOrderingRule.kt
* For defining import layout patterns see the [KtLint Source Code](https://github.com/pinterest/ktlint/blob/a6ca5b2edf95cc70a138a9470cfb6c4fd5d9d3ce/ktlint-ruleset-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/ImportOrderingRule.kt)
*/
@ActiveByDefault(since = "1.19.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -14,7 +14,7 @@ import io.gitlab.arturbosch.detekt.formatting.FormattingRule
import org.jetbrains.kotlin.com.intellij.lang.ASTNode

/**
* See <a href="https://ktlint.github.io/#rule-indentation">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io#rule-indentation) for documentation.
*/
@ActiveByDefault(since = "1.19.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -11,7 +11,7 @@ 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.
* See [ktlint-website](https://ktlint.github.io#rule-indentation) for documentation.
*/
@AutoCorrectable(since = "1.20.0")
class KdocWrapping(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -12,9 +12,9 @@ import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io) for documentation.
*
* This rules overlaps with [`style>MaxLineLength`](https://detekt.dev/style.html#maxlinelength)
* This rules overlaps with [style>MaxLineLength](https://detekt.dev/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.
*/
Expand Down
Expand Up @@ -6,7 +6,7 @@ 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.
* See [ktlint-website](https://ktlint.github.io#rule-spacing) for documentation.
*/
@AutoCorrectable(since = "1.20.0")
class ModifierListSpacing(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -7,9 +7,9 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io/#rule-modifier-order">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io#rule-modifier-order) for documentation.
*
* This rules overlaps with [`style>ModifierOrder`](https://detekt.dev/style.html#modifierorder)
* This rules overlaps with [style>ModifierOrder](https://detekt.dev/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")
Expand Down
Expand Up @@ -6,7 +6,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io/#rule-modifier-order">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io#rule-modifier-order) for documentation.
*/
@AutoCorrectable(since = "1.0.0")
class MultiLineIfElse(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -7,7 +7,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -7,7 +7,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io/#rule-blank">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io#rule-blank) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -7,7 +7,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io/#rule-empty-class-body">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io#rule-empty-class-body) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -6,7 +6,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io) for documentation.
*/
@AutoCorrectable(since = "1.4.0")
class NoEmptyFirstLineInMethodBlock(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -7,7 +7,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -7,7 +7,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -7,7 +7,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -7,7 +7,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io/#rule-semi">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io#rule-semi) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -7,7 +7,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io/#rule-trailing-whitespaces">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io#rule-trailing-whitespaces) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -7,7 +7,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io/#rule-unit-return">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io#rule-unit-return) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -7,7 +7,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -10,7 +10,7 @@ import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io/#rule-import">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io#rule-import) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
class NoWildcardImports(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -6,7 +6,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io) for documentation.
*/
@AutoCorrectable(since = "1.0.0")
class PackageName(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -13,7 +13,7 @@ import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See <a href="https://ktlint.github.io">ktlint-website</a> for documentation.
* See [ktlint-website](https://ktlint.github.io) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -6,7 +6,7 @@ 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.
* See [ktlint-website](https://ktlint.github.io#rule-spacing) for documentation.
*/
@AutoCorrectable(since = "1.16.0")
class SpacingAroundAngleBrackets(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -7,7 +7,7 @@ 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.
* See [ktlint-website](https://ktlint.github.io#rule-spacing) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -7,7 +7,7 @@ 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.
* See [ktlint-website](https://ktlint.github.io#rule-spacing) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -7,7 +7,7 @@ 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.
* See [ktlint-website](https://ktlint.github.io#rule-spacing) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -7,7 +7,7 @@ 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.
* See [ktlint-website](https://ktlint.github.io#rule-spacing) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -6,7 +6,7 @@ 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.
* See [ktlint-website](https://ktlint.github.io#rule-spacing) for documentation.
*/
@AutoCorrectable(since = "1.10.0")
class SpacingAroundDoubleColon(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -7,7 +7,7 @@ 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.
* See [ktlint-website](https://ktlint.github.io#rule-spacing) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down

0 comments on commit 9146e4d

Please sign in to comment.