Refactor common files and resources into a shared project

Instead of linked files which is less intuitive and manageable.
devlooped · Jun 9, 2024 · 4cd6a55 · 4cd6a55
1 parent bf7c169
commit 4cd6a55
Show file tree

Hide file tree

Showing 18 changed files with 113 additions and 18 deletions.
diff --git a/ThisAssembly.sln b/ThisAssembly.sln
@@ -10,9 +10,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		.editorconfig = .editorconfig
 		src\Directory.props = src\Directory.props
 		src\Directory.targets = src\Directory.targets
-		src\Directory.targets.user = src\Directory.targets.user
 		readme.md = readme.md
-		src\ThisAssembly.Prerequisites.targets = src\ThisAssembly.Prerequisites.targets
 	EndProjectSection
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ThisAssembly", "src\ThisAssembly\ThisAssembly.csproj", "{D3A47732-4937-4B6E-BCD1-66896D04E20D}"
@@ -40,6 +38,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ThisAssembly.Resources", "s
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ThisAssembly.Git", "src\ThisAssembly.Git\ThisAssembly.Git.csproj", "{F34F8470-7C60-4BB8-ACB5-569D6D0F6A46}"
 EndProject
+Project("{D954291E-2A0B-460D-934E-DC6B0785DB48}") = "Shared", "src\Shared\Shared.shproj", "{8E0F2A43-C9AF-4E46-BF70-CF8645371C12}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -92,4 +92,14 @@ Global
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {ADF2DC9F-5F77-4F6E-8804-CFF5892CD064}
 	EndGlobalSection
+	GlobalSection(SharedMSBuildProjectFiles) = preSolution
+		src\Shared\Shared.projitems*{14d0c5ba-8410-4454-87a2-7bf5993e1ea2}*SharedItemsImports = 5
+		src\Shared\Shared.projitems*{31c53cce-13fc-4890-803a-85cd146b909b}*SharedItemsImports = 5
+		src\Shared\Shared.projitems*{3e7158b5-bfef-4416-8226-9096c7c98268}*SharedItemsImports = 5
+		src\Shared\Shared.projitems*{8e0f2a43-c9af-4e46-bf70-cf8645371c12}*SharedItemsImports = 13
+		src\Shared\Shared.projitems*{a91c7a07-ffd6-4d19-bd78-b0bc8f9267db}*SharedItemsImports = 5
+		src\Shared\Shared.projitems*{b5007099-8be7-490b-9e9a-18cc50c92c29}*SharedItemsImports = 5
+		src\Shared\Shared.projitems*{cddf83bc-70be-46c3-bd79-524d868a2812}*SharedItemsImports = 5
+		src\Shared\Shared.projitems*{f34f8470-7c60-4bb8-acb5-569d6d0f6a46}*SharedItemsImports = 5
+	EndGlobalSection
 EndGlobal
diff --git a/src/Directory.props b/src/Directory.props
@@ -25,8 +25,4 @@
     <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
   </PropertyGroup>
 
-  <ItemGroup>
-    <Compile Include="$(MSBuildThisFileDirectory)*.cs" />
-  </ItemGroup>
-
 </Project>
diff --git a/src/Directory.targets b/src/Directory.targets
@@ -7,12 +7,6 @@
 
     <PackageFile Include="$(MSBuildThisFileDirectory)_._" PackagePath="lib/netstandard2.0/_._" />
     <PackageFile Include="*.props;*.targets" PackagePath="build\$(TargetFramework)\%(Filename)%(Extension)" Visible="true" />
-
-    <!-- Add prerequisites to package -->
-    <None Include="$(MSBuildThisFileDirectory)ThisAssembly.Prerequisites.targets" 
-          CopyToOutputDirectory="PreserveNewest" 
-          PackagePath="build\$(TargetFramework)\%(Filename)%(Extension)"
-          Condition="'$(IncludePrerequisites)' != 'false'"/>
   </ItemGroup>
 
 </Project>
