Fixes false positive of trailing whitespaces in kdoc #6370

atulgpt · 2023-08-05T16:50:56Z

codecov · 2023-08-05T16:59:38Z

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (bf0e3f6) 85.18% compared to head (2087ba4) 85.18%.

Additional details and impacted files

@@            Coverage Diff            @@
##               main    #6370   +/-   ##
=========================================
  Coverage     85.18%   85.18%           
- Complexity     4061     4067    +6     
=========================================
  Files           565      565           
  Lines         13321    13323    +2     
  Branches       2401     2401           
=========================================
+ Hits          11347    11349    +2     
  Misses          773      773           
  Partials       1201     1201

Files	Coverage Δ
...rturbosch/detekt/rules/style/TrailingWhitespace.kt	`97.22% <66.66%> (+0.16%)`	⬆️

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

BraisGabin · 2023-08-06T09:15:20Z

I'm not 100% sure about this one. Dokka doesn't support this. So they are really trailing spaces with no meaning. I would vote to close pr and issue until Dokka decides to support it. Otherwise I feel that we are adding false negatives more than adding a real feature.

atulgpt · 2023-08-06T15:25:47Z

I'm not 100% sure about this one. Dokka doesn't support this. So they are really trailing spaces with no meaning. I would vote to close pr and issue until Dokka decides to support it. Otherwise I feel that we are adding false negatives more than adding a real feature.

Hi, @BraisGabin I don't have a strong opinion on this issue. It's just that it is marked as a false positive in the bug tracker that's why I picked this issue. I am okay with any closing this issue as well

BraisGabin · 2023-08-10T15:53:59Z

I'm adding @TWiStErRob as reviewer here becuase it is his issue. I don't have a strong opinion here to be honest.

TWiStErRob

I agree with @BraisGabin, as I said in #5713 (comment).

I re-read the context, and while it's technically correct to support this, if KDoc doesn't do it, then people (like I did) will have a false sense that those spaces will do something.

Based on this I vote to close the PR; with the option to repurpose it in the future if/when feature is added, this is why I reviewed it. Until then, I think maybe opening a PR to update our docs and explain why those spaces are being flagged in "standard markdown" is the best way forward. That other PR could close the issue.

TWiStErRob · 2023-08-10T19:48:44Z

...kt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/TrailingWhitespace.kt

@@ -51,6 +52,15 @@ class TrailingWhitespace(config: Config = Config.empty) : Rule(config) {
        }
    }

+    private fun PsiElement.isKdocTrailingSpaces(trailingWhitespaces: Int): Boolean {
+        return this.parent is KDocSection && trailingWhitespaces == 2


Markdown spec says 2 or more.

Than I think that the first two are correct but the others are trailing spaces.

Huh, makes sense to interpret it that way. If we go with "report an error as we do it now but we change the message", it can still be just >=2 because any number is unsupported right now.

TWiStErRob · 2023-08-10T19:51:24Z

...kt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/TrailingWhitespace.kt

@@ -51,6 +52,15 @@ class TrailingWhitespace(config: Config = Config.empty) : Rule(config) {
        }
    }

