⬆️ Bump files with dotnet-file sync

# devlooped/oss

- Add grace period support post-install, simplify analyzer/generator devlooped/oss@75d492d
- Fix path to jwk.ps1 alongside the SponsorLink.targets devlooped/oss@c4830fc
- Dynamically fetch devlooped JWK from github devlooped/oss@55124bc
- Replace JWT package in tests targets too devlooped/oss@ba1310c
- Remove dependency on ThisAssembly devlooped/oss@c879f25
- SponsorLink code should be checked as regular code devlooped/oss@e81ab75
- Add support and showcase determining install time devlooped/oss@717ddb1
- Fix formatting/whitespace devlooped/oss@7febebc
- Introduce lazy-init of sponsoring status, simplify diagnostics devlooped/oss@5009784
- Set Version from VersionLabel if it's a refs/tags/ devlooped/oss@57653a2
- Cleanup build and publish to use VersionLabel devlooped/oss@14deaea

.editorconfig

@@ -107,6 +107,3 @@ dotnet_analyzer_diagnostic.category-Style.severity = none
 
 # VSTHRD200: Use "Async" suffix for async methods
 dotnet_diagnostic.VSTHRD200.severity = none
-
-[**/*SponsorLink*/**]
-generated_code = true

.github/workflows/os-matrix.json

@@ -0,0 +1 @@
+[ "ubuntu-latest", "macOS-latest", "windows-latest" ]

.netconfig

@@ -240,11 +240,6 @@
 	sha = a0ae7272f31c766ebb129ea38c11c01df93b6b5d
 	etag = 72ec691a085dc34f946627f7038a82569e44f0b63a9f4a7bd60f0f7b52fd198f
 	weak
-[file "src/SponsorLink/SponsorLink/devlooped.pub.jwk"]
-	url = https://github.com/devlooped/oss/blob/main/src/SponsorLink/SponsorLink/devlooped.pub.jwk
-	sha = a0ae7272f31c766ebb129ea38c11c01df93b6b5d
-	etag = cf884781ff88b4d096841e3169282762a898b2050c9b5dac0013bc15bdbee267
-	weak
 [file "src/SponsorLink/SponsorLink/sponsorable.md"]
 	url = https://github.com/devlooped/oss/blob/main/src/SponsorLink/SponsorLink/sponsorable.md
 	sha = a0ae7272f31c766ebb129ea38c11c01df93b6b5d

src/Directory.Build.props

@@ -46,8 +46,6 @@
 
   <PropertyGroup Label="Build">
     <Configuration Condition="'$(Configuration)' == '' and $(CI)">Release</Configuration>
-    <GenerateDocumentationFile>true</GenerateDocumentationFile>
-    <GenerateDocumentationFile Condition="$(MSBuildProjectName.Contains('Tests'))">false</GenerateDocumentationFile>
     <LangVersion>Latest</LangVersion>
 
     <!-- See https://docs.microsoft.com/en-us/dotnet/standard/assembly/reference-assemblies -->
@@ -118,6 +116,8 @@
 
   <PropertyGroup Label="Version" Condition="$(VersionLabel) != ''">
     <_VersionLabel>$(VersionLabel.Replace('refs/heads/', ''))</_VersionLabel>
+    <_VersionLabel>$(_VersionLabel.Replace('refs/tags/v', ''))</_VersionLabel>
+
     <!-- For PRs, we just need a fixed package version numbered after the PR # itself, so remove the commits # at the end -->
     <_VersionLabel Condition="$(_VersionLabel.Contains('refs/pull/'))">$(VersionLabel.TrimEnd('.0123456789'))</_VersionLabel>
     <!-- Next replace the prefix for simply 'pr', so we end up with 'pr99/merge' by default -->
@@ -128,7 +128,9 @@
     <_VersionLabel>$(_VersionLabel.Replace('/', '-'))</_VersionLabel>
 
     <!-- Set sanitized version to the actual version suffix used in build/pack -->
-    <VersionSuffix>$(_VersionLabel)</VersionSuffix>
+    <VersionSuffix Condition="!$(VersionLabel.Contains('refs/tags/'))">$(_VersionLabel)</VersionSuffix>
+    <!-- Special case for tags, the label is actually the version. Backs compat since passed-in value overrides MSBuild-set one -->
+    <Version Condition="$(VersionLabel.Contains('refs/tags/'))">$(_VersionLabel)</Version>
   </PropertyGroup>
 
   <ItemGroup Label="ThisAssembly.Project">

src/Directory.Build.targets

