Add analyzer section in project.assets.json file by martinrrm · Pull Request #7464 · NuGet/NuGet.Client

martinrrm · 2026-06-08T23:06:58Z

Bug

Progress: NuGet/Home#6279
SDK PR (draft): dotnet/sdk#54646

Description

Today project.assets.json does not record which analyzers a package contributes, and analyzers are applied regardless of PrivateAssets / ExcludeAssets / IncludeAssets. This PR implements the NuGet restore half of the "indicate analyzer assets in project.assets.json" feature (spec: NuGet/Home#14455). The SDK consumption half ships as a separate dotnet/sdk PR.

When a project opts in with <RestoreEnableAnalyzerAssets>true</RestoreEnableAnalyzerAssets>, restore now:

Emits an analyzers group under each package in the assets file, listing every analyzer assembly — any .dll under analyzers/ at any depth, excluding satellite .resources.dll — mirroring the SDK's analyzer discovery so the layout isn't assumed to be fixed.
Respects asset filtering. PrivateAssets, ExcludeAssets, and IncludeAssets now filter analyzers like any other asset type. Analyzers excluded or transitively suppressed are written as a bare _._ placeholder.
Attaches selection metadata to each entry: codeLanguage (cs/vb/fs/any) and, when present in the path, compilerApiVersion (roslynX.Y) — mirroring how content files carry codeLanguage — so the SDK selects applicable analyzers from metadata instead of parsing paths.

Gating. The feature is opt-in and only honored for projects targeting .NET 11 or greater; on earlier frameworks the opt-in is forced off in NuGet.targets (mirroring NuGetAuditMode gating). For multi-targeted projects the effective value is OR'd across frameworks. A disabled, commented scaffold documents the future default-on rollout step.

Telemetry. ProjectRestoreInformation now reports AnalyzerAssets.Enabled (opt-in state, emitted on every restore including no-ops) and AnalyzerAssets.Count (number of analyzer assets emitted, excluding _._ placeholders), so adoption and impact can be tracked through the rollout.

Public API & serialization. Adds ProjectRestoreMetadata.RestoreEnableAnalyzerAssets, LockFileTargetLibrary.AnalyzerAssets, and LockFileItem.CompilerApiVersionProperty. Both the Newtonsoft.Json and System.Text.Json read/write paths round-trip the new group, metadata, and restore property. The lock-file cache key includes the flag so toggling it invalidates correctly.

PR Checklist

Meaningful title, helpful description and a linked NuGet/Home issue
Added tests
Link to an issue or pull request to update docs if this PR changes settings, environment variables, new feature, etc.

jebriede

Approving with a few suggestions.

jebriede · 2026-06-09T21:12:30Z

+        private static bool IsAnalyzerAssetPath(string path)
+        {
+            return path.StartsWith("analyzers/", StringComparison.Ordinal)
+                && path.EndsWith(".dll", StringComparison.OrdinalIgnoreCase)


The "analyzers/" prefix check is StringComparison.Ordinal (case-sensitive) while the .dll / .resources.dll checks are OrdinalIgnoreCase. If a package authored the folder as Analyzers/ this would skip it while the SDK's discovery (which we're mirroring) may still pick it up. Was case-sensitivity on the folder segment intentional? If not, consider OrdinalIgnoreCase for consistency with the extension checks.

Yes this was intentional, we are mirroring sdk analysis discovery from https://github.com/dotnet/sdk/blob/8283adc1579c8bc2afb4458c81cbda0c6eac4466/src/Common/NuGetUtils.NuGet.cs#L43-L53.

jebriede

Approving with an optimization suggestion.

jebriede · 2026-06-15T21:40:36Z


                telemetry.TelemetryEvent[UpdatedAssetsFile] = restoreResult._isAssetsFileDirty.Value;
                telemetry.TelemetryEvent[UpdatedMSBuildFiles] = restoreResult._dirtyMSBuildFiles.Value.Count > 0;
+                telemetry.TelemetryEvent[AnalyzerAssetsCount] = CountAnalyzerAssets(assetsFile);


CountAnalyzerAssets runs on every real restore and walks every target and every library to populate AnalyzerAssetsCount. When the feature is off (which is the default and the common case during rollout) the count is always 0, so we pay for the full nested walk to produce a constant. Is it worth short-circuiting when the opt-in is disabled? Something like:

Suggested change

telemetry.TelemetryEvent[AnalyzerAssetsCount] = CountAnalyzerAssets(assetsFile);

telemetry.TelemetryEvent[AnalyzerAssetsCount] =

(_request.Project.RestoreMetadata?.RestoreEnableAnalyzerAssets ?? false)

? CountAnalyzerAssets(assetsFile)

: 0;

The inner walk is cheap per library (frozen libraries return Array.Empty), so this is a minor optimization rather than a correctness concern.

I'm going to make some changes here (like you said it always return 0) for the Telemetry, but we always want this since it will help us decide when to make this new behavior as default.

nkolev92

I think we're introducing a new implementation pattern in a couple of different places, but we already have an established one.

nkolev92 · 2026-06-16T00:29:53Z

      <Output TaskParameter="AbsolutePaths" PropertyName="RestoreOutputAbsolutePath" />
    </ConvertToAbsolutePath>

+    <ItemGroup Condition="'$(TargetFrameworks)' != ''">


Should we instead follow the logic for audit and pruning where the decision is made in code.

This implementation is only really a factor in standard CLI restore.
The other 3 restores share an implementation, this doesn't.

nkolev92 · 2026-06-16T00:37:16Z

+            return lockFileItems;
+        }
+
+        private static bool IsAnalyzerAssetPath(string path)


