Selectively enable and fix a few more rules

Author: andyleejordan

.editorconfig

@@ -57,6 +57,12 @@ dotnet_diagnostic.CA1506.severity = warning
 dotnet_diagnostic.CA1507.severity = error
 # CA1508: Avoid dead conditional code
 dotnet_diagnostic.CA1508.severity = error
+# CA1802: Use Literals Where Appropriate
+dotnet_diagnostic.CA1802.severity = error
+# CA1805: Do not initialize unnecessarily.
+dotnet_diagnostic.CA1805.severity = error
+# CA1820: Test for empty strings using string length
+dotnet_diagnostic.CA1820.severity = error
 # CA1822: Mark members as static
 dotnet_diagnostic.CA1822.severity = error
 # CA1823: Avoid unused private fields
@@ -65,9 +71,13 @@ dotnet_diagnostic.CA1823.severity = error
 dotnet_diagnostic.CA2007.severity = error
 # CA2016: Forward the CancellationToken parameter to methods that take one
 dotnet_diagnostic.CA2016.severity = error
+# CA2213: Disposable fields should be disposed
+dotnet_diagnostic.CA2213.severity = error
 # CA2254: The logging message template should not vary between calls to 'LoggerExtensions.*'
 dotnet_diagnostic.CA2254.severity = silent
 
+# RCS1049: Simplify boolean comparison
+dotnet_diagnostic.RCS1049.severity = error
 # RCS1102: Make class static
 dotnet_diagnostic.RCS1102.severity = error
 # RCS1139: Add summary element to documentation comment

PowerShellEditorServices.Common.props

@@ -14,6 +14,7 @@
     <!-- See: https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/overview -->
     <EnableNETAnalyzers>true</EnableNETAnalyzers>
     <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
+    <!-- TODO: Enable <AnalysisMode>All</AnalysisMode> -->
     <!-- See: https://docs.microsoft.com/en-us/dotnet/core/compatibility/sdk/6.0/implicit-namespaces -->
     <DisableImplicitNamespaceImports>true</DisableImplicitNamespaceImports>
   </PropertyGroup>

src/PowerShellEditorServices.Hosting/Configuration/EditorServicesConfig.cs