@@ -4,6 +4,13 @@
   <PropertyGroup Condition="'$(CI)' == 'true' and '$(Language)' == 'C#'">
     <DefineConstants>CI;$(DefineConstants)</DefineConstants>
   </PropertyGroup>
+
+  <PropertyGroup Label="Build">
+    <!-- Tests projects don't need API docs, typically -->
+    <GenerateDocumentationFile Condition="$(GenerateDocumentationFile) == '' and $(IsTestProject) == 'true'">false</GenerateDocumentationFile>
+    <GenerateDocumentationFile Condition="$(GenerateDocumentationFile) == '' and $(MSBuildProjectName.Contains('Tests'))">false</GenerateDocumentationFile>
+    <GenerateDocumentationFile Condition="$(GenerateDocumentationFile) == ''">true</GenerateDocumentationFile>
+  </PropertyGroup>
 
   <PropertyGroup Condition="'$(IsPackable)' == ''">
     <IsPackable Condition="'$(PackAsTool)' == 'true'">true</IsPackable>

src/SponsorLink/Analyzer/Analyzer.csproj

@@ -1,13 +1,16 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
+    <AssemblyName>SponsorableLib.Analyzers</AssemblyName>
     <TargetFramework>netstandard2.0</TargetFramework>
     <IsRoslynComponent>true</IsRoslynComponent>
     <PackFolder>analyzers/dotnet/roslyn4.0</PackFolder>
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
+    <MergeAnalyzerAssemblies>false</MergeAnalyzerAssemblies>
+    <MergeAnalyzerAssemblies Condition="'$(OS)' == 'Windows_NT'">true</MergeAnalyzerAssemblies>
     <CustomAfterMicrosoftCSharpTargets>$(MSBuildThisFileDirectory)..\SponsorLink.targets</CustomAfterMicrosoftCSharpTargets>
-    <MergeAnalyzerAssemblies>true</MergeAnalyzerAssemblies>
     <ImplicitUsings>disable</ImplicitUsings>
+    <FundingPackageId>SponsorableLib</FundingPackageId>
   </PropertyGroup>
 
   <ItemGroup>
@@ -22,11 +25,22 @@
   </ItemGroup>
 
   <ItemGroup>
-    <InternalsVisibleTo Include="Tests" />
+    <None Update="buildTransitive\SponsorableLib.targets" Pack="true" />
   </ItemGroup>
 
   <ItemGroup>
-    <None Update="buildTransitive\SponsorableLib.targets" Pack="true" />
+    <InternalsVisibleTo Include="Tests" />
   </ItemGroup>
 
+  <!-- To support tests, fake an extra sponsorable with the test key -->
+  <Target Name="ReadTestJwk" BeforeTargets="GetAssemblyAttributes">
+    <PropertyGroup>
+      <!-- Read public key we validate manifests against -->
+      <TestJwk>$([System.IO.File]::ReadAllText('$(MSBuildThisFileDirectory)..\Tests\keys\kzu.pub.jwk'))</TestJwk>
+    </PropertyGroup>
+    <ItemGroup>
+      <AssemblyMetadata Include="Funding.GitHub.kzu" Value="$(TestJwk)" />
+    </ItemGroup>
+  </Target>
+
 </Project>

src/SponsorLink/Analyzer/StatusReportingAnalyzer.cs

@@ -1,26 +1,45 @@
-using System.Collections.Immutable;
+using System;
+using System.Collections.Immutable;
+using System.IO;
+using System.Linq;
 using Devlooped.Sponsors;
+using Humanizer;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.Diagnostics;
 using static Devlooped.Sponsors.SponsorLink;
-using static ThisAssembly.Constants;
 
 namespace Analyzer;
 
