Make UnionAttribute a direct reference

- Splits the library into 2 projects, the attribute and the generator - Moves common project items to the Directory.Build.props - Updates Benchmarks to remove covering code that is no longer generated - Updates tests to work with new project layout - Adds SDK reference to PackAsAnalyzer - Updates namespaces
domn1995 · Jan 3, 2024 · 2b2de01 · 2b2de01
1 parent b750c4e
commit 2b2de01
Show file tree

Hide file tree

Showing 27 changed files with 138 additions and 128 deletions.
diff --git a/.gitignore b/.gitignore
@@ -348,3 +348,6 @@ MigrationBackup/
 
 # Ionide (cross platform F# VS Code tools) working folder
 .ionide/
+
+# JetBrains IDE metadata
+.idea/
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -1,6 +1,24 @@
 <Project>
+    <Sdk Name="ViHo.PackAsAnalyzer" Version="1.0.1" />
+
     <PropertyGroup>
         <Nullable>enable</Nullable>
+        <Version>1.11.0</Version>
+        <SignAssembly>False</SignAssembly>
+    </PropertyGroup>
+
+    <PropertyGroup Label="Package Attributes">
+        <Authors>domn1995</Authors>
+        <Company />
+        <Description>A simple source generator for discriminated unions in C#.</Description>
+        <PackageProjectUrl>https://github.com/domn1995/dunet</PackageProjectUrl>
+        <PackageReadmeFile>Readme.md</PackageReadmeFile>
+        <RepositoryUrl>https://github.com/domn1995/dunet</RepositoryUrl>
+        <PackageTags>source; generator; discriminated; union; functional; tagged;</PackageTags>
+        <PackageLicenseExpression>MIT</PackageLicenseExpression>
+        <PackageReleaseNotes>https://github.com/domn1995/dunet/releases</PackageReleaseNotes>
+        <RepositoryType>git</RepositoryType>
+        <PackageIcon>favicon.png</PackageIcon>
     </PropertyGroup>
 
     <PropertyGroup Condition="'$(Configuration)' == 'Release'">
@@ -10,4 +28,9 @@
     <Target Name="DotnetToolRestore" BeforeTargets="Restore">
         <Exec Command="dotnet tool restore" />
     </Target>
+
+    <ItemGroup Condition=" '$(IsPublishable)' == 'True' ">
+        <None Include="$(MSBuildThisFileDirectory)\README.md" Pack="true" PackagePath="\"/>
+        <None Include="$(MSBuildThisFileDirectory)\favicon.png" Pack="true" PackagePath="\"/>
+    </ItemGroup>
 </Project>
diff --git a/Dunet.sln b/Dunet.sln
@@ -3,7 +3,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
 VisualStudioVersion = 17.2.32519.379
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Dunet", "src\Dunet.csproj", "{13C0B629-4C48-4C73-AECB-06A476871C5B}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Dunet.Generator", "src\Dunet.Generator\Dunet.Generator.csproj", "{13C0B629-4C48-4C73-AECB-06A476871C5B}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Dunet.Test", "test\Dunet.Test.csproj", "{573E6767-C044-415B-9AD3-A1734B0DD684}"
 EndProject
@@ -25,6 +25,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ExpressionCalculatorWithSta
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Dunet.Benchmark", "benchmark\Dunet.Benchmark\Dunet.Benchmark.csproj", "{44A04A62-D495-4450-8C15-2BD67DF5159A}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Dunet", "src\Dunet\Dunet.csproj", "{9CC5D86B-26B5-47B5-8305-D099B171B1CD}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -71,6 +73,10 @@ Global
 		{44A04A62-D495-4450-8C15-2BD67DF5159A}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{44A04A62-D495-4450-8C15-2BD67DF5159A}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{44A04A62-D495-4450-8C15-2BD67DF5159A}.Release|Any CPU.Build.0 = Release|Any CPU
