Skip to content

Make CollectDeclaredReferences support incremental builds #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dfederm merged 1 commit into from
Apr 24, 2026
Merged

Make CollectDeclaredReferences support incremental builds #139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 75 additions & 13 deletions src/Package/build/ReferenceTrimmer.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,22 @@
<UsingTask TaskName="CollectDeclaredReferencesTask" AssemblyFile="$(ReferenceTrimmerTasksAssembly)" />

<PropertyGroup>
<CoreCompileDependsOn Condition="'$(EnableReferenceTrimmer)' != 'false'">$(CoreCompileDependsOn);CollectDeclaredReferences</CoreCompileDependsOn>
<CoreCompileDependsOn Condition="'$(EnableReferenceTrimmer)' != 'false'">$(CoreCompileDependsOn);_StabilizeCollectDeclaredReferences</CoreCompileDependsOn>
</PropertyGroup>
<ItemGroup>
<CompilerVisibleProperty Include="EnableReferenceTrimmerDiagnostics"/>
<CompilerVisibleProperty Include="ReferenceTrimmerUseSymbolAnalysis"/>
</ItemGroup>

<Target Name="CollectDeclaredReferences" DependsOnTargets="ResolveAssemblyReferences;PrepareProjectReferences" Condition="'$(EnableReferenceTrimmer)' != 'false'">
<Target Name="_PrepareCollectDeclaredReferences"
DependsOnTargets="ResolveAssemblyReferences;PrepareProjectReferences"
Condition="'$(EnableReferenceTrimmer)' != 'false'">
<PropertyGroup>
<_ReferenceTrimmerDeclaredReferencesFile>$([System.IO.Path]::GetFullPath('$(IntermediateOutputPath)_ReferenceTrimmer_DeclaredReferences.tsv'))</_ReferenceTrimmerDeclaredReferencesFile>
<_ReferenceTrimmerDeclaredReferencesFile>$([System.IO.Path]::GetFullPath('$(IntermediateOutputPath)_ReferenceTrimmer_DeclaredReferences.raw.tsv'))</_ReferenceTrimmerDeclaredReferencesFile>
<_ReferenceTrimmerUsedReferencesFile>$([System.IO.Path]::GetFullPath('$(IntermediateOutputPath)_ReferenceTrimmer_UsedReferences.log'))</_ReferenceTrimmerUsedReferencesFile>
<_ReferenceTrimmerUnusedReferencesFile>$([System.IO.Path]::GetFullPath('$(IntermediateOutputPath)_ReferenceTrimmer_UnusedReferences.log'))</_ReferenceTrimmerUnusedReferencesFile>
<_ReferenceTrimmerCollectInputsCacheFile>$([System.IO.Path]::GetFullPath('$(IntermediateOutputPath)_ReferenceTrimmer_CollectDeclaredReferences.cache'))</_ReferenceTrimmerCollectInputsCacheFile>
<_ReferenceTrimmerStableDeclaredReferencesFile>$([System.IO.Path]::GetFullPath('$(IntermediateOutputPath)_ReferenceTrimmer_DeclaredReferences.tsv'))</_ReferenceTrimmerStableDeclaredReferencesFile>
</PropertyGroup>
<ItemGroup>
<!--
Expand All @@ -27,11 +31,50 @@
<_ReferenceTrimmerResolvedReferences Include="@(ReferencePathWithRefAssemblies)" Condition="'%(ReferencePathWithRefAssemblies.ReferenceSourceTarget)' == 'ResolveAssemblyReference'"/>

<_ReferenceTrimmerProjectReferences Include="@(ReferencePathWithRefAssemblies)" Condition="'%(ReferencePathWithRefAssemblies.ReferenceSourceTarget)' == 'ProjectReference'" />

<!-- Hash non-file inputs so changes to item groups and properties are detected -->
<_CollectDeclaredReferencesHashInputs Include="@(_ReferenceTrimmerReferences -> 'REF=%(Identity)')" />
<_CollectDeclaredReferencesHashInputs Include="@(PackageReference -> 'PKG=%(Identity)')" />
<_CollectDeclaredReferencesHashInputs Include="@(ReferenceTrimmerIgnorePackageBuildFiles -> 'IGN=%(Identity)')" />
<_CollectDeclaredReferencesHashInputs Include="TFM=$(ReferringTargetFrameworkForProjectReferences)" />
<_CollectDeclaredReferencesHashInputs Include="TPM=$(TargetPlatformMoniker)" />
<_CollectDeclaredReferencesHashInputs Include="RID=$(RuntimeIdentifier)" />
<_CollectDeclaredReferencesHashInputs Include="NPR=$(NuGetPackageRoot)" />
</ItemGroup>

