IgnoreReturnValue: config options

[cortinico]

Follow-up to #2698: adding two config to the IgnoreReturnValue rule:

• restrictToAnnotatedMethods: true to toggle the analysis only on annotated methods
• returnValueAnnotations: ["*.CheckReturnValue", "*.CheckResult"] to provide a list of annotations to use during the inspection.

[codecov]

Codecov Report

Merging #2712 into master will increase coverage by 0.03%.
The diff coverage is 85.71%.

@@             Coverage Diff              @@
##             master    #2712      +/-   ##
============================================
+ Coverage     80.49%   80.52%   +0.03%     
- Complexity     2318     2322       +4     
============================================
  Files           378      378              
  Lines          6927     6944      +17     
  Branches       1257     1258       +1     
============================================
+ Hits           5576     5592      +16     
+ Misses          727      725       -2     
- Partials        624      627       +3     

Impacted Files	Coverage Δ	Complexity Δ
...turbosch/detekt/formatting/wrappers/Indentation.kt	100.00% <ø> (ø)	4.00 <0.00> (ø)
...ab/arturbosch/detekt/formatting/KtLintMultiRule.kt	91.66% <82.35%> (+3.91%)	7.00 <2.00> (+1.00)
...arturbosch/detekt/rules/bugs/IgnoredReturnValue.kt	84.09% <90.90%> (-2.76%)	12.00 <1.00> (+3.00)	⬇️

---

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 eb6291b...1719067. Read the comment docs.

[cortinico]

Do we know what's happening with the build here? It seems to fail on the compilation of the test snippet. I'm not able to reproduce locally.

Moreover I see a failure in

ForbiddenPublicDataClassSpec > public data class inside an ignored package should pass config as string FAILED

That seems unrelated.

[BraisGabin]

Do we know what's happening with the build here? It seems to fail on the compilation of the test snippet. I'm not able to reproduce locally.

You should be able to reproduce it with ./gradlew :detekt-rules:test -Pcompile-test-snippets=true. By default we don't compile the code snippets in local because it slow down the tests.

Moreover I see a failure in

ForbiddenPublicDataClassSpec > public data class inside an ignored package should pass config as string FAILED

That seems unrelated.

🤔 Maybe that test is flaky... strange.

[schalkms]

I've already experienced this problem. It could occur because of conflicting package declarations or classes with the same name.