From ce10dacdfc7890a317a45275a52dff1f77a65b53 Mon Sep 17 00:00:00 2001 From: Alex S Date: Tue, 10 Feb 2026 16:26:34 -0800 Subject: [PATCH 1/5] Add ability to skip packages --- README.md | 12 ++++++++++++ src/Package/build/ReferenceTrimmer.targets | 1 + src/Tasks/CollectDeclaredReferencesTask.cs | 14 +++++++++++++- src/Tests/E2ETests.cs | 1 + .../Library/Library.csproj | 8 ++++++++ 5 files changed, 35 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3d1cfb3..b26f034 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,18 @@ You can turn off specific docxml related warnings and errors while defaulting Re Note: To get better results, enable the [`IDE0005`](https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/ide0005) unnecessary `using` rule. This avoids the C# compiler seeing a false positive assembly usage from unneeded `using` directives causing it to miss a removable dependency. See also the note for why IDE0005 code analysis rule requires `` property to be enabled. Documentation generation is also required for accuracy of used references detection (based on https://github.com/dotnet/roslyn/issues/66188). +Note: Some packages are prevented from being trimmed as they contain build files, which prevent package reference from being trimmed, as there's no reliable way to determine whether it's safe to do. F.E, `Microsoft.Extensions.Logging.Abstractions` contains analyzer targets, which can definitely be ignored when deciding whether to trim or not. You can explicitly add such packages to `BuildFilesIgnoreForPackages` list (on a project level, or in `Directory.Build.props`). +Example +```xml + + + + +``` +Now these packages will be judged solely on whether they're actually being used or not. + ### C++ (.vcxproj projects) ReferenceTrimmer for C++ is an MSBuild [distributed logger](https://learn.microsoft.com/en-us/visualstudio/msbuild/logging-in-a-multi-processor-environment?view=vs-2022). It writes guidance to the MSBuild stdout stream (not to the MSBuild internal logger at this time) and writes `ReferenceTrimmerUnusedMSVCLibraries.json.log` to the build working directory. diff --git a/src/Package/build/ReferenceTrimmer.targets b/src/Package/build/ReferenceTrimmer.targets index e9d0e1c..582dd97 100644 --- a/src/Package/build/ReferenceTrimmer.targets +++ b/src/Package/build/ReferenceTrimmer.targets @@ -41,6 +41,7 @@ RuntimeIdentifier="$(RuntimeIdentifier)" NuGetRestoreTargets="$(NuGetRestoreTargets)" TargetFrameworkDirectories="$(TargetFrameworkDirectory)" + BuildFilesIgnoreForPackages="@(BuildFilesIgnoreForPackages)" NuGetPackageRoot="$(NuGetPackageRoot)" /> diff --git a/src/Tasks/CollectDeclaredReferencesTask.cs b/src/Tasks/CollectDeclaredReferencesTask.cs index 392d3dc..85b43a4 100644 --- a/src/Tasks/CollectDeclaredReferencesTask.cs +++ b/src/Tasks/CollectDeclaredReferencesTask.cs @@ -40,6 +40,8 @@ public sealed class CollectDeclaredReferencesTask : MSBuildTask public ITaskItem[]? PackageReferences { get; set; } + public ITaskItem[]? BuildFilesIgnoreForPackages { get; set; } + public string? ProjectAssetsFile { get; set; } public string? TargetFrameworkMoniker { get; set; } @@ -171,7 +173,7 @@ public override bool Execute() } // Ignore packages with build logic as we cannot easily evaluate whether the build logic is necessary or not. - if (packageInfo.BuildFiles.Count > 0) + if (packageInfo.BuildFiles.Count > 0 && !ShouldIgnoreBuildFilesForPackage(packageReference)) { continue; } @@ -196,6 +198,16 @@ public override bool Execute() return !Log.HasLoggedErrors; } + private bool ShouldIgnoreBuildFilesForPackage(ITaskItem packageReference) + { + if (BuildFilesIgnoreForPackages == null) + { + return false; + } + + return BuildFilesIgnoreForPackages.Any(item => string.Equals(item.ItemSpec, packageReference.ItemSpec, StringComparison.OrdinalIgnoreCase)); + } + private Dictionary GetPackageInfos() { var packageInfoBuilders = new Dictionary(StringComparer.OrdinalIgnoreCase); diff --git a/src/Tests/E2ETests.cs b/src/Tests/E2ETests.cs index 63a3124..da4a249 100644 --- a/src/Tests/E2ETests.cs +++ b/src/Tests/E2ETests.cs @@ -487,6 +487,7 @@ public Task PackageReferenceWithFakeBuildFile() expectedWarnings: [ new Warning("RT0003: PackageReference Microsoft.Extensions.Primitives can be removed", "Library/Library.csproj"), + new Warning("RT0003: PackageReference Microsoft.Extensions.Logging can be removed", "Library/Library.csproj"), ]); } diff --git a/src/Tests/TestData/PackageReferenceWithFakeBuildFile/Library/Library.csproj b/src/Tests/TestData/PackageReferenceWithFakeBuildFile/Library/Library.csproj index 48e5973..1896cf0 100644 --- a/src/Tests/TestData/PackageReferenceWithFakeBuildFile/Library/Library.csproj +++ b/src/Tests/TestData/PackageReferenceWithFakeBuildFile/Library/Library.csproj @@ -8,6 +8,14 @@ + + + + + + From a718394d94e796b0676ea4b524dbc2a3da9031fd Mon Sep 17 00:00:00 2001 From: Alex S Date: Tue, 10 Feb 2026 16:44:38 -0800 Subject: [PATCH 2/5] Rename the property to ignore build files --- README.md | 4 ++-- src/Package/build/ReferenceTrimmer.targets | 2 +- src/Tasks/CollectDeclaredReferencesTask.cs | 6 +++--- .../Library/Library.csproj | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b26f034..9813b92 100644 --- a/README.md +++ b/README.md @@ -54,14 +54,14 @@ You can turn off specific docxml related warnings and errors while defaulting Re Note: To get better results, enable the [`IDE0005`](https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/ide0005) unnecessary `using` rule. This avoids the C# compiler seeing a false positive assembly usage from unneeded `using` directives causing it to miss a removable dependency. See also the note for why IDE0005 code analysis rule requires `` property to be enabled. Documentation generation is also required for accuracy of used references detection (based on https://github.com/dotnet/roslyn/issues/66188). -Note: Some packages are prevented from being trimmed as they contain build files, which prevent package reference from being trimmed, as there's no reliable way to determine whether it's safe to do. F.E, `Microsoft.Extensions.Logging.Abstractions` contains analyzer targets, which can definitely be ignored when deciding whether to trim or not. You can explicitly add such packages to `BuildFilesIgnoreForPackages` list (on a project level, or in `Directory.Build.props`). +Note: Some packages are prevented from being trimmed as they contain build files, which prevent package reference from being trimmed, as there's no reliable way to determine whether it's safe to do. F.E, `Microsoft.Extensions.Logging.Abstractions` contains analyzer targets, which can definitely be ignored when deciding whether to trim or not. You can explicitly add such packages to `ReferenceTrimmerIgnorePackageBuildFiles` list (on a project level, or in `Directory.Build.props`). Example ```xml - + ``` Now these packages will be judged solely on whether they're actually being used or not. diff --git a/src/Package/build/ReferenceTrimmer.targets b/src/Package/build/ReferenceTrimmer.targets index 582dd97..6424082 100644 --- a/src/Package/build/ReferenceTrimmer.targets +++ b/src/Package/build/ReferenceTrimmer.targets @@ -41,7 +41,7 @@ RuntimeIdentifier="$(RuntimeIdentifier)" NuGetRestoreTargets="$(NuGetRestoreTargets)" TargetFrameworkDirectories="$(TargetFrameworkDirectory)" - BuildFilesIgnoreForPackages="@(BuildFilesIgnoreForPackages)" + ReferenceTrimmerIgnorePackageBuildFiles="@(ReferenceTrimmerIgnorePackageBuildFiles)" NuGetPackageRoot="$(NuGetPackageRoot)" /> diff --git a/src/Tasks/CollectDeclaredReferencesTask.cs b/src/Tasks/CollectDeclaredReferencesTask.cs index 85b43a4..32cf25e 100644 --- a/src/Tasks/CollectDeclaredReferencesTask.cs +++ b/src/Tasks/CollectDeclaredReferencesTask.cs @@ -40,7 +40,7 @@ public sealed class CollectDeclaredReferencesTask : MSBuildTask public ITaskItem[]? PackageReferences { get; set; } - public ITaskItem[]? BuildFilesIgnoreForPackages { get; set; } + public ITaskItem[]? ReferenceTrimmerIgnorePackageBuildFiles { get; set; } public string? ProjectAssetsFile { get; set; } @@ -200,12 +200,12 @@ public override bool Execute() private bool ShouldIgnoreBuildFilesForPackage(ITaskItem packageReference) { - if (BuildFilesIgnoreForPackages == null) + if (ReferenceTrimmerIgnorePackageBuildFiles == null) { return false; } - return BuildFilesIgnoreForPackages.Any(item => string.Equals(item.ItemSpec, packageReference.ItemSpec, StringComparison.OrdinalIgnoreCase)); + return ReferenceTrimmerIgnorePackageBuildFiles.Any(item => string.Equals(item.ItemSpec, packageReference.ItemSpec, StringComparison.OrdinalIgnoreCase)); } private Dictionary GetPackageInfos() diff --git a/src/Tests/TestData/PackageReferenceWithFakeBuildFile/Library/Library.csproj b/src/Tests/TestData/PackageReferenceWithFakeBuildFile/Library/Library.csproj index 1896cf0..a424517 100644 --- a/src/Tests/TestData/PackageReferenceWithFakeBuildFile/Library/Library.csproj +++ b/src/Tests/TestData/PackageReferenceWithFakeBuildFile/Library/Library.csproj @@ -15,7 +15,7 @@ - + From 80f2b37f9520b78243ae56124abdafadd8e5d1ce Mon Sep 17 00:00:00 2001 From: Alex S Date: Tue, 10 Feb 2026 16:45:23 -0800 Subject: [PATCH 3/5] Update minor version --- version.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/version.json b/version.json index 02ee64e..a48c5f6 100644 --- a/version.json +++ b/version.json @@ -1,7 +1,7 @@ { "$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", - "version": "3.3", - "assemblyVersion": "3.3", + "version": "3.4", + "assemblyVersion": "3.4", "buildNumberOffset": -1, "publicReleaseRefSpec": [ "^refs/tags/v\\d+\\.\\d+\\.\\d+" From cc2fcdff74999f9ac2406d95a663b676f76565f1 Mon Sep 17 00:00:00 2001 From: Alex S Date: Tue, 10 Feb 2026 17:15:06 -0800 Subject: [PATCH 4/5] Add default list of packages that can be trimmed --- src/Package/build/ReferenceTrimmer.props | 38 ++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/src/Package/build/ReferenceTrimmer.props b/src/Package/build/ReferenceTrimmer.props index ab9363b..d7b1e0b 100644 --- a/src/Package/build/ReferenceTrimmer.props +++ b/src/Package/build/ReferenceTrimmer.props @@ -22,4 +22,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From 208adf96704a77bca32ea7da9ca71997e6f08abd Mon Sep 17 00:00:00 2001 From: David Federman Date: Tue, 10 Feb 2026 23:20:55 -0800 Subject: [PATCH 5/5] Fixes --- README.md | 10 ++--- src/Package/build/ReferenceTrimmer.targets | 2 +- src/Tasks/CollectDeclaredReferencesTask.cs | 33 +++++++-------- src/Tests/E2ETests.cs | 40 ++++++++++++++++++- .../Library/Library.cs | 7 ++++ .../Library/Library.csproj | 23 +++++++++++ .../Library/Library.csproj | 8 ---- 7 files changed, 88 insertions(+), 35 deletions(-) create mode 100644 src/Tests/TestData/IgnorePackageBuildFiles/Library/Library.cs create mode 100644 src/Tests/TestData/IgnorePackageBuildFiles/Library/Library.csproj diff --git a/README.md b/README.md index 9813b92..6b893d2 100644 --- a/README.md +++ b/README.md @@ -54,17 +54,15 @@ You can turn off specific docxml related warnings and errors while defaulting Re Note: To get better results, enable the [`IDE0005`](https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/ide0005) unnecessary `using` rule. This avoids the C# compiler seeing a false positive assembly usage from unneeded `using` directives causing it to miss a removable dependency. See also the note for why IDE0005 code analysis rule requires `` property to be enabled. Documentation generation is also required for accuracy of used references detection (based on https://github.com/dotnet/roslyn/issues/66188). -Note: Some packages are prevented from being trimmed as they contain build files, which prevent package reference from being trimmed, as there's no reliable way to determine whether it's safe to do. F.E, `Microsoft.Extensions.Logging.Abstractions` contains analyzer targets, which can definitely be ignored when deciding whether to trim or not. You can explicitly add such packages to `ReferenceTrimmerIgnorePackageBuildFiles` list (on a project level, or in `Directory.Build.props`). -Example +Packages are prevented from being trimmed if they contain build files, as there's no reliable way to determine whether it's safe to do so. You can explicitly ignore specific packages' build files and cause them to be solely judged based on whther the libraries are used by adding the package to the `ReferenceTrimmerIgnorePackageBuildFiles` item on a project level, or in `Directory.Build.props`. + +Example: ```xml - ``` -Now these packages will be judged solely on whether they're actually being used or not. +A default set of `ReferenceTrimmerIgnorePackageBuildFiles` items is already included for well-known package, notably various `Microsoft.Extensions.*` packages. ### C++ (.vcxproj projects) ReferenceTrimmer for C++ is an MSBuild [distributed logger](https://learn.microsoft.com/en-us/visualstudio/msbuild/logging-in-a-multi-processor-environment?view=vs-2022). It writes guidance to the MSBuild stdout stream (not to the MSBuild internal logger at this time) and writes `ReferenceTrimmerUnusedMSVCLibraries.json.log` to the build working directory. diff --git a/src/Package/build/ReferenceTrimmer.targets b/src/Package/build/ReferenceTrimmer.targets index 6424082..18a6d36 100644 --- a/src/Package/build/ReferenceTrimmer.targets +++ b/src/Package/build/ReferenceTrimmer.targets @@ -41,7 +41,7 @@ RuntimeIdentifier="$(RuntimeIdentifier)" NuGetRestoreTargets="$(NuGetRestoreTargets)" TargetFrameworkDirectories="$(TargetFrameworkDirectory)" - ReferenceTrimmerIgnorePackageBuildFiles="@(ReferenceTrimmerIgnorePackageBuildFiles)" + IgnorePackageBuildFiles="@(ReferenceTrimmerIgnorePackageBuildFiles)" NuGetPackageRoot="$(NuGetPackageRoot)" /> diff --git a/src/Tasks/CollectDeclaredReferencesTask.cs b/src/Tasks/CollectDeclaredReferencesTask.cs index 32cf25e..061d725 100644 --- a/src/Tasks/CollectDeclaredReferencesTask.cs +++ b/src/Tasks/CollectDeclaredReferencesTask.cs @@ -40,7 +40,7 @@ public sealed class CollectDeclaredReferencesTask : MSBuildTask public ITaskItem[]? PackageReferences { get; set; } - public ITaskItem[]? ReferenceTrimmerIgnorePackageBuildFiles { get; set; } + public ITaskItem[]? IgnorePackageBuildFiles { get; set; } public string? ProjectAssetsFile { get; set; } @@ -172,8 +172,7 @@ public override bool Execute() continue; } - // Ignore packages with build logic as we cannot easily evaluate whether the build logic is necessary or not. - if (packageInfo.BuildFiles.Count > 0 && !ShouldIgnoreBuildFilesForPackage(packageReference)) + if (packageInfo.BuildFiles.Count > 0) { continue; } @@ -198,16 +197,6 @@ public override bool Execute() return !Log.HasLoggedErrors; } - private bool ShouldIgnoreBuildFilesForPackage(ITaskItem packageReference) - { - if (ReferenceTrimmerIgnorePackageBuildFiles == null) - { - return false; - } - - return ReferenceTrimmerIgnorePackageBuildFiles.Any(item => string.Equals(item.ItemSpec, packageReference.ItemSpec, StringComparison.OrdinalIgnoreCase)); - } - private Dictionary GetPackageInfos() { var packageInfoBuilders = new Dictionary(StringComparer.OrdinalIgnoreCase); @@ -257,6 +246,12 @@ private Dictionary GetPackageInfos() } } + HashSet packageToIgnoreBuildFiles = new(StringComparer.OrdinalIgnoreCase); + foreach (ITaskItem item in IgnorePackageBuildFiles ?? []) + { + packageToIgnoreBuildFiles.Add(item.ItemSpec); + } + // Get the transitive closure of assemblies included by each package foreach (LockFileTargetLibrary nugetLibrary in nugetLibraries) { @@ -286,11 +281,13 @@ private Dictionary GetPackageInfos() }) .ToList(); - List buildFiles = nugetLibrary.Build - .Select(item => item.Path) - .Where(IsValidFile) - .Select(path => Path.Combine(nugetLibraryAbsolutePath, path)) - .ToList(); + List buildFiles = packageToIgnoreBuildFiles.Contains(nugetLibrary.Name) + ? [] + : nugetLibrary.Build + .Select(item => item.Path) + .Where(IsValidFile) + .Select(path => Path.Combine(nugetLibraryAbsolutePath, path)) + .ToList(); // Add this package's assets, if there are any if (nugetLibraryAssemblies.Count > 0 || buildFiles.Count > 0) diff --git a/src/Tests/E2ETests.cs b/src/Tests/E2ETests.cs index da4a249..d2e5d29 100644 --- a/src/Tests/E2ETests.cs +++ b/src/Tests/E2ETests.cs @@ -487,10 +487,32 @@ public Task PackageReferenceWithFakeBuildFile() expectedWarnings: [ new Warning("RT0003: PackageReference Microsoft.Extensions.Primitives can be removed", "Library/Library.csproj"), - new Warning("RT0003: PackageReference Microsoft.Extensions.Logging can be removed", "Library/Library.csproj"), ]); } + [TestMethod] + public async Task IgnorePackageBuildFiles() + { + await RunMSBuildAsync( + projectFile: "Library/Library.csproj", + expectedWarnings: [], + globalProperties: new Dictionary + { + { "IgnorePackageBuildFiles", "false" }, + }); + + await RunMSBuildAsync( + projectFile: "Library/Library.csproj", + expectedWarnings: + [ + new Warning("RT0003: PackageReference Microsoft.Extensions.Logging can be removed", "Library/Library.csproj"), + ], + globalProperties: new Dictionary + { + { "IgnorePackageBuildFiles", "true" }, + }); + } + private static (string ExePath, string Verb) GetMsBuildExeAndVerb() { // On Windows, try to find Visual Studio @@ -524,7 +546,13 @@ private static (string ExePath, string Verb) GetMsBuildExeAndVerb() return ("dotnet", "build"); } - private async Task RunMSBuildAsync(string projectFile, Warning[] expectedWarnings, string[]? expectedConsoleOutputs = null, bool expectUnusedMsvcLibrariesLog = false, bool enableReferenceTrimmerDiagnostics = false) + private async Task RunMSBuildAsync( + string projectFile, + Warning[] expectedWarnings, + string[]? expectedConsoleOutputs = null, + bool expectUnusedMsvcLibrariesLog = false, + bool enableReferenceTrimmerDiagnostics = false, + IReadOnlyDictionary? globalProperties = null) { var testDataSourcePath = Path.GetFullPath(Path.Combine("TestData", TestContext?.TestName ?? string.Empty)); @@ -551,6 +579,14 @@ private async Task RunMSBuildAsync(string projectFile, Warning[] expectedWarning $"-distributedlogger:CentralLogger,\"{loggersAssemblyPath}\"*ForwardingLogger,\"{loggersAssemblyPath}\" " + (enableReferenceTrimmerDiagnostics ? "-p:EnableReferenceTrimmerDiagnostics=true" : string.Empty); + if (globalProperties is not null) + { + foreach ((string key, string value) in globalProperties) + { + msbuildArgs += $" -p:{key}={value}"; + } + } + Process? process = Process.Start( new ProcessStartInfo { diff --git a/src/Tests/TestData/IgnorePackageBuildFiles/Library/Library.cs b/src/Tests/TestData/IgnorePackageBuildFiles/Library/Library.cs new file mode 100644 index 0000000..958c389 --- /dev/null +++ b/src/Tests/TestData/IgnorePackageBuildFiles/Library/Library.cs @@ -0,0 +1,7 @@ +namespace Library +{ + public static class Foo + { + public static string Bar() => "Baz"; + } +} diff --git a/src/Tests/TestData/IgnorePackageBuildFiles/Library/Library.csproj b/src/Tests/TestData/IgnorePackageBuildFiles/Library/Library.csproj new file mode 100644 index 0000000..bc99305 --- /dev/null +++ b/src/Tests/TestData/IgnorePackageBuildFiles/Library/Library.csproj @@ -0,0 +1,23 @@ + + + + Library + net8.0 + + + + + + + + + + + + + + + + + + diff --git a/src/Tests/TestData/PackageReferenceWithFakeBuildFile/Library/Library.csproj b/src/Tests/TestData/PackageReferenceWithFakeBuildFile/Library/Library.csproj index a424517..48e5973 100644 --- a/src/Tests/TestData/PackageReferenceWithFakeBuildFile/Library/Library.csproj +++ b/src/Tests/TestData/PackageReferenceWithFakeBuildFile/Library/Library.csproj @@ -8,14 +8,6 @@ - - - - - -