diff --git a/src/EmbeddedResource.cs → src/Shared/EmbeddedResource.cs b/src/EmbeddedResource.cs → src/Shared/EmbeddedResource.cs
diff --git a/src/PathSanitizer.cs → src/Shared/PathSanitizer.cs b/src/PathSanitizer.cs → src/Shared/PathSanitizer.cs
diff --git a/src/Shared/Shared.projitems b/src/Shared/Shared.projitems
@@ -0,0 +1,31 @@
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <HasSharedItems>true</HasSharedItems>
+    <SharedGUID>8e0f2a43-c9af-4e46-bf70-cf8645371c12</SharedGUID>
+  </PropertyGroup>
+  <ItemGroup>
+    <Compile Include="$(MSBuildThisFileDirectory)**/*$(DefaultLanguageSourceExtension)" Source="Shared" />
+    <EmbeddedResource Include="$(MSBuildThisFileDirectory)**/*.resx" Source="Shared" />
+    <None Include="$(MSBuildThisFileDirectory)**/*" Exclude="$(MSBuildThisFileDirectory)*.projitems;$(MSBuildThisFileDirectory)*.shproj" Source="Shared" />
+    <None Remove="$(MSBuildThisFileDirectory)**/*$(DefaultLanguageSourceExtension)" />
+    <None Remove="$(MSBuildThisFileDirectory)**/*.resx" />
+  </ItemGroup>
+  <ItemGroup>
+    <Compile Update="@(Compile -&gt; WithMetadataValue('Source', 'Shared'))">
+      <Link>%(RecursiveDir)%(Filename)%(Extension)</Link>
+    </Compile>
+    <EmbeddedResource Update="@(EmbeddedResource -&gt; WithMetadataValue('Source', 'Shared'))">
+      <Link>%(RecursiveDir)%(Filename)%(Extension)</Link>
+    </EmbeddedResource>
+    <None Update="@(None -&gt; WithMetadataValue('Source', 'Shared'))">
+      <Link>%(RecursiveDir)%(Filename)%(Extension)</Link>
+    </None>
+  </ItemGroup>
+  <ItemGroup>
+    <!-- Add prerequisites to package -->
+    <None Update="$(MSBuildThisFileDirectory)*.props;$(MSBuildThisFileDirectory)*.targets" Condition="'$(PackSharedTargets)' != 'false'">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      <PackagePath>build\$(TargetFramework)\%(Filename)%(Extension)</PackagePath>
+    </None>
+  </ItemGroup>
+</Project>
diff --git a/src/Shared/Shared.shproj b/src/Shared/Shared.shproj
@@ -0,0 +1,16 @@
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup Label="Globals">
+    <ProjectGuid>8e0f2a43-c9af-4e46-bf70-cf8645371c12</ProjectGuid>
+  </PropertyGroup>
+  <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
+  <Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\CodeSharing\Microsoft.CodeSharing.Common.Default.props" />
+  <Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\CodeSharing\Microsoft.CodeSharing.Common.props" />
+  <Import Project="Shared.projitems" Label="Shared" />
+  <Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\CodeSharing\Microsoft.CodeSharing.CSharp.targets" />
+  <ItemGroup>
+    <PackageFile Remove="ThisAssembly.Prerequisites.targets" />
+  </ItemGroup>
+  <ItemGroup>
+    <UpToDateCheck Remove="ThisAssembly.Prerequisites.targets" />
+  </ItemGroup>
+</Project>
diff --git a/src/Shared/ThisAssembly.Prerequisites.targets b/src/Shared/ThisAssembly.Prerequisites.targets
@@ -0,0 +1,33 @@
+<Project>
+
+  <PropertyGroup>
+    <!-- Incremental source generator interface appeared first on Roslyn 4.0.1, see 
+         https://learn.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.iincrementalgenerator?view=roslyn-dotnet-4.0.1 -->
+    <ThisAssemblyMinimumRoslynVersion Condition="'$(ThisAssemblyMinimumRoslynVersion)' == ''">4.0</ThisAssemblyMinimumRoslynVersion>
+  </PropertyGroup>
+
+  <Target Name="_ThisAssemblyCheckCompilerVersion" BeforeTargets="CoreCompile">
+
+    <!-- Version comparison functions require MSBuild 16.5+ -->
+    <Error Text="ThisAssembly requires MSBuild 16.5 or greater."
+            Condition="$([System.Version]::Parse('16.5.0').CompareTo($([System.Version]::Parse($(MSBuildVersion))))) == 1" />
+
+    <PropertyGroup>
+      <!-- CompilerApiVersion comes from Microsoft.Managed.Core.CurrentVersions.targets -->
+      <RoslynVersion Condition="'$(CompilerApiVersion)' != ''">$(CompilerApiVersion.Substring(6))</RoslynVersion>
+      <RoslynVersion Condition="'$(RoslynVersion)' == ''">0.0</RoslynVersion>
+    </PropertyGroup>
+
+    <!-- Don't enforce compiler version for F#, since it's not surfacing the CompilerApiversion at all. 
+         See https://github.com/dotnet/sdk/blob/main/src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.PackageDependencyResolution.targets#L214 -->
+    <Warning Code="THIS001"
+             Text="ThisAssembly requires Compiler API (Roslyn) version $(ThisAssemblyMinimumRoslynVersion) or greater."
+             Condition="$([MSBuild]::VersionLessThan('$(RoslynVersion)', '$(ThisAssemblyMinimumRoslynVersion)')) and 
+                        ('$(Language)' == 'C#' Or '$(Language)' == 'VB')" />
+  </Target>
+
+  <PropertyGroup>
+    <ThisAssemblyPrerequisitesImported>true</ThisAssemblyPrerequisitesImported>
+  </PropertyGroup>
+
+</Project>
diff --git a/src/ThisAssembly.AssemblyInfo/ThisAssembly.AssemblyInfo.csproj b/src/ThisAssembly.AssemblyInfo/ThisAssembly.AssemblyInfo.csproj
@@ -51,4 +51,6 @@ on the `ThisAssembly.Info` class.
     <None Include="SponsorLink.cs" />
   </ItemGroup>
 
