feat: support process plugin schema v4 (#4)

Author: dsherret

.github/workflows/ci.yml

@@ -1,6 +1,12 @@
 name: CI
 
-on: [push, pull_request]
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+    tags:
+    - '*'
 
 jobs:
   build:
@@ -10,27 +16,38 @@ jobs:
     steps:
     - name: Checkout
       uses: actions/checkout@v2
-    - name: Setup .net
-      uses: actions/setup-dotnet@v1
+    - uses: denoland/setup-deno@v1
+    - uses: dtolnay/rust-toolchain@stable
+    - uses: Swatinem/rust-cache@v1
+    - uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: '3.1.x'
+        dotnet-version: '6.0.x'
 
-    - name: Build
+    - name: Build (Debug)
+      run: dotnet build DprintPluginRoslyn
+
+    - name: Test
+      run: dotnet test
+
+    - name: Test Exe
+      run: cd test && cargo test
+
+    - name: Build (Release)
       run: |
-        dotnet build -c Release --runtime win-x64
-        dotnet build -c Release --runtime linux-x64
-        dotnet build -c Release --runtime osx-x64
+        dotnet build DprintPluginRoslyn -c Release --runtime win-x64
+        dotnet build DprintPluginRoslyn -c Release --runtime linux-x64
+        dotnet build DprintPluginRoslyn -c Release --runtime osx-x64
 
     - name: Package
       run: |
-        cd DprintPluginRoslyn/bin/Release/netcoreapp3.1/osx-x64
+        cd DprintPluginRoslyn/bin/Release/net6.0/osx-x64
         zip -r ../../../../../dprint-plugin-roslyn-x86_64-apple-darwin.zip ./*
         cd ../linux-x64
         zip -r ../../../../../dprint-plugin-roslyn-x86_64-unknown-linux-gnu.zip ./*
         cd ../win-x64
         zip -r ../../../../../dprint-plugin-roslyn-x86_64-pc-windows-msvc.zip ./*
     - name: Create plugin file
-      run: node scripts/createPluginFile.js
+      run: deno run --allow-read=. --allow-write=. scripts/create_plugin_file.ts
 
     - name: Get tag version
       if: startsWith(github.ref, 'refs/tags/')

.gitignore

@@ -1,3 +1,4 @@
 .vs
 bin
 obj
+test/target

.rustfmt.toml

@@ -0,0 +1,2 @@
+max_width = 160
+tab_spaces = 2

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "deno.enable": true,
+  "deno.lint": false,
+  "deno.unstable": false
+}

DprintPluginRoslyn.Tests/Configuration/ConfigurationHelperTests.cs

@@ -4,48 +4,47 @@
 using System.Collections.Generic;
 using System.Linq;
 
-namespace Dprint.Plugins.Roslyn.Configuration
+namespace Dprint.Plugins.Roslyn.Configuration;
+
+[TestFixture]
+public class ConfigurationHelperTests
 {
-  [TestFixture]
-  public class ConfigurationHelperTests
-  {
     [Test]
     public void HandlePluginConfig_VariousCorrectInput_Handles()
     {
-      var pluginConfig = new Dictionary<string, object>()
-            {
-                { "csharp.indentBlock", true },
-                { "csharp.labelPositioning", "noIndent" },
-            };
-      var context = new ConfigurationResolutionContext(pluginConfig, new AdhocWorkspace().Options);
-      ConfigurationHelpers.HandlePluginConfig(context, typeof(CSharpFormattingOptions), "csharp.");
-      var options = context.GetOptions();
+        var pluginConfig = new Dictionary<string, object>()
+        {
+            { "csharp.indentBlock", true },
+            { "csharp.labelPositioning", "noIndent" },
+        };
+        var context = new ConfigurationResolutionContext(pluginConfig, new AdhocWorkspace().Options);
+        ConfigurationHelpers.HandlePluginConfig(context, typeof(CSharpFormattingOptions), "csharp.");
+        var options = context.GetOptions();
 
-      Assert.That(options.GetOption(CSharpFormattingOptions.IndentBlock), Is.True);
-      Assert.That(options.GetOption(CSharpFormattingOptions.LabelPositioning), Is.EqualTo(LabelPositionOptions.NoIndent));
-      Assert.That(pluginConfig.Count, Is.EqualTo(0)); // should have cleared the plugin config
+        Assert.That(options.GetOption(CSharpFormattingOptions.IndentBlock), Is.True);
+        Assert.That(options.GetOption(CSharpFormattingOptions.LabelPositioning), Is.EqualTo(LabelPositionOptions.NoIndent));
+        Assert.That(pluginConfig.Count, Is.EqualTo(0)); // should have cleared the plugin config
     }
 
     [Test]
     public void HandlePluginConfig_IncorrectInput_Diagnostics()
     {
-      var pluginConfig = new Dictionary<string, object>()
-            {
-                { "csharp.indentBlock", "asdf" },
-                { "csharp.labelPositioning", "testing" },
-                { "csharp.unknown", true }
-            };
-      var context = new ConfigurationResolutionContext(pluginConfig, new AdhocWorkspace().Options);
-      ConfigurationHelpers.HandlePluginConfig(context, typeof(CSharpFormattingOptions), "csharp.");
-      var diagnostics = context.GetDiagnostics().ToList();
-      Assert.That(diagnostics.Count, Is.EqualTo(3));
-      Assert.That(diagnostics[0].PropertyName, Is.EqualTo("csharp.indentBlock"));
-      Assert.That(diagnostics[0].Message, Is.EqualTo("Property value was expected to be Boolean, but was String."));
-      Assert.That(diagnostics[1].PropertyName, Is.EqualTo("csharp.labelPositioning"));
-      Assert.That(diagnostics[1].Message, Is.EqualTo("Could not parse string 'testing' to enum: Microsoft.CodeAnalysis.CSharp.Formatting.LabelPositionOptions"));
-      Assert.That(diagnostics[2].PropertyName, Is.EqualTo("csharp.unknown"));
-      Assert.That(diagnostics[2].Message, Is.EqualTo("Could not find property on CSharpFormattingOptions with name 'Unknown'"));
-      Assert.That(pluginConfig.Count, Is.EqualTo(0)); // should have cleared the plugin config
+        var pluginConfig = new Dictionary<string, object>()
+        {
+            { "csharp.indentBlock", "asdf" },
+            { "csharp.labelPositioning", "testing" },
+            { "csharp.unknown", true }
+        };
+        var context = new ConfigurationResolutionContext(pluginConfig, new AdhocWorkspace().Options);
+        ConfigurationHelpers.HandlePluginConfig(context, typeof(CSharpFormattingOptions), "csharp.");
+        var diagnostics = context.GetDiagnostics().ToList();
+        Assert.That(diagnostics.Count, Is.EqualTo(3));
+        Assert.That(diagnostics[0].PropertyName, Is.EqualTo("csharp.indentBlock"));
+        Assert.That(diagnostics[0].Message, Is.EqualTo("Property value was expected to be Boolean, but was String."));
+        Assert.That(diagnostics[1].PropertyName, Is.EqualTo("csharp.labelPositioning"));
+        Assert.That(diagnostics[1].Message, Is.EqualTo("Could not parse string 'testing' to enum: Microsoft.CodeAnalysis.CSharp.Formatting.LabelPositionOptions"));
+        Assert.That(diagnostics[2].PropertyName, Is.EqualTo("csharp.unknown"));
+        Assert.That(diagnostics[2].Message, Is.EqualTo("Could not find property on CSharpFormattingOptions with name 'Unknown'"));
+        Assert.That(pluginConfig.Count, Is.EqualTo(0)); // should have cleared the plugin config
     }
-  }
 }

DprintPluginRoslyn.Tests/DprintPluginRoslyn.Tests.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>netcoreapp3.1</TargetFramework>
+    <TargetFramework>net6.0</TargetFramework>
 
     <IsPackable>false</IsPackable>
 

DprintPluginRoslyn.Tests/WorkspaceTests.cs

@@ -1,45 +1,48 @@
-using NUnit.Framework;
+using Dprint.Plugins.Roslyn.Configuration;
+using NUnit.Framework;
 using System.Collections.Generic;
+using System.Text;
 
-namespace Dprint.Plugins.Roslyn
+namespace Dprint.Plugins.Roslyn;
+
+[TestFixture]
+public class WorkspaceTests
 {
-  [TestFixture]
-  public class WorkspaceTests
-  {
     [Test]
     public void GetDiagnostics_UnhandledPropertyNames_Diagnostics()
     {
-      var workspace = new Workspace();
-      var pluginConfig = new Dictionary<string, object>()
-            {
-                { "csharp.indentBlock", true },
-                { "csharp.labelPositioning", "noIndent" },
-                { "unknownProp", false }
-            };
-      workspace.SetPluginConfig(pluginConfig);
-      var diagnostics = workspace.GetDiagnostics();
-      Assert.That(diagnostics.Count, Is.EqualTo(1));
-      Assert.That(diagnostics[0].PropertyName, Is.EqualTo("unknownProp"));
-      Assert.That(diagnostics[0].Message, Is.EqualTo("Unknown configuration property name."));
+        var workspace = new Workspace();
+        var pluginConfig = new Dictionary<string, object>()
+        {
+            { "csharp.indentBlock", true },
+            { "csharp.labelPositioning", "noIndent" },
+            { "unknownProp", false }
+        };
+        workspace.SetConfig(1, new(), pluginConfig);
+        var diagnostics = workspace.GetDiagnostics(1);
+        Assert.That(diagnostics.Count, Is.EqualTo(1));
+        Assert.That(diagnostics[0].PropertyName, Is.EqualTo("unknownProp"));
+        Assert.That(diagnostics[0].Message, Is.EqualTo("Unknown configuration property name."));
     }
 
     [Test]
     public void GetResolvedConfig_Default_Gets()
     {
-      var workspace = new Workspace();
-      var resolvedConfig = workspace.GetResolvedConfig();
-      Assert.That(resolvedConfig["csharp.indentBlock"], Is.EqualTo(true));
-      Assert.That(resolvedConfig["visualBasic.indentationSize"], Is.EqualTo(4));
+        var workspace = new Workspace();
+        workspace.SetConfig(1, new(), new());
+        var resolvedConfig = workspace.GetFormatters(1).GetResolvedConfig();
+        Assert.That(resolvedConfig["csharp.indentBlock"], Is.EqualTo(true));
+        Assert.That(resolvedConfig["visualBasic.indentationSize"], Is.EqualTo(4));
     }
 
     [Test]
     public void Issue3_SetIndentWidth()
     {
-      var workspace = new Workspace();
-      var pluginConfig = new Serialization.JsonSerializer().Deserialize<Dictionary<string, object>>("{\"indentWidth\": 2 }");
-      workspace.SetPluginConfig(pluginConfig);
-      var diagnostics = workspace.GetDiagnostics();
-      Assert.That(diagnostics.Count, Is.EqualTo(0));
+        var workspace = new Workspace();
+        var textBytes = Encoding.UTF8.GetBytes("{\"indentWidth\": 2 }");
+        var pluginConfig = new Serialization.JsonSerializer().Deserialize<Dictionary<string, object>>(textBytes);
+        workspace.SetConfig(2, new(), pluginConfig);
+        var diagnostics = workspace.GetDiagnostics(2);
+        Assert.That(diagnostics.Count, Is.EqualTo(0));
     }
-  }
 }

DprintPluginRoslyn.sln

@@ -1,7 +1,7 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio Version 16
-VisualStudioVersion = 16.0.30204.135
+# Visual Studio Version 17
+VisualStudioVersion = 17.1.32319.34
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DprintPluginRoslyn", "DprintPluginRoslyn\DprintPluginRoslyn.csproj", "{BF479150-5FBD-43A1-A332-EB5468E28935}"
 EndProject
@@ -12,7 +12,6 @@ EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{511546F0-D3AD-4F0D-86C7-195FB2890981}"
 	ProjectSection(SolutionItems) = preProject
 		.github\workflows\ci.yml = .github\workflows\ci.yml
-		.github\workflows\publish.yml = .github\workflows\publish.yml
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "scripts", "scripts", "{F99ED3AC-E082-4923-9A28-014BD79BE864}"

DprintPluginRoslyn/ArgParser.cs

@@ -1,28 +1,27 @@
 using System;
 
-namespace Dprint.Plugins.Roslyn
+namespace Dprint.Plugins.Roslyn;
+
+public struct CliArguments
 {
-  public struct CliArguments
-  {
     public int ParentProcessId { get; set; }
-  }
+}
 
-  public class ArgParser
-  {
+public class ArgParser
+{
     public CliArguments ParseArgs(string[] args)
     {
-      // very simple and not smart for now
-      for (var i = 0; i < args.Length; i++)
-      {
-        if (args[i] == "--parent-pid" && i + 1 < args.Length)
+        // very simple and not smart for now
+        for (var i = 0; i < args.Length; i++)
         {
-          return new CliArguments
-          {
-            ParentProcessId = int.Parse(args[i + 1]),
-          };
+            if (args[i] == "--parent-pid" && i + 1 < args.Length)
+            {
+                return new CliArguments
+                {
+                    ParentProcessId = int.Parse(args[i + 1]),
+                };
+            }
         }
-      }
-      throw new Exception("Failed parsing arguments. Expected --parent-pid");
+        throw new Exception("Failed parsing arguments. Expected --parent-pid");
     }
-  }
 }

DprintPluginRoslyn/Communication/BigEndianBitConverter.cs

@@ -1,25 +1,23 @@
 using System;
 
-namespace Dprint.Plugins.Roslyn.Communication
-{
-  // the cli uses uints and big endian
+namespace Dprint.Plugins.Roslyn.Communication;
 
-  public static class BigEndianBitConverter
-  {
+// the cli uses uints and big endian
+public static class BigEndianBitConverter
+{
     public static uint GetUInt(byte[] bytes)
     {
-      if (BitConverter.IsLittleEndian)
-        Array.Reverse(bytes);
+        if (BitConverter.IsLittleEndian)
+            Array.Reverse(bytes);
 
-      return BitConverter.ToUInt32(bytes);
+        return BitConverter.ToUInt32(bytes);
     }
 
     public static byte[] GetBytes(uint value)
     {
-      var bytes = BitConverter.GetBytes(value);
-      if (BitConverter.IsLittleEndian)
-        Array.Reverse(bytes);
-      return bytes;
+        var bytes = BitConverter.GetBytes(value);
+        if (BitConverter.IsLittleEndian)
+            Array.Reverse(bytes);
+        return bytes;
     }
-  }
 }