Add Visual Basic support (#26)

Previously, scip-dotnet only supported C#. This PR adds support for
Visual Basic as well. We are able to reuse a lot of code from the C#
indexer by extracting shared logic related to formatting symbols.

Author: sagi1623

ScipDotnet.Tests/SnapshotTests.cs

@@ -214,6 +214,7 @@ private Dictionary<String, SymbolInformation> SymbolTable(Document document)
 
     private string FormatDocument(Index index, Document document)
     {
+        var commentChar = document.Language == "C#" ? "//" : "'";
         var sb = new StringBuilder();
         var inputPath = new Uri(index.Metadata.ProjectRoot + "/" + document.RelativePath).LocalPath;
         var occurrences = document.Occurrences.ToList();
@@ -237,7 +238,11 @@ private string FormatDocument(Index index, Document document)
                 var role = isDefinition ? "definition" : "reference";
                 var length = range.End.Character - range.Start.Character;
                 var indent = new String(' ', range.Start.Character);
-                sb.Append("//")
+                if (document.Language == "Visual Basic")
+                {
+                    indent += " ";
+                }
+                sb.Append(commentChar)
                     .Append(indent)
                     .Append(new String('^', length))
                     .Append(' ')
@@ -248,7 +253,7 @@ private string FormatDocument(Index index, Document document)
                 if (isDefinition)
                 {
                     var info = symtab.GetValueOrDefault(occurrence.Symbol, new SymbolInformation());
-                    var prefix = "//" + indent + new String(' ', length + 1);
+                    var prefix = commentChar + indent + new String(' ', length + 1);
                     foreach (var documentation in info.Documentation)
                     {
                         sb.Append(prefix).Append("documentation ").AppendLine(documentation.Replace("\n", "\\n"));
@@ -272,8 +277,6 @@ private string FormatDocument(Index index, Document document)
         return sb.ToString();
     }
 
-    private static int CompareOccurrences(Occurrence a, Occurrence b)
-    {
-        return Range.FromOccurrence(a).CompareTo(Range.FromOccurrence(b));
-    }
+    private static int CompareOccurrences(Occurrence a, Occurrence b) =>
+        Range.FromOccurrence(a).CompareTo(Range.FromOccurrence(b));
 }

ScipDotnet/IndexCommandHandler.cs

@@ -39,15 +39,13 @@ public static async Task<int> Process(IHost host, List<FileInfo> projects, strin
         return 0;
     }
 
-    private static FileInfo OutputFile(FileInfo workingDirectory, string output)
-    {
-        return Path.IsPathRooted(output) ? new FileInfo(output) : new FileInfo(Path.Join(workingDirectory.FullName, output));
-    }
+    private static FileInfo OutputFile(FileInfo workingDirectory, string output) =>
+        Path.IsPathRooted(output) ? new FileInfo(output) : new FileInfo(Path.Join(workingDirectory.FullName, output));
 
     private static async Task ScipIndex(IHost host, IndexCommandOptions options)
     {
         var stopwatch = Stopwatch.StartNew();
-        var indexer = host.Services.GetRequiredService<ScipIndexer>();
+        var indexer = host.Services.GetRequiredService<ScipProjectIndexer>();
         var index = new Scip.Index
         {
             Metadata = new Metadata
@@ -71,18 +69,16 @@ 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 FixThisProblem(string examplePath) =>
+        "To fix this problem, pass the path of a solution (.sln) or project (.csproj/.vbrpoj) file to the `scip-dotnet index` command. " +
+        $"For example, run: scip-dotnet index {examplePath}";
 
     private static List<FileInfo> FindSolutionOrProjectFile(FileInfo workingDirectory, ILogger logger)
     {
         var paths = Directory.GetFiles(workingDirectory.FullName).Where(file =>
             string.Equals(Path.GetExtension(file), ".sln", StringComparison.OrdinalIgnoreCase) ||
-            string.Equals(Path.GetExtension(file), ".csproj", StringComparison.OrdinalIgnoreCase)
+            string.Equals(Path.GetExtension(file), ".csproj", StringComparison.OrdinalIgnoreCase) ||
+            string.Equals(Path.GetExtension(file), ".vbproj", StringComparison.OrdinalIgnoreCase)
         ).ToList();
 
         if (paths.Count != 0)
@@ -91,7 +87,7 @@ private static List<FileInfo> FindSolutionOrProjectFile(FileInfo workingDirector
         }
 
         logger.LogError(
-            "No solution (.sln) or .csproj file detected in the working directory '{WorkingDirectory}'. {FixThis}",
+            "No solution (.sln) or .csproj/.vbproj file detected in the working directory '{WorkingDirectory}'. {FixThis}",
             workingDirectory.FullName, FixThisProblem("SOLUTION_FILE"));
         return new List<FileInfo>();
     }

ScipDotnet/Program.cs

@@ -19,7 +19,7 @@ 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")
+            new Argument<FileInfo>("projects", "Path to the .sln (solution) or .csproj/.vbproj file")
                 { Arity = ArgumentArity.ZeroOrMore },
             new Option<string>("--output", () => "index.scip",
                 "Path to the output SCIP index file"),
@@ -43,7 +43,7 @@ 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.")
+                "SCIP indexer for the C# and Visual basic programming languages. Built with the Roslyn .NET compiler. Supports MSBuild.")
             {
                 indexCommand,
             };
@@ -60,7 +60,7 @@ public static async Task<int> Main(string[] args)
                 host.ConfigureServices((_, collection) =>
                     collection
                         .AddSingleton(_ => CreateWorkspace())
-                        .AddTransient<ScipIndexer>()
+                        .AddTransient<ScipProjectIndexer>()
                         .AddTransient(services => (Workspace)services.GetRequiredService<MSBuildWorkspace>())
                 );
             })