Converge QuickFix & SuggestedFix terminology into one

It was a bit confusing that in some parts of the codebase,
the rule's fixes were called "QuickFix" sometimes (more
like towards the user) and "SuggestedFix" in others (more
API-wise). With this commit we just converge both ways into
one, and a much simpler one: fix.

Author: knocte

src/FSharpLint.Console/Program.fs

@@ -25,7 +25,7 @@ type ExitCode =
     | Error = -1
     | Success = 0
     | NoSuchRuleName = 1
-    | NoSuggestedFix = 2
+    | NoFix = 2
 
 let fileTypeHelp = "Input type the linter will run against. If this is not set, the file type will be inferred from the file extension."
 
@@ -42,7 +42,7 @@ with
             match this with
             | Format _ -> "Output format of the linter."
             | Lint _ -> "Runs FSharpLint against a file or a collection of files."
-            | Fix _ -> "Apply quickfixes for specified rule name or names (comma separated)."
+            | Fix _ -> "Apply fixes for specified rule name or names (comma separated)."
             | Version -> "Prints current version."
 
 // TODO: investigate erroneous warning on this type definition
@@ -70,7 +70,7 @@ with
     interface IArgParserTemplate with
         member this.Usage =
             match this with
-            | Fix_Target _ -> "Rule name to be applied with suggestedFix and input to lint."
+            | Fix_Target _ -> "Rule name to be applied with fix and input to lint."
             | Fix_File_Type _ -> fileTypeHelp
 // fsharplint:enable UnionCasesNames
 