+		{9CC5D86B-26B5-47B5-8305-D099B171B1CD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{9CC5D86B-26B5-47B5-8305-D099B171B1CD}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{9CC5D86B-26B5-47B5-8305-D099B171B1CD}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{9CC5D86B-26B5-47B5-8305-D099B171B1CD}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

diff --git a/benchmark/Dunet.Benchmark/Dunet.Benchmark.csproj b/benchmark/Dunet.Benchmark/Dunet.Benchmark.csproj
@@ -12,7 +12,8 @@
     </ItemGroup>
 
     <ItemGroup>
-      <ProjectReference Include="..\..\src\Dunet.csproj" />
+      <ProjectReference Include="..\..\src\Dunet\Dunet.csproj" />
+      <ProjectReference Include="..\..\src\Dunet.Generator\Dunet.Generator.csproj" />
     </ItemGroup>
 
 </Project>
diff --git a/benchmark/Dunet.Benchmark/SourceGeneratorBenchmark.cs b/benchmark/Dunet.Benchmark/SourceGeneratorBenchmark.cs
@@ -1,9 +1,8 @@
 using BenchmarkDotNet.Attributes;
-using Dunet.UnionAttributeGeneration;
-using Dunet.UnionGeneration;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp;
 using System.Reflection;
+using Dunet.Generator.UnionGeneration;
 
 namespace Dunet.Benchmark;
 
@@ -58,9 +57,8 @@ partial record None();
             throw new InvalidOperationException("Compilation returned null");
 
         var unionGenerator = new UnionGenerator();
-        var unionAttributeGenerator = new UnionAttributeGenerator();
 
-        var driver = CSharpGeneratorDriver.Create(unionGenerator, unionAttributeGenerator);
+        var driver = CSharpGeneratorDriver.Create(unionGenerator);
 
         return (compilation, driver);
     }
@@ -87,7 +85,12 @@ private static Compilation CreateCompilation(params string[] sources) =>
             sources.Select(static source => CSharpSyntaxTree.ParseText(source)),
             new[]
             {
-                MetadataReference.CreateFromFile(typeof(Binder).GetTypeInfo().Assembly.Location)
+                // Resolves to System.Private.CoreLib.dll
+                MetadataReference.CreateFromFile(typeof(object).GetTypeInfo().Assembly.Location),
+                // Resolves to System.Runtime.dll, which is needed for the Attribute type
+                // Can't use typeof(Attribute).GetTypeInfo().Assembly.Location because it resolves to System.Private.CoreLib.dll
+                MetadataReference.CreateFromFile(AppDomain.CurrentDomain.GetAssemblies().First(f => f.FullName?.Contains("System.Runtime") == true).Location),
+                MetadataReference.CreateFromFile(typeof(UnionAttribute).GetTypeInfo().Assembly.Location)
             },
             new CSharpCompilationOptions(OutputKind.ConsoleApplication)
         );

diff --git a/integration/Dunet.Integration.csproj b/integration/Dunet.Integration.csproj
@@ -9,7 +9,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Dunet" Version="1.10.0" />
+        <PackageReference Include="Dunet" Version="1.11.0" />
         <PackageReference Include="FluentAssertions" Version="6.12.0" />
         <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
         <PackageReference Include="xunit" Version="2.6.4" />

