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.

Sign up for GitHub

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

Jump to bottom

Add `comments` with a list of regexes to `ForbiddenComment` #5981

Merged

cortinico merged 30 commits into detekt:main from atulgpt:fixes-3508

May 21, 2023

Contributor

atulgpt commented Apr 10, 2023

Fixes #3508


          Add valuePatterns list of regexes

github-actions bot added the rules label

vercel bot deployed to Preview

April 10, 2023 22:10

View deployment

codecov bot commented Apr 10, 2023 •

edited

Codecov Report

Merging #5981 (6166297) into main (b925968) will increase coverage by 0.28%.
The diff coverage is 100.00%.

@@             Coverage Diff              @@
##               main    #5981      +/-   ##
============================================
+ Coverage     84.66%   84.94%   +0.28%     
- Complexity     3836     4026     +190     
============================================
  Files           549      569      +20     
  Lines         13065    13498     +433     
  Branches       2305     2381      +76     
============================================
+ Hits          11061    11466     +405     
- Misses          868      869       +1     
- Partials       1136     1163      +27

Impacted Files	Coverage Δ
.../arturbosch/detekt/rules/style/ForbiddenComment.kt	`98.63% <100.00%> (-1.37%)`	⬇️

... and 61 files with indirect coverage changes

cortinico changed the title ~~Add valuePatterns list of regexes~~ Add valuePatterns with a list of regexes to ForbiddenComment

cortinico added this to the 1.23.0 milestone

Member

cortinico commented Apr 11, 2023

CI is crashing on rule code here:

 Caused by: java.lang.StringIndexOutOfBoundsException: String index out of range: -2
	at java.lang.String.substring(String.java:1931)
	at io.gitlab.arturbosch.detekt.rules.style.ForbiddenComment.checkForbiddenComment(ForbiddenComment.kt:87)
	at io.gitlab.arturbosch.detekt.rules.style.ForbiddenComment.visitKtFile(ForbiddenComment.kt:65)

TWiStErRob reviewed

View reviewed changes

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenComment.kt Outdated Show resolved Hide resolved

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenComment.kt Outdated Show resolved Hide resolved

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenComment.kt Outdated Show resolved Hide resolved

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenComment.kt Outdated Show resolved Hide resolved


          Apply suggestions from code review

5eba48b

Co-authored-by: Róbert Papp <papp.robert.s@gmail.com>

vercel bot deployed to Preview

April 11, 2023 19:52

View deployment


          Deprecate values option

6ef834c

atulgpt force-pushed the fixes-3508 branch from b1bb990 to 6ef834c Compare

April 11, 2023 20:12

vercel bot deployed to Preview

April 11, 2023 20:18

View deployment


          Check against complete text

06350d1

vercel bot deployed to Preview

April 13, 2023 21:51

View deployment

atulgpt requested a review from TWiStErRob

April 14, 2023 17:11

BraisGabin reviewed

View reviewed changes

Member

BraisGabin left a comment

Looks good. Just a comment about the naming. What do you think?

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenComment.kt Outdated Show resolved Hide resolved

TWiStErRob approved these changes

View reviewed changes

Member

TWiStErRob left a comment

Sorry for the wait. Looks good on my side, I don't think there are blockers, just a few thoughts.

...-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenCommentSpec.kt Outdated Show resolved Hide resolved

...-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenCommentSpec.kt Show resolved Hide resolved

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenComment.kt Outdated Show resolved Hide resolved

...-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenCommentSpec.kt Show resolved Hide resolved


          Apply suggestions from code review

d9dc02f

Co-authored-by: Róbert Papp <papp.robert.s@gmail.com>

vercel bot deployed to Preview

May 6, 2023 18:27

View deployment


          Update the valuePatterns config name to comments

6e22238

Add tc when comment is present in between

vercel bot deployed to Preview

May 6, 2023 18:49

View deployment

TWiStErRob reviewed

View reviewed changes

