From 138b093b774d780c77a61c3b6062e0de9fc84cbb Mon Sep 17 00:00:00 2001
From: Daniel Cazzulino <daniel@cazzulino.com>
Date: Mon, 30 Sep 2024 18:09:52 -0300
Subject: [PATCH] Avoid non-Git constants conflict, update root comment

As presently defined, if a custom constant in user's project had a naming conflict (i.e. `Root` or `Url`), the item metadata in the editorconfig/options would be mixed up, since it uses the item spec for that.

By using the full area name, we avoid that, and switch instead to the custom root feature of using `Root=.` instead.

We also take advantage of the new custom root summary comment to better reflect the nature of the provided constants.
---
 src/ThisAssembly.Git/ThisAssembly.Git.targets | 24 +++++++++++--------
 1 file changed, 14 insertions(+), 10 deletions(-)

diff --git a/src/ThisAssembly.Git/ThisAssembly.Git.targets b/src/ThisAssembly.Git/ThisAssembly.Git.targets
index d268c09f..31d5b3cc 100644
--- a/src/ThisAssembly.Git/ThisAssembly.Git.targets
+++ b/src/ThisAssembly.Git/ThisAssembly.Git.targets
@@ -6,6 +6,10 @@
     <PackageReference Update="ThisAssembly.Git" PrivateAssets="all" PackTransitive="false" />
   </ItemGroup>
 
+  <PropertyGroup>
+    <ThisAssemblyGitComment>Provides access to build-time git information</ThisAssemblyGitComment>
+  </PropertyGroup>
+
   <PropertyGroup Condition="'$(RepositoryBranch)' == ''">
     <!-- GitHub Actions: https://docs.github.com/en/actions/reference/environment-variables#default-environment-variables -->
     <RepositoryBranch Condition="'$(RepositoryBranch)' == '' and '$(GITHUB_REF)' != '' and $(GITHUB_REF.Contains('refs/pull/'))">pr$(GITHUB_REF.Replace('refs/pull/', '').Replace('/merge', ''))</RepositoryBranch>
@@ -82,18 +86,18 @@
       <EmptySourceControlValue>[pending build]</EmptySourceControlValue>
     </PropertyGroup>
     <ItemGroup Condition="'$(EnableSourceControlManagerQueries)' != 'true'">
-      <Constant Include="Branch" Value="$(EmptySourceControlValue)" Root="Git" />
-      <Constant Include="Commit" Value="$(EmptySourceControlValue)" Root="Git" />
-      <Constant Include="Sha" Value="$(EmptySourceControlValue)" Root="Git" />
-      <Constant Include="Root" Value="$(EmptySourceControlValue)" Root="Git" />
-      <Constant Include="Url" Value="$(EmptySourceControlValue)" Root="Git" />
+      <Constant Include="Git.Branch" Value="$(EmptySourceControlValue)" Root="." RootComment="$(ThisAssemblyGitComment)" />
+      <Constant Include="Git.Commit" Value="$(EmptySourceControlValue)" Root="." RootComment="$(ThisAssemblyGitComment)" />
+      <Constant Include="Git.Sha" Value="$(EmptySourceControlValue)" Root="." RootComment="$(ThisAssemblyGitComment)" />
+      <Constant Include="Git.Root" Value="$(EmptySourceControlValue)" Root="." RootComment="$(ThisAssemblyGitComment)" />
+      <Constant Include="Git.Url" Value="$(EmptySourceControlValue)" Root="." RootComment="$(ThisAssemblyGitComment)" />
     </ItemGroup>
     <ItemGroup Condition="'$(EnableSourceControlManagerQueries)' == 'true'">
-      <Constant Include="Branch" Value="$(RepositoryBranch)" Root="Git" />
-      <Constant Include="Commit" Value="$(RepositoryCommit)" Root="Git" />
-      <Constant Include="Sha" Value="$(RepositorySha)" Root="Git" />
-      <Constant Include="Root" Value="$(RepositoryRoot.Replace('\', '/'))" Root="Git" />
-      <Constant Include="Url" Value="$(RepositoryUrl)" Root="Git" />
+      <Constant Include="Git.Branch" Value="$(RepositoryBranch)" Root="." RootComment="$(ThisAssemblyGitComment)" />
+      <Constant Include="Git.Commit" Value="$(RepositoryCommit)" Root="." RootComment="$(ThisAssemblyGitComment)" />
+      <Constant Include="Git.Sha" Value="$(RepositorySha)" Root="." RootComment="$(ThisAssemblyGitComment)" />
+      <Constant Include="Git.Root" Value="$(RepositoryRoot.Replace('\', '/'))" Root="." RootComment="$(ThisAssemblyGitComment)" />
+      <Constant Include="Git.Url" Value="$(RepositoryUrl)" Root="." RootComment="$(ThisAssemblyGitComment)" />
     </ItemGroup>
   </Target>