switch to json writer, set target to net462

Author: Vladislav Kalugin

.github/workflows/build.yaml

@@ -1,6 +1,6 @@
 name: Build dotnet package
 
-on: [push]
+on: [ push ]
 
 jobs:
   build:
@@ -17,6 +17,4 @@ jobs:
         uses: actions/upload-artifact@v3
         with:
           name: msbuild-database
-          path: bin/Release/netstandard2.0/msbuild-database.dll
-  
-      
+          path: bin/Release/net462

.github/workflows/publish_release.yaml

@@ -20,9 +20,12 @@ jobs:
         run: |
           export VERSION=$(date '+%Y.%-m').$GITHUB_RUN_NUMBER
           echo "VERSION=$VERSION" >> $GITHUB_ENV
-      - uses: "marvinpinto/action-automatic-releases@latest"
+      - name: Archive release
+        run: zip -r msbuild-release.zip bin/Release/net462
+      - name: Publish release
+        uses: "marvinpinto/action-automatic-releases@latest"
         with:
           repo_token: "${{ secrets.GITHUB_TOKEN }}"
           automatic_release_tag: "${{ env.VERSION }}"
           prerelease: true
-          files: bin/Release/netstandard2.0/msbuild-database.dll
+          files: msbuild-release.zip

msbuild-database.cs

@@ -9,6 +9,8 @@
 using System.Web;
 using Microsoft.Build.Framework;
 using Microsoft.Build.Utilities;
+using System.Text.Json;
+
 
 /// <summary>
 /// An MsBuild logger that emit compile_commands.json and link_commands.json files from a C++ project build.
@@ -18,6 +20,20 @@
 /// </remarks>
 public class CompileDatabase : Logger
 {
+    private class CompileCommand
+    {
+        public String command { get; set; }
+        public String directory { get; set; }
+        public String file { get; set; }
+    }
+
+    private class LinkCommand
+    {
+        public String command { get; set; }
+        public String directory { get; set; }
+        public List<String> files { get; set; }
+    }
+
     public override void Initialize(IEventSource eventSource)
     {
         string compileOutputFilePath = "compile_commands.json";
@@ -28,11 +44,10 @@ public override void Initialize(IEventSource eventSource)
             const bool append = false;
             Encoding utf8WithoutBom = new UTF8Encoding(false);
             this.CompileStreamWriter = new StreamWriter(compileOutputFilePath, append, utf8WithoutBom);
-            this.firstLine = true;
-            CompileStreamWriter.WriteLine("[");
-
             this.LinkStreamWriter = new StreamWriter(linkOutputFilePath, append, utf8WithoutBom);
-            LinkStreamWriter.WriteLine("[");
+
+            compileCommands = new List<CompileCommand>();
+            linkCommands = new List<LinkCommand>();
         }
         catch (Exception ex)
         {
@@ -246,9 +261,9 @@ private void ProcessCompileCommand(string compilerPath, string[] cmdArgs, String
         }
 
         // simplify the compile command to avoid .. etc.
-        string compileCommand = '"' + Path.GetFullPath(compilerPath) + "\" " + String.Join(" ", cmdArgs);
+        string compileCommand = Path.GetFullPath(compilerPath) + " " + String.Join(" ", cmdArgs);
 
-        WriteCompileCommand(compileCommand, filenames, dirname);
+        addCompileCommand(compileCommand, filenames, dirname);
     }
 
     private void ProcessLinkCommand(string compilerPath, string[] cmdArgs, String dirname)
@@ -300,88 +315,58 @@ private void ProcessLinkCommand(string compilerPath, string[] cmdArgs, String di
         }
 
         // simplify the compile command to avoid .. etc.
-        string compileCommand = '"' + Path.GetFullPath(compilerPath) + "\" " + String.Join(" ", cmdArgs);
+        string linkCommand = Path.GetFullPath(compilerPath) + " " + String.Join(" ", cmdArgs);
 
-        WriteLinkCommand(compileCommand, filenames, dirname);
+        addLinkCommand(linkCommand, filenames, dirname);
     }
 
