Package the SG into the runtime package

The SG can be disabled by the consumer project by settings the following MSBuild property: <DisableCSnakesRuntimeSourceGenerator>true</DisableCSnakesRuntimeSourceGenerator>
tonybaloney · Sep 18, 2024 · 0e6fbf8 · 0e6fbf8
1 parent 9ed59f3
commit 0e6fbf8
Show file tree

Hide file tree

Showing 9 changed files with 58 additions and 42 deletions.
diff --git a/.github/workflows/dotnet-publish-ci.yml b/.github/workflows/dotnet-publish-ci.yml
@@ -33,9 +33,6 @@ jobs:
         run: dotnet build --no-restore -c ${{ env.DOTNET_CONFIGURATION }}
         working-directory: src
 
-      - name: Publish NuGet package CSnakes
-        run: dotnet pack src/CSnakes --no-build -c ${{ env.DOTNET_CONFIGURATION }} -o ./nuget -p:VersionSuffix='alpha.${{ github.run_number }}'
-
       - name: Publish NuGet package CSnakes.Runtime
         run: dotnet pack src/CSnakes.Runtime --no-build -c ${{ env.DOTNET_CONFIGURATION }} -o ./nuget -p:VersionSuffix='alpha.${{ github.run_number }}'
 

diff --git a/.github/workflows/dotnet-publish-main.yml b/.github/workflows/dotnet-publish-main.yml
@@ -38,9 +38,6 @@ jobs:
         run: dotnet build --no-restore -c ${{ env.DOTNET_CONFIGURATION }}
         working-directory: src
 
-      - name: Publish NuGet package CSnakes
-        run: dotnet pack src/CSnakes --no-build -c ${{ env.DOTNET_CONFIGURATION }} -o ./nuget -p:VersionSuffix='beta.${{ github.run_number }}'
-
       - name: Publish NuGet package CSnakes.Runtime
         run: dotnet pack src/CSnakes.Runtime --no-build -c ${{ env.DOTNET_CONFIGURATION }} -o ./nuget -p:VersionSuffix='beta.${{ github.run_number }}'
 

diff --git a/.github/workflows/dotnet-publish-release.yml b/.github/workflows/dotnet-publish-release.yml
@@ -33,9 +33,6 @@ jobs:
         run: dotnet build --no-restore -c Release
         working-directory: src
 
-      - name: Publish NuGet package CSnakes
-        run: dotnet pack src/CSnakes --no-build -c Release -o ./nuget
-
       - name: Publish NuGet package CSnakes.Runtime
         run: dotnet pack src/CSnakes.Runtime --no-build -c Release -o ./nuget
 

diff --git a/samples/simple/ExamplePythonDependency/ExamplePythonDependency.csproj b/samples/simple/ExamplePythonDependency/ExamplePythonDependency.csproj
@@ -30,7 +30,6 @@
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="CSnakes.SourceGeneration" Version="1.*-*" />
         <PackageReference Include="CSnakes.Runtime" Version="1.*-*" />
     </ItemGroup>
 

diff --git a/src/CSnakes.Runtime/CSnakes.Runtime.csproj b/src/CSnakes.Runtime/CSnakes.Runtime.csproj
@@ -1,11 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <PackageId>CSnakes.Runtime</PackageId>
-    <Title>CSnakes Runtime</Title>
-    <IsPackable>true</IsPackable>
-    <GeneratePackageOnBuild>$(EnableLocalPackaging)</GeneratePackageOnBuild>
-
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
 
     <!-- Tensor<T> and related APIs in System.Numerics.Tensors are experimental in .NET 9 -->
@@ -23,4 +18,10 @@
     <PackageReference Include="System.Text.Json" />
   </ItemGroup>
 
+  <ItemGroup>
+    <!-- Reference the source generator purely for packaging purposes -->
+    <ProjectReference Include="..\CSnakes.SourceGeneration\CSnakes.SourceGeneration.csproj" ReferenceOutputAssembly="false" />
+  </ItemGroup>
+
+  <Import Project="Packaging.targets" />
 </Project>