<Hash ItemsToHash="@(_CollectDeclaredReferencesHashInputs)">
<Output TaskParameter="HashResult" PropertyName="_CollectDeclaredReferencesHash" />
</Hash>

<WriteLinesToFile
Lines="$(_CollectDeclaredReferencesHash)"
File="$(_ReferenceTrimmerCollectInputsCacheFile)"
Overwrite="true"
WriteOnlyWhenDifferent="true" />

<ItemGroup>
<!-- File-based inputs -->
<_CollectDeclaredReferencesInputs Include="$(ProjectAssetsFile)" Condition="Exists('$(ProjectAssetsFile)')" />
<_CollectDeclaredReferencesInputs Include="@(_ReferenceTrimmerResolvedReferences)" />
<_CollectDeclaredReferencesInputs Include="@(_ReferenceTrimmerProjectReferences)" />
<!-- Cache file captures non-file inputs (item groups, properties) -->
<_CollectDeclaredReferencesInputs Include="$(_ReferenceTrimmerCollectInputsCacheFile)" />

<!-- https://github.com/dotnet/roslyn/blob/main/docs/analyzers/Using%20Additional%20Files.md#in-a-project-file -->
<AdditionalFiles Include="$(_ReferenceTrimmerStableDeclaredReferencesFile)" />
<FileWrites Include="$(_ReferenceTrimmerDeclaredReferencesFile)" />
<FileWrites Include="$(_ReferenceTrimmerStableDeclaredReferencesFile)" />
<FileWrites Include="$(_ReferenceTrimmerCollectInputsCacheFile)" />
</ItemGroup>
</Target>

<Target Name="CollectDeclaredReferences"
DependsOnTargets="_PrepareCollectDeclaredReferences"
Condition="'$(EnableReferenceTrimmer)' != 'false'"
Inputs="@(_CollectDeclaredReferencesInputs)"
Outputs="$(_ReferenceTrimmerDeclaredReferencesFile)">
<CollectDeclaredReferencesTask
OutputFile="$(_ReferenceTrimmerDeclaredReferencesFile)"
MSBuildProjectFile="$(MSBuildProjectFile)"
References="@(_ReferenceTrimmerReferences)"
ResolvedReferences="@(_ReferenceTrimmerResolvedReferences)"
ProjectReferences="@(_ReferenceTrimmerProjectReferences)"
Expand All @@ -44,23 +87,42 @@
TargetFrameworkDirectories="$(TargetFrameworkDirectory)"
IgnorePackageBuildFiles="@(ReferenceTrimmerIgnorePackageBuildFiles)"
NuGetPackageRoot="$(NuGetPackageRoot)" />
</Target>

<ItemGroup>
<!-- https://github.com/dotnet/roslyn/blob/main/docs/analyzers/Using%20Additional%20Files.md#in-a-project-file -->
<AdditionalFiles Include="$(_ReferenceTrimmerDeclaredReferencesFile)" />
<EmbedInBinlog Include="$(_ReferenceTrimmerDeclaredReferencesFile)" />
<FileWrites Include="$(_ReferenceTrimmerDeclaredReferencesFile)" />
</ItemGroup>
<!--
Stabilize the declared references file for the compiler. The raw .tsv is written
by CollectDeclaredReferences whenever it runs, but we don't want its timestamp
changes to trigger a CoreCompile re-run when content hasn't changed.
WriteOnlyWhenDifferent ensures the stable file's timestamp only changes when
content actually differs.
-->
<Target Name="_StabilizeCollectDeclaredReferences"
DependsOnTargets="CollectDeclaredReferences"
Condition="'$(EnableReferenceTrimmer)' != 'false'"
Inputs="$(_ReferenceTrimmerDeclaredReferencesFile)"
Outputs="$(_ReferenceTrimmerStableDeclaredReferencesFile)">
<ReadLinesFromFile File="$(_ReferenceTrimmerDeclaredReferencesFile)">
<Output TaskParameter="Lines" ItemName="_ReferenceTrimmerDeclaredReferencesLines" />
</ReadLinesFromFile>

