Core(Framework,Rules): SuggestedFix refactoring

webwarrior-ws · webwarrior-ws · commit a5837921e461 · 2025-07-28T13:18:34.000+02:00
Removed FromText property of SuggestedFix as it duplicates
FromRange functionality and is not actually used anywhere.
diff --git a/src/FSharpLint.Core/Framework/Suggestion.fs b/src/FSharpLint.Core/Framework/Suggestion.fs
@@ -6,9 +6,6 @@ open FSharp.Compiler.Text
 /// Information for consuming applications to provide an automated fix for a lint suggestion.
 [<NoEquality; NoComparison>]
 type SuggestedFix = {
-    /// Text to be replaced.
-    FromText:string
-
     /// Location of the text to be replaced.
     FromRange:Range
 
diff --git a/src/FSharpLint.Core/Rules/Conventions/AvoidSinglePipeOperator.fs b/src/FSharpLint.Core/Rules/Conventions/AvoidSinglePipeOperator.fs
@@ -48,7 +48,7 @@ let runner (args: AstNodeRuleParams) =
                                 match maybeFuncText, maybeArgText with
                                 | Some(funcText), Some(argText) ->
                                     let replacementText = sprintf "%s %s" funcText argText
-                                    Some { FromText=args.FileContent; FromRange=range; ToText=replacementText }
+                                    Some { FromRange=range; ToText=replacementText }
                                 | _ -> None)
                             errors ident.idRange (Some suggestedFix)
                 else
diff --git a/src/FSharpLint.Core/Rules/Conventions/Binding/FavourAsKeyword.fs b/src/FSharpLint.Core/Rules/Conventions/Binding/FavourAsKeyword.fs
@@ -30,7 +30,7 @@ let private checkForNamedPatternEqualsConstant (args:AstNodeRuleParams) pattern
                     ExpressionUtilities.tryFindTextOfRange constRange args.FileContent
                     |> Option.bind (fun constText ->
 
-                        lazy (Some { FromText = text; FromRange = fromRange; ToText = $"{constText} as {ident.idText}"})
+                        lazy (Some { FromRange = fromRange; ToText = $"{constText} as {ident.idText}"})
                         |> Some
                     )
 
diff --git a/src/FSharpLint.Core/Rules/Conventions/Binding/FavourIgnoreOverLetWild.fs b/src/FSharpLint.Core/Rules/Conventions/Binding/FavourIgnoreOverLetWild.fs
@@ -19,7 +19,6 @@ let private checkForBindingToAWildcard pattern range fileContent (expr: SynExpr)
             { Range = range
               Message = Resources.GetString("RulesFavourIgnoreOverLetWildError")
               SuggestedFix = Some (lazy (Some({ FromRange = letBindingRange
-                                                FromText = fileContent
                                                 ToText = sprintf "(%s) |> ignore" exprText })))
               TypeChecks = [] } |> Array.singleton
         else
