Add StringShouldBeRawString.kt rule #5705

atulgpt · 2023-01-17T20:51:18Z

github-actions · 2023-01-17T20:52:03Z

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

Generated by 🚫 dangerJS against 2af4f64

...style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/StringShouldBeRawStringSpec.kt

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

codecov · 2023-01-17T21:05:16Z

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 · 2023-01-17T22:53:09Z

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

...style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/StringShouldBeRawStringSpec.kt

BraisGabin · 2023-01-18T00:09:40Z

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 · 2023-01-18T00:20:46Z

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 :)

Rename fun to getStringSequenceExcludingRawString

BraisGabin

It looks good :)

...style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/StringShouldBeRawStringSpec.kt

BraisGabin · 2023-01-18T11:41:33Z

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

+        if (maxEscapedCharacterCount == Int.MAX_VALUE) {
+            return
+        }


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.

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?

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 🤷.

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

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

Remove corresponding Int tests Make extension parameter non null

atulgpt · 2023-02-03T07:46:09Z

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

BraisGabin · 2023-02-21T15:27:07Z

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

github-actions bot added the rules label Jan 17, 2023

github-advanced-security bot found potential problems Jan 17, 2023

View reviewed changes

...les-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/StringShouldBeRawString.kt Fixed Show fixed Hide fixed

vercel bot deployed to Preview January 17, 2023 20:56 View deployment

atulgpt force-pushed the fixes-5697 branch 2 times, most recently from 3f0c9fa to dbc255b Compare January 17, 2023 21:04

vercel bot deployed to Preview January 17, 2023 21:12 View deployment

atulgpt force-pushed the fixes-5697 branch from dbc255b to 2ba3233 Compare January 17, 2023 23:42

github-advanced-security bot found potential problems Jan 17, 2023

View reviewed changes

...style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/StringShouldBeRawStringSpec.kt Fixed Show fixed Hide fixed

vercel bot deployed to Preview January 17, 2023 23:47 View deployment

Add StringShouldBeRawString.kt rule

6a7b3fd

atulgpt force-pushed the fixes-5697 branch from 2ba3233 to 6a7b3fd Compare January 18, 2023 07:39

vercel bot deployed to Preview January 18, 2023 07:45 View deployment

Correct grammar in the rule doc

247844f

Rename fun to getStringSequenceExcludingRawString

vercel bot deployed to Preview January 18, 2023 10:43 View deployment

BraisGabin reviewed Jan 18, 2023

View reviewed changes

BraisGabin added this to the 1.23.0 milestone Jan 18, 2023

Remove check for Int.MAX and Int.MIN

2af4f64

Remove corresponding Int tests Make extension parameter non null

vercel bot deployed to Preview January 18, 2023 13:51 View deployment

BraisGabin approved these changes Feb 21, 2023

View reviewed changes

BraisGabin merged commit 576a3f7 into detekt:main Feb 21, 2023

BraisGabin mentioned this pull request Feb 21, 2023

Fix main - Don't use Stream #5802

Merged

cortinico added the notable changes Marker for notable changes in the changelog label Feb 26, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add StringShouldBeRawString.kt rule #5705

Add StringShouldBeRawString.kt rule #5705

atulgpt commented Jan 17, 2023

github-actions bot commented Jan 17, 2023 •

edited

Loading

codecov bot commented Jan 17, 2023 •

edited

Loading

3flex commented Jan 17, 2023

BraisGabin commented Jan 18, 2023

3flex commented Jan 18, 2023

BraisGabin left a comment

BraisGabin Jan 18, 2023

atulgpt Jan 18, 2023

BraisGabin Jan 18, 2023

BraisGabin Jan 18, 2023

atulgpt commented Feb 3, 2023

BraisGabin commented Feb 21, 2023

Add StringShouldBeRawString.kt rule #5705

Add StringShouldBeRawString.kt rule #5705

Conversation

atulgpt commented Jan 17, 2023

github-actions bot commented Jan 17, 2023 • edited Loading

codecov bot commented Jan 17, 2023 • edited Loading

Codecov Report

3flex commented Jan 17, 2023

BraisGabin commented Jan 18, 2023

3flex commented Jan 18, 2023

BraisGabin left a comment

Choose a reason for hiding this comment

BraisGabin Jan 18, 2023

Choose a reason for hiding this comment

atulgpt Jan 18, 2023

Choose a reason for hiding this comment

BraisGabin Jan 18, 2023

Choose a reason for hiding this comment

BraisGabin Jan 18, 2023

Choose a reason for hiding this comment

atulgpt commented Feb 3, 2023

BraisGabin commented Feb 21, 2023

github-actions bot commented Jan 17, 2023 •

edited

Loading

codecov bot commented Jan 17, 2023 •

edited

Loading