Add NoNameShadowing rule #3477
Add NoNameShadowing rule #3477
Conversation
Codecov Report
@@ Coverage Diff @@
## master #3477 +/- ##
============================================
- Coverage 80.28% 80.08% -0.20%
- Complexity 2784 2851 +67
============================================
Files 454 457 +3
Lines 8415 8537 +122
Branches 1608 1648 +40
============================================
+ Hits 6756 6837 +81
- Misses 789 793 +4
- Partials 870 907 +37
Continue to review full report at Codecov.
|
| NoNameShadowing: | ||
| active: false |
There was a problem hiding this comment.
+1 for putting this under naming. Thank you!
| super.visitProperty(property) | ||
| report(property) |
There was a problem hiding this comment.
Today I learned: KtProperty and DestructuringDeclarationEntry are the sealed types of KtVariableDeclaration
| import org.jetbrains.kotlin.resolve.BindingContext | ||
|
|
||
| /** | ||
| * Disallows shadowing variable declarations. |
There was a problem hiding this comment.
We should elaborate a bit here. I don't know if it's necessary to explain what variable shadowing means. But at least say why it's bad.
| val findings = subject.compileAndLintWithContext(env, code) | ||
| assertThat(findings).hasSize(1) | ||
| assertThat(findings[0]).hasMessage("Name shadowed: k") | ||
| } |
There was a problem hiding this comment.
Does this implementation check the double it when you nest two lambdas?
| assertThat(findings).hasSize(1) | ||
| assertThat(findings[0]).hasMessage("Name shadowed: it") | ||
| } | ||
|
|
There was a problem hiding this comment.
| it("report shadowing nested lambda implicit 'it' parameter") { | |
| val code = """ | |
| fun test() { | |
| listOf(1).forEach { | |
| listOf(2).forEach { | |
| } | |
| } | |
| } | |
| """ | |
| val findings = subject.compileAndLintWithContext(env, code) | |
| assertThat(findings).hasSize(1) | |
| assertThat(findings[0]).hasMessage("Name shadowed: it") | |
| } | |
Do this have sense?
…t/rules/naming/NoNameShadowingSpec.kt Co-authored-by: Brais Gabín <braisgabin@gmail.com>
| report(parameter) | ||
| } | ||
|
|
||
| private fun report(declaration: KtNamedDeclaration) { |
There was a problem hiding this comment.
Please rename this function. report is a method of the superclass and is doing the actual issue reporting. Here you're instead checking for diagnostics and eventually reporting.
Fixes #240