diff --git a/src/FSharpLint.Core/Rules/Conventions/Binding/FavourTypedIgnore.fs b/src/FSharpLint.Core/Rules/Conventions/Binding/FavourTypedIgnore.fs
@@ -15,8 +15,7 @@ let private runner (args: AstNodeRuleParams) =
                 (ExpressionUtilities.tryFindTextOfRange range text
                  |> Option.map
                      (fun fromText ->
-                         { FromText = fromText
-                           FromRange = range
+                         { FromRange = range
                            ToText = identifier }))
 
         { Range = range
diff --git a/src/FSharpLint.Core/Rules/Conventions/Binding/TupleOfWildcards.fs b/src/FSharpLint.Core/Rules/Conventions/Binding/TupleOfWildcards.fs
@@ -28,7 +28,7 @@ let private checkTupleOfWildcards fileContents pattern identifier identifierRang
         let refactorTo = constructorString 1
         let error = String.Format(errorFormat, refactorFrom, refactorTo)
         let suggestedFix = lazy(
-            Some { SuggestedFix.FromRange = identifierRange; FromText = fileContents; ToText = refactorTo })
+            Some { SuggestedFix.FromRange = identifierRange; ToText = refactorTo })
         { Range = range; Message = error; SuggestedFix = Some suggestedFix; TypeChecks = [] } |> Array.singleton
     | _ -> Array.empty
 
diff --git a/src/FSharpLint.Core/Rules/Conventions/Binding/UselessBinding.fs b/src/FSharpLint.Core/Rules/Conventions/Binding/UselessBinding.fs
@@ -51,9 +51,9 @@ let private runner (args:AstNodeRuleParams) =
     let maybeSuggestedFix = 
         match args.GetParents(args.NodeIndex) with
         | AstNode.ModuleDeclaration(SynModuleDecl.Let(_, _, range)) :: _ ->
-            Some({ FromRange = range; FromText = "let"; ToText = "" })
+            Some({ FromRange = range; ToText = "" })
         | AstNode.Expression(SynExpr.LetOrUse(_, false, _, _, range, _)) :: _ -> 
-            Some({ FromRange = range; FromText = "use"; ToText = "" })
+            Some({ FromRange = range; ToText = "" })
         | _ -> None
     match args.AstNode with
     | AstNode.Binding(SynBinding(_, _, _, isMutable, _, _, _, pattern, _, expr, range, _, _))
diff --git a/src/FSharpLint.Core/Rules/Conventions/Binding/WildcardNamedWithAsPattern.fs b/src/FSharpLint.Core/Rules/Conventions/Binding/WildcardNamedWithAsPattern.fs
@@ -13,7 +13,7 @@ let private checkForWildcardNamedWithAsPattern fileContents pattern =
         when wildcardRange <> range ->
         let suggestedFix = 
             lazy(
-                Some { FromRange = range; FromText = fileContents; ToText = identifier.idText })
+                Some { FromRange = range; ToText = identifier.idText })
         { Range = range
           Message = Resources.GetString("RulesWildcardNamedWithAsPattern")
           SuggestedFix = Some suggestedFix
diff --git a/src/FSharpLint.Core/Rules/Conventions/FavourConsistentThis.fs b/src/FSharpLint.Core/Rules/Conventions/FavourConsistentThis.fs
@@ -24,7 +24,7 @@ let runner (config: Config) args =
             if identifiers.Length = 2 then
                 match identifiers  with
                 | head::_ when isNotConsistent head.idText symbol ->
-                    let suggestedFix = lazy(Some({ FromRange = head.idRange; FromText = head.idText; ToText = symbol }))
+                    let suggestedFix = lazy(Some({ FromRange = head.idRange; ToText = symbol }))
                     let error =
                         { Range = range
                           Message = String.Format(Resources.GetString "RulesFavourConsistentThis", config.Symbol)
diff --git a/src/FSharpLint.Core/Rules/Conventions/FavourReRaise.fs b/src/FSharpLint.Core/Rules/Conventions/FavourReRaise.fs
@@ -18,7 +18,7 @@ let private runner (args: AstNodeRuleParams) =
     let rec checkExpr (expr) maybeIdent =
         match expr with
         | SynExpr.App (_, _, SynExpr.Ident raiseId, expression, range) when raiseId.idText = "raise" ->
-            let suggestedFix = lazy(Some({ FromRange = range; FromText = raiseId.idText; ToText = "reraise()" }))
+            let suggestedFix = lazy(Some({ FromRange = range; ToText = "reraise()" }))
             match expression with
             | SynExpr.Ident ident ->
                 match maybeIdent with
diff --git a/src/FSharpLint.Core/Rules/Conventions/FavourStaticEmptyFields.fs b/src/FSharpLint.Core/Rules/Conventions/FavourStaticEmptyFields.fs
@@ -31,7 +31,7 @@ let private generateError (fileContents: string) (range:FSharp.Compiler.Text.Ran
             | EmptyStringLiteral -> "String.Empty"
             | EmptyListLiteral -> "List.Empty"
             | EmptyArrayLiteral -> "Array.empty"
-        Some({ FromRange = range; FromText = fileContents; ToText = replacementText }))
+        Some({ FromRange = range; ToText = replacementText }))
     { Range = range
       Message = getStaticEmptyErrorMessage range emptyLiteralType
       SuggestedFix = Some suggestedFix
diff --git a/src/FSharpLint.Core/Rules/Conventions/FunctionReimplementation/CanBeReplacedWithComposition.fs b/src/FSharpLint.Core/Rules/Conventions/FunctionReimplementation/CanBeReplacedWithComposition.fs
@@ -64,7 +64,7 @@ let private validateLambdaCannotBeReplacedWithComposition fileContents _ lambda
     | Some funcStrings ->
         let suggestedFix =
             lazy(
-                Some { FromRange = range; FromText = fileContents; ToText = String.Join(" >> ", funcStrings) })
+                Some { FromRange = range; ToText = String.Join(" >> ", funcStrings) })
         { Range = range
           Message = Resources.GetString("RulesCanBeReplacedWithComposition")
           SuggestedFix = Some suggestedFix
diff --git a/src/FSharpLint.Core/Rules/Conventions/FunctionReimplementation/ReimplementsFunction.fs b/src/FSharpLint.Core/Rules/Conventions/FunctionReimplementation/ReimplementsFunction.fs
@@ -33,7 +33,7 @@ let private validateLambdaIsNotPointless (text:string) lambda range =
 
         let suggestedFix = lazy(
             ExpressionUtilities.tryFindTextOfRange range text
-            |> Option.map (fun fromText -> { FromText = fromText; FromRange = range; ToText = identifier }))
+            |> Option.map (fun fromText -> { FromRange = range; ToText = identifier }))
 
         { Range = range
           Message = String.Format(Resources.GetString("RulesReimplementsFunction"), identifier)
diff --git a/src/FSharpLint.Core/Rules/Conventions/Naming/NamingHelper.fs b/src/FSharpLint.Core/Rules/Conventions/Naming/NamingHelper.fs
@@ -14,20 +14,20 @@ open FSharp.Compiler.Symbols
 module QuickFixes =
     let removeAllUnderscores (ident:Ident) = lazy(
         let toText = ident.idText.Replace("_", "")
-        Some { FromText = ident.idText; FromRange = ident.idRange; ToText = toText })
+        Some { FromRange = ident.idRange; ToText = toText })
 
     let removeNonPrefixingUnderscores (ident:Ident) = lazy(
         let prefixingUnderscores =
             ident.idText |> Seq.takeWhile (fun x -> x = '_') |> String.Concat
 
         let toText = prefixingUnderscores + ident.idText.Replace("_", "")
-        Some { FromText = ident.idText; FromRange = ident.idRange; ToText = toText })
+        Some { FromRange = ident.idRange; ToText = toText })
 
     let addPrefix prefix (ident:Ident) = lazy(
-        Some { FromText = ident.idText; FromRange = ident.idRange; ToText = prefix + ident.idText })
+        Some { FromRange = ident.idRange; ToText = prefix + ident.idText })
 
     let addSuffix suffix (ident:Ident) = lazy(
-        Some { FromText = ident.idText; FromRange = ident.idRange; ToText = ident.idText + suffix })
+        Some { FromRange = ident.idRange; ToText = ident.idText + suffix })
 
     let private mapFirstChar map (str:string) =
         let prefix =