I think we should be using ManagedCodeConventions here.

That's what knows how to find the patterns.

NuGet.Client/src/NuGet.Core/NuGet.Packaging/ContentModel/ManagedCodeConventions.cs

Lines 529 to 540 in d66371a

NativeLibraries = new PatternSet(

conventions.Properties,

groupPatterns: new PatternDefinition[]

{

new PatternDefinition("runtimes/{rid}/nativeassets/{tfm}/{any?}", table: DotnetAnyTable),

new PatternDefinition("runtimes/{rid}/native/{any?}", table: null, defaults: DefaultTfmAny)

},

pathPatterns: new PatternDefinition[]

{

new PatternDefinition("runtimes/{rid}/nativeassets/{tfm}/{any}", table: DotnetAnyTable),

new PatternDefinition("runtimes/{rid}/native/{any}", table: null, defaults: DefaultTfmAny)

});

nkolev92 · 2026-06-16T00:37:58Z

        /// the group has items. Empty groups are left alone.
        /// </summary>
-        private static void ClearIfExists<T>(IList<T> group, Func<string, T> factory) where T : LockFileItem
+        private static void ClearIfExists<T>(IList<T> group, Func<string, T> factory, bool copyProperties = true) where T : LockFileItem


Can you explain what are the properties we're stopping from copying in the analyzers scenario?

kartheekp-ms · 2026-06-16T05:22:29Z

+                int segmentLength = separator - segmentStart;
+                ReadOnlySpan<char> segment = path.AsSpan(segmentStart, segmentLength);
+
+                if (segment.Equals("cs".AsSpan(), StringComparison.OrdinalIgnoreCase))


The hard coded strings still cause allocations. Is there any way to avoid them?

Add analyzer section in project.assets.json

1c19af5

martinrrm requested a review from a team as a code owner June 8, 2026 23:06

martinrrm requested review from kartheekp-ms and zivkan June 8, 2026 23:06

jebriede previously approved these changes Jun 9, 2026

View reviewed changes

martinrrm mentioned this pull request Jun 9, 2026

[spec] Indicate analyzer assets and respect analyzer filtering in project.assets.json NuGet/Home#14455

Open

kartheekp-ms reviewed Jun 12, 2026

View reviewed changes

Comment thread src/NuGet.Core/NuGet.Commands/RestoreCommand/Utility/LockFileUtils.cs Outdated

kartheekp-ms reviewed Jun 12, 2026

View reviewed changes

Comment thread src/NuGet.Core/NuGet.ProjectModel/LockFile/LockFileFormat.cs

kartheekp-ms reviewed Jun 12, 2026

View reviewed changes

Comment thread test/NuGet.Core.Tests/NuGet.Commands.Test/RestoreCommandTests/RestoreCommandTests.cs

PR comments

95dcd89

martinrrm dismissed jebriede’s stale review via 95dcd89 June 15, 2026 18:21

martinrrm requested review from jebriede and kartheekp-ms June 15, 2026 20:44

jebriede approved these changes Jun 15, 2026

View reviewed changes

nkolev92 reviewed Jun 16, 2026

View reviewed changes

kartheekp-ms reviewed Jun 16, 2026

View reviewed changes

	NativeLibraries = new PatternSet(
	conventions.Properties,
	groupPatterns: new PatternDefinition[]
	{
	new PatternDefinition("runtimes/{rid}/nativeassets/{tfm}/{any?}", table: DotnetAnyTable),
	new PatternDefinition("runtimes/{rid}/native/{any?}", table: null, defaults: DefaultTfmAny)
	},
	pathPatterns: new PatternDefinition[]
	{
	new PatternDefinition("runtimes/{rid}/nativeassets/{tfm}/{any}", table: DotnetAnyTable),
	new PatternDefinition("runtimes/{rid}/native/{any}", table: null, defaults: DefaultTfmAny)
	});

Conversation

martinrrm commented Jun 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bug

Description

PR Checklist

Uh oh!

jebriede left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jebriede Jun 9, 2026

Choose a reason for hiding this comment

Uh oh!

martinrrm Jun 14, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jebriede left a comment

Choose a reason for hiding this comment

Uh oh!

jebriede Jun 15, 2026

Choose a reason for hiding this comment

Uh oh!

martinrrm Jun 18, 2026

Choose a reason for hiding this comment

Uh oh!

nkolev92 left a comment

Choose a reason for hiding this comment

Uh oh!

nkolev92 Jun 16, 2026

Choose a reason for hiding this comment

Uh oh!

nkolev92 Jun 16, 2026

Choose a reason for hiding this comment

Uh oh!

nkolev92 Jun 16, 2026

Choose a reason for hiding this comment

Uh oh!

kartheekp-ms Jun 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

martinrrm commented Jun 8, 2026 •

edited

Loading

kartheekp-ms Jun 16, 2026 •

edited

Loading