+    private fun PsiElement.isKdocTrailingSpaces(trailingWhitespaces: Int): Boolean {
+        return this.parent is KDocSection && trailingWhitespaces == 2


Are nested list items still parented by KDocSection: nested list items?

TWiStErRob · 2023-08-10T19:53:19Z

...kt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/TrailingWhitespace.kt

+        return this.parent is KDocSection && trailingWhitespaces == 2
+    }
+
+    private fun PsiElement.shouldReport(trailingWhitespacesCount: Int): Boolean {


I would flip this to simplify:

Suggested change

private fun PsiElement.shouldReport(trailingWhitespacesCount: Int): Boolean {

private fun PsiElement.isValid(trailingWhitespacesCount: Int): Boolean {

TWiStErRob · 2023-08-10T19:55:19Z

...ules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/TrailingWhitespaceSpec.kt

+        fun `reports a excessive trailing spaces in kdoc`() {
+            val code = """
+                /**
+                * a   


These tests look really funny without visible spaces, would

Suggested change

* a

* a$space$space$space

be a stretch?

This could also prevent future bulk clean-up of trailing spaces inside string literals.

TWiStErRob · 2023-08-10T19:57:12Z

...ules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/TrailingWhitespaceSpec.kt

+        fun `reports a excessive trailing spaces in kdoc`() {
+            val code = """
+                /**
+                * a   


Align stars to mimic real(er) code.

BraisGabin · 2023-08-11T06:54:55Z

Until then, I think maybe opening a PR to update our docs and explain why those spaces are being flagged in "standard markdown" is the best way forward. That other PR could close the issue.

And what if we report an error as we do it now but we change the message? We could say that this feature of markdown is not supported and link to the open issue.

Even so, I don't see too much value here. To me we could directly close this PR and the issues directly. I would leave that decission to @atulgpt as he is the one doing the heavy lifting here.

TWiStErRob · 2023-08-11T10:06:20Z

And what if we report an error as we do it now but we change the message? We could say that this feature of markdown is not supported and link to the open issue.

I like that!

atulgpt · 2023-08-16T14:41:56Z

Until then, I think maybe opening a PR to update our docs and explain why those spaces are being flagged in "standard markdown" is the best way forward. That other PR could close the issue.

And what if we report an error as we do it now but we change the message? We could say that this feature of markdown is not supported and link to the open issue.

Even so, I don't see too much value here. To me we could directly close this PR and the issues directly. I would leave that decission to @atulgpt as he is the one doing the heavy lifting here.

Hi @BraisGabin, @TWiStErRob I will update the PR incorporating your reviews

BraisGabin · 2023-11-09T14:03:19Z

@detekt/maintainers We need to take a decission here. A go or a not go to this PR. To me this is a not go and just close the issue as "work as expected". If Dokka fix the issue I would be more than happy to add this but now until that moment.

TWiStErRob · 2023-11-09T23:06:07Z

Vote to close, but open another with a doc update to the rule (1 sentence) to explain what's happening.

[or maybe detect the case, and provide a clear edge case error message, probably not worth the effort/maintenance]

schalkms · 2023-11-10T15:24:30Z

Same - good decision!

atulgpt · 2023-11-11T18:41:51Z

Yup makes sense closing the issue.. o/w ROI was not justified

Fixes false positive of trailing whitespaces in kdoc

532efc8

detekt-ci added the rules label Aug 5, 2023

vercel bot deployed to Preview August 5, 2023 16:56 View deployment

BraisGabin enabled auto-merge (squash) August 6, 2023 09:11

BraisGabin disabled auto-merge August 6, 2023 09:12

BraisGabin requested a review from TWiStErRob August 10, 2023 15:52

TWiStErRob reviewed Aug 10, 2023

View reviewed changes

cortinico modified the milestones: 1.23.2, 2.0.0 Aug 19, 2023

cortinico added the pick request Marker for PRs that should be ported to the 1.0 release branch label Aug 19, 2023

Merge branch 'main' into fixes/5713/trailin-space-kdoc

2087ba4

cortinico enabled auto-merge (squash) October 29, 2023 08:47

vercel bot deployed to Preview October 29, 2023 08:52 View deployment

cortinico disabled auto-merge October 29, 2023 09:24

BraisGabin closed this Nov 10, 2023

TWiStErRob mentioned this pull request Nov 12, 2023

Explain #5713: KDoc line breaks are whitespaces #6621

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes false positive of trailing whitespaces in kdoc #6370

Fixes false positive of trailing whitespaces in kdoc #6370

atulgpt commented Aug 5, 2023

codecov bot commented Aug 5, 2023 •

edited

BraisGabin commented Aug 6, 2023

atulgpt commented Aug 6, 2023

BraisGabin commented Aug 10, 2023

TWiStErRob left a comment

TWiStErRob Aug 10, 2023

BraisGabin Aug 11, 2023

TWiStErRob Aug 11, 2023

TWiStErRob Aug 10, 2023

TWiStErRob Aug 10, 2023

TWiStErRob Aug 10, 2023

TWiStErRob Aug 10, 2023

TWiStErRob Aug 10, 2023

BraisGabin commented Aug 11, 2023 •

edited

TWiStErRob commented Aug 11, 2023

atulgpt commented Aug 16, 2023

BraisGabin commented Nov 9, 2023

TWiStErRob commented Nov 9, 2023

schalkms commented Nov 10, 2023

atulgpt commented Nov 11, 2023

	private fun PsiElement.shouldReport(trailingWhitespacesCount: Int): Boolean {
	private fun PsiElement.isValid(trailingWhitespacesCount: Int): Boolean {

Fixes false positive of trailing whitespaces in kdoc #6370

Fixes false positive of trailing whitespaces in kdoc #6370

Conversation

atulgpt commented Aug 5, 2023

codecov bot commented Aug 5, 2023 • edited

Codecov Report

BraisGabin commented Aug 6, 2023

atulgpt commented Aug 6, 2023

BraisGabin commented Aug 10, 2023

TWiStErRob left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BraisGabin commented Aug 11, 2023 • edited

TWiStErRob commented Aug 11, 2023

atulgpt commented Aug 16, 2023

BraisGabin commented Nov 9, 2023

TWiStErRob commented Nov 9, 2023

schalkms commented Nov 10, 2023

atulgpt commented Nov 11, 2023

codecov bot commented Aug 5, 2023 •

edited

BraisGabin commented Aug 11, 2023 •

edited