Kdoc fixer: not ask @return on simple delegating getters: #1022

Cheshiriks · 2021-08-02T14:48:19Z

What's done:

fixed bug in WRONG_NEWLINES
now don't ask @return on function with name same last reference Expression
Closes Kdoc fixer false-negative: not generating a Kdoc for several public functions #965

@return

### What's done: * fixed bug in WRONG_NEWLINES * now don't ask @return on function with name same last reference Expression Closes #965

codecov · 2021-08-02T14:57:16Z

Codecov Report

Merging #1022 (9e2a471) into master (55b5724) will decrease coverage by 0.01%.
The diff coverage is 75.00%.

@@             Coverage Diff              @@
##             master    #1022      +/-   ##
============================================
- Coverage     83.80%   83.79%   -0.02%     
- Complexity     2424     2428       +4     
============================================
  Files           102      102              
  Lines          6108     6114       +6     
  Branches       1809     1811       +2     
============================================
+ Hits           5119     5123       +4     
  Misses          273      273              
- Partials        716      718       +2

Flag	Coverage Δ
unittests	`83.79% <75.00%> (-0.02%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
.../ruleset/rules/chapter6/classes/DataClassesRule.kt	`75.00% <ø> (ø)`
.../diktat/ruleset/rules/chapter2/kdoc/KdocMethods.kt	`86.61% <75.00%> (-0.89%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 55b5724...9e2a471. Read the comment docs.

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter2/kdoc/KdocMethods.kt

### What's done: * fixed bug in WRONG_NEWLINES Closes #965

petertrr · 2021-08-04T09:36:17Z

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter2/kdoc/KdocMethods.kt

+        if (node.isSingleLineGetterOrSetter()) {
+            return false
+        }
+        val lastDotQualifiedExpression = node.findChildByType(DOT_QUALIFIED_EXPRESSION)?.text?.substringAfterLast('.')


foo.bar(x.prop) will yield prop) with this logic, if I understand correctly. And you need bar

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter2/kdoc/KdocMethods.kt

### What's done: * fixed bug in WRONG_NEWLINES Closes #965

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter2/kdoc/KdocMethods.kt

@return

### What's done: * fixed bug in WRONG_NEWLINES * now don't ask @return on function with name same last reference Expression Closes #965

@return

### What's done: * fixed bug in WRONG_NEWLINES * now don't ask @return on function with name same last reference Expression Closes #965

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter2/kdoc/KdocMethods.kt

petertrr · 2021-08-09T10:11:58Z

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter2/kdoc/KdocMethods.kt

+        return funName == lastDotQualifiedExpression
+    }
+
+    @Suppress("WRONG_NEWLINES")


Why did you suppress it?)

The Diktat merge 2 lines into one, and then breaks down on LONG_LINE

Then please create an issue with a reproducer, it looks like behavior that we need to avoid

petertrr · 2021-08-09T10:12:41Z

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter6/classes/DataClassesRule.kt

 import com.pinterest.ktlint.core.ast.ElementType.ENUM_KEYWORD
 import com.pinterest.ktlint.core.ast.ElementType.FUN
 import com.pinterest.ktlint.core.ast.ElementType.INNER_KEYWORD
-import com.pinterest.ktlint.core.ast.ElementType.INTERFACE_KEYWORD


It's not the first time that I see how diktat removes unused imports in a file, on which it hasn't complained before. Do you have any thought, why this can happen?

Yes. We need to investigate this

Please create an issue about this too

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter2/kdoc/KdocMethods.kt

### What's done: * fixed bug in WRONG_NEWLINES Closes #965

Kdoc fixer: not ask @return on simple delegating getters:

bf002bd

### What's done: * fixed bug in WRONG_NEWLINES * now don't ask @return on function with name same last reference Expression Closes #965

Cheshiriks requested a review from petertrr August 2, 2021 14:48

petertrr requested changes Aug 2, 2021

View reviewed changes

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter2/kdoc/KdocMethods.kt Outdated Show resolved Hide resolved

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter2/kdoc/KdocMethods.kt Outdated Show resolved Hide resolved

Cheshiriks added 4 commits August 3, 2021 14:09

Kdoc fixer: not ask return on simple delegating getters:

96f4483

### What's done: * fixed bug in WRONG_NEWLINES Closes #965

Merge branch 'master' into feature/simple_delegating_getters

dc8b1ee

Kdoc fixer: not ask return on simple delegating getters:

ea6f1d1

### What's done: * fixed bug in WRONG_NEWLINES Closes #965

Merge branch 'master' into feature/simple_delegating_getters

981e774

petertrr requested changes Aug 4, 2021

View reviewed changes

Cheshiriks added 2 commits August 5, 2021 13:13

Kdoc fixer: not ask return on simple delegating getters:

b4c3a0e

### What's done: * fixed bug in WRONG_NEWLINES Closes #965

Kdoc fixer: not ask return on simple delegating getters:

cf2a9d1

### What's done: * fixed bug in WRONG_NEWLINES Closes #965

petertrr requested changes Aug 6, 2021

View reviewed changes

diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter2/kdoc/KdocMethods.kt Outdated Show resolved Hide resolved

Cheshiriks added 2 commits August 9, 2021 12:11

Kdoc fixer: not ask @return on simple delegating getters:

4169c44

### What's done: * fixed bug in WRONG_NEWLINES * now don't ask @return on function with name same last reference Expression Closes #965

Kdoc fixer: not ask @return on simple delegating getters:

20c8190

### What's done: * fixed bug in WRONG_NEWLINES * now don't ask @return on function with name same last reference Expression Closes #965

petertrr requested changes Aug 9, 2021

View reviewed changes

Kdoc fixer: not ask return on simple delegating getters:

9e2a471

### What's done: * fixed bug in WRONG_NEWLINES Closes #965

petertrr approved these changes Aug 10, 2021

View reviewed changes

Cheshiriks merged commit bad9569 into master Aug 11, 2021

petertrr deleted the feature/simple_delegating_getters branch May 25, 2022 09:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Kdoc fixer: not ask @return on simple delegating getters: #1022

Kdoc fixer: not ask @return on simple delegating getters: #1022

Cheshiriks commented Aug 2, 2021

codecov bot commented Aug 2, 2021 •

edited

Loading

petertrr Aug 4, 2021

petertrr Aug 9, 2021

Cheshiriks Aug 10, 2021

petertrr Aug 10, 2021 •

edited

Loading

petertrr Aug 9, 2021

Cheshiriks Aug 10, 2021

petertrr Aug 10, 2021

Kdoc fixer: not ask @return on simple delegating getters: #1022

Kdoc fixer: not ask @return on simple delegating getters: #1022

Conversation

Cheshiriks commented Aug 2, 2021

What's done:

codecov bot commented Aug 2, 2021 • edited Loading

Codecov Report

petertrr Aug 4, 2021

Choose a reason for hiding this comment

petertrr Aug 9, 2021

Choose a reason for hiding this comment

Cheshiriks Aug 10, 2021

Choose a reason for hiding this comment

petertrr Aug 10, 2021 • edited Loading

Choose a reason for hiding this comment

petertrr Aug 9, 2021

Choose a reason for hiding this comment

Cheshiriks Aug 10, 2021

Choose a reason for hiding this comment

petertrr Aug 10, 2021

Choose a reason for hiding this comment

codecov bot commented Aug 2, 2021 •

edited

Loading

petertrr Aug 10, 2021 •

edited

Loading