Be consistent with error suppression

Avoiding pragmas wherever possible.

Author: andyleejordan

.editorconfig

@@ -54,11 +54,11 @@ dotnet_diagnostic.CA1068.severity = error
 # CA1501: Avoid excessive inheritance
 dotnet_diagnostic.CA1501.severity = error
 # CA1502: Avoid excessive complexity
-dotnet_diagnostic.CA1502.severity = warning
+dotnet_diagnostic.CA1502.severity = silent
 # CA1505: Avoid unmaintainable code
 dotnet_diagnostic.CA1505.severity = error
 # CA1506: Avoid excessive class coupling
-dotnet_diagnostic.CA1506.severity = warning
+dotnet_diagnostic.CA1506.severity = silent
 # CA1507: Use nameof in place of string
 dotnet_diagnostic.CA1507.severity = error
 # CA1508: Avoid dead conditional code
@@ -95,22 +95,22 @@ dotnet_diagnostic.RCS1210.severity = error
 # RCS1036: Remove unnecessary blank line
 dotnet_diagnostic.RCS1036.severity = error
 # RCS1075: Avoid empty catch clause that catches System.Exception
-dotnet_diagnostic.RCS1075.severity = suggestion
+dotnet_diagnostic.RCS1075.severity = error
 # RCS1170: Use read-only auto-implemented property
 dotnet_diagnostic.RCS1170.severity = error
 
 # VSTHRD002: Avoid problematic synchronous waits
-dotnet_diagnostic.VSTHRD002.severity = suggestion
+dotnet_diagnostic.VSTHRD002.severity = error
 # VSTHRD003: Avoid awaiting foreign Tasks
-dotnet_diagnostic.VSTHRD003.severity = suggestion
+dotnet_diagnostic.VSTHRD003.severity = error
 # VSTHRD105: Avoid method overloads that assume TaskScheduler.Current
-dotnet_diagnostic.VSTHRD105.severity = suggestion
+dotnet_diagnostic.VSTHRD105.severity = error
 # VSTHRD100: Avoid async void methods
-dotnet_diagnostic.VSTHRD100.severity = suggestion
+dotnet_diagnostic.VSTHRD100.severity = error
 # VSTHRD103: Call async methods when in an async method
-dotnet_diagnostic.VSTHRD103.severity = suggestion
+dotnet_diagnostic.VSTHRD103.severity = error
 # VSTHRD110: Observe result of async calls
-dotnet_diagnostic.VSTHRD110.severity = suggestion
+dotnet_diagnostic.VSTHRD110.severity = error
 # VSTHRD114: Avoid returning a null Task
 dotnet_diagnostic.VSTHRD114.severity = error
 # VSTHRD200: Use "Async" suffix for awaitable methods

src/PowerShellEditorServices.Hosting/Commands/StartEditorServicesCommand.cs

@@ -215,7 +215,7 @@ protected override void BeginProcessing()
         }
 #pragma warning restore IDE0022
 
-        [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1031:Do not catch general exception types", Justification = "Uses ThrowTerminatingError() instead")]
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD002:Avoid problematic synchronous waits", Justification = "We have to wait here, it's the whole program.")]
         protected override void EndProcessing()
         {
             _logger.Log(PsesLogLevel.Diagnostic, "Beginning EndProcessing block");
@@ -232,9 +232,7 @@ protected override void EndProcessing()
                 using EditorServicesLoader psesLoader = EditorServicesLoader.Create(_logger, editorServicesConfig, SessionDetailsPath, _loggerUnsubscribers);
                 _logger.Log(PsesLogLevel.Verbose, "Loading EditorServices");
                 // Synchronously start editor services and wait here until it shuts down.
-#pragma warning disable VSTHRD002
                 psesLoader.LoadAndRunEditorServicesAsync().GetAwaiter().GetResult();
-#pragma warning restore VSTHRD002
             }
             catch (Exception e)
             {

src/PowerShellEditorServices.Hosting/EditorServicesLoader.cs

@@ -382,19 +382,18 @@ private void ValidateConfiguration()
             }
         }
 
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1825:Avoid zero-length array allocations", Justification = "Cannot use Array.Empty, since it must work in net452")]
         private static Version GetPSVersion()
         {
             // In order to read the $PSVersionTable variable,
             // we are forced to create a new runspace to avoid concurrency issues,
             // which is expensive.
             // Rather than do that, we instead go straight to the source,
             // which is a static property, internal in WinPS and public in PS 6+
-#pragma warning disable CA1825
             return typeof(PSObject).Assembly
                 .GetType("System.Management.Automation.PSVersionInfo")
                 .GetMethod("get_PSVersion", BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic)
-                .Invoke(null, new object[0] /* Cannot use Array.Empty, since it must work in net452 */) as Version;
-#pragma warning restore CA1825
+                .Invoke(null, new object[0]) as Version;
         }
     }
 }