diff --git a/src/CSnakes.Runtime/NuGet/buildTransitive/net8.0/CSnakes.Runtime.targets b/src/CSnakes.Runtime/NuGet/buildTransitive/net8.0/CSnakes.Runtime.targets
@@ -0,0 +1,19 @@
+<Project>
+  <Target Name="_CSnakes_Runtime_GatherAnalyzers">
+
+    <ItemGroup>
+      <_CSnakes_Runtime_Analyzer Include="@(Analyzer)" Condition="'%(Analyzer.NuGetPackageId)' == 'CSnakes.Runtime'" />
+    </ItemGroup>
+  </Target>
+
+  <Target Name="_CSnakes_Runtime_RemoveAnalyzers" 
+          Condition="'$(DisableCSnakesRuntimeSourceGenerator)' == 'true'"
+          AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
+          DependsOnTargets="_CSnakes_Runtime_GatherAnalyzers">
+
+    <!-- Remove all our analyzers -->
+    <ItemGroup>
+      <Analyzer Remove="@(_CSnakes_Runtime_Analyzer)" />
+    </ItemGroup>
+  </Target>
+</Project>
diff --git a/src/CSnakes.Runtime/Packaging.targets b/src/CSnakes.Runtime/Packaging.targets
@@ -0,0 +1,33 @@
+<Project>
+  <PropertyGroup>
+    <PackageId>CSnakes.Runtime</PackageId>
+    <Title>CSnakes Runtime</Title>
+    <IsPackable>true</IsPackable>
+
+    <!-- warning NU5128: Add lib or ref assemblies for the netstandard2.0 target framework -->
+    <NoWarn>$(NoWarn);NU5128</NoWarn>
+
+    <DevelopmentDependency>true</DevelopmentDependency>
+    <GeneratePackageOnBuild>$(EnableLocalPackaging)</GeneratePackageOnBuild>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <None Include="NuGet\buildTransitive\**\*" CopyToOutputDirectory="PreserveNewest" Pack="true" PackagePath="buildTransitive\%(RecursiveDir)%(Filename)%(Extension)" />
+  </ItemGroup>
+
+  <Target Name="_PackSourceGeneratorOutputs" BeforeTargets="_GetPackageFiles">
+    <!-- Find out the source generator and its dependencies locations -->
+    <MSBuild Projects="@(ProjectReference)"
+             Targets="GetTargetPath"
+             BuildInParallel="true"
+             Properties="TargetFramework=netstandard2.0"
+             Condition="$([System.String]::Copy('%(Identity)').Contains('CSnakes.SourceGeneration'))">
+      <Output TaskParameter="TargetOutputs" ItemName="DependentAssemblies" />
+    </MSBuild>
+
+    <!-- ...and pack the dependencies -->
+    <ItemGroup>
+      <None Include="@(DependentAssemblies)" Pack="true" PackagePath="analyzers/dotnet/cs" />
+    </ItemGroup>
+  </Target>
+</Project>
diff --git a/src/CSnakes.SourceGeneration/CSnakes.SourceGeneration.csproj b/src/CSnakes.SourceGeneration/CSnakes.SourceGeneration.csproj
@@ -3,7 +3,6 @@
     <TargetFrameworks>netstandard2.0</TargetFrameworks>
     <EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
     <NoWarn>$(NoWarn);RS1035</NoWarn>
-    <IsPackable>true</IsPackable>
   </PropertyGroup>
 
   <ItemGroup>
@@ -28,6 +27,4 @@
       <TargetPathWithTargetPlatformMoniker Include="$(PKGSuperpower)\lib\netstandard2.0\Superpower.dll" IncludeRuntimeDependency="false" />
     </ItemGroup>
   </Target>
-
-  <Import Project="Packaging.targets" />
 </Project>
diff --git a/src/CSnakes.SourceGeneration/Packaging.targets b/src/CSnakes.SourceGeneration/Packaging.targets