saveourtool/diktat

WhiteSpaceRule doesn't cover some cases with comma

Open

#1,239 opened on Mar 21, 2022

View on GitHubContributor guide
 (2 comments) (0 reactions) (1 assignee)Kotlin (40 forks)github user discovery
enhancementgood first issuehelp wantedneeded

Repository metrics

Stars
 (571 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I have found a reproducer for https://github.com/analysis-dev/diktat/blob/5e2e2ed194a1f74904893ecd8a4c7dd4bb9afd57/diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter3/files/WhiteSpaceRule.kt#L254-L255

[WARN ] 2022-03-21 18:01:16 Colon with treeParent.elementType=DESTRUCTURING_DECLARATION_ENTRY, not handled by WhiteSpaceRule
[WARN ] 2022-03-21 18:01:16 Colon with treeParent.elementType=DESTRUCTURING_DECLARATION_ENTRY, not handled by WhiteSpaceRule
[WARN ] 2022-03-21 18:01:17 Colon with treeParent.elementType=DESTRUCTURING_DECLARATION_ENTRY, not handled by WhiteSpaceRule
[WARN ] 2022-03-21 18:01:17 Colon with treeParent.elementType=DESTRUCTURING_DECLARATION_ENTRY, not handled by WhiteSpaceRule

However, I don't even know which file has caused this :(

Contributor guide

Research direction
Examine the WhiteSpaceRule.kt file, specifically the part that handles colon tokens (around line 254). Add handling for DESTRUCTURING DECLARATION ENTRY as a parent type to suppress warnings.
Tech stack
kotlin
Domain
tooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
KotlinGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75