-    private void WriteCompileCommand(string compileCommand, List<string> files, string dirname)
+    private void addCompileCommand(string compileCommand, List<string> files, string dirname)
     {
         foreach (string filename in files)
         {
-            // Terminate the preceding entry
-            if (firstLine)
+            CompileCommand commandVal = new CompileCommand
             {
-                firstLine = false;
-            }
-            else
-            {
-                CompileStreamWriter.WriteLine(",");
-            }
+                command = compileCommand,
+                directory = dirname,
+                file = filename
+            };
 
-            // Write one entry
-            CompileStreamWriter.WriteLine("  {");
-            CompileStreamWriter.WriteLine(String.Format(
-                "    \"command\": \"{0}\",",
-                HttpUtility.JavaScriptStringEncode(compileCommand)));
-            CompileStreamWriter.WriteLine(String.Format(
-                "    \"file\": \"{0}\",",
-                HttpUtility.JavaScriptStringEncode(filename)));
-            CompileStreamWriter.WriteLine(String.Format(
-                "    \"directory\": \"{0}\"",
-                HttpUtility.JavaScriptStringEncode(dirname)));
-            CompileStreamWriter.Write("  }");
+            compileCommands.Add(commandVal);
         }
     }
 
-    private void WriteLinkCommand(string linkCommand, List<string> files, string dirname)
+    private void addLinkCommand(string linkCommand, List<string> files, string dirname)
     {
-        LinkStreamWriter.WriteLine("  {");
-        LinkStreamWriter.WriteLine(String.Format(
-            "    \"directory\": \"{0}\",",
-            HttpUtility.JavaScriptStringEncode(dirname)));
-        LinkStreamWriter.WriteLine(String.Format(
-            "    \"command\": \"{0}\",",
-            HttpUtility.JavaScriptStringEncode(linkCommand)));
-        LinkStreamWriter.WriteLine("    \"files\": [");
-        bool fl = true;
-        foreach (string filename in files)
+        LinkCommand commandVal = new LinkCommand()
         {
-            if (fl)
-            {
-                fl = false;
-            }
-            else
-            {
-                LinkStreamWriter.WriteLine(",");
-            }
-
-            LinkStreamWriter.Write(String.Format("      \"{0}\"",
-                HttpUtility.JavaScriptStringEncode(filename)));
-        }
+            command = linkCommand,
+            directory = dirname,
+            files = files
+        };
 
-        LinkStreamWriter.WriteLine();
-        LinkStreamWriter.WriteLine("    ]");
-        LinkStreamWriter.WriteLine("  }");
+        linkCommands.Add(commandVal);
     }
 
     public override void Shutdown()
     {
-        if (!firstLine)
+        JsonSerializerOptions jsonSerializerOptions = new JsonSerializerOptions
         {
-            CompileStreamWriter.WriteLine();
-        }
-
-        CompileStreamWriter.WriteLine("]");
+            WriteIndented = true,
+            Encoder = System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping
+        };
+        CompileStreamWriter.WriteLine(JsonSerializer.Serialize(compileCommands, jsonSerializerOptions));
         CompileStreamWriter.Close();
 
-        LinkStreamWriter.WriteLine("]");
+
+        LinkStreamWriter.WriteLine(JsonSerializer.Serialize(linkCommands, jsonSerializerOptions));
         LinkStreamWriter.Close();
 
         base.Shutdown();
     }
 
+
+    private List<CompileCommand> compileCommands;
+    private List<LinkCommand> linkCommands;
     private StreamWriter CompileStreamWriter;
     private StreamWriter LinkStreamWriter;
-    private bool firstLine;
 }

msbuild-database.csproj

@@ -1,14 +1,17 @@
 <Project Sdk="Microsoft.NET.Sdk" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
 
   <PropertyGroup>
-    <TargetFrameworks>netstandard2.0</TargetFrameworks>
+    <TargetFrameworks>net462</TargetFrameworks>
     <Product />
     <Description>An MsBuild logger that emit compile_commands.json and link_commands.json files from a C++</Description>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <SelfContained>true</SelfContained>
+    <PublishSingleFile>true</PublishSingleFile>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.Build" Version="14.3.0" PrivateAssets="All" />
     <PackageReference Include="Microsoft.Build.Utilities.Core" Version="14.3.0" PrivateAssets="All" />
+    <PackageReference Include="System.Text.Json" Version="7.0.0" />
   </ItemGroup>
 
 </Project>