@@ -129,31 +129,31 @@ let private start (arguments:ParseResults<ToolArgs>) (toolsPath:Ionide.ProjInfo.
 
     let handleFixResult (target: string) (ruleName: string) = function
         | LintResult.Success warnings ->
-            String.Format(Resources.GetString "ConsoleApplyingSuggestedFixFile", target) |> output.WriteInfo
+            String.Format(Resources.GetString "ConsoleApplyingFixFile", target) |> output.WriteInfo
             let increment = 1
             let noFixIncrement = 0
-            let countSuggestedFix = 
+            let countFix =
                 warnings
                 |> List.sumBy (fun (element: Suggestion.LintWarning) ->
                     let sourceCode = File.ReadAllText element.FilePath
                     if String.Equals(ruleName, element.RuleName, StringComparison.InvariantCultureIgnoreCase) then
-                        match element.Details.SuggestedFix with
-                        | Some lazySuggestedFix ->
-                            lazySuggestedFix.Force()
-                            |> Option.iter (fun suggestedFix ->
+                        match element.Details.Fix with
+                        | Some lazyFix ->
+                            lazyFix.Force()
+                            |> Option.iter (fun fix ->
                                 let updatedSourceCode = 
-                                    let builder = StringBuilder(sourceCode.Length + suggestedFix.ToText.Length)
+                                    let builder = StringBuilder(sourceCode.Length + fix.ToText.Length)
                                     let firstPart = 
                                         sourceCode.AsSpan(
                                             0,
-                                            (ExpressionUtilities.findPos suggestedFix.FromRange.Start sourceCode).Value
+                                            (ExpressionUtilities.findPos fix.FromRange.Start sourceCode).Value
                                         )
                                     let secondPart = 
                                         sourceCode.AsSpan
-                                            (ExpressionUtilities.findPos suggestedFix.FromRange.End sourceCode).Value
+                                            (ExpressionUtilities.findPos fix.FromRange.End sourceCode).Value
                                     builder
                                         .Append(firstPart)
-                                        .Append(suggestedFix.ToText)
+                                        .Append(fix.ToText)
                                         .Append(secondPart)
                                         .ToString()
                                 File.WriteAllText(
@@ -167,10 +167,10 @@ let private start (arguments:ParseResults<ToolArgs>) (toolsPath:Ionide.ProjInfo.
                         noFixIncrement)
             outputWarnings warnings
 
-            if countSuggestedFix > 0 then
+            if countFix > 0 then
                 exitCode <- ExitCode.Success
             else
-                exitCode <- ExitCode.NoSuggestedFix
+                exitCode <- ExitCode.NoFix
 
         | LintResult.Failure failure -> handleError ExitCode.Error failure.Description
 
@@ -215,7 +215,7 @@ let private start (arguments:ParseResults<ToolArgs>) (toolsPath:Ionide.ProjInfo.
 
         linting fileType lintParams target toolsPath false None
 
-    let applySuggestedFix (fixArgs: ParseResults<FixArgs>) =
+    let applyFix (fixArgs: ParseResults<FixArgs>) =
         let fixParams = getParams None
         let ruleName, target = fixArgs.GetResult Fix_Target
         let fileType = fixArgs.TryGetResult Fix_File_Type |> Option.defaultValue (inferFileType target)
@@ -242,7 +242,7 @@ let private start (arguments:ParseResults<ToolArgs>) (toolsPath:Ionide.ProjInfo.
 
     match arguments.GetSubCommand() with
     | Lint lintArgs -> applyLint lintArgs
-    | Fix fixArgs -> applySuggestedFix fixArgs
+    | Fix fixArgs -> applyFix fixArgs
     | _ -> ()
 
     int exitCode

src/FSharpLint.Core/Framework/Suggestion.fs

@@ -5,7 +5,7 @@ open FSharp.Compiler.Text
 
 /// Information for consuming applications to provide an automated fix for a lint suggestion.
 [<NoEquality; NoComparison>]
-type SuggestedFix = {
+type Fix = {
     /// Location of the text to be replaced.
     FromRange:Range
 
@@ -22,7 +22,7 @@ type WarningDetails = {
     Message:string
 
     /// Information to provide an automated fix.
-    SuggestedFix:Lazy<SuggestedFix option> option
+    Fix:Lazy<Fix option> option
 
     /// Type checks to be performed to confirm this suggestion is valid.
     /// Suggestion is only considered valid when all type checks resolve to true.

src/FSharpLint.Core/Rules/Conventions/AsyncExceptionWithoutReturn.fs

@@ -46,7 +46,7 @@ let rec checkExpression (expression: SynExpr) (range: range) =
         ->
         { Range = range
           Message = Resources.GetString "RulesAsyncExceptionWithoutReturn"
-          SuggestedFix = None
+          Fix = None
           TypeChecks = List.Empty }
         |> Array.singleton
     | SynExpr.App (_, _, funcExpr, _, range) ->

src/FSharpLint.Core/Rules/Conventions/AvoidSinglePipeOperator.fs

@@ -9,11 +9,11 @@ open FSharpLint.Framework.Ast
 open FSharpLint.Framework.Rules
 
 let runner (args: AstNodeRuleParams) =
-    let errors range suggestedFix =
+    let errors range fix =
         {
             Range = range
             Message = String.Format(Resources.GetString ("RulesAvoidSinglePipeOperator"))
-            SuggestedFix = suggestedFix
+            Fix = fix
             TypeChecks = List.Empty
         } |> Array.singleton
 
@@ -42,15 +42,15 @@ let runner (args: AstNodeRuleParams) =
                         if isParentPiped then
                             Array.empty
                         else
-                            let suggestedFix = lazy(
+                            let fix = lazy(
                                 let maybeFuncText = ExpressionUtilities.tryFindTextOfRange outerArgExpr.Range args.FileContent
                                 let maybeArgText = ExpressionUtilities.tryFindTextOfRange argExpr.Range args.FileContent
                                 match maybeFuncText, maybeArgText with
                                 | Some(funcText), Some(argText) ->
                                     let replacementText = sprintf "%s %s" funcText argText
                                     Some { FromRange=range; ToText=replacementText }
                                 | _ -> None)
-                            errors ident.idRange (Some suggestedFix)
+                            errors ident.idRange (Some fix)
                 else
                     Array.empty
             | _ ->

src/FSharpLint.Core/Rules/Conventions/AvoidTooShortNames.fs

@@ -23,7 +23,7 @@ let private checkIdentifier (identifier:Ident) (idText:string) =
         |> Array.map (fun message ->
             { Range = identifier.idRange
               Message = message
-              SuggestedFix = None
+              Fix = None
               TypeChecks = List.Empty })
     else
         Array.empty

src/FSharpLint.Core/Rules/Conventions/Binding/FavourAsKeyword.fs

@@ -23,7 +23,7 @@ let private checkForNamedPatternEqualsConstant (args:AstNodeRuleParams) pattern
 
             let fromRange = Range.mkRange "" range.Start constRange.End
 
-            let suggestedFix =
+            let fix =
                 ExpressionUtilities.tryFindTextOfRange fromRange args.FileContent
                 |> Option.bind (fun text ->
 
@@ -38,7 +38,7 @@ let private checkForNamedPatternEqualsConstant (args:AstNodeRuleParams) pattern
 
             { Range = fromRange
               Message = Resources.GetString("RulesFavourAsKeyword")
-              SuggestedFix = suggestedFix
+              Fix = fix
               TypeChecks = [] } |> Array.singleton
 
         | _ -> Array.empty

src/FSharpLint.Core/Rules/Conventions/Binding/FavourIgnoreOverLetWild.fs

@@ -18,8 +18,8 @@ let private checkForBindingToAWildcard pattern range fileContent (expr: SynExpr)
         if findWildAndIgnoreParens pattern then
             { Range = range
               Message = Resources.GetString("RulesFavourIgnoreOverLetWildError")
-              SuggestedFix = Some (lazy (Some({ FromRange = letBindingRange
-                                                ToText = sprintf "(%s) |> ignore" exprText })))
+              Fix = Some (lazy (Some({ FromRange = letBindingRange
+                                       ToText = sprintf "(%s) |> ignore" exprText })))
               TypeChecks = [] } |> Array.singleton
         else
             Array.empty

src/FSharpLint.Core/Rules/Conventions/Binding/FavourTypedIgnore.fs

@@ -10,7 +10,7 @@ open FSharpLint.Framework.Rules
 let private runner (args: AstNodeRuleParams) =
     let generateError identifier range text =
 
-        let suggestedFix =
+        let fix =
             lazy
                 (ExpressionUtilities.tryFindTextOfRange range text
                  |> Option.map
@@ -20,7 +20,7 @@ let private runner (args: AstNodeRuleParams) =
 
         { Range = range
           Message = String.Format(Resources.GetString "RulesFavourTypedIgnore", identifier)
-          SuggestedFix = Some suggestedFix
+          Fix = Some fix
           TypeChecks = [] }
 
     let isTyped expression identifier range text =

src/FSharpLint.Core/Rules/Conventions/Binding/TupleOfWildcards.fs

@@ -27,9 +27,9 @@ let private checkTupleOfWildcards fileContents pattern identifier identifierRang
         let refactorFrom = constructorString (List.length patterns)
         let refactorTo = constructorString 1
         let error = String.Format(errorFormat, refactorFrom, refactorTo)
-        let suggestedFix = lazy(
-            Some { SuggestedFix.FromRange = identifierRange; ToText = refactorTo })
-        { Range = range; Message = error; SuggestedFix = Some suggestedFix; TypeChecks = [] } |> Array.singleton
+        let fix = lazy(
+            Some { Fix.FromRange = identifierRange; ToText = refactorTo })
+        { Range = range; Message = error; Fix = Some fix; TypeChecks = [] } |> Array.singleton
     | _ -> Array.empty
 
 let private isTupleMemberArgs breadcrumbs tupleRange =

src/FSharpLint.Core/Rules/Conventions/Binding/UselessBinding.fs

@@ -9,7 +9,7 @@ open FSharp.Compiler.CodeAnalysis
 open FSharpLint.Framework.Ast
 open FSharpLint.Framework.Rules
 
-let private checkForUselessBinding (checkInfo:FSharpCheckFileResults option) pattern expr range maybeSuggestedFix =
+let private checkForUselessBinding (checkInfo:FSharpCheckFileResults option) pattern expr range maybeFix =
     match checkInfo with
     | Some checkInfo ->
         let rec findBindingIdentifier = function
@@ -42,13 +42,13 @@ let private checkForUselessBinding (checkInfo:FSharpCheckFileResults option) pat
         |> Option.map (fun ident ->
             { Range = range
               Message = Resources.GetString("RulesUselessBindingError")
-              SuggestedFix = Some (lazy(maybeSuggestedFix))
+              Fix = Some (lazy(maybeFix))
               TypeChecks = [ checkNotMutable ident ] })
         |> Option.toArray
     | _ -> Array.empty
 
 let private runner (args:AstNodeRuleParams) =
-    let maybeSuggestedFix = 
+    let maybeFix =
         match args.GetParents(args.NodeIndex) with
         | AstNode.ModuleDeclaration(SynModuleDecl.Let(_, _, range)) :: _ ->
             Some({ FromRange = range; ToText = "" })
@@ -57,8 +57,8 @@ let private runner (args:AstNodeRuleParams) =
         | _ -> None
     match args.AstNode with
     | AstNode.Binding(SynBinding(_, _, _, isMutable, _, _, _, pattern, _, expr, range, _, _))
-            when maybeSuggestedFix.IsSome && not isMutable ->
-                checkForUselessBinding args.CheckInfo pattern expr range maybeSuggestedFix
+            when maybeFix.IsSome && not isMutable ->
+                checkForUselessBinding args.CheckInfo pattern expr range maybeFix
     | _ ->
         Array.empty