Add option to toggle unused declarations analyzer (dotnet#4074)

* Add option to toggle unused declarations analyzer * Better name and handle registering code fixes. This will ensure that if someone uses warnon:1182, we won't suggest fixes if they've turned off the feature.
forki · Jan 3, 2018 · 939050e · 939050e
1 parent c6a5a98
commit 939050e
Show file tree

Hide file tree

Showing 20 changed files with 94 additions and 3 deletions.
diff --git a/vsintegration/src/FSharp.Editor/CodeFix/RenameUnusedValue.fs b/vsintegration/src/FSharp.Editor/CodeFix/RenameUnusedValue.fs
@@ -47,6 +47,9 @@ type internal FSharpRenameUnusedValueCodeFixProvider
 
     override __.RegisterCodeFixesAsync context : Task =
         asyncMaybe {
+            // Don't show code fixes for unused values, even if they are compiler-generated.
+            do! Option.guard Settings.CodeFixes.UnusedDeclarations
+
             let document = context.Document
             let! sourceText = document.GetTextAsync()
             let ident = sourceText.ToString(context.Span)

diff --git a/vsintegration/src/FSharp.Editor/Diagnostics/UnusedDeclarationsAnalyzer.fs b/vsintegration/src/FSharp.Editor/Diagnostics/UnusedDeclarationsAnalyzer.fs
@@ -100,6 +100,8 @@ type internal UnusedDeclarationsAnalyzer() =
 
     override __.AnalyzeSemanticsAsync(document, cancellationToken) =
         asyncMaybe {
+            do! Option.guard Settings.CodeFixes.UnusedDeclarations
+
             do Trace.TraceInformation("{0:n3} (start) UnusedDeclarationsAnalyzer", DateTime.Now.TimeOfDay.TotalSeconds)
             do! Async.Sleep DefaultTuning.UnusedDeclarationsAnalyzerInitialDelay |> liftAsync // be less intrusive, give other work priority most of the time
             match getProjectInfoManager(document).TryGetOptionsForEditingDocumentOrProject(document) with

diff --git a/vsintegration/src/FSharp.Editor/Options/EditorOptions.fs b/vsintegration/src/FSharp.Editor/Options/EditorOptions.fs
@@ -34,7 +34,8 @@ type QuickInfoOptions =
 type CodeFixesOptions =
     { SimplifyName: bool
       AlwaysPlaceOpensAtTopLevel: bool
-      UnusedOpens: bool }
+      UnusedOpens: bool 
+      UnusedDeclarations: bool }
 
 [<CLIMutable>]
 type LanguageServicePerformanceOptions = 
@@ -59,7 +60,8 @@ type internal Settings [<ImportingConstructor>](store: SettingsStore) =
               // See https://github.com/Microsoft/visualfsharp/pull/3238#issue-237699595
               SimplifyName = false 
               AlwaysPlaceOpensAtTopLevel = false
-              UnusedOpens = true }
+              UnusedOpens = true 
+              UnusedDeclarations = true }
 
         store.RegisterDefault
             { EnableInMemoryCrossProjectReferences = true

diff --git a/vsintegration/src/FSharp.UIResources/CodeFixesOptionControl.xaml b/vsintegration/src/FSharp.UIResources/CodeFixesOptionControl.xaml
@@ -26,6 +26,8 @@
                         <StackPanel Margin="15 0 0 0"/>
                         <CheckBox x:Name="unusedOpens" IsChecked="{Binding UnusedOpens}"
                                   Content="{x:Static local:Strings.Unused_opens_code_fix}"/>
+                        <CheckBox x:Name="unusedDeclaration" IsChecked="{Binding UnusedDeclarations}"
+                                  Content="{x:Static local:Strings.Unused_declaration_code_fix}"/>
                     </StackPanel>
                 </GroupBox>
             </StackPanel>

diff --git a/vsintegration/src/FSharp.UIResources/Strings.Designer.cs b/vsintegration/src/FSharp.UIResources/Strings.Designer.cs
diff --git a/vsintegration/src/FSharp.UIResources/Strings.resx b/vsintegration/src/FSharp.UIResources/Strings.resx
@@ -165,4 +165,7 @@
   <data name="Unused_opens_code_fix" xml:space="preserve">
     <value>Remove unused open statements</value>
   </data>
+  <data name="Unused_declaration_code_fix" xml:space="preserve">
+    <value>Analyze and suggest fixes for unused values</value>
+  </data>
 </root>
diff --git a/vsintegration/src/FSharp.UIResources/xlf/Strings.cs.xlf b/vsintegration/src/FSharp.UIResources/xlf/Strings.cs.xlf
@@ -82,6 +82,11 @@
         <target state="translated">Odebrat nepoužívané otevřené výkazy</target>
         <note />
       </trans-unit>
+      <trans-unit id="Unused_declaration_code_fix">
+        <source>Analyze and suggest fixes for unused values</source>
+        <target state="new">Analyze and suggest fixes for unused values</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>
diff --git a/vsintegration/src/FSharp.UIResources/xlf/Strings.de.xlf b/vsintegration/src/FSharp.UIResources/xlf/Strings.de.xlf
@@ -82,6 +82,11 @@
         <target state="translated">Nicht verwendete "open"-Anweisungen entfernen</target>
         <note />
       </trans-unit>
+      <trans-unit id="Unused_declaration_code_fix">
+        <source>Analyze and suggest fixes for unused values</source>
+        <target state="new">Analyze and suggest fixes for unused values</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>
diff --git a/vsintegration/src/FSharp.UIResources/xlf/Strings.en.xlf b/vsintegration/src/FSharp.UIResources/xlf/Strings.en.xlf
@@ -82,6 +82,11 @@
         <target state="new">Remove unused open statements</target>
         <note />
       </trans-unit>
+      <trans-unit id="Unused_declaration_code_fix">
+        <source>Analyze and suggest fixes for unused values</source>
+        <target state="new">Analyze and suggest fixes for unused values</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>
diff --git a/vsintegration/src/FSharp.UIResources/xlf/Strings.es.xlf b/vsintegration/src/FSharp.UIResources/xlf/Strings.es.xlf
@@ -82,6 +82,11 @@
         <target state="translated">Quitar instrucciones open no usadas</target>
         <note />
       </trans-unit>
+      <trans-unit id="Unused_declaration_code_fix">
+        <source>Analyze and suggest fixes for unused values</source>
+        <target state="new">Analyze and suggest fixes for unused values</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>
diff --git a/vsintegration/src/FSharp.UIResources/xlf/Strings.fr.xlf b/vsintegration/src/FSharp.UIResources/xlf/Strings.fr.xlf
@@ -82,6 +82,11 @@
         <target state="translated">Supprimer les instructions open inutilisées</target>
         <note />
       </trans-unit>
+      <trans-unit id="Unused_declaration_code_fix">
+        <source>Analyze and suggest fixes for unused values</source>
+        <target state="new">Analyze and suggest fixes for unused values</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>
diff --git a/vsintegration/src/FSharp.UIResources/xlf/Strings.it.xlf b/vsintegration/src/FSharp.UIResources/xlf/Strings.it.xlf
@@ -82,6 +82,11 @@
         <target state="translated">Rimuovi istruzioni OPEN inutilizzate</target>
         <note />
       </trans-unit>
+      <trans-unit id="Unused_declaration_code_fix">
+        <source>Analyze and suggest fixes for unused values</source>
+        <target state="new">Analyze and suggest fixes for unused values</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>
diff --git a/vsintegration/src/FSharp.UIResources/xlf/Strings.ja.xlf b/vsintegration/src/FSharp.UIResources/xlf/Strings.ja.xlf
@@ -82,6 +82,11 @@
         <target state="translated">未使用の Open ステートメントを削除する</target>
         <note />
       </trans-unit>
+      <trans-unit id="Unused_declaration_code_fix">
+        <source>Analyze and suggest fixes for unused values</source>
+        <target state="new">Analyze and suggest fixes for unused values</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>
diff --git a/vsintegration/src/FSharp.UIResources/xlf/Strings.ko.xlf b/vsintegration/src/FSharp.UIResources/xlf/Strings.ko.xlf
@@ -82,6 +82,11 @@
         <target state="translated">사용되지 않는 open 문 제거</target>
         <note />
       </trans-unit>
+      <trans-unit id="Unused_declaration_code_fix">
+        <source>Analyze and suggest fixes for unused values</source>
+        <target state="new">Analyze and suggest fixes for unused values</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>
diff --git a/vsintegration/src/FSharp.UIResources/xlf/Strings.pl.xlf b/vsintegration/src/FSharp.UIResources/xlf/Strings.pl.xlf
@@ -82,6 +82,11 @@
         <target state="translated">Usuń nieużywane otwarte instrukcje</target>
         <note />
       </trans-unit>
+      <trans-unit id="Unused_declaration_code_fix">
+        <source>Analyze and suggest fixes for unused values</source>
+        <target state="new">Analyze and suggest fixes for unused values</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>
diff --git a/vsintegration/src/FSharp.UIResources/xlf/Strings.pt-BR.xlf b/vsintegration/src/FSharp.UIResources/xlf/Strings.pt-BR.xlf
@@ -82,6 +82,11 @@
         <target state="translated">Remover instruções abertas não usadas</target>
         <note />
       </trans-unit>
+      <trans-unit id="Unused_declaration_code_fix">
+        <source>Analyze and suggest fixes for unused values</source>
+        <target state="new">Analyze and suggest fixes for unused values</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>
diff --git a/vsintegration/src/FSharp.UIResources/xlf/Strings.ru.xlf b/vsintegration/src/FSharp.UIResources/xlf/Strings.ru.xlf
@@ -82,6 +82,11 @@
         <target state="translated">Удалить неиспользуемые открытые операторы</target>
         <note />
       </trans-unit>
+      <trans-unit id="Unused_declaration_code_fix">
+        <source>Analyze and suggest fixes for unused values</source>
+        <target state="new">Analyze and suggest fixes for unused values</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>
diff --git a/vsintegration/src/FSharp.UIResources/xlf/Strings.tr.xlf b/vsintegration/src/FSharp.UIResources/xlf/Strings.tr.xlf
@@ -82,6 +82,11 @@
         <target state="translated">Kullanılmayan açık deyimleri kaldır</target>
         <note />
       </trans-unit>
+      <trans-unit id="Unused_declaration_code_fix">
+        <source>Analyze and suggest fixes for unused values</source>
+        <target state="new">Analyze and suggest fixes for unused values</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>
diff --git a/vsintegration/src/FSharp.UIResources/xlf/Strings.zh-Hans.xlf b/vsintegration/src/FSharp.UIResources/xlf/Strings.zh-Hans.xlf
@@ -82,6 +82,11 @@
         <target state="translated">删除未使用的 open 语句</target>
         <note />
       </trans-unit>
+      <trans-unit id="Unused_declaration_code_fix">
+        <source>Analyze and suggest fixes for unused values</source>
+        <target state="new">Analyze and suggest fixes for unused values</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>
diff --git a/vsintegration/src/FSharp.UIResources/xlf/Strings.zh-Hant.xlf b/vsintegration/src/FSharp.UIResources/xlf/Strings.zh-Hant.xlf
@@ -82,6 +82,11 @@
         <target state="translated">移除未使用的 open 陳述式</target>
         <note />
       </trans-unit>
+      <trans-unit id="Unused_declaration_code_fix">
+        <source>Analyze and suggest fixes for unused values</source>
+        <target state="new">Analyze and suggest fixes for unused values</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>