feature: Importing extra build/ content in Plugins (#215)

Author: amis92

README.md

@@ -29,6 +29,7 @@ Instructions on development and using this project's source code are in [CONTRIB
     - [Package your code generator](#package-your-code-generator)
       - [Separate out the attribute](#separate-out-the-attribute)
       - [Create the metapackage](#create-the-metapackage)
+      - [Add extra `build/` content in Plugin package](#add-extra-build-content-in-plugin-package)
 
 ## How to write your own code generator
 
@@ -457,6 +458,14 @@ as it's dependant packages.
 
 > 📋 For a sample metapackage, see [MetapackageSample](samples/MetapackageSample/).
 
+
+#### Add extra `build/` content in Plugin package
+
+`CG.R.Plugin.Sdk` creates custom `build/PackageId.props/targets` files. If you want
+to add custom MSBuild props/targets into NuGet package's `build` folder (and have it
+imported when package is referenced), you'll need to use `PackageBuildFolderProjectImport`
+ItemGroup, as shown in `PackagedGenerator` sample.
+
 [NuPkg]: https://nuget.org/packages/CodeGeneration.Roslyn
 [AttrNuPkg]: https://nuget.org/packages/CodeGeneration.Roslyn.Attributes
 [ToolNuPkg]: https://nuget.org/packages/CodeGeneration.Roslyn.Tool

samples/PackageConsumer/PackageConsumer.csproj

@@ -14,4 +14,10 @@
     </PackageReference>
   </ItemGroup>
 
+  <!-- This target tests whether using PackageBuildFolderProjectImport in Plugin works as expected. -->
+  <Target Name="CheckPluginBuildPropsTargetsImported" AfterTargets="AfterBuild">
+    <Error Text="Generator Test.props not imported." Condition=" '$(TestPropertyProps)' != 'true' " />
+    <Error Text="Generator Test.targets not imported." Condition=" '$(TestPropertyTargets)' != 'true' " />
+  </Target>
+
 </Project>

samples/PackagedGenerator/PackagedGenerator.csproj

@@ -7,6 +7,11 @@
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="build/**" Pack="true" PackagePath="build" KeepDuplicates="false" />
+    <PackageBuildFolderProjectImport Include="@(None->'%(Filename)%(Extension)')"/>
+  </ItemGroup>
+
   <Import Project="$(CodeGenerationRoslynPluginSdkPath)Sdk.targets" />
 
 </Project>

samples/PackagedGenerator/build/Test.props

@@ -0,0 +1,5 @@
+<Project>
+    <PropertyGroup>
+        <TestPropertyProps>true</TestPropertyProps>
+    </PropertyGroup>
+</Project>

samples/PackagedGenerator/build/Test.targets

@@ -0,0 +1,5 @@
+<Project>
+    <PropertyGroup>
+        <TestPropertyTargets>true</TestPropertyTargets>
+    </PropertyGroup>
+</Project>

src/CodeGeneration.Roslyn.Plugin.Sdk/build/BuildPluginPackage.targets

@@ -41,18 +41,27 @@
   </Target>
 
   <!--
-    This target writes a PackageId.props file that will get packed into build/ folder in NuGet.
-    That props file adds the path to the Plugin dll to the CodeGenerationRoslynPlugin ItemGroup,
-    so that CodeGeneration.Roslyn tooling can read and load generator plugins.
+    This target writes PackageId.props/targets files that will get packed into build/ folder in NuGet.
+    Those MSBuild files add the path to the Plugin dll to the CodeGenerationRoslynPlugin ItemGroup,
+    so that CodeGeneration.Roslyn tooling can read and load generator plugins, and additionally
+    create a target that checks whether the Tool targets were imported, and warns if they weren't.
+
+    It also imports any PackageBuildFolderProjectImport items as per extension - .props in .props,
+    .targets in .targets. It doesn't handle actually packaging those files correctly.
   -->
   <Target Name="CreatePluginPackageBuildProps"
           DependsOnTargets="DefinePluginPackagePath"
           Condition=" '$(PackAsCodeGenerationRoslynPlugin)' == 'true' ">
+    <ItemGroup>
+      <_PackageBuildFolderProjectImport_props Include="@(PackageBuildFolderProjectImport->Distinct())" Condition=" '%(Extension)' == '.props' " />
+      <_PackageBuildFolderProjectImport_targets Include="@(PackageBuildFolderProjectImport->Distinct())" Condition=" '%(Extension)' == '.targets' " />
+    </ItemGroup>
     <PropertyGroup>
       <PackagePropsContent>
         <![CDATA[
 <?xml version="1.0" encoding="utf-8" ?>
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+@(_PackageBuildFolderProjectImport_props->'  <Import Project="%(Identity)" />', '%0D%0A')
   <ItemGroup>
     <CodeGenerationRoslynPlugin Include="%24(MSBuildThisFileDirectory)../$(PluginPackagePath)/$(TargetFileName)" />
   </ItemGroup>
@@ -63,6 +72,7 @@
         <![CDATA[
 <?xml version="1.0" encoding="utf-8" ?>
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+@(_PackageBuildFolderProjectImport_targets->'  <Import Project="%(Identity)" />', '%0D%0A')
   <Target Name="CheckCgrToolUsed" BeforeTargets="Build">
     <Warning Condition=" '%24(UsingCodeGenerationRoslynToolTargets)' != 'true' " Text="CodeGeneration.Roslyn.Tool build targets weren't detected. CG.R Plugins (generators) won't be run without importing targets from the CodeGeneration.Roslyn.Tool package (v$(PackageVersion))." />
   </Target>