Rename FL0093

Better to not mention "sprintf" in the rule name, in case we
change this rule in the future to recommend inline strings
(e.g. `$"foo{bar}"`).

Author: knocte

docs/content/how-tos/rule-configuration.md

@@ -133,4 +133,4 @@ The following rules can be specified for linting.
 - [NoAsyncRunSynchronouslyInLibrary (FL0090)](rules/FL0090.html)
 - [FavourNestedFunctions (FL0091)](rules/FL0091.html)
 - [DisallowShadowing (FL0092)](rules/FL0092.html)
-- [PreferStringInterpolationWithSprintf (FL0093)](rules/FL0093.html)
+- [DiscourageStringInterpolationWithStringFormat (FL0093)](rules/FL0093.html)

docs/content/how-tos/rules/FL0093.md

@@ -4,7 +4,7 @@ category: how-to
 hide_menu: true
 ---
 
-# PreferStringInterpolationWithSprintf (FL0091)
+# DiscourageStringInterpolationWithStringFormat (FL0091)
 
 *Introduced in `0.26.12`*
 
@@ -23,7 +23,7 @@ Use sprintf instead of String.Format.
 ## Rule Settings
 
     {
-        "preferStringInterpolationWithSprintf": {
+        "discourageStringInterpolationWithStringFormat": {
             "enabled": false
         }
     }

src/FSharpLint.Core/Application/Configuration.fs

@@ -387,7 +387,7 @@ type ConventionsConfig =
       ensureTailCallDiagnosticsInRecursiveFunctions:EnabledConfig option
       favourNestedFunctions:EnabledConfig option
       disallowShadowing:EnabledConfig option
-      preferStringInterpolationWithSprintf:EnabledConfig option}
+      discourageStringInterpolationWithStringFormat:EnabledConfig option}
 with
     member this.Flatten() =
         Array.concat
@@ -417,7 +417,7 @@ with
                 this.indexerAccessorStyleConsistency |> Option.bind (constructRuleWithConfig IndexerAccessorStyleConsistency.rule) |> Option.toArray
                 this.favourNestedFunctions |> Option.bind (constructRuleIfEnabled FavourNestedFunctions.rule) |> Option.toArray
                 this.disallowShadowing |> Option.bind (constructRuleIfEnabled DisallowShadowing.rule) |> Option.toArray
-                this.preferStringInterpolationWithSprintf |> Option.bind (constructRuleIfEnabled PreferStringInterpolationWithSprintf.rule) |> Option.toArray
+                this.discourageStringInterpolationWithStringFormat |> Option.bind (constructRuleIfEnabled DiscourageStringInterpolationWithStringFormat.rule) |> Option.toArray
             |]
 
 [<Obsolete(ObsoleteMsg, ObsoleteWarnTreatAsError)>]
@@ -561,7 +561,7 @@ type Configuration =
       NoAsyncRunSynchronouslyInLibrary:EnabledConfig option
       FavourNestedFunctions:EnabledConfig option
       DisallowShadowing:EnabledConfig option
