Reduce warnings

Author: andyleejordan

.editorconfig

@@ -39,7 +39,7 @@ dotnet_diagnostic.CS0649.severity = error
 # CS1570: Parameter has no matching param tag in the XML comment
 dotnet_diagnostic.CS1570.severity = silent
 # CS1574: XML comment has cref attribute that could not be resolved.
-dotnet_diagnostic.CS1574.severity = suggestion
+dotnet_diagnostic.CS1574.severity = silent
 # CS1591: Missing XML comment for publicly visible type or member
 dotnet_diagnostic.CS1591.severity = silent
 # CS1998: This async method lacks 'await' operators and will run synchronously

src/PowerShellEditorServices/Extensions/EditorContext.cs

@@ -86,26 +86,15 @@ public void SetSelection(
         /// </summary>
         /// <param name="startPosition">The starting position of the selection.</param>
         /// <param name="endPosition">The ending position of the selection.</param>
-        public void SetSelection(
-            FilePosition startPosition,
-            FilePosition endPosition)
-        {
-            SetSelection(
-                new FileRange(
-                    startPosition,
-                    endPosition));
-        }
+        public void SetSelection(FilePosition startPosition, FilePosition endPosition) => SetSelection(new FileRange(startPosition, endPosition));
 
         /// <summary>
         /// Sets a selection in the host editor's active buffer.
         /// </summary>
         /// <param name="selectionRange">The range of the selection.</param>
-        public void SetSelection(FileRange selectionRange)
-        {
-            editorOperations
-                .SetSelectionAsync(selectionRange.ToBufferRange())
-                .Wait();
-        }
+        #pragma warning disable VSTHRD002
+        public void SetSelection(FileRange selectionRange) => editorOperations.SetSelectionAsync(selectionRange.ToBufferRange()).Wait();
+        #pragma warning restore VSTHRD002
 
         #endregion
     }

src/PowerShellEditorServices/Extensions/EditorFileRanges.cs

@@ -274,7 +274,7 @@ public interface ILspCurrentFileContext : IFileContext
         ILspFileRange SelectionRange { get; }
     }
 
-    internal struct OmnisharpLspPosition : ILspFilePosition, IEquatable<OmnisharpLspPosition>
+    internal readonly struct OmnisharpLspPosition : ILspFilePosition, IEquatable<OmnisharpLspPosition>
     {
         private readonly Position _position;
 
@@ -287,7 +287,7 @@ internal struct OmnisharpLspPosition : ILspFilePosition, IEquatable<OmnisharpLsp
         public bool Equals(OmnisharpLspPosition other) => _position == other._position;
     }
 
-    internal struct OmnisharpLspRange : ILspFileRange, IEquatable<OmnisharpLspRange>
+    internal readonly struct OmnisharpLspRange : ILspFileRange, IEquatable<OmnisharpLspRange>
     {
         private readonly Range _range;
 
@@ -300,7 +300,7 @@ internal struct OmnisharpLspRange : ILspFileRange, IEquatable<OmnisharpLspRange>
         public bool Equals(OmnisharpLspRange other) => _range == other._range;
     }
 
-    internal struct BufferFilePosition : IFilePosition, IEquatable<BufferFilePosition>
+    internal readonly struct BufferFilePosition : IFilePosition, IEquatable<BufferFilePosition>
     {
         private readonly BufferPosition _position;
 
@@ -317,7 +317,7 @@ public bool Equals(BufferFilePosition other)
         }
     }
 
