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.

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

Update ktlint rule doc links #5258

Merged
merged 1 commit into from Sep 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Expand Up @@ -7,7 +7,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#annotation-formatting) for documentation.
*/
@AutoCorrectable(since = "1.0.0")
@ActiveByDefault(since = "1.22.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 [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#annotation-spacing) for documentation.
*/
@AutoCorrectable(since = "1.0.0")
@ActiveByDefault(since = "1.22.0")
Expand Down
Expand Up @@ -12,7 +12,7 @@ import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#argument-list-wrapping) for documentation.
*/
@AutoCorrectable(since = "1.0.0")
@ActiveByDefault(since = "1.22.0")
Expand Down
Expand Up @@ -6,7 +6,8 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint-readme](https://github.com/pinterest/ktlint#experimental-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/experimental/#block-comment-initial-star-alignment) 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 [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#chain-wrapping) 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 [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#comment-spacing) 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 [ktlint-readme](https://github.com/pinterest/ktlint#experimental-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/experimental/#comment-wrapping) for documentation.
*/
@AutoCorrectable(since = "1.20.0")
class CommentWrapping(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -6,7 +6,8 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint-readme](https://github.com/pinterest/ktlint#experimental-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/experimental/#discouraged-comment-location) for
* documentation.
*/
@AutoCorrectable(since = "1.20.0")
class DiscouragedCommentLocation(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 [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#enum-entry) for documentation.
*/
@AutoCorrectable(since = "1.4.0")
@ActiveByDefault(since = "1.22.0")
Expand Down
Expand Up @@ -6,7 +6,7 @@ import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#file-name) for documentation.
*
* This rules overlaps with [naming>MatchingDeclarationName](https://detekt.dev/naming.html#matchingdeclarationname)
* from the standard rules, make sure to enable just one.
Expand Down
Expand Up @@ -11,7 +11,7 @@ import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#final-newline) for documentation.
*
* 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.
Expand Down
Expand Up @@ -6,7 +6,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint-readme](https://github.com/pinterest/ktlint#experimental-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/experimental/#fun-keyword-spacing) for documentation.
*/
@AutoCorrectable(since = "1.20.0")
class FunKeywordSpacing(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -6,7 +6,8 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint-readme](https://github.com/pinterest/ktlint#experimental-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/experimental/#function-type-reference-spacing) for
* documentation.
*/
@AutoCorrectable(since = "1.20.0")
class FunctionTypeReferenceSpacing(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -10,7 +10,7 @@ import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#import-ordering) for documentation.
*
* 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)
*/
Expand Down
Expand Up @@ -13,7 +13,7 @@ import io.gitlab.arturbosch.detekt.formatting.FormattingRule
import org.jetbrains.kotlin.com.intellij.lang.ASTNode

/**
* See [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#indentation) for documentation.
*/
@ActiveByDefault(since = "1.19.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 [ktlint-readme](https://github.com/pinterest/ktlint#experimental-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/experimental/#kdoc-wrapping) for documentation.
*/
@AutoCorrectable(since = "1.20.0")
class KdocWrapping(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -11,7 +11,7 @@ import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#max-line-length) for documentation.
*
* 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
Expand Down
Expand Up @@ -6,7 +6,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint-readme](https://github.com/pinterest/ktlint#experimental-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/experimental/#modifier-list-spacing) for documentation.
*/
@AutoCorrectable(since = "1.20.0")
class ModifierListSpacing(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 [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#modifier-order) for documentation.
*
* 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.
Expand Down
Expand Up @@ -7,7 +7,7 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#multiline-if-else) for documentation.
*/
@AutoCorrectable(since = "1.0.0")
@ActiveByDefault(since = "1.22.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 [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#no-blank-lines-before) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -7,7 +7,8 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint-website](https://ktlint.github.io) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#no-blank-lines-in-chained-method-calls) for
* documentation.
*/
@ActiveByDefault(since = "1.22.0")
@AutoCorrectable(since = "1.22.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 [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#no-consecutive-blank-lines) 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 [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#no-empty-class-bodies) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -7,7 +7,8 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#no-leading-empty-lines-in-method-blocks) for
* documentation.
*/
@AutoCorrectable(since = "1.4.0")
@ActiveByDefault(since = "1.22.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 [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#no-line-break-after-else) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -7,7 +7,8 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#no-line-break-before-assignment) 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 [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#no-multi-spaces) 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 [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#no-semicolons) 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 [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#no-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 [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#no-unit-as-return-type) 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 [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#no-unused-imports) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down
Expand Up @@ -9,7 +9,7 @@ import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#no-wildcard-imports) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
class NoWildcardImports(config: Config) : FormattingRule(config) {
Expand Down
Expand Up @@ -7,7 +7,8 @@ import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#no-underscores-in-package-names) for
* documentation.
*/
@AutoCorrectable(since = "1.0.0")
@ActiveByDefault(since = "1.22.0")
Expand Down
Expand Up @@ -12,7 +12,7 @@ import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule

/**
* See [ktlint-readme](https://github.com/pinterest/ktlint#standard-rules) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#parameter-list-wrapping) 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 [ktlint-readme](https://github.com/pinterest/ktlint#spacing) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#angle-bracket-spacing) for documentation.
*/
@AutoCorrectable(since = "1.16.0")
@ActiveByDefault(since = "1.22.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 [ktlint-readme](https://github.com/pinterest/ktlint#spacing) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#colon-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 [ktlint-readme](https://github.com/pinterest/ktlint#spacing) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#comma-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 [ktlint-readme](https://github.com/pinterest/ktlint#spacing) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#curly-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 [ktlint-readme](https://github.com/pinterest/ktlint#spacing) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#dot-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 [ktlint-readme](https://github.com/pinterest/ktlint#spacing) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#double-colon-spacing) for documentation.
*/
@AutoCorrectable(since = "1.10.0")
@ActiveByDefault(since = "1.22.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 [ktlint-readme](https://github.com/pinterest/ktlint#spacing) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#keyword-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 [ktlint-readme](https://github.com/pinterest/ktlint#spacing) for documentation.
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/#operator-spacing) for documentation.
*/
@ActiveByDefault(since = "1.0.0")
@AutoCorrectable(since = "1.0.0")
Expand Down