@@ -41,11 +41,11 @@ module QuickFixes =
 
     let toPascalCase (ident:Ident) = lazy(
         let pascalCaseIdent = ident.idText |> mapFirstChar Char.ToUpper
-        Some { FromText = ident.idText; FromRange = ident.idRange; ToText = pascalCaseIdent })
+        Some { FromRange = ident.idRange; ToText = pascalCaseIdent })
 
     let toCamelCase (ident:Ident) = lazy(
         let camelCaseIdent = ident.idText |> mapFirstChar Char.ToLower
-        Some { FromText = ident.idText; FromRange = ident.idRange; ToText = camelCaseIdent })
+        Some { FromRange = ident.idRange; ToText = camelCaseIdent })
 
 [<Literal>]
 let private NumberOfExpectedBackticks = 4
diff --git a/src/FSharpLint.Core/Rules/Conventions/NoPartialFunctions.fs b/src/FSharpLint.Core/Rules/Conventions/NoPartialFunctions.fs
@@ -109,7 +109,7 @@ let private checkIfPartialIdentifier (config:Config) (identifier:string) (range:
                 {
                     Range = range
                     Message = String.Format(Resources.GetString "RulesConventionsNoPartialFunctionsReplacementError", replacementFunction, identifier)
-                    SuggestedFix = Some (lazy ( Some { FromText = identifier; FromRange = range; ToText = replacementFunction }))
+                    SuggestedFix = Some (lazy ( Some { FromRange = range; ToText = replacementFunction }))
                     TypeChecks = []
                 })
 