-    internal struct BufferFileRange : IFileRange, IEquatable<BufferFileRange>
+    internal readonly struct BufferFileRange : IFileRange, IEquatable<BufferFileRange>
     {
         private readonly BufferRange _range;
 

src/PowerShellEditorServices/Extensions/EditorObject.cs

@@ -115,7 +115,9 @@ internal EditorObject(
         /// at the time this method is invoked.
         /// </summary>
         /// <returns>A instance of the EditorContext class.</returns>
+        #pragma warning disable VSTHRD002, VSTHRD104
         public EditorContext GetEditorContext() => _editorOperations.GetEditorContextAsync().Result;
+        #pragma warning restore VSTHRD002, VSTHRD104
 
         internal void SetAsStaticInstance()
         {

src/PowerShellEditorServices/Extensions/EditorWindow.cs

@@ -39,6 +39,7 @@ internal EditorWindow(IEditorOperations editorOperations)
         #endregion
 
         #region Public Methods
+        #pragma warning disable VSTHRD002 // These are public APIs that use async internal methods.
 
         /// <summary>
         /// Shows an informational message to the user.
@@ -71,6 +72,7 @@ internal EditorWindow(IEditorOperations editorOperations)
         /// <param name="timeout">A timeout in milliseconds for how long the message should remain visible.</param>
         public void SetStatusBarMessage(string message, int timeout) => editorOperations.SetStatusBarMessageAsync(message, timeout).Wait();
 
+        #pragma warning restore VSTHRD002
         #endregion
     }
 }

src/PowerShellEditorServices/Extensions/EditorWorkspace.cs

@@ -31,6 +31,7 @@ public sealed class EditorWorkspace
         #endregion
 
         #region Public Methods
+        #pragma warning disable VSTHRD002 // These are public APIs that use async internal methods.
 
         /// <summary>
         /// Creates a new file in the editor
@@ -53,6 +54,7 @@ public sealed class EditorWorkspace
         /// <param name="preview">Determines wether the file is opened as a preview or as a durable editor.</param>
         public void OpenFile(string filePath, bool preview) => editorOperations.OpenFileAsync(filePath, preview).Wait();
 
+        #pragma warning restore VSTHRD002
         #endregion
     }
 }

src/PowerShellEditorServices/Extensions/FileContext.cs

@@ -209,12 +209,14 @@ 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
         public void InsertText(string textToInsert, IFileRange insertRange)
         {
             editorOperations
                 .InsertTextAsync(scriptFile.DocumentUri.ToString(), textToInsert, insertRange.ToBufferRange())
                 .Wait();
         }
+        #pragma warning restore VSTHRD002
 
         #endregion
 
@@ -232,6 +234,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
         public void SaveAs(string newFilePath)
         {
             // Do some validation here so that we can provide a helpful error if the path won't work
@@ -244,8 +247,9 @@ public void SaveAs(string newFilePath)
                 throw new IOException(string.Format("The file '{0}' already exists", absolutePath));
             }
 
-            editorOperations.SaveFileAsync(scriptFile.FilePath, newFilePath);
+            editorOperations.SaveFileAsync(scriptFile.FilePath, newFilePath).Wait();
         }
+        #pragma warning restore VSTHRD002
 
         #endregion
     }

src/PowerShellEditorServices/Hosting/EditorServicesServerFactory.cs

@@ -83,7 +83,7 @@ public static EditorServicesServerFactory Create(string logPath, int minimumLogL
         /// <param name="inputStream">The protocol transport input stream.</param>
         /// <param name="outputStream">The protocol transport output stream.</param>
         /// <param name="hostStartupInfo">The host details configuration for Editor Services
-        /// instantation.</param>
+        /// instantiation.</param>
         /// <returns>A new, unstarted language server instance.</returns>
         public PsesLanguageServer CreateLanguageServer(
             Stream inputStream,

src/PowerShellEditorServices/Logging/LoggerExtensions.cs

@@ -9,6 +9,7 @@ namespace Microsoft.PowerShell.EditorServices.Logging
 {
     internal static class LoggerExtensions
     {
+        // TODO: These need to be fixed (and used consistently).
         public static void LogException(
             this ILogger logger,
             string message,

src/PowerShellEditorServices/Services/DebugAdapter/DebugService.cs

@@ -559,19 +559,6 @@ public StackFrameDetails[] GetStackFrames()
             }
         }
 
-        internal StackFrameDetails[] GetStackFrames(CancellationToken cancellationToken)
-        {
-            debugInfoHandle.Wait(cancellationToken);
-            try
-            {
-                return stackFrameDetails;
-            }
-            finally
-            {
-                debugInfoHandle.Release();
-            }
-        }
-
         internal async Task<StackFrameDetails[]> GetStackFramesAsync()
         {
             await debugInfoHandle.WaitAsync().ConfigureAwait(false);