-      PreferStringInterpolationWithSprintf:EnabledConfig option }
+      DiscourageStringInterpolationWithStringFormat:EnabledConfig option }
 with
     static member Zero = {
         Global = None
@@ -590,7 +590,7 @@ with
         RecursiveAsyncFunction = None
         AvoidTooShortNames = None
         IndexerAccessorStyleConsistency = None
-        PreferStringInterpolationWithSprintf = None
+        DiscourageStringInterpolationWithStringFormat = None
         RedundantNewKeyword = None
         FavourNonMutablePropertyInitialization = None
         FavourReRaise = None

src/FSharpLint.Core/FSharpLint.Core.fsproj

@@ -62,7 +62,7 @@
     <Compile Include="Rules\Conventions\FavourSingleton.fs" />
     <Compile Include="Rules\Conventions\FavourNestedFunctions.fs" />
     <Compile Include="Rules\Conventions\DisallowShadowing.fs" />
-    <Compile Include="Rules\Conventions\PreferStringInterpolationWithSprintf.fs" />
+    <Compile Include="Rules\Conventions\DiscourageStringInterpolationWithStringFormat.fs" />
     <Compile Include="Rules\Conventions\SourceLength\SourceLengthHelper.fs" />
     <Compile Include="Rules\Conventions\SourceLength\MaxLinesInLambdaFunction.fs" />
     <Compile Include="Rules\Conventions\SourceLength\MaxLinesInMatchLambdaFunction.fs" />

…/PreferStringInterpolationWithSprintf.fs …geStringInterpolationWithStringFormat.fssrc/FSharpLint.Core/Rules/Conventions/PreferStringInterpolationWithSprintf.fs renamed to src/FSharpLint.Core/Rules/Conventions/DiscourageStringInterpolationWithStringFormat.fs src/FSharpLint.Core/Rules/Conventions/PreferStringInterpolationWithSprintf.fs renamed to src/FSharpLint.Core/Rules/Conventions/DiscourageStringInterpolationWithStringFormat.fs

@@ -1,4 +1,4 @@
-module FSharpLint.Rules.PreferStringInterpolationWithSprintf
+module FSharpLint.Rules.DiscourageStringInterpolationWithStringFormat
 
 open System
 open FSharpLint.Framework
@@ -13,7 +13,7 @@ let runner args =
 
     let emitViolation range =
         { Range = range
-          Message = Resources.GetString "RulesPreferStringInterpolationWithSprintf"
+          Message = Resources.GetString "RulesDiscourageStringInterpolationWithStringFormat"
           SuggestedFix = None
           TypeChecks = List.empty }
         |> Array.singleton
@@ -51,7 +51,7 @@ let runner args =
     | _ -> Array.empty
 
 let rule =
-    { Name = "PreferStringInterpolationWithSprintf"
-      Identifier = Identifiers.PreferStringInterpolationWithSprintf
+    { Name = "DiscourageStringInterpolationWithStringFormat"
+      Identifier = Identifiers.DiscourageStringInterpolationWithStringFormat
       RuleConfig = { AstNodeRuleConfig.Runner = runner; Cleanup = ignore } }
     |> AstNodeRule

src/FSharpLint.Core/Rules/Identifiers.fs

@@ -97,4 +97,4 @@ let FavourSingleton = identifier 89
 let NoAsyncRunSynchronouslyInLibrary = identifier 90
 let FavourNestedFunctions = identifier 91
 let DisallowShadowing = identifier 92
-let PreferStringInterpolationWithSprintf = identifier 93
+let DiscourageStringInterpolationWithStringFormat = identifier 93

src/FSharpLint.Core/Text.resx

@@ -402,7 +402,7 @@
   <data name="RulesDisallowShadowing" xml:space="preserve">
     <value>Rename variable or parameter so that it doesn't shadow another one with the same name.</value>
   </data>
-  <data name="RulesPreferStringInterpolationWithSprintf" xml:space="preserve">
+  <data name="RulesDiscourageStringInterpolationWithStringFormat" xml:space="preserve">
     <value>Use sprintf instead of String.Format.</value>
   </data>
 </root>

src/FSharpLint.Core/fsharplint.json

@@ -302,7 +302,7 @@
     "indentation": {
         "enabled": false
     },
-    "preferStringInterpolationWithSprintf": {
+    "discourageStringInterpolationWithStringFormat": {
         "enabled": false
     },
     "maxCharactersOnLine": {

tests/FSharpLint.Core.Tests/FSharpLint.Core.Tests.fsproj

@@ -41,7 +41,7 @@
     <Compile Include="Rules\Conventions\SourceLength.fs" />
     <Compile Include="Rules\Conventions\NoPartialFunctions.fs" />
     <Compile Include="Rules\Conventions\FavourReRaise.fs" />
-    <Compile Include="Rules\Conventions\PreferStringInterpolationWithSprintf.fs" />
+    <Compile Include="Rules\Conventions\DiscourageStringInterpolationWithStringFormat.fs" />
     <Compile Include="Rules\Conventions\FavourConsistentThis.fs" />
     <Compile Include="Rules\Conventions\AvoidTooShortNames.fs" />
     <Compile Include="Rules\Conventions\AvoidSinglePipeOperator.fs" />

…/PreferStringInterpolationWithSprintf.fs …geStringInterpolationWithStringFormat.fstests/FSharpLint.Core.Tests/Rules/Conventions/PreferStringInterpolationWithSprintf.fs renamed to tests/FSharpLint.Core.Tests/Rules/Conventions/DiscourageStringInterpolationWithStringFormat.fs tests/FSharpLint.Core.Tests/Rules/Conventions/PreferStringInterpolationWithSprintf.fs renamed to tests/FSharpLint.Core.Tests/Rules/Conventions/DiscourageStringInterpolationWithStringFormat.fs

@@ -1,12 +1,12 @@
-module FSharpLint.Core.Tests.Rules.Conventions.PreferStringInterpolationWithSprintf
+module FSharpLint.Core.Tests.Rules.Conventions.DiscourageStringInterpolationWithStringFormat
 
 open NUnit.Framework
 open FSharpLint.Rules
 open FSharpLint.Core.Tests
 
 [<TestFixture>]
-type TestConventionsPreferStringInterpolationWithSprintf() =
-    inherit TestAstNodeRuleBase.TestAstNodeRuleBase(PreferStringInterpolationWithSprintf.rule)
+type TestConventionsDiscourageStringInterpolationWithStringFormat() =
+    inherit TestAstNodeRuleBase.TestAstNodeRuleBase(DiscourageStringInterpolationWithStringFormat.rule)
 
     [<Test>]
     member this.StringInterpolationWithSprintfShouldNotProduceError() =