VarCouldBeVal: Add configuration flag ignoreLateinitVar

[rli]

I'm not entirely convinced that it makes sense to disable this across the entire codebase, but maybe someone else has a use-case.

Fixes #4731

[BraisGabin]

I'm not entirely convinced that it makes sense to disable this across the entire codebase, but maybe someone else has a use-case.

I agree but how could we fix this otherwise? I mean, do you see any better way to fix this for your use case? In general I don't want to add a feature just because "maybe someone else has a use-case".

In your case, does it seem right to add an @Suppress to those files? Or to exclude the path of those files? Or to exclude them by package?

Sorry maybe I over-simplify your use case and I propouse a solution that doesn't fit your use case.

[codecov]

Codecov Report

Merging #4745 (7f6d958) into main (7960453) will decrease coverage by 0.00%.
The diff coverage is 85.71%.

@@             Coverage Diff              @@
##               main    #4745      +/-   ##
============================================
- Coverage     84.69%   84.69%   -0.01%     
- Complexity     3418     3419       +1     
============================================
  Files           490      490              
  Lines         11235    11240       +5     
  Branches       2068     2068              
============================================
+ Hits           9516     9520       +4     
  Misses          675      675              
- Partials       1044     1045       +1     

Impacted Files	Coverage Δ
...lab/arturbosch/detekt/rules/style/VarCouldBeVal.kt	80.39% <85.71%> (-0.03%)	⬇️

---

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 7960453...7f6d958. Read the comment docs.

[vladimirfx]

I have a myriad of use cases. 90% of all our lateinit usages are flagged. Our config now is polluted with ignoreAnnotated :

  VarCouldBeVal:
    active: true
    ignoreAnnotated:
      - 'javax.persistence.Version'
      - 'javax.ws.rs.core.Context'
      - 'javax.inject.Inject'
      - 'org.springframework.beans.factory.annotation.Autowired'

But all these excludes are NOT enough because there are cases where no annotations at field level (see @QuarkusTestResource which is set at class level).

Very waiting for merge.