Merge pull request #338 from kindermannhubert/improvedHelp

Improved and colorized help output + code quality improvements.

Author: kindermannhubert

CSharpRepl.Services/Configuration.cs

@@ -37,11 +37,11 @@ public sealed class Configuration
         Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location) ??
         Environment.CurrentDirectory;
 
-    public static readonly IReadOnlyCollection<string> SymbolServers = new[]
-    {
+    public static readonly IReadOnlyCollection<string> SymbolServers =
+    [
         "https://symbols.nuget.org/download/symbols/",
         "http://msdl.microsoft.com/download/symbols/"
-    };
+    ];
 
     public HashSet<string> References { get; }
     public HashSet<string> Usings { get; }
@@ -84,8 +84,8 @@ public Configuration(
         OpenAIConfiguration? openAIConfiguration = null,
         string? cultureName = null)
     {
-        References = references?.ToHashSet() ?? new HashSet<string>();
-        Usings = usings?.ToHashSet() ?? new HashSet<string>();
+        References = references?.ToHashSet() ?? [];
+        Usings = usings?.ToHashSet() ?? [];
         Framework = framework ?? FrameworkDefault;
         Trace = trace;
         UseTerminalPaletteTheme = useTerminalPaletteTheme;
@@ -136,7 +136,7 @@ public Configuration(
         StreamPipedInput = streamPipedInput;
         TabSize = tabSize;
         LoadScript = loadScript;
-        LoadScriptArgs = loadScriptArgs ?? Array.Empty<string>();
+        LoadScriptArgs = loadScriptArgs ?? [];
         OutputForEarlyExit = outputForEarlyExit;
         OpenAIConfiguration = openAIConfiguration;
         var triggerCompletionList =
@@ -148,19 +148,19 @@ public Configuration(
 
         if (submitPromptKeyPatterns?.Any() != true)
         {
-            submitPromptKeyPatterns = new[] { "Enter" };
+            submitPromptKeyPatterns = ["Enter"];
         }
         if (submitPromptDetailedKeyPatterns?.Any() != true)
         {
-            submitPromptDetailedKeyPatterns = new[] { "Ctrl+Enter", "Ctrl+Alt+Enter" };
+            submitPromptDetailedKeyPatterns = ["Ctrl+Enter", "Ctrl+Alt+Enter"];
         }
 
         var submitPrompt = ParseKeyPressPatterns(submitPromptKeyPatterns.Concat(submitPromptDetailedKeyPatterns).ToArray());
         SubmitPromptDetailedKeys = ParseKeyPressPatterns(submitPromptDetailedKeyPatterns);
 
         var commitCompletion = new KeyPressPatterns(
             CompletionRules.Default.DefaultCommitCharacters.Select(c => new KeyPressPattern(c))
-            .Concat(new KeyPressPattern[] { new(ConsoleKey.Enter), new(ConsoleKey.Tab) })
+            .Concat([new(ConsoleKey.Enter), new(ConsoleKey.Tab)])
             .ToArray());
 
         KeyBindings = new(

CSharpRepl.Services/Disassembly/Disassembler.cs

@@ -35,8 +35,8 @@ public Disassembler(CSharpCompilationOptions compilationOptions, AssemblyReferen
         this.referenceService = referenceService;
 
         // we will try to compile the user's code several different ways. The first one that succeeds will be used.
-        this.compilers = new (string name, CompileDelegate compile)[]
-        {
+        this.compilers =
+        [
             // "console application" will work for standalone statements, due to C#'s top-level statement feature.
             (name: "Console Application (with top-level statements)",
              compile: (code, optimizationLevel) => Compile(code, optimizationLevel, OutputKind.ConsoleApplication)),
@@ -46,7 +46,7 @@ public Disassembler(CSharpCompilationOptions compilationOptions, AssemblyReferen
             // Compiling as a script will work for most other cases, but it's quite verbose so we use it as a last resort.
             (name: "Scripting session (will be overly verbose)",
              compile: (code, optimizationLevel) => scriptRunner.CompileTransient(code, optimizationLevel))
-        };
+        ];
     }
 
     public EvaluationResult Disassemble(string code, bool debugMode)
@@ -88,7 +88,7 @@ public EvaluationResult Disassemble(string code, bool debugMode)
                         .Select(line => line.TrimEnd()) // output has trailing spaces on some lines, clean those up
                     )
                     + string.Join('\n', commentFooter);
-                return new EvaluationResult.Success(code, ilCode, Array.Empty<MetadataReference>());
+                return new EvaluationResult.Success(code, ilCode, []);
             }
 
             // failure, we couldn't compile it, move on to the next compiler configuration.
@@ -118,7 +118,7 @@ private static PlainTextOutput DisassembleFile(PEFile file)
         var asmReader = asm.GetMetadataReader();
         var definedTypes = asmReader.TypeDefinitions.ToArray();
         var definedTypeNames = definedTypes.Select(t => asmReader.GetString(asmReader.GetTypeDefinition(t).Name)).ToArray();
-        if (definedTypeNames.Except(new[] { "<Module>", "Program", "RefSafetyRulesAttribute", "EmbeddedAttribute" }).Any())
+        if (definedTypeNames.Except(["<Module>", "Program", "RefSafetyRulesAttribute", "EmbeddedAttribute"]).Any())
         {
             new ReflectionDisassembler(ilCodeOutput, CancellationToken.None).WriteModuleContents(file); // writes to the "ilCodeOutput" variable
             return ilCodeOutput;
@@ -133,7 +133,7 @@ private static PlainTextOutput DisassembleFile(PEFile file)
         var programType = asmReader.GetTypeDefinition(definedTypes[programTypeIndex]);
         var methods = programType.GetMethods().ToArray();
         var methodNames = methods.Select(m => asmReader.GetString(asmReader.GetMethodDefinition(m).Name)).ToArray();
-        if (methodNames.Except(new[] { "<Main>$", ".ctor" }).Any())
+        if (methodNames.Except(["<Main>$", ".ctor"]).Any())
         {
             return DisassembleAll(file, ilCodeOutput);
         }
@@ -153,7 +153,7 @@ private Compilation Compile(string code, OptimizationLevel optimizationLevel, Ou
     {
         var ast = CSharpSyntaxTree.ParseText(code, new CSharpParseOptions(LanguageVersion.Latest));
         var compilation = CSharpCompilation.Create("CompilationForDisassembly",
-            new[] { ast },
+            [ast],
             referenceService.LoadedReferenceAssemblies,
             compilationOptions
                 .WithOutputKind(outputKind)

CSharpRepl.Services/Dotnet/DotnetBuilder.cs

@@ -36,7 +36,7 @@ public DotnetBuilder(IConsoleEx console)
 
     private Process StartBuild(string path, out List<string> output)
     {
-        output = new List<string>();
+        output = [];
         var process = new Process
         {
             StartInfo =

CSharpRepl.Services/Extensions/KeyExtensions.cs

@@ -6,15 +6,14 @@ namespace CSharpRepl.Services.Extensions;
 
 public static class KeyExtensions
 {
-    private static string GetStringValue(this KeyPressPattern pattern)
+    public static string GetStringValue(this KeyPressPattern pattern)
     {
         if (pattern.Key != default)
         {
             return pattern.Modifiers == default
                 ? $"{pattern.Key}"
                 : $"{pattern.Modifiers.GetStringValue()}+{pattern.Key}";
         }
-
         return $"{pattern.Character}";
     }
 
@@ -26,7 +25,4 @@ private static string GetStringValue(this ConsoleModifiers modifiers)
             .Select(x => x.ToString());
         return string.Join("+", values);
     }
-
-    public static string GetStringValue(this KeyPressPatterns patterns)
-        => patterns.DefinedPatterns!.First().GetStringValue();
 }

CSharpRepl.Services/Nuget/ConsoleNugetLogger.cs

@@ -25,7 +25,7 @@ internal sealed class ConsoleNugetLogger : ILogger
     private readonly Configuration configuration;
     private readonly string successPrefix;
     private readonly string errorPrefix;
-    private readonly List<Line> lines = new();
+    private readonly List<Line> lines = [];
     private readonly object linesLock = new(); // Lock for the lines list
     private int linesRendered;
 
@@ -83,7 +83,7 @@ public void LogMinimal(string data)
 
     public void LogError(string data)
     {
-        lock(linesLock)
+        lock (linesLock)
         {
             lines.Add(CreateLine(data, isError: true));
         }

CSharpRepl.Services/Nuget/NugetHelper.cs

@@ -3,6 +3,7 @@
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
 using System;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Reflection;
 using System.Runtime.Versioning;
@@ -31,7 +32,7 @@ public static RuntimeGraph GetRuntimeGraph(Action<string>? error)
         return new RuntimeGraph();
     }
 
-    public static NuGetFramework GetCurrentFramework()
+    public static bool TryGetCurrentFramework([NotNullWhen(true)] out NuGetFramework? result)
     {
         var assembly = Assembly.GetEntryAssembly();
         if (assembly is null ||
@@ -41,6 +42,13 @@ public static NuGetFramework GetCurrentFramework()
         }
 
         var targetFrameworkAttribute = assembly.GetCustomAttribute<TargetFrameworkAttribute>();
-        return NuGetFramework.Parse(targetFrameworkAttribute?.FrameworkName);
+        if (targetFrameworkAttribute is null)
+        {
+            result = null;
+            return false;
+        }
+
+        result = NuGetFramework.Parse(targetFrameworkAttribute.FrameworkName);
+        return true;
     }
 }

CSharpRepl.Services/Nuget/NugetPackageInstaller.cs

@@ -5,7 +5,6 @@
 using System;
 using System.Collections.Generic;
 using System.Collections.Immutable;
-using System.Globalization;
 using System.IO;
 using System.Linq;
 using System.Runtime.InteropServices;
@@ -51,9 +50,14 @@ public async Task<ImmutableArray<PortableExecutableReference>> InstallAsync(
 
         try
         {
-            ISettings settings = ReadSettings();
-            var targetFramework = NugetHelper.GetCurrentFramework();
+            if (!NugetHelper.TryGetCurrentFramework(out var targetFramework))
+            {
+                logger.LogFinish($"Unable to get current target framework.", success: false);
+                return [];
+            }
+
             var nuGetProject = CreateFolderProject(targetFramework, Path.Combine(Configuration.ApplicationDirectory, "packages"));
+            var settings = ReadSettings();
             var sourceRepositoryProvider = new SourceRepositoryProvider(new PackageSourceProvider(settings), Repository.Provider.GetCoreV3());
             var packageManager = CreatePackageManager(settings, nuGetProject, sourceRepositoryProvider);
 
@@ -74,7 +78,7 @@ public async Task<ImmutableArray<PortableExecutableReference>> InstallAsync(
             if (!packageIdentity.HasVersion)
             {
                 logger.LogFinish($"Could not find package '{packageIdentity}'", success: false);
-                return ImmutableArray<PortableExecutableReference>.Empty;
+                return [];
             }
 
             var skipInstall = nuGetProject.PackageExists(packageIdentity);
@@ -100,7 +104,7 @@ public async Task<ImmutableArray<PortableExecutableReference>> InstallAsync(
         catch (Exception ex)
         {
             logger.LogFinish($"Could not find package '{packageId}'. Error: {ex}", success: false);
-            return ImmutableArray<PortableExecutableReference>.Empty;
+            return [];
         }
     }
 
@@ -161,7 +165,7 @@ string[] FindDlls(NuGetFramework framework) =>
             .Select(i => i.Path)
             .Where(p => p.EndsWith(".dll", StringComparison.OrdinalIgnoreCase))
             .ToArray()
-            ?? Array.Empty<string>();
+            ?? [];
 
         var supportedFrameworks = (await reader.GetSupportedFrameworksAsync(cancellationToken))
             .Where(f => FindDlls(f).Any()) //Not all supported frameworks contains dlls. E.g. Microsoft.CSharp.4.7.0\lib\netcoreapp2.0 contains only empty file '_._'.
@@ -230,7 +234,7 @@ private async Task DownloadPackageAsync(
 
         await packageManager.InstallPackageAsync(packageManager.PackagesFolderNuGetProject,
             packageIdentity, resolutionContext, projectContext,
-            primarySourceRepositories, Array.Empty<SourceRepository>(), cancellationToken);
+            primarySourceRepositories, [], cancellationToken);
     }
 
     private async Task<PackageIdentity> QueryLatestPackageVersion(

CSharpRepl.Services/Roslyn/DocumentationComment.cs

@@ -26,9 +26,9 @@ internal sealed class DocumentationComment
 {
     private static readonly ThreadLocal<StringBuilder> stringBuilder = new(() => new());
 
-    private readonly Dictionary<string, FormattedString> _parameterTexts = new();
-    private readonly Dictionary<string, FormattedString> _typeParameterTexts = new();
-    private readonly Dictionary<string, ImmutableArray<FormattedString>> _exceptionTexts = new();
+    private readonly Dictionary<string, FormattedString> _parameterTexts = [];
+    private readonly Dictionary<string, FormattedString> _typeParameterTexts = [];
+    private readonly Dictionary<string, ImmutableArray<FormattedString>> _exceptionTexts = [];
 
     /// <summary>
     /// True if an error occurred when parsing.
@@ -68,17 +68,17 @@ internal sealed class DocumentationComment
     /// <summary>
     /// The names of items in &lt;param&gt; tags.
     /// </summary>
-    public ImmutableArray<string> ParameterNames { get; private set; } = ImmutableArray<string>.Empty;
+    public ImmutableArray<string> ParameterNames { get; private set; } = [];
 
     /// <summary>
     /// The names of items in &lt;typeparam&gt; tags.
     /// </summary>
-    public ImmutableArray<string> TypeParameterNames { get; private set; } = ImmutableArray<string>.Empty;
+    public ImmutableArray<string> TypeParameterNames { get; private set; } = [];
 
     /// <summary>
     /// The types of items in &lt;exception&gt; tags.
     /// </summary>
-    public ImmutableArray<string> ExceptionTypes { get; private set; } = ImmutableArray<string>.Empty;
+    public ImmutableArray<string> ExceptionTypes { get; private set; } = [];
 
     /// <summary>
     /// The item named in the &lt;completionlist&gt; tag's cref attribute.
@@ -89,7 +89,7 @@ internal sealed class DocumentationComment
     /// <summary>
     /// Used for <see cref="CommentBuilder.TrimEachLine"/> method, to prevent new allocation of string
     /// </summary>
-    private static readonly string[] s_NewLineAsStringArray = new string[] { "\n" };
+    private static readonly string[] s_NewLineAsStringArray = ["\n"];
 
     private DocumentationComment(string fullXmlFragment)
     {
@@ -175,9 +175,9 @@ private DocumentationComment ParseInternal(string xml)
                 }
             }
 
-            _comment.ParameterNames = _parameterNamesBuilder == null ? ImmutableArray<string>.Empty : _parameterNamesBuilder.ToImmutable();
-            _comment.TypeParameterNames = _typeParameterNamesBuilder == null ? ImmutableArray<string>.Empty : _typeParameterNamesBuilder.ToImmutable();
-            _comment.ExceptionTypes = _exceptionTypesBuilder == null ? ImmutableArray<string>.Empty : _exceptionTypesBuilder.ToImmutable();
+            _comment.ParameterNames = _parameterNamesBuilder == null ? [] : _parameterNamesBuilder.ToImmutable();
+            _comment.TypeParameterNames = _typeParameterNamesBuilder == null ? [] : _typeParameterNamesBuilder.ToImmutable();
+            _comment.ExceptionTypes = _exceptionTypesBuilder == null ? [] : _exceptionTypesBuilder.ToImmutable();
 
             return _comment;
         }
@@ -314,7 +314,7 @@ private void ParseCallback(XmlReader reader)
                         if (_exceptionTextBuilders == null || !_exceptionTextBuilders.ContainsKey(type))
                         {
                             (_exceptionTypesBuilder ??= ImmutableArray.CreateBuilder<string>()).Add(type);
-                            (_exceptionTextBuilders ??= new Dictionary<string, ImmutableArray<FormattedString>.Builder>()).Add(type, ImmutableArray.CreateBuilder<FormattedString>());
+                            (_exceptionTextBuilders ??= []).Add(type, ImmutableArray.CreateBuilder<FormattedString>());
                         }
 
                         _exceptionTextBuilders[type].Add(exceptionText);

CSharpRepl.Services/Roslyn/Formatting/CustomObjectFormatters/GuidFormatter.cs

@@ -20,8 +20,7 @@ public override StyledString FormatToText(Guid value, Level level, Formatter for
         var parts = value.ToString().Split('-');
         var style = formatter.GetStyle(ClassificationTypeNames.NumericLiteral);
         return new StyledString(
-            new StyledStringSegment[]
-            {
+            [
                 new(parts[0], style),
                 new("-"),
                 new(parts[1], style),
@@ -31,6 +30,6 @@ public override StyledString FormatToText(Guid value, Level level, Formatter for
                 new(parts[3], style),
                 new("-"),
                 new(parts[4], style)
-            });
+            ]);
     }
 }

CSharpRepl.Services/Roslyn/Formatting/FormattedObject.cs

@@ -17,7 +17,7 @@ public FormattedObject(IRenderable renderable, object? value)
 
     public IEnumerable<FormattedObject> FormatMembers(PrettyPrinter prettyPrinter, Level level, bool includeNonPublic)
     {
-        if (Value is null) return Array.Empty<FormattedObject>();
+        if (Value is null) return [];
 
         return prettyPrinter.FormatMembers(Value, level.Increment(), includeNonPublic);
     }