Add refactoring to replace ! with .Value (dotnet#11227)

Author: cartermp

FSharp.Editor.fsproj

@@ -90,6 +90,7 @@
     <Compile Include="Commands\FsiCommandService.fs" />
     <Compile Include="Commands\XmlDocCommandService.fs" />
     <Compile Include="Refactor\AddExplicitTypeToParameter.fs" />
+    <Compile Include="Refactor\ChangeDerefToValueRefactoring.fs" />
     <Compile Include="CodeFix\CodeFixHelpers.fs" />
     <Compile Include="CodeFix\AddTypeAnnotationToObjectOfIndeterminateType.fs" />
     <Compile Include="CodeFix\AddMissingRecToMutuallyRecFunctions.fs" />

FSharp.Editor.resx

@@ -273,6 +273,9 @@
   <data name="ConvertToNotEqualsEqualityExpression" xml:space="preserve">
     <value>Use '&lt;&gt;' for inequality check</value>
   </data>
+  <data name="UseValueInsteadOfDeref" xml:space="preserve">
+    <value>Use '.Value' to dereference expression</value>
+  </data>
   <data name="AddTypeAnnotation" xml:space="preserve">
     <value>Add type annotation</value>
   </data>

Refactor/ChangeDerefToValueRefactoring.fs

@@ -0,0 +1,64 @@
+// Copyright (c) Microsoft Corporation.  All Rights Reserved.  See License.txt in the project root for license information.
+
+namespace Microsoft.VisualStudio.FSharp.Editor
+
+open System
+open System.Composition
+open System.Threading
+
+open FSharp.Compiler
+open FSharp.Compiler.CodeAnalysis
+open FSharp.Compiler.Symbols
+open FSharp.Compiler.Text
+open FSharp.Compiler.Syntax
+
+open Microsoft.CodeAnalysis.Text
+open Microsoft.CodeAnalysis.CodeRefactorings
+open Microsoft.CodeAnalysis.CodeActions
+
+[<ExportCodeRefactoringProvider(FSharpConstants.FSharpLanguageName, Name = "ChangeDerefToValue"); Shared>]
+type internal FSharpChangeDerefToValueRefactoring
+    [<ImportingConstructor>]
+    (
+        checkerProvider: FSharpCheckerProvider, 
+        projectInfoManager: FSharpProjectOptionsManager
+    ) =
+    inherit CodeRefactoringProvider()
+
+    static let userOpName = "ChangeDerefToValue"
+
+    override _.ComputeRefactoringsAsync context =
+        asyncMaybe {
+            let document = context.Document
+            let! parsingOptions, _ = projectInfoManager.TryGetOptionsForEditingDocumentOrProject(document, context.CancellationToken, userOpName)
+            let! sourceText = context.Document.GetTextAsync(context.CancellationToken)
+            let! parseResults = checkerProvider.Checker.ParseFile(document.FilePath, sourceText.ToFSharpSourceText(), parsingOptions, userOpName=userOpName) |> liftAsync
+
+            let selectionRange = RoslynHelpers.TextSpanToFSharpRange(document.FilePath, context.Span, sourceText)
+            let! derefRange = parseResults.TryRangeOfRefCellDereferenceContainingPos selectionRange.Start
+            let! exprRange = parseResults.TryRangeOfExpressionBeingDereferencedContainingPos selectionRange.Start
+
+            let combinedRange = Range.unionRanges derefRange exprRange
+            let! combinedSpan = RoslynHelpers.TryFSharpRangeToTextSpan(sourceText, combinedRange)
+            let replacementString =
+                // Trim off the `!`
+                sourceText.GetSubText(combinedSpan).ToString().[1..] + ".Value"
+
+            let title = SR.UseValueInsteadOfDeref()
+
+            let getChangedText (sourceText: SourceText) =
+                sourceText.WithChanges(TextChange(combinedSpan, replacementString))
+
+            let codeAction =
+                CodeAction.Create(
+                    title,
+                    (fun (cancellationToken: CancellationToken) ->
+                        async {
+                            let! sourceText = context.Document.GetTextAsync(cancellationToken) |> Async.AwaitTask
+                            return context.Document.WithText(getChangedText sourceText)
+                        } |> RoslynHelpers.StartAsyncAsTask(cancellationToken)),
+                    title)
+            context.RegisterRefactoring(codeAction)
+        }
+        |> Async.Ignore
+        |> RoslynHelpers.StartAsyncUnitAsTask(context.CancellationToken)

xlf/FSharp.Editor.cs.xlf

@@ -262,6 +262,11 @@
         <target state="translated">Negovat výraz pomocí not</target>
         <note />
       </trans-unit>
+      <trans-unit id="UseValueInsteadOfDeref">
+        <source>Use '.Value' to dereference expression</source>
+        <target state="new">Use '.Value' to dereference expression</target>
+        <note />
+      </trans-unit>
       <trans-unit id="WrapExpressionInParentheses">
         <source>Wrap expression in parentheses</source>
         <target state="translated">Uzavřít výraz do závorek</target>

xlf/FSharp.Editor.de.xlf

@@ -262,6 +262,11 @@
         <target state="translated">"not" zum Negieren eines Ausdruck verwenden</target>
         <note />
       </trans-unit>
+      <trans-unit id="UseValueInsteadOfDeref">
+        <source>Use '.Value' to dereference expression</source>
+        <target state="new">Use '.Value' to dereference expression</target>
+        <note />
+      </trans-unit>
       <trans-unit id="WrapExpressionInParentheses">
         <source>Wrap expression in parentheses</source>
         <target state="translated">Ausdruck in Klammern einschließen</target>

xlf/FSharp.Editor.es.xlf

@@ -262,6 +262,11 @@
         <target state="translated">Usar "not" para negar la expresión</target>
         <note />
       </trans-unit>
+      <trans-unit id="UseValueInsteadOfDeref">
+        <source>Use '.Value' to dereference expression</source>
+        <target state="new">Use '.Value' to dereference expression</target>
+        <note />
+      </trans-unit>
       <trans-unit id="WrapExpressionInParentheses">
         <source>Wrap expression in parentheses</source>
         <target state="translated">Encapsular la expresión entre paréntesis</target>

xlf/FSharp.Editor.fr.xlf

@@ -262,6 +262,11 @@
         <target state="translated">Utiliser 'not' pour annuler l'expression</target>
         <note />
       </trans-unit>
+      <trans-unit id="UseValueInsteadOfDeref">
+        <source>Use '.Value' to dereference expression</source>
+        <target state="new">Use '.Value' to dereference expression</target>
+        <note />
+      </trans-unit>
       <trans-unit id="WrapExpressionInParentheses">
         <source>Wrap expression in parentheses</source>
         <target state="translated">Mettre l'expression entre parenthèses</target>

xlf/FSharp.Editor.it.xlf

@@ -262,6 +262,11 @@
         <target state="translated">Usare 'not' per negare l'espressione</target>
         <note />
       </trans-unit>
+      <trans-unit id="UseValueInsteadOfDeref">
+        <source>Use '.Value' to dereference expression</source>
+        <target state="new">Use '.Value' to dereference expression</target>
+        <note />
+      </trans-unit>
       <trans-unit id="WrapExpressionInParentheses">
         <source>Wrap expression in parentheses</source>
         <target state="translated">Racchiudere l'espressione tra parentesi</target>

xlf/FSharp.Editor.ja.xlf

@@ -262,6 +262,11 @@
         <target state="translated">式を否定するには 'not' を使用する</target>
         <note />
       </trans-unit>
+      <trans-unit id="UseValueInsteadOfDeref">
+        <source>Use '.Value' to dereference expression</source>
+        <target state="new">Use '.Value' to dereference expression</target>
+        <note />
+      </trans-unit>
       <trans-unit id="WrapExpressionInParentheses">
         <source>Wrap expression in parentheses</source>
         <target state="translated">式をかっこで囲む</target>

xlf/FSharp.Editor.ko.xlf

@@ -262,6 +262,11 @@
         <target state="translated">식을 부정하려면 'not' 사용</target>
         <note />
       </trans-unit>
+      <trans-unit id="UseValueInsteadOfDeref">
+        <source>Use '.Value' to dereference expression</source>
+        <target state="new">Use '.Value' to dereference expression</target>
+        <note />
+      </trans-unit>
       <trans-unit id="WrapExpressionInParentheses">
         <source>Wrap expression in parentheses</source>
         <target state="translated">식을 괄호로 래핑</target>