-
-
Notifications
You must be signed in to change notification settings - Fork 767
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 documentation for TrailingComma rules #5513
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
5af7b73
Update default config of TrailingComma to upstream
chao2zhang 34f356f
Update detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/…
chao2zhang 476ed79
Update detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/…
chao2zhang 7513394
Update doc to reflect ktlint to be an upstream
chao2zhang 37ebcec
Update .gitignore
chao2zhang File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,22 +3,32 @@ package io.gitlab.arturbosch.detekt.formatting.wrappers | |
import com.pinterest.ktlint.core.api.UsesEditorConfigProperties | ||
import com.pinterest.ktlint.ruleset.standard.TrailingCommaOnDeclarationSiteRule | ||
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.AutoCorrectable | ||
import io.gitlab.arturbosch.detekt.api.internal.Configuration | ||
import io.gitlab.arturbosch.detekt.formatting.FormattingRule | ||
|
||
/** | ||
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/standard/) for documentation. | ||
* | ||
* The default config comes from ktlint and follows these conventions: | ||
* - [Kotlin coding convention](https://kotlinlang.org/docs/coding-conventions.html#trailing-commas) recommends | ||
* trailing comma encourage the use of trailing commas at the declaration site and | ||
* leaves it at your discretion for the call site. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As above |
||
* - [Android Kotlin style guide](https://developer.android.com/kotlin/style-guide) does not include | ||
* trailing comma usage yet. | ||
*/ | ||
@AutoCorrectable(since = "1.22.0") | ||
class TrailingCommaOnDeclarationSite(config: Config) : FormattingRule(config) { | ||
|
||
override val wrapping = TrailingCommaOnDeclarationSiteRule() | ||
override val issue = issueFor("Rule to mandate/forbid trailing commas at declaration sites") | ||
|
||
@Configuration("Defines whether a trailing comma (or no trailing comma) should be enforced at declaration sites") | ||
private val useTrailingCommaOnDeclarationSite by config(false) | ||
@Configuration("Defines whether trailing commas are required (true) or forbidden (false) at declaration sites") | ||
private val useTrailingCommaOnDeclarationSite by configWithAndroidVariants( | ||
defaultValue = true, | ||
defaultAndroidValue = false, | ||
) | ||
|
||
override fun overrideEditorConfigProperties(): Map<UsesEditorConfigProperties.EditorConfigProperty<*>, String> = | ||
mapOf( | ||
|
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
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.
I think you'd suggested adding a reference to the Android style guide? Though that style guide doesn't say anything about trailing commas, so I expect we will get some issues raised.
Perhaps instead it can be made clear that the defaults match upstream ktlint.
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.
Will emphasize ktlint here