...-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenCommentSpec.kt Show resolved Hide resolved

TWiStErRob reviewed

View reviewed changes

...-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenCommentSpec.kt Show resolved Hide resolved

...-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenCommentSpec.kt Outdated Show resolved Hide resolved


          Use static import of io.gitlab.arturbosch.detekt.test.assertThat

e2a3af0

atulgpt requested a review from BraisGabin

May 6, 2023 22:02

vercel bot deployed to Preview

May 6, 2023 22:07

View deployment

BraisGabin approved these changes

View reviewed changes

BraisGabin changed the title ~~Add valuePatterns with a list of regexes to ForbiddenComment~~ Add comments with a list of regexes to ForbiddenComment

marschwar reviewed

View reviewed changes

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenComment.kt Show resolved Hide resolved

vercel bot deployed to Preview

May 19, 2023 17:42

View deployment

atulgpt added 2 commits

May 19, 2023 23:29


          Refactor report to common reportCodeSmell method

b6f35e9


          Update TC to reflect the updated message

a5be5a4

Contributor Author

atulgpt commented May 19, 2023

Pushed ~~6 7~~ 8 commits, mainly the docs, and some more test cases and minor fixes. Also noticed a few more things while writing the docs, please have a look.

Thanks a lot for contributing in this

atulgpt commented

View reviewed changes

...-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenCommentSpec.kt Show resolved Hide resolved


          Update the detekt.yml ForbiddenComment reason config to match the…

1565fb6

… default values

vercel bot deployed to Preview

May 19, 2023 18:11

View deployment

atulgpt commented

View reviewed changes

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenComment.kt Outdated Show resolved Hide resolved

atulgpt commented

View reviewed changes

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenComment.kt Show resolved Hide resolved

vercel bot deployed to Preview

May 19, 2023 18:18

View deployment

TWiStErRob mentioned this pull request

CI reported detekt-formatting issue that wasn't found locally #6111

Closed

TWiStErRob added 2 commits

May 19, 2023 21:20


          Improve marker removal docs

f4c59c1


          Clarify why it matters.

948cb73

vercel bot deployed to Preview

May 19, 2023 20:26

View deployment

atulgpt mentioned this pull request

New rule: Reports the usages of <expr1>?.let { <expr2> } ?: run { <single_line_expr> } #6112

Open


          Update the warning message to only use reason if available

0a1763f

vercel bot deployed to Preview

May 19, 2023 22:11

View deployment

TWiStErRob reviewed

View reviewed changes

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenComment.kt Outdated Show resolved Hide resolved

TWiStErRob approved these changes

View reviewed changes

Member

TWiStErRob left a comment

Let's aim to resolve the rest of the threads and GO!

atulgpt added 2 commits

May 20, 2023 03:58


          Remove not necessary ZWSP

b03bd56


          Update message to remove  in detekt

fe491f6

Contributor Author

atulgpt commented May 19, 2023

Let's aim to resolve the rest of the threads and GO!

Yesss... It got stretched way too much but yes it was a nice experience to learn about new things. Thanks for your support

vercel bot deployed to Preview

May 19, 2023 22:36

View deployment

cortinico reviewed

View reviewed changes

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenComment.kt Outdated Show resolved Hide resolved

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenComment.kt Outdated Show resolved Hide resolved

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenComment.kt Show resolved Hide resolved

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenComment.kt Show resolved Hide resolved


          Minor clarifications and formatting.

vercel bot deployed to Preview

May 20, 2023 17:20

View deployment

TWiStErRob approved these changes

View reviewed changes

Member

TWiStErRob left a comment

Everything is resolved, @cortinico merge as you wish for 1.23

TWiStErRob mentioned this pull request

False negative ForbiddenComment with common TODO markers #6116

Closed

cortinico merged commit e65ef3b into detekt:main

23 checks passed

atulgpt deleted the fixes-3508 branch

May 22, 2023 08:07

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment