Use Microsoft.CodeAnalysis.NetAnalyzers and code-style analyzers (#58)

* Use Microsoft.CodeAnalysis.NetAnalyzers and code-style analyzers

* Fix CA1822 (make static) and CA2000 (dispose before losing scope)

* Fix CA1062 (validate parameter of public method)

* Disable CA2007

* Fix CA1815

* Fix CA1310

* Fix CA1307

* Update AppTests.cs

* Cleanup

* Address review comments

* More cleanup

* Update src/Valet.UnitTests/Models/ManifestTests.cs

* Update src/Valet.UnitTests/Services/DockerServiceTests.cs

* Run dotnet format whitespace

* Disable JSON002

Co-authored-by: Ethan Dennis <ethanis@github.com>
Co-authored-by: Ethan Dennis <erdennis13@gmail.com>

Author: Youssef1313

src/.editorconfig

@@ -0,0 +1,99 @@
+# top-most EditorConfig file
+root = true
+
+# Don't use tabs for indentation.
+[*]
+indent_style = space
+# (Please don't specify an indent_size here; that has too many unintended consequences.)
+
+# Code files
+[*.{cs,csx,vb,vbx}]
+indent_size = 4
+insert_final_newline = true
+charset = utf-8-bom
+
+# XML project files
+[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj}]
+indent_size = 2
+
+# XML config files
+[*.{props,targets,ruleset,config,nuspec,resx,vsixmanifest,vsct}]
+indent_size = 2
+
+# JSON files
+[*.json]
+indent_size = 2
+
+# Powershell files
+[*.ps1]
+indent_size = 2
+
+# Shell script files
+[*.sh]
+end_of_line = lf
+indent_size = 2
+
+# The following applies to unit tests directory only.
+[Valet.UnitTests/**.cs]
+
+# CA1707: Identifiers should not contain underscores
+dotnet_diagnostic.CA1707.severity = none
+
+# The following applies to all files.
+[*.cs]
+
+dotnet_analyzer_diagnostic.category-Style.severity = warning
+
+csharp_style_namespace_declarations = file_scoped
+
+# IDE0008: Use explicit type
+dotnet_diagnostic.IDE0008.severity = none
+
+# IDE0058: Expression value is never used
+dotnet_diagnostic.IDE0058.severity = none
+
+# IDE0022: Use block body for methods
+dotnet_diagnostic.IDE0022.severity = none
+
+# IDE0011: Add braces
+dotnet_diagnostic.IDE0011.severity = none
+
+# IDE0130: Namespace does not match folder structure
+dotnet_diagnostic.IDE0130.severity = none
+
+# JSON002: Probable JSON string detected
+dotnet_diagnostic.JSON002.severity = none
+
+
+# CA2007: Consider calling ConfigureAwait on the awaited task
+dotnet_diagnostic.CA2007.severity = none
+
+# CA1303: Do not pass literals as localized parameters
+dotnet_diagnostic.CA1303.severity = none
+
+# CA1002: Do not expose generic lists
+dotnet_diagnostic.CA1002.severity = none
+
+# CA1724: Type names should not match namespaces
+dotnet_diagnostic.CA1724.severity = none
+
+# CA2227: Collection properties should be read only
+dotnet_diagnostic.CA2227.severity = none
+
+# CA2201: Do not raise reserved exception types
+dotnet_diagnostic.CA2201.severity = none
+
+# CA1065: Do not raise exceptions in unexpected locations
+dotnet_diagnostic.CA1065.severity = none
+
+# CA1031: Do not catch general exception types
+dotnet_diagnostic.CA1031.severity = none
+
+# CA1812: Avoid uninstantiated internal classes
+dotnet_diagnostic.CA1812.severity = none
+
+# CA1815: Override equals and operator equals on value types
+dotnet_diagnostic.CA1815.severity = none
+
+# CA1014: Mark assemblies with CLSCompliant
+dotnet_diagnostic.CA1014.severity = none

src/Directory.Build.props

@@ -0,0 +1,12 @@
+<Project>
+
+  <PropertyGroup>
+    <AnalysisLevel>latest</AnalysisLevel>
+    <AnalysisMode>AllEnabledByDefault</AnalysisMode>
+    <EnableNETAnalyzers>true</EnableNETAnalyzers>
+    <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
+    <Nullable>enable</Nullable>
+    <Features>strict</Features>
+  </PropertyGroup>
+
+</Project>

src/Valet.UnitTests/AppTests.cs

@@ -1,10 +1,9 @@
-using System;
+using System;
 using System.IO;
 using System.Threading.Tasks;
 using Moq;
 using NUnit.Framework;
 using Valet.Interfaces;
-using Valet.Services;
 
 namespace Valet.UnitTests;
 
@@ -16,6 +15,7 @@ public class AppTests
     private Mock<IDockerService> _dockerService;
     private Mock<IConfigurationService> _configurationService;
     private App _app;
+    private TextWriter _out;
 #pragma warning restore CS8618
 
     [SetUp]
@@ -25,6 +25,13 @@ public void BeforeEachTest()
         _processService = new Mock<IProcessService>();
         _configurationService = new Mock<IConfigurationService>();
         _app = new App(_dockerService.Object, _processService.Object, _configurationService.Object);
+        _out = Console.Out;
+    }
+
+    [TearDown]
+    public void AfterEachTest()
+    {
+        Console.SetOut(_out);
     }
 
     [TestCase("4256ea72fd01deac3e967f6b19f907587dcd6f0a976301f1aecc73dc6f146a4a", "4256ea72fd01deac3e967f6b19f907587dcd6f0a976301f1aecc73dc6f146a4a", "")]
@@ -35,7 +42,7 @@ public async Task CheckForUpdates_NoUpdatesNeeded(string? latestImage, string? c
         var image = "valet-customers/valet-cli";
         var server = "ghcr.io";
 
-        var stringWriter = new StringWriter();
+        using var stringWriter = new StringWriter();
         Console.SetOut(stringWriter);
 
         _dockerService.Setup(handler =>
@@ -61,7 +68,7 @@ public async Task CheckForUpdates_RaisesCaughtException()
         var image = "valet-customers/valet-cli";
         var server = "ghcr.io";
 
-        var stringWriter = new StringWriter();
+        using var stringWriter = new StringWriter();
         Console.SetOut(stringWriter);
 
         _dockerService.Setup(handler =>
@@ -75,4 +82,4 @@ public async Task CheckForUpdates_RaisesCaughtException()
         Assert.AreEqual("", stringWriter.ToString());
         _processService.VerifyAll();
     }
-}
+}

src/Valet.UnitTests/Models/ManifestTests.cs

@@ -1,5 +1,4 @@
-using System.Text.Json;
-using Moq;
+using System.Text.Json;
 using NUnit.Framework;
 using Valet.Models.Docker;
 
@@ -8,7 +7,7 @@ namespace Valet.UnitTests;
 [TestFixture]
 public class ManifestTests
 {
-    private string manifestResult = @"
+    private readonly string manifestResult = @"
 {
         ""schemaVersion"": 2,
         ""mediaType"": ""application/vnd.docker.distribution.manifest.v2+json"",
@@ -84,4 +83,4 @@ public void GetDigest()
 
         Assert.AreEqual("4256ea72fd01deac3e967f6b19f907587dcd6f0a976301f1aecc73dc6f146a4a", manifest?.GetDigest());
     }
-}
+}

src/Valet.UnitTests/Models/StringExtensionsTests.cs

@@ -1,4 +1,4 @@
-using NUnit.Framework;
+using NUnit.Framework;
 using Valet.Models;
 
 namespace Valet.UnitTests.Models;
@@ -12,4 +12,4 @@ public void EscapeIfNeeded_ReturnsExpected(string input, string expected)
     {
         Assert.AreEqual(expected, input.EscapeIfNeeded());
     }
-}
+}

src/Valet.UnitTests/Models/VariableTests.cs

@@ -1,4 +1,4 @@
-using NUnit.Framework;
+using NUnit.Framework;
 using Valet.Models;
 
 namespace Valet.UnitTests.Models;
@@ -45,4 +45,4 @@ public void Placeholder_ReturnsExpected(bool isPassword, string? defaultValue, s
         // Act
         Assert.AreEqual(expectedPlaceholder, variable.Placeholder);
     }
-}
+}

src/Valet.UnitTests/Services/ConfigurationServiceTests.cs

@@ -1,5 +1,4 @@
-using System;
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.Collections.Immutable;
 using System.IO;
 using System.Threading.Tasks;
@@ -98,4 +97,4 @@ public async Task ReadCurrentVariablesAsync_FileExists_ReturnsVariables()
         // Assert
         Assert.AreEqual(expectedResult, result);
     }
-}
+}

src/Valet.UnitTests/Services/DockerServiceTests.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.IO;
 using System.Threading.Tasks;
@@ -157,7 +157,7 @@ public async Task ExecuteCommandAsync_InvokesDocker_ReturnsTrue()
                 "docker",
                 $"run --rm -t -v \"{Directory.GetCurrentDirectory()}\":/data {server}/{image}:{version} {string.Join(' ', arguments)}",
                 Directory.GetCurrentDirectory(),
-                new[] { new System.ValueTuple<string, string>("MSYS_NO_PATHCONV", "1") },
+                new[] { new ValueTuple<string, string>("MSYS_NO_PATHCONV", "1") },
                 true,
                 null
             )
@@ -188,7 +188,7 @@ public async Task ExecuteCommandAsync_InvokesDocker_WithEnvironmentVariables_Ret
                 "docker",
                 $"run --rm -t --env GITHUB_ACCESS_TOKEN=foo --env GITHUB_INSTANCE_URL=https://github.fabrikam.com --env JENKINS_ACCESS_TOKEN=bar -v \"{Directory.GetCurrentDirectory()}\":/data {server}/{image}:{version} {string.Join(' ', arguments)}",
                 Directory.GetCurrentDirectory(),
-                new[] { new System.ValueTuple<string, string>("MSYS_NO_PATHCONV", "1") },
+                new[] { new ValueTuple<string, string>("MSYS_NO_PATHCONV", "1") },
                 true,
                 null
             )
@@ -217,7 +217,7 @@ public async Task ExecuteCommandAsync_InvokesDocker_WithAdditionalDockerArgument
                 "docker",
                 $"run --rm -t --network=host -v \"{Directory.GetCurrentDirectory()}\":/data {server}/{image}:{version} {string.Join(' ', arguments)}",
                 Directory.GetCurrentDirectory(),
-                new[] { new System.ValueTuple<string, string>("MSYS_NO_PATHCONV", "1") },
+                new[] { new ValueTuple<string, string>("MSYS_NO_PATHCONV", "1") },
                 true,
                 null
             )
@@ -422,4 +422,4 @@ public async Task GetLatestImageDigest_ParsesDigestCorrectly()
         Assert.AreEqual("4256ea72fd01deac3e967f6b19f907587dcd6f0a976301f1aecc73dc6f146a4a", result);
         _processService.VerifyAll();
     }
-}
+}

src/Valet.UnitTests/Valet.UnitTests.csproj

@@ -2,7 +2,6 @@
 
     <PropertyGroup>
         <TargetFramework>net6.0</TargetFramework>
-        <Nullable>enable</Nullable>
 
         <IsPackable>false</IsPackable>
     </PropertyGroup>

src/Valet/App.cs

@@ -1,12 +1,12 @@
-using Valet.Interfaces;
+using Valet.Interfaces;
 using Valet.Models;
 
 namespace Valet;
 
 public class App
 {
-    const string ValetImage = "valet-customers/valet-cli";
-    const string ValetContainerRegistry = "ghcr.io";
+    private const string ValetImage = "valet-customers/valet-cli";
+    private const string ValetContainerRegistry = "ghcr.io";
 
     private readonly IDockerService _dockerService;
     private readonly IProcessService _processService;
@@ -64,7 +64,7 @@ public async Task<int> GetVersionAsync()
 
         var formattedGhVersion = ghVersion.Split(Environment.NewLine, StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries).FirstOrDefault();
         var formattedGhValetVersion = ghValetVersion.Split(Environment.NewLine, StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries)
-            .FirstOrDefault(x => x.Contains("github/gh-valet"));
+            .FirstOrDefault(x => x.Contains("github/gh-valet", StringComparison.Ordinal));
         var formattedValetVersion = valetVersion.Split(Environment.NewLine, StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries).FirstOrDefault() ?? "unknown";
 
         Console.WriteLine(formattedGhVersion);
@@ -83,10 +83,10 @@ public async Task CheckForUpdatesAsync()
 
             await Task.WhenAll(latestImageDigestTask, currentImageDigestTask);
 
-            var latestImageDigest = latestImageDigestTask?.Result;
-            var currentImageDigest = currentImageDigestTask?.Result;
+            var latestImageDigest = await latestImageDigestTask;
+            var currentImageDigest = await currentImageDigestTask;
 
-            if (latestImageDigest != null && currentImageDigest != null && !latestImageDigest.Equals(currentImageDigest))
+            if (latestImageDigest != null && currentImageDigest != null && !latestImageDigest.Equals(currentImageDigest, StringComparison.Ordinal))
             {
                 Console.WriteLine("A new version of the Valet CLI is available. Run 'gh valet update' to update.");
             }
@@ -108,4 +108,4 @@ public async Task<int> ConfigureAsync()
         Console.WriteLine("Environment variables successfully updated.");
         return 0;
     }
-}
+}