<WriteLinesToFile
Lines="@(_ReferenceTrimmerDeclaredReferencesLines)"
File="$(_ReferenceTrimmerStableDeclaredReferencesFile)"
Overwrite="true"
WriteOnlyWhenDifferent="true" />
</Target>

<Target Name="_EmbedReferenceTrimmerDiagnosticsInBinlog"
AfterTargets="CoreCompile"
Condition="'$(EnableReferenceTrimmer)' != 'false' and '$(EnableReferenceTrimmerDiagnostics)' == 'true'">
<ItemGroup Condition="Exists('$(_ReferenceTrimmerUsedReferencesFile)')">
Condition="'$(EnableReferenceTrimmer)' != 'false'">
<ItemGroup Condition="Exists('$(_ReferenceTrimmerDeclaredReferencesFile)')">
<EmbedInBinlog Include="$(_ReferenceTrimmerDeclaredReferencesFile)" />
</ItemGroup>
<ItemGroup Condition="'$(EnableReferenceTrimmerDiagnostics)' == 'true' and Exists('$(_ReferenceTrimmerUsedReferencesFile)')">
<EmbedInBinlog Include="$(_ReferenceTrimmerUsedReferencesFile)" />
<FileWrites Include="$(_ReferenceTrimmerUsedReferencesFile)" />
</ItemGroup>
<ItemGroup Condition="Exists('$(_ReferenceTrimmerUnusedReferencesFile)')">
<ItemGroup Condition="'$(EnableReferenceTrimmerDiagnostics)' == 'true' and Exists('$(_ReferenceTrimmerUnusedReferencesFile)')">
<EmbedInBinlog Include="$(_ReferenceTrimmerUnusedReferencesFile)" />
<FileWrites Include="$(_ReferenceTrimmerUnusedReferencesFile)" />
</ItemGroup>
Expand Down
29 changes: 6 additions & 23 deletions src/Tasks/CollectDeclaredReferencesTask.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
using System.Reflection;
using System.Text;
using System.Xml.Linq;
using Microsoft.Build.Framework;
using NuGet.Common;
Expand Down Expand Up @@ -30,9 +29,6 @@ public sealed class CollectDeclaredReferencesTask : MSBuildTask
[Required]
public string? OutputFile { get; set; }

[Required]
public string? MSBuildProjectFile { get; set; }

public ITaskItem[]? References { get; set; }

public ITaskItem[]? ResolvedReferences { get; set; }
Expand Down Expand Up @@ -482,35 +478,22 @@ private static void SaveDeclaredReferences(IReadOnlyList<DeclaredReference> decl
{
const char fieldDelimiter = '\t';

StringBuilder writer = new();
using StreamWriter writer = new(filePath);
foreach (DeclaredReference reference in declaredReferences)
{
writer.Append(reference.AssemblyPath);
writer.Append(fieldDelimiter);
writer.Write(reference.AssemblyPath);
writer.Write(fieldDelimiter);
string kindString = reference.Kind switch
{
DeclaredReferenceKind.Reference => nameof(DeclaredReferenceKind.Reference),
DeclaredReferenceKind.ProjectReference => nameof(DeclaredReferenceKind.ProjectReference),
DeclaredReferenceKind.PackageReference => nameof(DeclaredReferenceKind.PackageReference),
_ => throw new InvalidDataException($"Unknown reference kind '{reference.Kind}'."),
};
writer.Append(kindString);
writer.Append(fieldDelimiter);
writer.Append(reference.Spec);
writer.AppendLine();
writer.Write(kindString);
writer.Write(fieldDelimiter);
writer.WriteLine(reference.Spec);
}

string newContent = writer.ToString();
if (File.Exists(filePath))
{
string existing = File.ReadAllText(filePath);
if (string.Equals(existing, newContent, StringComparison.OrdinalIgnoreCase))
{
return;
}
}

File.WriteAllText(filePath, newContent);
}

private sealed class PackageInfoBuilder
Expand Down
Loading