diff --git a/src/Dunet.Generator/Dunet.Generator.csproj b/src/Dunet.Generator/Dunet.Generator.csproj
@@ -0,0 +1,30 @@
+<Project Sdk="Microsoft.NET.Sdk">
+    <PropertyGroup>
+        <TargetFramework>netstandard2.0</TargetFramework>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+        <LangVersion>12.0</LangVersion>
+        <IsPublishable>True</IsPublishable>
+        <NoWarn>$(NoWarn);NU5128</NoWarn>
+        <EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
+        <RootNamespace>Dunet.Generator</RootNamespace>
+        <IsRoslynComponent>true</IsRoslynComponent>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <None Include="$(OutputPath)/$(AssemblyName).dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4">
+            <PrivateAssets>all</PrivateAssets>
+            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+        </PackageReference>
+        <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.8.0" />
+        <PackageReference Include="PolySharp" Version="1.14.1">
+            <PrivateAssets>all</PrivateAssets>
+            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+        </PackageReference>
+    </ItemGroup>
+
+</Project>
diff --git a/src/IdentifierExtensions.cs → src/Dunet.Generator/IdentifierExtensions.cs b/src/IdentifierExtensions.cs → src/Dunet.Generator/IdentifierExtensions.cs
@@ -1,4 +1,4 @@
-namespace Dunet;
+namespace Dunet.Generator;
 
 internal static class IdentifierExtensions
 {

diff --git a/src/SyntaxExtensions.cs → src/Dunet.Generator/SyntaxExtensions.cs b/src/SyntaxExtensions.cs → src/Dunet.Generator/SyntaxExtensions.cs
@@ -2,7 +2,7 @@
 using Microsoft.CodeAnalysis.CSharp;
 using Microsoft.CodeAnalysis.CSharp.Syntax;
 
-namespace Dunet;
+namespace Dunet.Generator;
 
 internal static class SyntaxExtensions
 {

diff --git a/src/Dunet.Generator/UnionAttributeGeneration/UnionAttributeSource.cs b/src/Dunet.Generator/UnionAttributeGeneration/UnionAttributeSource.cs
@@ -0,0 +1,8 @@
+namespace Dunet.Generator.UnionAttributeGeneration;
+
+internal static class UnionAttributeSource
+{
+    public const string Namespace = "Dunet";
+    public const string Name = "UnionAttribute";
+    public const string FullyQualifiedName = $"{Namespace}.{Name}";
+}
diff --git a/...eneration/UnionExtensionsSourceBuilder.cs → ...eneration/UnionExtensionsSourceBuilder.cs b/...eneration/UnionExtensionsSourceBuilder.cs → ...eneration/UnionExtensionsSourceBuilder.cs
@@ -1,7 +1,7 @@
-using Dunet.UnionGeneration;
-using System.Text;
+using System.Text;
+using Dunet.Generator.UnionGeneration;
 
-namespace Dunet.UnionExtensionsGeneration;
+namespace Dunet.Generator.UnionExtensionsGeneration;
 
 internal static class UnionExtensionsSourceBuilder
 {

diff --git a/...nionGeneration/ImmutableEquatableArray.cs → ...nionGeneration/ImmutableEquatableArray.cs b/...nionGeneration/ImmutableEquatableArray.cs → ...nionGeneration/ImmutableEquatableArray.cs
@@ -1,9 +1,6 @@
-namespace Dunet.UnionGeneration;
+using System.Collections;
 
-using System;
-using System.Collections;
-using System.Collections.Generic;
-using System.Linq;
+namespace Dunet.Generator.UnionGeneration;
 
 public static class ImmutableEquatableArray
 {

diff --git a/...on/IncrementalValuesProviderExtensions.cs → ...on/IncrementalValuesProviderExtensions.cs b/...on/IncrementalValuesProviderExtensions.cs → ...on/IncrementalValuesProviderExtensions.cs
@@ -1,6 +1,6 @@
 using Microsoft.CodeAnalysis;
 
-namespace Dunet.UnionGeneration;
+namespace Dunet.Generator.UnionGeneration;
 
 /// <summary>
 /// Provides extension methods for an <see cref="IncrementalValuesProvider{TValues}"/>.

diff --git a/...neration/RecordDeclarationSyntaxParser.cs → ...neration/RecordDeclarationSyntaxParser.cs b/...neration/RecordDeclarationSyntaxParser.cs → ...neration/RecordDeclarationSyntaxParser.cs
@@ -1,9 +1,9 @@
-using Dunet.UnionAttributeGeneration;
+using Dunet.Generator.UnionAttributeGeneration;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp;
 using Microsoft.CodeAnalysis.CSharp.Syntax;
 
-namespace Dunet.UnionGeneration;
+namespace Dunet.Generator.UnionGeneration;
 
 /// <summary>
 /// Retrieves semantic information from record declarations.

diff --git a/...nionGeneration/StringBuilderExtensions.cs → ...nionGeneration/StringBuilderExtensions.cs b/...nionGeneration/StringBuilderExtensions.cs → ...nionGeneration/StringBuilderExtensions.cs
@@ -1,6 +1,6 @@
 using System.Text;
 
-namespace Dunet.UnionGeneration;
+namespace Dunet.Generator.UnionGeneration;
 
 internal static class StringBuilderExtensions
 {

diff --git a/src/UnionGeneration/UnionDeclaration.cs → ...rator/UnionGeneration/UnionDeclaration.cs b/src/UnionGeneration/UnionDeclaration.cs → ...rator/UnionGeneration/UnionDeclaration.cs
@@ -1,6 +1,6 @@
 using Microsoft.CodeAnalysis;
 
-namespace Dunet.UnionGeneration;
+namespace Dunet.Generator.UnionGeneration;
 
 internal sealed record UnionDeclaration(
     ImmutableEquatableArray<string> Imports,

diff --git a/src/UnionGeneration/UnionGenerator.cs → ...nerator/UnionGeneration/UnionGenerator.cs b/src/UnionGeneration/UnionGenerator.cs → ...nerator/UnionGeneration/UnionGenerator.cs
@@ -1,12 +1,12 @@
-using Dunet.UnionExtensionsGeneration;
+using System.Collections.Immutable;
+using System.Text;
+using Dunet.Generator.UnionExtensionsGeneration;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp;
 using Microsoft.CodeAnalysis.CSharp.Syntax;
 using Microsoft.CodeAnalysis.Text;
-using System.Collections.Immutable;
-using System.Text;
 
-namespace Dunet.UnionGeneration;
+namespace Dunet.Generator.UnionGeneration;
 
 [Generator]
 public sealed class UnionGenerator : IIncrementalGenerator

diff --git a/src/UnionGeneration/UnionSourceBuilder.cs → ...tor/UnionGeneration/UnionSourceBuilder.cs b/src/UnionGeneration/UnionSourceBuilder.cs → ...tor/UnionGeneration/UnionSourceBuilder.cs
@@ -1,6 +1,6 @@
 using System.Text;
 
-namespace Dunet.UnionGeneration;
+namespace Dunet.Generator.UnionGeneration;
 
 internal static class UnionSourceBuilder
 {

diff --git a/src/Dunet.csproj b/src/Dunet.csproj
diff --git a/src/Dunet/Dunet.csproj b/src/Dunet/Dunet.csproj
@@ -0,0 +1,15 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <TargetFrameworks>netstandard2.0;net8.0</TargetFrameworks>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+        <LangVersion>12.0</LangVersion>
+        <IsPublishable>True</IsPublishable>
+        <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
+    </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Dunet.Generator\Dunet.Generator.csproj" PackAsAnalyzer="true" PrivateAssets="all" />
+  </ItemGroup>
+</Project>
diff --git a/src/Dunet/UnionAttribute.cs b/src/Dunet/UnionAttribute.cs
@@ -0,0 +1,9 @@
+using System;
+
+namespace Dunet;
+
+/// <summary>
+/// Enables dunet union source generation for the decorated partial record.
+/// </summary>
+[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]
+public sealed class UnionAttribute : Attribute {}
diff --git a/src/UnionAttributeGeneration/UnionAttributeGenerator.cs b/src/UnionAttributeGeneration/UnionAttributeGenerator.cs
diff --git a/src/UnionAttributeGeneration/UnionAttributeSource.cs b/src/UnionAttributeGeneration/UnionAttributeSource.cs