Tweak console formatting

Author: olafurpg

ScipDotnet/IndexCommandHandler.cs

@@ -70,27 +70,36 @@ private static async Task ScipIndex(IHost host, IndexCommandOptions options)
             stopwatch.Elapsed.ToFriendlyString());
     }
 
+    private static string FixThisProblem(string examplePath)
+    {
+        return "To fix this problem, pass the path of a solution (.sln) or project (.csproj) file to the `scip-dotnet index` command. " +
+        $"For example, run: scip-dotnet index {examplePath}";
+    }
+    
     private static string? FindSolutionOrProjectFile(FileInfo workingDirectory, ILogger<IndexCommandOptions> logger)
     {
-        var files = Directory.GetFiles(workingDirectory.FullName).Where(file =>
+        var paths = Directory.GetFiles(workingDirectory.FullName).Where(file =>
             string.Equals(Path.GetExtension(file), ".sln", StringComparison.OrdinalIgnoreCase) ||
             string.Equals(Path.GetExtension(file), ".csproj", StringComparison.OrdinalIgnoreCase)
         ).ToList();
-        if (files.Count == 0)
-        {
-            logger.LogError(
-                "No solution (.sln) or .csproj file detected in the working directory '{WorkingDirectory}'. Use the --solution-file argument to specify which solution file to index", workingDirectory.FullName);
-            return null;
-        }
 
-        if (files.Count != 1)
+        switch (paths.Count)
         {
-            logger.LogError(
-                "Ambiguous solution files: {Join}. Use the --solution-file argument to specify which solution file to index",
-                String.Join(", ", files));
-            return null;
+            case 0:
+                logger.LogError(
+                    "No solution (.sln) or .csproj file detected in the working directory '{WorkingDirectory}'. {FixThis}",
+                    workingDirectory.FullName, FixThisProblem("SOLUTION_FILE"));
+                return null;
+            case 1:
+                return paths.First();
         }
 
-        return files.First();
+        var relativePaths = paths.Select(path => Path.GetRelativePath(workingDirectory.FullName, path)).ToList();
+        logger.LogError(
+            "Ambiguous solution files: {Join}. {FixThis}",
+            String.Join(", ", relativePaths),
+            FixThisProblem(relativePaths.First()));
+        return null;
+
     }
 }

ScipDotnet/Program.cs

@@ -19,7 +19,8 @@ public static async Task<int> Main(string[] args)
     {
         var indexCommand = new Command("index", "Index a solution file")
         {
-            new Argument<FileInfo>("projects", "Path to the .sln (solution) or .csproj file") { Arity = ArgumentArity.ZeroOrOne },
+            new Argument<FileInfo>("projects", "Path to the .sln (solution) or .csproj file")
+                { Arity = ArgumentArity.ZeroOrOne },
             new Option<string>("--output", () => "index.scip",
                 "Path to the output SCIP index file"),
             new Option<FileInfo>("--working-directory",
@@ -41,15 +42,21 @@ public static async Task<int> Main(string[] args)
         };
         indexCommand.Handler = CommandHandler.Create(IndexCommandHandler.Process);
         var rootCommand =
-            new RootCommand("SCIP indexer for the C# programming language. Built with the Roslyn .NET compiler. Supports MSBuild.")
+            new RootCommand(
+                "SCIP indexer for the C# programming language. Built with the Roslyn .NET compiler. Supports MSBuild.")
             {
                 indexCommand,
             };
         var builder = new CommandLineBuilder(rootCommand);
         return await builder.UseHost(_ => Host.CreateDefaultBuilder(), host =>
             {
                 host.ConfigureAppConfiguration(b => b.AddInMemoryCollection());
-                host.ConfigureLogging(b => b.AddFilter("Microsoft.Hosting.Lifetime", LogLevel.None));
+                host.ConfigureLogging(b => b.AddSimpleConsole(options =>
+                {
+                    options.IncludeScopes = true;
+                    options.SingleLine = true;
+                    options.TimestampFormat = "HH:mm:ss ";
+                }).AddFilter("Microsoft.Hosting.Lifetime", LogLevel.None));
                 host.ConfigureServices((_, collection) =>
                     collection
                         .AddSingleton(_ => CreateWorkspace())

readme.md

@@ -20,7 +20,7 @@ cd scip-dotnet
 
 Finally, use `dotnet run` to run the indexer locally.
 ```shell
-dotnet run --project ScipDotnet -- index --working-directory PATH_TO_DIRECTORY_YOU_WANT_TO_INDEX
+dotnet run --framework net6.0 --project ScipDotnet -- index --working-directory PATH_TO_DIRECTORY_YOU_WANT_TO_INDEX
 ```
 
 Once scip-dotnet has finished indexing the project, there should be an `index.scip` at the root of the