-[DiagnosticAnalyzer(LanguageNames.CSharp)]
+[DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)]
 public class StatusReportingAnalyzer : DiagnosticAnalyzer
 {
-    public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray<DiagnosticDescriptor>.Empty;
+    public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(new DiagnosticDescriptor(
+        "SL001", "Report Sponsoring Status", "Reports sponsoring status determined by SponsorLink", "Sponsors",
+        DiagnosticSeverity.Warning, true));
 
     public override void Initialize(AnalysisContext context)
     {
         context.EnableConcurrentExecution();
         context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
 
-        context.RegisterCodeBlockAction(c =>
+        context.RegisterCompilationAction(c =>
         {
-            var status = Diagnostics.GetStatus(Funding.Product);
-            Tracing.Trace($"Status: {status}");
+            var installed = c.Options.AdditionalFiles.Where(x =>
+            {
+                var options = c.Options.AnalyzerConfigOptionsProvider.GetOptions(x);
+                // In release builds, we'll have a single such item, since we IL-merge the analyzer.
+                return options.TryGetValue("build_metadata.Analyzer.ItemType", out var itemType) &&
+                       options.TryGetValue("build_metadata.Analyzer.NuGetPackageId", out var packageId) &&
+                       itemType == "Analyzer" &&
+                       packageId == "SponsorableLib";
+            }).Select(x => File.GetLastWriteTime(x.Path)).OrderByDescending(x => x).FirstOrDefault();
+
+            var status = Diagnostics.GetOrSetStatus(() => c.Options);
+
+            if (installed != default)
+                Tracing.Trace($"Status: {status}, Installed: {(DateTime.Now - installed).Humanize()} ago");
+            else
+                Tracing.Trace($"Status: {status}, unknown install time");
         });
     }
 }

src/SponsorLink/Analyzer/StatusReportingGenerator.cs

@@ -0,0 +1,23 @@
+using Devlooped.Sponsors;
+using Microsoft.CodeAnalysis;
+using static Devlooped.Sponsors.SponsorLink;
+
+namespace Analyzer;
+
+[Generator]
+public class StatusReportingGenerator : IIncrementalGenerator
+{
+    public void Initialize(IncrementalGeneratorInitializationContext context)
+    {
+        context.RegisterSourceOutput(
+            // this is required to ensure status is registered properly independently 
+            // of analyzer runs.
+            context.GetSponsorAdditionalFiles().Combine(context.AnalyzerConfigOptionsProvider),
+            (spc, source) =>
+            {
+                var (manifests, options) = source;
+                var status = Diagnostics.GetOrSetStatus(manifests, options);
+                spc.AddSource("StatusReporting.cs", $"// Status: {status}");
+            });
+    }
+}

src/SponsorLink/Analyzer/buildTransitive/SponsorableLib.targets

@@ -1,3 +1,7 @@
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <Import Project="Devlooped.Sponsors.targets"/>
+  <ItemGroup>
+    <!-- Brings in the analyzer file to report installation time -->
+    <FundingPackageId Include="SponsorableLib" />
+  </ItemGroup>
 </Project>

src/SponsorLink/Directory.Build.props

@@ -15,7 +15,11 @@
 
     <!-- Roslyn caches analyzers aggressively so we are better off using a very dynamic version number 
          for local builds where a quick devloop is key. We bump version every 10 seconds -->
-    <Version>42.42.$([System.Math]::Floor($([MSBuild]::Divide($([System.DateTime]::Now.TimeOfDay.TotalSeconds), 10))))</Version>
+    <Epoc>$([System.DateTime]::Parse("2024-03-15"))</Epoc>
+    <TotalDays>$([System.DateTime]::UtcNow.Subtract($(Epoc)).TotalDays)</TotalDays>
+    <Days>$([System.Math]::Truncate($(TotalDays)))</Days>
+    <Seconds>$([System.Math]::Floor($([MSBuild]::Divide($([System.DateTime]::UtcNow.TimeOfDay.TotalSeconds), 10))))</Seconds>
+    <Version>42.$(Days).$(Seconds)</Version>
 
     <Product>SponsorableLib</Product>
   </PropertyGroup>

src/SponsorLink/Library/Library.csproj

@@ -1,11 +1,13 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
+    <AssemblyName>SponsorableLib</AssemblyName>
     <TargetFramework>netstandard2.0</TargetFramework>
     <PackNone>true</PackNone>
     <PackageId>SponsorableLib</PackageId>
     <Description>Sample library incorporating SponsorLink checks</Description>
     <PackOnBuild>true</PackOnBuild>
+    <PublishRepositoryUrl>true</PublishRepositoryUrl>
   </PropertyGroup>
 
   <ItemGroup>
@@ -16,16 +18,8 @@
     <ProjectReference Include="..\Analyzer\Analyzer.csproj" ReferenceOutputAssembly="false" OutputType="Analyzer" />
   </ItemGroup>
 
-  <ItemGroup>
-    <EmbeddedResource Update="Resources.resx">
-      <!-- Default to Just Works resources generation. See https://www.cazzulino.com/resources.html -->
-      <Generator>MSBuild:Compile</Generator>
-      <StronglyTypedFileName>$(IntermediateOutputPath)\$([MSBuild]::ValueOrDefault('%(RelativeDir)', '').Replace('\', '.').Replace('/', '.'))%(Filename).g$(DefaultLanguageSourceExtension)</StronglyTypedFileName>
-      <StronglyTypedLanguage>$(Language)</StronglyTypedLanguage>
-      <StronglyTypedNamespace Condition="'%(RelativeDir)' == ''">$(RootNamespace)</StronglyTypedNamespace>
-      <StronglyTypedNamespace Condition="'%(RelativeDir)' != ''">$(RootNamespace).$([MSBuild]::ValueOrDefault('%(RelativeDir)', '').Replace('\', '.').Replace('/', '.').TrimEnd('.'))</StronglyTypedNamespace>
-      <StronglyTypedClassName>%(Filename)</StronglyTypedClassName>
-    </EmbeddedResource>
-  </ItemGroup>
+  <Target Name="Version" AfterTargets="GetPackageContents" DependsOnTargets="GetPackageTargetPath">
+    <Message Importance="high" Text="$(MSBuildProjectName) &gt; $(PackageTargetPath)" />
+  </Target>
 
 </Project>

src/SponsorLink/Library/readme.md

@@ -0,0 +1,5 @@
+# Sponsorable Library
+
+Example of a library that is available for sponsorship and leverages 
+[SponsorLink](https://github.com/devlooped/SponsorLink) to remind users 
+in an IDE (VS/Rider).

src/SponsorLink/SponsorLink.Tests.targets

@@ -0,0 +1,38 @@
+<Project>
+  <!-- For inclusion in test projects that reference analyzers as project references -->
+
+  <PropertyGroup>
+    <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
+  </PropertyGroup>
+
+  <ItemGroup Condition="'$(ManagePackageVersionsCentrally)' == 'true'">
+    <PackageReference Include="Humanizer.Core" VersionOverride="2.14.1" PrivateAssets="all" Pack="false" />
+    <PackageReference Include="Microsoft.IdentityModel.JsonWebTokens" Version="7.6.2" PrivateAssets="all" Pack="false" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(ManagePackageVersionsCentrally)' != 'true'">
+    <PackageReference Include="Humanizer.Core" Version="2.14.1" PrivateAssets="all" Pack="false" />
+    <PackageReference Include="Microsoft.IdentityModel.JsonWebTokens" Version="7.6.2" PrivateAssets="all" Pack="false" />
+  </ItemGroup>
+
+  <Target Name="AddSponsorLinkAnalyzerDependencies" BeforeTargets="CoreCompile" DependsOnTargets="ResolveLockFileCopyLocalFiles">
+    <ItemGroup>
+      <!-- NOTE: keep in sync with ILRepack'ed assemblies as needed -->
+      <ReferenceCopyLocalAssemblies Include="@(ReferenceCopyLocalPaths)" Condition="'%(Extension)' == '.dll' 
+        And !$([MSBuild]::ValueOrDefault('%(FileName)', '').EndsWith('.resources', StringComparison.OrdinalIgnoreCase))
+        And !$([MSBuild]::ValueOrDefault('%(FileName)', '').StartsWith('ThisAssembly', StringComparison.OrdinalIgnoreCase))" />
+      <Analyzer Include="@(ReferenceCopyLocalAssemblies)" Condition="
+        !$([MSBuild]::ValueOrDefault('%(FileName)', '').StartsWith('Microsoft.CodeAnalysis', StringComparison.OrdinalIgnoreCase)) And
+        !$([MSBuild]::ValueOrDefault('%(FileName)', '').StartsWith('Microsoft.CSharp', StringComparison.OrdinalIgnoreCase)) And
+        !$([MSBuild]::ValueOrDefault('%(FileName)', '').StartsWith('System.', StringComparison.OrdinalIgnoreCase))"
+      />
+      <!-- Brings in System/Microsoft.IdentityModel, System.Text.Encodings.Web, System.Text.Json  -->
+      <Analyzer Include="@(ReferenceCopyLocalAssemblies)" Condition="
+        $([MSBuild]::ValueOrDefault('%(FileName)', '').StartsWith('System.IdentityModel', StringComparison.OrdinalIgnoreCase)) Or
+        $([MSBuild]::ValueOrDefault('%(FileName)', '').StartsWith('Microsoft.IdentityModel', StringComparison.OrdinalIgnoreCase)) Or
+        $([MSBuild]::ValueOrDefault('%(FileName)', '').StartsWith('System.Text', StringComparison.OrdinalIgnoreCase))"
+      />
+    </ItemGroup>
+  </Target>
+
+</Project>