@@ -76,12 +76,12 @@ public EditorServicesConfig(
         /// <summary>
         /// Names of or paths to any additional modules to load on startup.
         /// </summary>
-        public IReadOnlyList<string> AdditionalModules { get; set; } = null;
+        public IReadOnlyList<string> AdditionalModules { get; set; }
 
         /// <summary>
         /// Flags of features to enable on startup.
         /// </summary>
-        public IReadOnlyList<string> FeatureFlags { get; set; } = null;
+        public IReadOnlyList<string> FeatureFlags { get; set; }
 
         /// <summary>
         /// The console REPL experience to use in the integrated console
@@ -97,12 +97,12 @@ public EditorServicesConfig(
         /// <summary>
         /// Configuration for the language server protocol transport to use.
         /// </summary>
-        public ITransportConfig LanguageServiceTransport { get; set; } = null;
+        public ITransportConfig LanguageServiceTransport { get; set; }
 
         /// <summary>
         /// Configuration for the debug adapter protocol transport to use.
         /// </summary>
-        public ITransportConfig DebugServiceTransport { get; set; } = null;
+        public ITransportConfig DebugServiceTransport { get; set; }
 
         /// <summary>
         /// PowerShell profile locations for Editor Services to use for its profiles.

src/PowerShellEditorServices.Hosting/Configuration/TransportConfig.cs

@@ -49,7 +49,7 @@ public sealed class StdioTransportConfig : ITransportConfig
 
         public string SessionFileTransportName => "Stdio";
 
-        public IReadOnlyDictionary<string, object> SessionFileEntries { get; } = null;
+        public IReadOnlyDictionary<string, object> SessionFileEntries { get; }
 
         public Task<(Stream inStream, Stream outStream)> ConnectStreamsAsync()
         {

src/PowerShellEditorServices/Hosting/EditorServicesServerFactory.cs

@@ -58,7 +58,8 @@ public static EditorServicesServerFactory Create(string logPath, int minimumLogL
             SelfLog.Enable(msg => Debug.WriteLine(msg));
 #endif
 
-            ILoggerFactory loggerFactory = new LoggerFactory().AddSerilog();
+            LoggerFactory loggerFactory = new();
+            loggerFactory.AddSerilog();
 
             // Hook up logging from the host so that its recorded in the log file
             hostLogger.Subscribe(new HostLoggerAdapter(loggerFactory));

src/PowerShellEditorServices/Server/PsesDebugServer.cs

@@ -124,6 +124,7 @@ public void Dispose()
             _debugAdapterServer.Dispose();
             _inputStream.Dispose();
             _outputStream.Dispose();
+            _loggerFactory.Dispose();
             _serverStopped.SetResult(true);
             // TODO: If the debugger has stopped, should we clear the breakpoints?
         }

src/PowerShellEditorServices/Services/Analysis/AnalysisService.cs

@@ -136,7 +136,7 @@ public AnalysisService(
         public void StartScriptDiagnostics(
             ScriptFile[] filesToAnalyze)
         {
-            if (_configurationService.CurrentSettings.ScriptAnalysis.Enable == false)
+            if (!_configurationService.CurrentSettings.ScriptAnalysis.Enable)
             {
                 return;
             }
@@ -468,7 +468,7 @@ private static Hashtable GetCommentHelpRuleSettings(string helpLocation, bool fo
         }
 
         #region IDisposable Support
-        private bool disposedValue = false; // To detect redundant calls
+        private bool disposedValue; // To detect redundant calls
 
         protected virtual void Dispose(bool disposing)
         {

src/PowerShellEditorServices/Services/Analysis/PssaCmdletAnalysisEngine.cs

@@ -258,7 +258,7 @@ public Task<ScriptFileMarker[]> AnalyzeScriptAsync(string scriptContent, Hashtab
         public PssaCmdletAnalysisEngine RecreateWithRules(string[] rules) => new(_logger, _analysisRunspacePool, _pssaModuleInfo, rules);
 
         #region IDisposable Support
-        private bool disposedValue = false; // To detect redundant calls
+        private bool disposedValue; // To detect redundant calls
 
         protected virtual void Dispose(bool disposing)
         {

src/PowerShellEditorServices/Services/PowerShell/Utility/ErrorRecordExtensions.cs

@@ -12,7 +12,7 @@ namespace Microsoft.PowerShell.EditorServices.Services.PowerShell.Utility
 {
     internal static class ErrorRecordExtensions
     {
-        private static readonly Action<PSObject> s_setWriteStreamProperty = null;
+        private static readonly Action<PSObject> s_setWriteStreamProperty;
 
         [SuppressMessage("Performance", "CA1810:Initialize reference type static fields inline", Justification = "cctor needed for version specific initialization")]
         static ErrorRecordExtensions()

src/PowerShellEditorServices/Services/TextDocument/FoldingReference.cs

@@ -20,7 +20,7 @@ internal class FoldingReference : IComparable<FoldingReference>, IEquatable<Fold
         /// <summary>
         /// The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.
         /// </summary>
-        public int StartCharacter { get; set; } = 0;
+        public int StartCharacter { get; set; }
 
         /// <summary>
         /// The zero-based line number where the folded range ends.
@@ -30,7 +30,7 @@ internal class FoldingReference : IComparable<FoldingReference>, IEquatable<Fold
         /// <summary>
         /// The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.
         /// </summary>
-        public int EndCharacter { get; set; } = 0;
+        public int EndCharacter { get; set; }
 
         /// <summary>
         /// Describes the kind of the folding range such as `comment' or 'region'.

src/PowerShellEditorServices/Services/TextDocument/TokenOperations.cs

@@ -13,8 +13,6 @@ namespace Microsoft.PowerShell.EditorServices.Services.TextDocument
     /// </summary>
     internal static class TokenOperations
     {
-        private static readonly FoldingRangeKind? RegionKindNone = null;
-
         // These regular expressions are used to match lines which mark the start and end of region comment in a PowerShell
         // script. They are based on the defaults in the VS Code Language Configuration at;
         // https://github.com/Microsoft/vscode/blob/64186b0a26/extensions/powershell/language-configuration.json#L26-L31
@@ -48,7 +46,7 @@ internal static FoldingReferenceList FoldableReferences(
                     case TokenKind.RCurly:
                         if (tokenCurlyStack.Count > 0)
                         {
-                            refList.SafeAdd(CreateFoldingReference(tokenCurlyStack.Pop(), token, RegionKindNone));
+                            refList.SafeAdd(CreateFoldingReference(tokenCurlyStack.Pop(), token, default));
                         }
                         break;
 
@@ -64,7 +62,7 @@ internal static FoldingReferenceList FoldableReferences(
                     case TokenKind.RParen:
                         if (tokenParenStack.Count > 0)
                         {
-                            refList.SafeAdd(CreateFoldingReference(tokenParenStack.Pop(), token, RegionKindNone));
+                            refList.SafeAdd(CreateFoldingReference(tokenParenStack.Pop(), token, default));
                         }
                         break;
 
@@ -76,7 +74,7 @@ internal static FoldingReferenceList FoldableReferences(
                     case TokenKind.HereStringExpandable:
                         if (token.Extent.StartLineNumber != token.Extent.EndLineNumber)
                         {
-                            refList.SafeAdd(CreateFoldingReference(token, token, RegionKindNone));
+                            refList.SafeAdd(CreateFoldingReference(token, token, default));
                         }
                         break;
                 }

src/PowerShellEditorServices/Services/Workspace/LanguageServerSettings.cs

@@ -383,7 +383,7 @@ public class PesterSettings
         /// <summary>
         /// Whether integration features specific to Pester v5 are enabled
         /// </summary>
-        public bool UseLegacyCodeLens { get; set; } = false;
+        public bool UseLegacyCodeLens { get; set; }
 
         /// <summary>
         /// Update these settings from another settings object

test/PowerShellEditorServices.Test.E2E/Processes/StdioServerProcess.cs

@@ -23,7 +23,9 @@ public class StdioServerProcess : ServerProcess
         /// <summary>
         ///     The current server process (if any).
         /// </summary>
+#pragma warning disable CA2213
         private Process _serverProcess;
+#pragma warning restore CA2213
 
         /// <summary>
         ///     Create a new <see cref="StdioServerProcess"/>.
@@ -55,7 +57,7 @@ protected override void Dispose(bool disposing)
             if (disposing)
             {
                 Process serverProcess = Interlocked.Exchange(ref _serverProcess, null);
-                if (serverProcess != null)
+                if (serverProcess is not null)
                 {
                     if (!serverProcess.HasExited)
                     {
@@ -65,6 +67,7 @@ protected override void Dispose(bool disposing)
                     serverProcess.Dispose();
                 }
             }
+            base.Dispose(disposing);
         }
 
         /// <summary>
@@ -126,7 +129,7 @@ public override Task Stop()
             return ServerExitCompletion.Task;
         }
 
-        public event EventHandler<ProcessExitedArgs> ProcessExited;
+        public event EventHandler<ProcessExitedEventArgs> ProcessExited;
 
         /// <summary>
         ///     Called when the server process has exited.
@@ -147,7 +150,7 @@ private void ServerProcess_Exit(object sender, EventArgs args)
             string errorMsg = serverProcess.StandardError.ReadToEnd();
 
             OnExited();
-            ProcessExited?.Invoke(this, new ProcessExitedArgs(exitCode, errorMsg));
+            ProcessExited?.Invoke(this, new ProcessExitedEventArgs(exitCode, errorMsg));
             if (exitCode != 0)
             {
                 ServerExitCompletion.TrySetException(new ProcessExitedException("Stdio server process exited unexpectedly", exitCode, errorMsg));
@@ -174,9 +177,9 @@ public ProcessExitedException(string message, int exitCode, string errorMessage)
         public string ErrorMessage { get; init; }
     }
 
-    public class ProcessExitedArgs : EventArgs
+    public class ProcessExitedEventArgs : EventArgs
     {
-        public ProcessExitedArgs(int exitCode, string errorMessage)
+        public ProcessExitedEventArgs(int exitCode, string errorMessage)
         {
             ExitCode = exitCode;
             ErrorMessage = errorMessage;

test/PowerShellEditorServices.Test.Shared/Completion/CompleteCommandFromModule.cs

@@ -8,7 +8,7 @@ namespace Microsoft.PowerShell.EditorServices.Test.Shared.Completion
 {
     internal static class CompleteCommandFromModule
     {
-        public static readonly string GetRandomDetail =
+        public const string GetRandomDetail =
             "Get-Random [[-Maximum] <Object>] [-SetSeed <int>] [-Minimum <Object>]";
 
         public static readonly ScriptRegion SourceDetails = new(

test/PowerShellEditorServices.Test.Shared/TestUtilities/TestUtilities.cs

@@ -81,7 +81,7 @@ public static string NormalizeNewlines(string unixString)
         /// <summary>
         /// Not for use in production -- convenience code for debugging tests.
         /// </summary>
-        public static void AWAIT_DEBUGGER_HERE(
+        public static void AwaitDebuggerHere(
             [CallerMemberName] string callerName = null,
             [CallerFilePath] string callerPath = null,
             [CallerLineNumber] int callerLine = -1)

test/PowerShellEditorServices.Test/Debugging/DebugServiceTests.cs

@@ -62,6 +62,7 @@ public DebugServiceTests()
         public void Dispose()
         {
             debugService.Abort();
+            debuggerStoppedQueue.Dispose();
             psesHost.StopAsync().Wait();
             GC.SuppressFinalize(this);
         }
@@ -113,7 +114,7 @@ private void AssertDebuggerStopped(
 
             Assert.True(psesHost.DebugContext.IsStopped);
 
-            if (scriptPath != "")
+            if (!string.IsNullOrEmpty(scriptPath))
             {
                 // TODO: The drive letter becomes lower cased on Windows for some reason.
                 Assert.Equal(scriptPath, eventArgs.ScriptPath, ignoreCase: true);

test/PowerShellEditorServices.Test/Session/PathEscapingTests.cs

@@ -23,7 +23,7 @@ public class PathEscapingTests
         [InlineData("/CJK.chars/脚本/[hello].ps1", "/CJK.chars/脚本/`[hello`].ps1")]
         [InlineData("C:\\Animals\\утка\\quack.ps1", "C:\\Animals\\утка\\quack.ps1")]
         [InlineData("C:\\&nimals\\утка\\qu*ck?.ps1", "C:\\&nimals\\утка\\qu`*ck`?.ps1")]
-        public void CorrectlyWildcardEscapesPaths_NoSpaces(string unescapedPath, string escapedPath)
+        public void CorrectlyWildcardEscapesPathsNoSpaces(string unescapedPath, string escapedPath)
         {
             string extensionEscapedPath = PathUtils.WildcardEscapePath(unescapedPath);
             Assert.Equal(escapedPath, extensionEscapedPath);
@@ -44,7 +44,7 @@ public void CorrectlyWildcardEscapesPaths_NoSpaces(string unescapedPath, string
         [InlineData("/CJK chars/脚本/[hello].ps1", "/CJK` chars/脚本/`[hello`].ps1")]
         [InlineData("C:\\Animal s\\утка\\quack.ps1", "C:\\Animal` s\\утка\\quack.ps1")]
         [InlineData("C:\\&nimals\\утка\\qu*ck?.ps1", "C:\\&nimals\\утка\\qu`*ck`?.ps1")]
-        public void CorrectlyWildcardEscapesPaths_Spaces(string unescapedPath, string escapedPath)
+        public void CorrectlyWildcardEscapesPathsSpaces(string unescapedPath, string escapedPath)
         {
             string extensionEscapedPath = PathUtils.WildcardEscapePath(unescapedPath, escapeSpaces: true);
             Assert.Equal(escapedPath, extensionEscapedPath);

test/PowerShellEditorServices.Test/Session/ScriptFileTests.cs

@@ -377,11 +377,11 @@ public void CanGetRangeAtLineBoundaries()
 
         [Trait("Category", "ScriptFile")]
         [Fact]
-        public void CanSplitLines_NoTrailingNewline() => Assert.Equal(s_testStringLines_noTrailingNewline, _scriptFile_noTrailingNewline.FileLines);
+        public void CanSplitLinesNoTrailingNewline() => Assert.Equal(s_testStringLines_noTrailingNewline, _scriptFile_noTrailingNewline.FileLines);
 
         [Trait("Category", "ScriptFile")]
         [Fact]
-        public void CanSplitLines_TrailingNewline() => Assert.Equal(s_testStringLines_trailingNewline, _scriptFile_trailingNewline.FileLines);
+        public void CanSplitLinesTrailingNewline() => Assert.Equal(s_testStringLines_trailingNewline, _scriptFile_trailingNewline.FileLines);
 
         [Trait("Category", "ScriptFile")]
         [Fact]