Add additional logging (#71)

Author: mmanela

ScipDotnet/IndexCommandHandler.cs

@@ -77,6 +77,11 @@ private static async Task ScipIndex(IHost host, IndexCommandOptions options)
             index.Documents.Add(document);
         }
 
+        if (index.Documents.Count <= 0)
+        {
+            options.Logger.LogWarning("Indexing finished without error but no documents were indexed.");
+        }
+
         await File.WriteAllBytesAsync(options.Output.FullName, index.ToByteArray());
         options.Logger.LogInformation("done: {OptionsOutput} {TimeElapsed}", options.Output,
             stopwatch.Elapsed.ToFriendlyString());

ScipDotnet/ScipProjectIndexer.cs

@@ -74,6 +74,7 @@ await host.Services.GetRequiredService<MSBuildWorkspace>()
                 .OpenSolutionAsync(rootProject.FullName)).Projects).ToList();
 
 
+        options.Logger.LogDebug($"Found {projects.Count()} projects");
         var projectsPerProjFile = projects.GroupBy(x => x.FilePath);
         var framework = $"net{Environment.Version.Major}.0";
         foreach (var projectGroup in projectsPerProjFile)
@@ -101,6 +102,7 @@ await host.Services.GetRequiredService<MSBuildWorkspace>()
 
             var globals = new Dictionary<ISymbol, ScipSymbol>(SymbolEqualityComparer.Default);
 
+            options.Logger.LogDebug($"Found {project.Documents.Count()} documents in {projectGroup.Key}");
             foreach (var document in project.Documents)
             {
                 if (options.Matcher.Match(options.WorkingDirectory.FullName, document.FilePath).HasMatches)

readme.md

@@ -115,6 +115,14 @@ A total of 1 test files matched the specified pattern.
 If you're happy with the new behavior, run
 `SCIP_UPDATE_SNAPSHOTS=true dotnet test` to update the snapshot tests.
 
+## Logging
+
+By default, only logs of warning level or higher are shown. To show debug logs set the following environment variable before running scip-dotnet
+
+```
+export Logging__LogLevel__Default=Debug
+```
+
 ## Releasing a new version
 
 First, make sure that you are on the latest `main` branch and have no dirty