Add StringShouldBeRawString.kt rule

[atulgpt]

Fixes #5697

[github-actions]

	Messages
📖	Thanks for adding a new rule to Detekt ❤️

Generated by 🚫 dangerJS against 2af4f64

[codecov]

Codecov Report

Merging #5705 (2af4f64) into main (0f689b3) will increase coverage by 84.46%.
The diff coverage is 84.48%.

@@             Coverage Diff             @@
##             main    #5705       +/-   ##
===========================================
+ Coverage        0   84.46%   +84.46%     
- Complexity      0     3753     +3753     
===========================================
  Files           0      544      +544     
  Lines           0    12763    +12763     
  Branches        0     2236     +2236     
===========================================
+ Hits            0    10780    +10780     
- Misses          0      865      +865     
- Partials        0     1118     +1118     

Impacted Files	Coverage Δ
...osch/detekt/rules/style/StringShouldBeRawString.kt	84.21% <84.21%> (ø)
...rturbosch/detekt/rules/style/StyleGuideProvider.kt	100.00% <100.00%> (ø)
...n/io/gitlab/arturbosch/detekt/api/ConsoleReport.kt	100.00% <0.00%> (ø)
...n/io/github/detekt/report/sarif/RuleDescriptors.kt	30.43% <0.00%> (ø)
...io/github/detekt/tooling/internal/PluginsHolder.kt	100.00% <0.00%> (ø)
...tlab/arturbosch/detekt/core/reporting/Colorizer.kt	78.57% <0.00%> (ø)
...bosch/detekt/api/internal/CommaSeparatedPattern.kt	100.00% <0.00%> (ø)
...arturbosch/detekt/generator/printer/RulePrinter.kt	96.66% <0.00%> (ø)
...rturbosch/detekt/core/settings/PropertiesFacade.kt	100.00% <0.00%> (ø)
...ub/detekt/psi/internal/FullQualifiedNameGuesser.kt	87.50% <0.00%> (ø)
... and 535 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[3flex]

Couple of notes:

• rule name should reference "multiline" in the name, not just "raw string"
• I think there should be an option to ignore single lines with \n. Sometimes it's simpler to have a string like "line 1\nline 2", than to convert to a multiline string (and remember we have other rules that relate to formatting multiline strings and enforcing use of trimIndent and trimMargin). All of a sudden there's a bunch of extra things to get "right". Or there could be an option for single lines for max number of new line escape characters which triggers the violation

[BraisGabin]

rule name should reference "multiline" in the name, not just "raw string"

The second example on the issue doesn't talk about multi-line. A regex is a good example of a single line raw string that is better than a normal string.

[3flex]

Good point. I only looked at this very quickly, but the issue being fixed is "Rule for encouraging MultilineRawString". The proposed rule is a bit different.

Agree that this proposal makes sense as is, so ignore my comment :)

[BraisGabin]

It looks good :)

[BraisGabin]

If the user doesn't want this rule s/he should disable it. We don't need to have two different ways to disable it.

[atulgpt]

Sure. But currently if we set Int.MAX_VALUE in the detekt.yml the working of rule breaks. BTW @BraisGabin is there any sanitisation on user input through detekt.yml?

[BraisGabin]

Int.MAX_VALUE doesn't seems like a sane value. We shouldn't care about that. If they would like the max value of a long it wouldn't work either 🤷.

[BraisGabin]

And there is little sanitation on that regard as far as I know.

[atulgpt]

Hi @BraisGabin is this PR good for merge? Or some changes are required? cc @cortinico @TWiStErRob for their inputs as well

[BraisGabin]

This is good to go! Sorry for the delay :)