@@ -297,7 +297,7 @@ let private isNonStaticInstanceMemberCall (checkFile:FSharpCheckFileResults) nam
                              | Function replacementFunctionName ->
                                 Some { Range = range
                                        Message = String.Format(Resources.GetString "RulesConventionsNoPartialFunctionsReplacementError", replacementFunctionName, fullyQualifiedInstanceMember)
-                                       SuggestedFix = Some (lazy ( Some { FromText = (String.concat "." names) ; FromRange = range; ToText = replacementFunctionName }))
+                                       SuggestedFix = Some (lazy ( Some { FromRange = range; ToText = replacementFunctionName }))
                                        TypeChecks = (fun () -> typeMatches) |> List.singleton }
                         else
                             None
@@ -336,7 +336,7 @@ let private checkMemberCallOnExpression
                 | Function replacementFunctionName ->
                     Some { Range = originalRange
                            Message = String.Format(Resources.GetString "RulesConventionsNoPartialFunctionsReplacementError", replacementFunctionName, fullyQualifiedInstanceMember)
-                           SuggestedFix = Some (lazy ( Some { FromText = (ExpressionUtilities.tryFindTextOfRange originalRange flieContent).Value ; FromRange = originalRange; ToText = replacementFunctionName }))
+                           SuggestedFix = Some (lazy ( Some { FromRange = originalRange; ToText = replacementFunctionName }))
                            TypeChecks = (fun () -> true) |> List.singleton }
             else
                 None)