+  <Import Project="..\Shared\Shared.projitems" Label="Shared" />
+
 </Project>
diff --git a/src/ThisAssembly.Constants/ThisAssembly.Constants.csproj b/src/ThisAssembly.Constants/ThisAssembly.Constants.csproj
@@ -67,4 +67,6 @@ C#:
     <PackageReference Include="PolySharp" Version="1.14.1" PrivateAssets="All" />
   </ItemGroup>
 
+  <Import Project="..\Shared\Shared.projitems" Label="Shared" />
+
 </Project>
diff --git a/src/ThisAssembly.Git/ThisAssembly.Git.csproj b/src/ThisAssembly.Git/ThisAssembly.Git.csproj
@@ -42,4 +42,6 @@
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="all" />
   </ItemGroup>
 
+  <Import Project="..\Shared\Shared.projitems" Label="Shared" />
+
 </Project>
diff --git a/src/ThisAssembly.Metadata/ThisAssembly.Metadata.csproj b/src/ThisAssembly.Metadata/ThisAssembly.Metadata.csproj
@@ -63,4 +63,6 @@ C#:
     <PackageReference Include="PolySharp" Version="1.14.1" PrivateAssets="All" />
   </ItemGroup>
 
+  <Import Project="..\Shared\Shared.projitems" Label="Shared" />
+
 </Project>
diff --git a/src/ThisAssembly.Project/ThisAssembly.Project.csproj b/src/ThisAssembly.Project/ThisAssembly.Project.csproj
@@ -58,4 +58,6 @@ C#:
     <PackageReference Include="PolySharp" Version="1.14.1" PrivateAssets="All" />
   </ItemGroup>
 
+  <Import Project="..\Shared\Shared.projitems" Label="Shared" />
+
 </Project>
diff --git a/src/ThisAssembly.Resources/ResourcesGenerator.cs b/src/ThisAssembly.Resources/ResourcesGenerator.cs
@@ -16,7 +16,7 @@ public void Initialize(IncrementalGeneratorInitializationContext context)
         {
             context.RegisterPostInitializationOutput(
                 spc => spc.AddSource(
-                    "ThisAssembly.Resources.EmbeddedResource.cs",
+                    "ThisAssembly.EmbeddedResource.cs",
                     SourceText.From(EmbeddedResource.GetContent("EmbeddedResource.cs"), Encoding.UTF8)));
 
             var files = context.AdditionalTextsProvider

diff --git a/src/ThisAssembly.Resources/ThisAssembly.Resources.csproj b/src/ThisAssembly.Resources/ThisAssembly.Resources.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
@@ -40,11 +40,13 @@
   </ItemGroup>
 
   <ItemGroup>
-    <EmbeddedResource Include="..\EmbeddedResource.cs" />
+    <None Include="SponsorLink.cs" />
   </ItemGroup>
 
+  <Import Project="..\Shared\Shared.projitems" Label="Shared" />
+
   <ItemGroup>
-    <None Include="SponsorLink.cs" />
+    <EmbeddedResource Include="@(Compile -> WithMetadataValue('Filename', 'EmbeddedResource'))" />
   </ItemGroup>
 
 </Project>
diff --git a/src/ThisAssembly.Strings/ThisAssembly.Strings.csproj b/src/ThisAssembly.Strings/ThisAssembly.Strings.csproj
@@ -48,5 +48,7 @@ such as "Hello {name}".
   <ItemGroup>
     <None Include="SponsorLink.cs" />
   </ItemGroup>
+
+  <Import Project="..\Shared\Shared.projitems" Label="Shared" />
 
 </Project>
diff --git a/src/ThisAssembly.Tests/ThisAssembly.Tests.csproj b/src/ThisAssembly.Tests/ThisAssembly.Tests.csproj
@@ -78,7 +78,7 @@
     <Compile Include="..\ThisAssembly.Strings\Model.cs" Link="Model.cs" />
   </ItemGroup>
 
-  <Import Project="..\ThisAssembly.Prerequisites.targets" />
+  <Import Project="..\Shared\ThisAssembly.Prerequisites.targets" />
   <Import Project="..\*\ThisAssembly*.targets" />
 
 </Project>
diff --git a/src/ThisAssembly/ThisAssembly.csproj b/src/ThisAssembly/ThisAssembly.csproj
@@ -4,7 +4,8 @@
     <TargetFramework>netstandard2.0</TargetFramework>
     <IsPackable>true</IsPackable>
     <PackBuildOutput>false</PackBuildOutput>
-    <IncludePrerequisites>false</IncludePrerequisites>
+    <!-- Whether to include targets from Shared project -->
+    <PackSharedTargets>false</PackSharedTargets>
   </PropertyGroup>
 
   <PropertyGroup>