src/PowerShellEditorServices.Hosting/Internal/EditorServicesRunner.cs

@@ -201,6 +201,7 @@ private async Task RunTempDebugSessionAsync(HostStartupInfo hostDetails)
             await debugServer.WaitForShutdown().ConfigureAwait(false);
         }
 
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD003:Avoid awaiting foreign Tasks", Justification = "It's a wrapper.")]
         private async Task StartDebugServer(Task<PsesDebugServer> debugServerCreation)
         {
             PsesDebugServer debugServer = await debugServerCreation.ConfigureAwait(false);
@@ -304,6 +305,7 @@ private void WriteStartupBanner()
             _config.PSHost.UI.WriteLine(_config.StartupBanner);
         }
 
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD110:Observe result of async calls", Justification = "Intentionally fire and forget.")]
         private void DebugServer_OnSessionEnded(object sender, EventArgs args)
         {
             _logger.Log(PsesLogLevel.Verbose, "Debug session ended, restarting debug service...");

src/PowerShellEditorServices/Extensions/EditorContext.cs

@@ -92,9 +92,8 @@ public void SetSelection(
         /// Sets a selection in the host editor's active buffer.
         /// </summary>
         /// <param name="selectionRange">The range of the selection.</param>
-        #pragma warning disable VSTHRD002
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD002:Avoid problematic synchronous waits", Justification = "Supporting synchronous API.")]
         public void SetSelection(FileRange selectionRange) => editorOperations.SetSelectionAsync(selectionRange.ToBufferRange()).Wait();
-        #pragma warning restore VSTHRD002
 
         #endregion
     }

src/PowerShellEditorServices/Extensions/EditorObject.cs

@@ -115,13 +115,12 @@ internal EditorObject(
         /// at the time this method is invoked.
         /// </summary>
         /// <returns>A instance of the EditorContext class.</returns>
-        #pragma warning disable VSTHRD002, VSTHRD104
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD002:Avoid problematic synchronous waits", Justification = "Supporting synchronous API.")]
         public EditorContext GetEditorContext() => _editorOperations.GetEditorContextAsync().Result;
-        #pragma warning restore VSTHRD002, VSTHRD104
 
         internal void SetAsStaticInstance()
         {
-            EditorObject.Instance = this;
+            Instance = this;
             s_editorObjectReady.TrySetResult(true);
         }
     }

src/PowerShellEditorServices/Extensions/EditorWindow.cs

@@ -43,31 +43,36 @@ internal EditorWindow(IEditorOperations editorOperations)
         /// Shows an informational message to the user.
         /// </summary>
         /// <param name="message">The message to be shown.</param>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD002:Avoid problematic synchronous waits", Justification = "Supporting synchronous API.")]
         public void ShowInformationMessage(string message) => editorOperations.ShowInformationMessageAsync(message).Wait();
 
         /// <summary>
         /// Shows an error message to the user.
         /// </summary>
         /// <param name="message">The message to be shown.</param>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD002:Avoid problematic synchronous waits", Justification = "Supporting synchronous API.")]
         public void ShowErrorMessage(string message) => editorOperations.ShowErrorMessageAsync(message).Wait();
 
         /// <summary>
         /// Shows a warning message to the user.
         /// </summary>
         /// <param name="message">The message to be shown.</param>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD002:Avoid problematic synchronous waits", Justification = "Supporting synchronous API.")]
         public void ShowWarningMessage(string message) => editorOperations.ShowWarningMessageAsync(message).Wait();
 
         /// <summary>
         /// Sets the status bar message in the editor UI (if applicable).
         /// </summary>
         /// <param name="message">The message to be shown.</param>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD002:Avoid problematic synchronous waits", Justification = "Supporting synchronous API.")]
         public void SetStatusBarMessage(string message) => editorOperations.SetStatusBarMessageAsync(message, null).Wait();
 
         /// <summary>
         /// Sets the status bar message in the editor UI (if applicable).
         /// </summary>
         /// <param name="message">The message to be shown.</param>
         /// <param name="timeout">A timeout in milliseconds for how long the message should remain visible.</param>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD002:Avoid problematic synchronous waits", Justification = "Supporting synchronous API.")]
         public void SetStatusBarMessage(string message, int timeout) => editorOperations.SetStatusBarMessageAsync(message, timeout).Wait();
 
         #endregion

src/PowerShellEditorServices/Extensions/EditorWorkspace.cs

@@ -42,19 +42,22 @@ public sealed class EditorWorkspace
         /// <summary>
         /// Creates a new file in the editor.
         /// </summary>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD002:Avoid problematic synchronous waits", Justification = "Supporting synchronous API.")]
         public void NewFile() => editorOperations.NewFileAsync(string.Empty).Wait();
 
         /// <summary>
         /// Creates a new file in the editor.
         /// </summary>
         /// <param name="content">The content to place in the new file.</param>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD002:Avoid problematic synchronous waits", Justification = "Supporting synchronous API.")]
         public void NewFile(string content) => editorOperations.NewFileAsync(content).Wait();
 
         /// <summary>
         /// Opens a file in the workspace. If the file is already open
         /// its buffer will be made active.
         /// </summary>
         /// <param name="filePath">The path to the file to be opened.</param>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD002:Avoid problematic synchronous waits", Justification = "Supporting synchronous API.")]
         public void OpenFile(string filePath) => editorOperations.OpenFileAsync(filePath).Wait();
 
         /// <summary>
@@ -64,25 +67,29 @@ public sealed class EditorWorkspace
         /// </summary>
         /// <param name="filePath">The path to the file to be opened.</param>
         /// <param name="preview">Determines wether the file is opened as a preview or as a durable editor.</param>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD002:Avoid problematic synchronous waits", Justification = "Supporting synchronous API.")]
         public void OpenFile(string filePath, bool preview) => editorOperations.OpenFileAsync(filePath, preview).Wait();
 
         /// <summary>
         /// Closes a file in the workspace.
         /// </summary>
         /// <param name="filePath">The path to the file to be closed.</param>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD002:Avoid problematic synchronous waits", Justification = "Supporting synchronous API.")]
         public void CloseFile(string filePath) => editorOperations.CloseFileAsync(filePath).Wait();
 
         /// <summary>
         /// Saves an open file in the workspace.
         /// </summary>
         /// <param name="filePath">The path to the file to be saved.</param>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD002:Avoid problematic synchronous waits", Justification = "Supporting synchronous API.")]
         public void SaveFile(string filePath) => editorOperations.SaveFileAsync(filePath).Wait();
 
         /// <summary>
         /// Saves a file with a new name AKA a copy.
         /// </summary>
         /// <param name="oldFilePath">The file to copy.</param>
         /// <param name="newFilePath">The file to create.</param>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD002:Avoid problematic synchronous waits", Justification = "Supporting synchronous API.")]
         public void SaveFile(string oldFilePath, string newFilePath) => editorOperations.SaveFileAsync(oldFilePath, newFilePath).Wait();
 
         #endregion

src/PowerShellEditorServices/Extensions/FileContext.cs

@@ -208,14 +208,13 @@ public void InsertText(
         /// </summary>
         /// <param name="textToInsert">The text string to insert.</param>
         /// <param name="insertRange">The buffer range which will be replaced by the string.</param>
-        #pragma warning disable VSTHRD002
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD002:Avoid problematic synchronous waits", Justification = "Supporting synchronous API.")]
         public void InsertText(string textToInsert, IFileRange insertRange)
         {
             editorOperations
                 .InsertTextAsync(scriptFile.DocumentUri.ToString(), textToInsert, insertRange.ToBufferRange())
                 .Wait();
         }
-        #pragma warning restore VSTHRD002
 
         #endregion
 
@@ -224,6 +223,7 @@ public void InsertText(string textToInsert, IFileRange insertRange)
         /// <summary>
         /// Saves this file.
         /// </summary>
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD110:Observe result of async calls", Justification = "Supporting synchronous API.")]
         public void Save() => editorOperations.SaveFileAsync(scriptFile.FilePath);
 
         /// <summary>
@@ -233,7 +233,7 @@ public void InsertText(string textToInsert, IFileRange insertRange)
         /// the path where the file should be saved,
         /// including the file name with extension as the leaf
         /// </param>
-        #pragma warning disable VSTHRD002
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "VSTHRD002:Avoid problematic synchronous waits", Justification = "Supporting synchronous API.")]
         public void SaveAs(string newFilePath)
         {
             // Do some validation here so that we can provide a helpful error if the path won't work
@@ -248,7 +248,6 @@ public void SaveAs(string newFilePath)
 
             editorOperations.SaveFileAsync(scriptFile.FilePath, newFilePath).Wait();
         }
-        #pragma warning restore VSTHRD002
 
         #endregion
     }