diff --git a/src/FSharpLint.Core/Rules/Conventions/RaiseWithTooManyArguments/FailwithBadUsage.fs b/src/FSharpLint.Core/Rules/Conventions/RaiseWithTooManyArguments/FailwithBadUsage.fs
@@ -37,8 +37,7 @@ let private runner (args: AstNodeRuleParams) =
                 Some(
                     lazy
                         (Some
-                            { FromText = $"%s{failwithKeyword} %s{failwithErrorMessage}"
-                              FromRange = range
+                            { FromRange = range
                               ToText = $"raise <| Exception(\"%s{failwithErrorMessage}\", %s{param})" })
                 )
             | _ -> None
diff --git a/src/FSharpLint.Core/Rules/Conventions/RecursiveAsyncFunction.fs b/src/FSharpLint.Core/Rules/Conventions/RecursiveAsyncFunction.fs
@@ -47,8 +47,7 @@ let checkRecursiveAsyncFunction (args:AstNodeRuleParams) (range:Range) (doBangEx
             let suggestedFix = lazy(
                 ExpressionUtilities.tryFindTextOfRange doTokenRange args.FileContent
                 |> Option.map (fun fromText ->
-                    { FromText = fromText
-                      FromRange = doTokenRange
+                    { FromRange = doTokenRange
                       ToText = "return!" }))
 
             { Range = range
diff --git a/src/FSharpLint.Core/Rules/Conventions/RedundantNewKeyword.fs b/src/FSharpLint.Core/Rules/Conventions/RedundantNewKeyword.fs
@@ -38,7 +38,7 @@ let private generateFix (text:string) range = lazy(
     |> Option.map (fun fromText ->
         let withoutLeadingWhitespace = fromText.TrimStart()
         let newKeywordRemoved = withoutLeadingWhitespace.Substring(3).TrimStart()
-        { FromText = fromText; FromRange = range; ToText = newKeywordRemoved }))
+        { FromRange = range; ToText = newKeywordRemoved }))
 
 
 let runner args =
diff --git a/src/FSharpLint.Core/Rules/Conventions/SuggestUseAutoProperty.fs b/src/FSharpLint.Core/Rules/Conventions/SuggestUseAutoProperty.fs
@@ -78,8 +78,7 @@ let private runner (args: AstNodeRuleParams) =
                     (match memberIdentifier.LongIdent with
                      | [ _; memberName ] ->
                          Some
-                             { FromText = args.FileContent
-                               FromRange = memberIdentifier.Range
+                             { FromRange = memberIdentifier.Range
                                ToText = $"val {memberName.idText}" }
                      | _ -> None)
 
diff --git a/src/FSharpLint.Core/Rules/Formatting/TupleFormatting/TupleCommaSpacing.fs b/src/FSharpLint.Core/Rules/Formatting/TupleFormatting/TupleCommaSpacing.fs
@@ -22,7 +22,6 @@ let checkTupleCommaSpacing (args:AstNodeRuleParams) (tupleExprs:SynExpr list) tu
                 |> Option.map (fun commaText ->
                     lazy(
                         { FromRange = commaRange
-                          FromText = commaText
                           ToText = ", " } |> Some
                         ) )
             { Range = commaRange
diff --git a/src/FSharpLint.Core/Rules/Formatting/TupleFormatting/TupleParentheses.fs b/src/FSharpLint.Core/Rules/Formatting/TupleFormatting/TupleParentheses.fs
@@ -16,7 +16,7 @@ let checkTupleHasParentheses (args:AstNodeRuleParams) _ range parentNode =
         ExpressionUtilities.tryFindTextOfRange range args.FileContent
         |> Option.map (fun text ->
             let suggestedFix = lazy(
-                { FromRange = range; FromText = text; ToText = $"({text})" }
+                { FromRange = range; ToText = $"({text})" }
                 |> Some)
             { Range = range
               Message = Resources.GetString("RulesFormattingTupleParenthesesError")
diff --git a/src/FSharpLint.Core/Rules/Formatting/TypePrefixing.fs b/src/FSharpLint.Core/Rules/Formatting/TypePrefixing.fs
@@ -23,7 +23,7 @@ let checkTypePrefixing (config:Config) (args:AstNodeRuleParams) range typeName t
         let prefixSuggestion typeName =
             let suggestedFix = lazy(
                 (ExpressionUtilities.tryFindTextOfRange range args.FileContent, typeArgs)
-                ||> Option.map2 (fun fromText typeArgs -> { FromText = fromText; FromRange = range; ToText = $"{typeName}<{typeArgs}>" }))
+                ||> Option.map2 (fun fromText typeArgs -> { FromRange = range; ToText = $"{typeName}<{typeArgs}>" }))
             { Range = range
               Message = Resources.GetString("RulesFormattingGenericPrefixError")
               SuggestedFix = Some suggestedFix
@@ -42,7 +42,7 @@ let checkTypePrefixing (config:Config) (args:AstNodeRuleParams) range typeName t
             then
                 let suggestedFix = lazy(
                     (ExpressionUtilities.tryFindTextOfRange range args.FileContent, typeArgs)
-                    ||> Option.map2 (fun fromText typeArgs -> { FromText = fromText; FromRange = range; ToText = $"{typeArgs} {typeName}" }))
+                    ||> Option.map2 (fun fromText typeArgs -> { FromRange = range; ToText = $"{typeArgs} {typeName}" }))
                 { Range = range
                   Message =  String.Format(recommendPostfixErrMsg.Value, typeName)
                   SuggestedFix = Some suggestedFix
@@ -57,7 +57,7 @@ let checkTypePrefixing (config:Config) (args:AstNodeRuleParams) range typeName t
             // Prefer special postfix (e.g. int []).
             let suggestedFix = lazy(
                 (ExpressionUtilities.tryFindTextOfRange range args.FileContent, typeArgs)
-                ||> Option.map2 (fun fromText typeArgs -> { FromText = fromText; FromRange = range; ToText = $"{typeArgs} []" }))
+                ||> Option.map2 (fun fromText typeArgs -> { FromRange = range; ToText = $"{typeArgs} []" }))
             { Range = range
               Message = Resources.GetString("RulesFormattingF#ArrayPostfixError")
               SuggestedFix = Some suggestedFix
diff --git a/src/FSharpLint.Core/Rules/Formatting/TypedItemSpacing.fs b/src/FSharpLint.Core/Rules/Formatting/TypedItemSpacing.fs
@@ -56,7 +56,7 @@ let private checkRange (config:Config) (args:AstNodeRuleParams) (range:Range) =
                 let spacesBeforeString = " " |> String.replicate expectedSpacesBefore
                 let spacesAfterString = " " |> String.replicate expectedSpacesAfter
                 let suggestedFix = lazy(
-                    { FromRange = range; FromText = text; ToText = $"{trimmedOtherText}{spacesBeforeString}:{spacesAfterString}{trimmedTypeText}" }
+                    { FromRange = range; ToText = $"{trimmedOtherText}{spacesBeforeString}:{spacesAfterString}{trimmedTypeText}" }
                     |> Some)
                 let errorFormatString = Resources.GetString("RulesFormattingTypedItemSpacingError")
                 Some
diff --git a/src/FSharpLint.Core/Rules/Hints/HintMatcher.fs b/src/FSharpLint.Core/Rules/Hints/HintMatcher.fs
@@ -581,7 +581,7 @@ let private hintError typeChecks hint (args:AstNodeRuleParams) range matchedVari
 
         let suggestedFix = lazy(
             ExpressionUtilities.tryFindTextOfRange range args.FileContent
-            |> Option.map (fun fromText -> { FromText = fromText; FromRange = range; ToText = toText }))
+            |> Option.map (fun fromText -> { FromRange = range; ToText = toText }))
 
         { Range = range; Message = error; SuggestedFix = Some suggestedFix; TypeChecks = typeChecks }
     | Suggestion.Message(message) ->
diff --git a/src/FSharpLint.Core/Rules/Typography/NoTabCharacters.fs b/src/FSharpLint.Core/Rules/Typography/NoTabCharacters.fs
@@ -33,7 +33,6 @@ let checkNoTabCharacters literalStrings (args:LineRuleParams) =
                     lazy
                         (Some(
                             { FromRange = range
-                              FromText = "\t"
                               ToText = String.replicate args.GlobalConfig.numIndentationSpaces " " }
                         ))
                 )

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ let private checkForNamedPatternEqualsConstant (args:AstNodeRuleParams) pattern`
`30`	`30`	`ExpressionUtilities.tryFindTextOfRange constRange args.FileContent`
`31`	`31`	`\|> Option.bind (fun constText ->`
`32`	`32`
`33`		`- lazy (Some { FromText = text; FromRange = fromRange; ToText = $"{constText} as {ident.idText}"})`
	`33`	`+ lazy (Some { FromRange = fromRange; ToText = $"{constText} as {ident.idText}"})`
`34`	`34`	`\|> Some`
`35`	`35`	`)`
`36`	`36`