Merge pull request #243 from xt0rted/dotnet-8

xt0rted · web-flow · commit 43987e5aa81c · 2024-04-09T23:34:14.000-04:00
Target .net 8
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,9 +2,9 @@
 
 ## Unreleased
 
-> [!NOTE]
-> This version drops support for .NET Core 3.1 which is no longer supported
-
+- Dropped support for .NET Core 3.1
+- Dropped Support for .NET 6
+- Added support for .NET 8
 - Adjusted globbing so `:` acts like a path separator ([#131](https://github.com/xt0rted/dotnet-run-script/pull/131))
   - `foo:*` will match `foo:bar` but not `foo:bar:baz`
   - `foo:*:baz` will match `foo:bar:baz`
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -1,11 +1,12 @@
 <Project>
 
   <PropertyGroup>
-    <TargetFrameworks>net6.0</TargetFrameworks>
+    <TargetFramework>net8.0</TargetFramework>
     <LangVersion>latest</LangVersion>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <IsPackable>false</IsPackable>
+    <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
   </PropertyGroup>
 
   <PropertyGroup>
diff --git a/README.md b/README.md
@@ -138,7 +138,7 @@ Arguments passed after the double dash are passed through to each executing scri
 In this example both the `--configuration` and `--framework` options will be passed to each of the four scripts when running them.
 
 ```console
-dotnet r build test:unit test:integration package -- --configuration Release --framework net6.0
+dotnet r build test:unit test:integration package -- --configuration Release --framework net8.0
 ```
 
 ### Globbing or wildcard support
diff --git a/analysis/roslynator.editorconfig b/analysis/roslynator.editorconfig
@@ -559,9 +559,6 @@ dotnet_diagnostic.RCS1174.severity = error
 # RCS1175: Unused 'this' parameter
 dotnet_diagnostic.RCS1175.severity = error
 
-# RCS1176: Use 'var' instead of explicit type (when the type is not obvious)
-dotnet_diagnostic.RCS1176.severity = error
-
 # RCS1177: Use 'var' instead of explicit type (in foreach)
 dotnet_diagnostic.RCS1177.severity = error
 
@@ -778,6 +775,9 @@ dotnet_diagnostic.RCS1253.severity = error
 # RCS1254: Normalize format of enum flag value
 dotnet_diagnostic.RCS1254.severity = error
 
+# RCS1264: Use 'var' or explicit type
+dotnet_diagnostic.RCS1264.severity = error
+
 # RCS9001: Use pattern matching
 dotnet_diagnostic.RCS9001.severity = error
 
diff --git a/global.json b/global.json
@@ -1,8 +1,7 @@
 {
   "sdk": {
-    "version": "6.0.420"
+    "version": "8.0.203"
   },
-  //"scriptShell": "pwsh",
   "scripts": {
     // project scripts
     "clean": "dotnet r clean:*",
@@ -12,7 +11,6 @@
     "build": "dotnet build",
 
     "test": "dotnet test",
-    "test:6": "dotnet r test -- --framework net6.0",
 
     "test:unit": "dotnet r test -- --filter \"category=unit\"",
     "test:int": "dotnet r test -- --filter \"category=integration\"",
diff --git a/src/ArgumentBuilder.cs b/src/ArgumentBuilder.cs
@@ -1,3 +1,6 @@
+#pragma warning disable IDISP001 // Dispose created
+#pragma warning disable IDISP003 // Dispose previous before re-assigning
+
 namespace RunScript;
 
 using System.Runtime.CompilerServices;
@@ -79,13 +82,13 @@ public static string EscapeAndConcatenateCommandAndArgArrayForCmdProcessStart(
     }
 
     /// <summary>
-    /// Concatinates the command and arguments without any escaping.
+    /// Concatenates the command and arguments without any escaping.
     /// This is meant to be used for display only and not for passing to a new process.
     /// </summary>
     /// <param name="command">The base command.</param>
     /// <param name="args">List of optional arguments.</param>
-    /// <returns>A raw concatination of the <paramref name="command"/> and <paramref name="args"/>.</returns>
-    public static string ConcatinateCommandAndArgArrayForDisplay(
+    /// <returns>A raw concatenation of the <paramref name="command"/> and <paramref name="args"/>.</returns>
+    public static string ConcatenateCommandAndArgArrayForDisplay(
         string? command,
         string[]? args)
     {
diff --git a/src/CommandBuilder.cs b/src/CommandBuilder.cs
@@ -2,11 +2,8 @@ namespace RunScript;
 
 using System.Text.RegularExpressions;
 
-internal class CommandBuilder
+internal partial class CommandBuilder
 {
-    // This is the same regex used by npm's run-script library
-    public static readonly Regex IsCmdCheck = new("(?:^|\\\\)cmd(?:\\.exe)?$", RegexOptions.IgnoreCase);
-
     private readonly IConsoleWriter _writer;
     private readonly IEnvironment _environment;
     private readonly Project _project;
@@ -31,6 +28,10 @@ public CommandBuilder(
 
     public ProcessContext? ProcessContext { get; private set; }
 
+    // This is the same regex used by npm's run-script library
+    [GeneratedRegex("(?:^|\\\\)cmd(?:\\.exe)?$", RegexOptions.IgnoreCase)]
+    public static partial Regex IsCmdCheck();
+
     public void SetUpEnvironment(string? scriptShellOverride)
     {
         var (scriptShell, isCmd) = GetScriptShell(scriptShellOverride ?? _project.ScriptShell);
@@ -61,7 +62,7 @@ public ICommandGroupRunner CreateGroupRunner(CancellationToken cancellationToken
             ? _environment.GetEnvironmentVariable("COMSPEC") ?? "cmd"
             : "sh";
 
-        var isCmd = IsCmdCheck.IsMatch(shell);
+        var isCmd = IsCmdCheck().IsMatch(shell);
 
         return (shell, isCmd);
     }
diff --git a/src/CommandGroupRunner.cs b/src/CommandGroupRunner.cs
@@ -36,7 +36,11 @@ public virtual ICommandRunner BuildCommand()
 
     public async Task<int> RunAsync(string name, string[]? scriptArgs)
     {
-        var scriptNames = ImmutableArray.Create(new[] { "pre" + name, name, "post" + name });
+        var scriptNames = ImmutableArray.Create([
+            "pre" + name,
+            name,
+            "post" + name,
+        ]);
 
         foreach (var subScript in scriptNames.Where(scriptName => _scripts.ContainsKey(scriptName) || scriptName == "env"))
         {
diff --git a/src/CommandRunner.cs b/src/CommandRunner.cs
@@ -25,7 +25,7 @@ public async Task<int> RunAsync(string name, string cmd, string[]? args)
     {
         _cancellationToken.ThrowIfCancellationRequested();
 
-        _writer.Banner(name, ArgumentBuilder.ConcatinateCommandAndArgArrayForDisplay(cmd, args));
+        _writer.Banner(name, ArgumentBuilder.ConcatenateCommandAndArgArrayForDisplay(cmd, args));
 
         using (var process = new Process())
         {
@@ -36,6 +36,7 @@ public async Task<int> RunAsync(string name, string cmd, string[]? args)
 
             var outStream = new StreamForwarder();
             var errStream = new StreamForwarder();
+
             Task? taskOut = null;
             Task? taskErr = null;
 
diff --git a/src/GlobalCommands.cs b/src/GlobalCommands.cs
@@ -3,7 +3,7 @@ namespace RunScript;
 internal static class GlobalCommands
 {
     /// <summary>
-    /// The help command that lists all the scripts availble in the <g>global.json</g>.
+    /// The help command that lists all the scripts available in the <g>global.json</g>.
     /// </summary>
     /// <param name="writer">The console logger instance to use.</param>
     /// <param name="scripts">The project's scripts.</param>
@@ -28,7 +28,7 @@ public static void PrintAvailableScripts(IConsoleWriter writer, IDictionary<stri
     /// <exception cref="ArgumentNullException"></exception>
     public static void PrintEnvironmentVariables(IConsoleWriter writer, IEnvironment environment)
     {
-        if (environment is null) throw new ArgumentNullException(nameof(environment));
+        ArgumentNullException.ThrowIfNull(environment);
 
         writer.Banner("env");
 
diff --git a/src/ProjectLoader.cs b/src/ProjectLoader.cs
@@ -2,11 +2,18 @@ namespace RunScript;
 
 using System.Text.Json;
 
-internal class ProjectLoader
+internal static class ProjectLoader
 {
-    public async Task<(Project, string)> LoadAsync(string executingDirectory)
+    private static readonly JsonSerializerOptions _jsonOptions = new()
+    {
+        PropertyNameCaseInsensitive = true,
+        ReadCommentHandling = JsonCommentHandling.Skip,
+    };
+
+    public static async Task<(Project, string)> LoadAsync(string executingDirectory)
     {
         var jsonPath = CheckFolderForFile(executingDirectory, "global.json");
+
         if (jsonPath is null)
         {
             throw new RunScriptException("No global.json found in folder path");
@@ -18,6 +25,7 @@ internal class ProjectLoader
             : executingDirectory;
 
         var project = await LoadGlobalJsonAsync(jsonPath);
+
         if (project is null)
         {
             throw new RunScriptException("Error parsing global.json");
@@ -31,15 +39,17 @@ internal class ProjectLoader
         return (project, workingDirectory);
     }
 
-    private string? CheckFolderForFile(string path, string file)
+    private static string? CheckFolderForFile(string path, string file)
     {
         var filePath = Path.Combine(path, file);
+
         if (File.Exists(filePath))
         {
             return filePath;
         }
 
         var parentPath = Directory.GetParent(path)?.FullName;
+
         if (parentPath is null)
         {
             return null;
@@ -56,11 +66,7 @@ internal class ProjectLoader
         {
             return JsonSerializer.Deserialize<Project>(
                 json,
-                new JsonSerializerOptions
-                    {
-                        PropertyNameCaseInsensitive = true,
-                        ReadCommentHandling = JsonCommentHandling.Skip,
-                    });
+                _jsonOptions);
         }
         catch
         {
diff --git a/src/RunScriptCommand.cs b/src/RunScriptCommand.cs
@@ -39,14 +39,14 @@ public int Invoke(InvocationContext context)
 
     public async Task<int> InvokeAsync(InvocationContext context)
     {
-        if (context is null) throw new ArgumentNullException(nameof(context));
+        ArgumentNullException.ThrowIfNull(context);
 
         var ifPresent = context.ParseResult.GetValueForOption(GlobalOptions.IfPresent);
         var scriptShell = context.ParseResult.GetValueForOption(GlobalOptions.ScriptShell);
         var verbose = context.ParseResult.GetValueForOption(GlobalOptions.Verbose);
         var scripts = context.ParseResult.GetValueForArgument(GlobalArguments.Scripts);
 
-        IConsoleWriter writer = new ConsoleWriter(context.Console, _consoleFormatProvider, verbose);
+        var writer = new ConsoleWriter(context.Console, _consoleFormatProvider, verbose);
 
         writer.VerboseBanner();
 
@@ -55,7 +55,7 @@ public async Task<int> InvokeAsync(InvocationContext context)
         {
             _environment.SetEnvironmentVariable("INIT_CWD", _workingDirectory);
 
-            (project, _workingDirectory) = await new ProjectLoader().LoadAsync(_workingDirectory);
+            (project, _workingDirectory) = await ProjectLoader.LoadAsync(_workingDirectory);
         }
         catch (Exception ex)
         {
@@ -157,7 +157,7 @@ internal static List<ScriptResult> FindScripts(
                     Evaluation =
                     {
                         CaseInsensitive = true,
-                    }
+                    },
                 });
 
             foreach (var projectScript in projectScripts.Keys)
diff --git a/src/RunScriptException.cs b/src/RunScriptException.cs
@@ -1,7 +1,5 @@
 namespace RunScript;
 
-using System.Runtime.Serialization;
-
 public class RunScriptException : Exception
 {
     public RunScriptException()
@@ -17,9 +15,4 @@ public RunScriptException(string? message, Exception? innerException)
         : base(message, innerException)
     {
     }
-
-    protected RunScriptException(SerializationInfo info, StreamingContext context)
-        : base(info, context)
-    {
-    }
 }
diff --git a/src/StreamForwarder.cs b/src/StreamForwarder.cs
@@ -5,7 +5,7 @@ namespace RunScript;
 // https://github.com/dotnet/sdk/blob/a758a468b71e15303198506a8de1040649aa0f35/src/Cli/Microsoft.DotNet.Cli.Utils/StreamForwarder.cs
 internal sealed class StreamForwarder
 {
-    private static readonly char[] _ignoreCharacters = { '\r' };
+    private static readonly char[] _ignoreCharacters = ['\r'];
 
     private const char FlushBuilderCharacter = '\n';
 
@@ -53,7 +53,7 @@ public Task BeginReadAsync(TextReader reader)
 
     public void Read(TextReader reader)
     {
-        if (reader is null) throw new ArgumentNullException(nameof(reader));
+        ArgumentNullException.ThrowIfNull(reader);
 
         const int bufferSize = 1;
 
diff --git a/src/ValueStringBuilder.cs b/src/ValueStringBuilder.cs
@@ -1,3 +1,4 @@
+#pragma warning disable IDISP008 // Don't assign member with injected and created disposables
 #pragma warning disable RCS1162 // Avoid chain of assignments.
 
 namespace RunScript;
@@ -24,7 +25,7 @@ public ValueStringBuilder(Span<char> initialBuffer)
         _pos = 0;
     }
 
-    public int Length => _pos;
+    public readonly int Length => _pos;
 
     public override string ToString()
     {
diff --git a/src/run-script.csproj b/src/run-script.csproj
@@ -47,10 +47,6 @@
 
   <ItemGroup>
     <PackageReference Include="DotNet.Glob" Version="3.1.3" />
-    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1">
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
-      <PrivateAssets>all</PrivateAssets>
-    </PackageReference>
     <PackageReference Include="System.CommandLine" Version="2.0.0-beta4.22272.1" />
     <PackageReference Include="System.CommandLine.Rendering" Version="0.4.0-alpha.22272.1" />
   </ItemGroup>
diff --git a/test/.editorconfig b/test/.editorconfig
@@ -1,4 +1,10 @@
 [*.cs]
+# CA1861: Avoid constant arrays as arguments
+dotnet_diagnostic.CA1861.severity = none
+
+# IDISP001: Dispose created
+dotnet_diagnostic.IDISP001.severity = none
+
 # IDE0022: Use expression body for methods
 dotnet_diagnostic.IDE0022.severity = none
 
diff --git a/test/ArgumentBuilderTests.cs b/test/ArgumentBuilderTests.cs
@@ -18,7 +18,7 @@ public class ArgumentBuilderTests
     [InlineData("c m d", new[] { @"C:\Program Files\dotnet\" }, @"c m d ""C:\Program Files\dotnet\""")]
     [InlineData("c m d", new[] { @"backslash\""preceedingquote" }, @"c m d ""backslash\\\""preceedingquote""")]
     [InlineData("c m d", new[] { @""" hello """ }, @"c m d ""\"" hello \""""")]
-    public void EscapeAndConcatenateCommandAndArgArrayForProcessStart(string command, string[] args, string expected)
+    public void EscapeAndConcatenateCommandAndArgArrayForProcessStart(string command, string[]? args, string expected)
     {
         // Given / When
         var result = ArgumentBuilder.EscapeAndConcatenateCommandAndArgArrayForProcessStart(command, args);
@@ -41,7 +41,7 @@ public void EscapeAndConcatenateCommandAndArgArrayForProcessStart(string command
     [InlineData("c m d", new[] { @"C:\Program Files\dotnet\" }, @"c m d^ ^""^C^:^\^P^r^o^g^r^a^m^ ^F^i^l^e^s^\^d^o^t^n^e^t^\^""")]
     [InlineData("c m d", new[] { @"backslash\""preceedingquote" }, @"c m d^ ^b^a^c^k^s^l^a^s^h^\^""^p^r^e^c^e^e^d^i^n^g^q^u^o^t^e")]
     [InlineData("c m d", new[] { @""" hello """ }, @"c m d^ ^""^""^ ^h^e^l^l^o^ ^""^""")]
-    public void EscapeAndConcatenateCommandAndArgArrayForCmdProcessStart(string command, string[] args, string expected)
+    public void EscapeAndConcatenateCommandAndArgArrayForCmdProcessStart(string command, string[]? args, string expected)
     {
         // Given / When
         var result = ArgumentBuilder.EscapeAndConcatenateCommandAndArgArrayForCmdProcessStart(command, args);
@@ -62,10 +62,10 @@ public void EscapeAndConcatenateCommandAndArgArrayForCmdProcessStart(string comm
     [InlineData(new[] { @"C:\Program Files\dotnet\" }, @"c m d C:\Program Files\dotnet\")]
     [InlineData(new[] { @"backslash\""preceedingquote" }, @"c m d backslash\""preceedingquote")]
     [InlineData(new[] { @""" hello """ }, @"c m d "" hello """)]
-    public void ConcatinateCommandAndArgArrayForDisplay(string[] args, string expected)
+    public void ConcatinateCommandAndArgArrayForDisplay(string[]? args, string expected)
     {
         // Given / When
-        var result = ArgumentBuilder.ConcatinateCommandAndArgArrayForDisplay("c m d", args);
+        var result = ArgumentBuilder.ConcatenateCommandAndArgArrayForDisplay("c m d", args);
 
         // Then
         result.ShouldBe(expected);
diff --git a/test/CommandBuilderTests.cs b/test/CommandBuilderTests.cs
@@ -18,7 +18,7 @@ public class CommandBuilderTests
     public void IsCmdCheck_should_match_cmd_variations(string shell)
     {
         // Given / When / Then
-        CommandBuilder.IsCmdCheck.IsMatch(shell).ShouldBeTrue();
+        CommandBuilder.IsCmdCheck().IsMatch(shell).ShouldBeTrue();
     }
 
     [Theory]
@@ -27,7 +27,7 @@ public void IsCmdCheck_should_match_cmd_variations(string shell)
     public void IsCmdCheck_should_not_match_non_cmd_variations(string shell)
     {
         // Given / When / Then
-        CommandBuilder.IsCmdCheck.IsMatch(shell).ShouldBeFalse();
+        CommandBuilder.IsCmdCheck().IsMatch(shell).ShouldBeFalse();
     }
 
     [Theory]
diff --git a/test/Integration/CommandBuilderTests.cs b/test/Integration/CommandBuilderTests.cs
diff --git a/test/ProjectLoaderTests.cs b/test/ProjectLoaderTests.cs
diff --git a/test/RunScriptCommandTests.cs b/test/RunScriptCommandTests.cs

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,11 @@ public virtual ICommandRunner BuildCommand()`
`36`	`36`
`37`	`37`	`public async Task<int> RunAsync(string name, string[]? scriptArgs)`
`38`	`38`	`{`
`39`		`- var scriptNames = ImmutableArray.Create(new[] { "pre" + name, name, "post" + name });`
	`39`	`+ var scriptNames = ImmutableArray.Create([`
	`40`	`+ "pre" + name,`
	`41`	`+ name,`
	`42`	`+ "post" + name,`
	`43`	`+ ]);`
`40`	`44`
`41`	`45`	`foreach (var subScript in scriptNames.Where(scriptName => _scripts.ContainsKey(scriptName) \|\| scriptName == "env"))`
`42`	`46`	`{`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ public async Task<int> RunAsync(string name, string cmd, string[]? args)`
`25`	`25`	`{`
`26`	`26`	`_cancellationToken.ThrowIfCancellationRequested();`
`27`	`27`
`28`		`- _writer.Banner(name, ArgumentBuilder.ConcatinateCommandAndArgArrayForDisplay(cmd, args));`
	`28`	`+ _writer.Banner(name, ArgumentBuilder.ConcatenateCommandAndArgArrayForDisplay(cmd, args));`
`29`	`29`
`30`	`30`	`using (var process = new Process())`
`31`	`31`	`{`
`@@ -36,6 +36,7 @@ public async Task<int> RunAsync(string name, string cmd, string[]? args)`
`36`	`36`
`37`	`37`	`var outStream = new StreamForwarder();`
`38`	`38`	`var errStream = new StreamForwarder();`
	`39`	`+`
`39`	`40`	`Task? taskOut = null;`
`40`	`41`	`Task? taskErr = null;`
`41`	`42`