dotnet/roslyn

Allow PublicApiAnalyzers to track internal APIs with `[Internal]` prefix

Open

#79,658 创建于 2025年7月29日

在 GitHub 查看
 (1 评论) (1 反应) (0 负责人)C# (20,414 star) (4,257 fork)batch import
Area-AnalyzersArea-IDEhelp wanted

描述

Tracking internal APIs can be useful in cases where IVT is used and compatibility between different versions of components is required.

For example:

  • Project1 has a ProjectReference to Project2.
  • Project2 exposes IVT to Project1
  • Both projects produce NuGet packages
  • If I make a change in internal API in Project2 that is called by Project1, that means a binary incompatibility is introduced.

Suggestion: all internal APIs, unless annotated with EmbeddedAttribute, can be tracked as an opt-in feature.

That way, Project2 is forced to add EmbeddedAttribute when not intended to be used by IVT, and otherwise breaking changes can be tracked more easily.

贡献者指南

技术栈
csharp
领域
apideveloper experience
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
C#Roslyn analyzersInternalsVisibleTo
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
55
研究方向
Examine the PublicApiAnalyzers folder in the dotnet/roslyn repository to understand how public APIs are currently tracked. Look for existing attributes like EmbeddedAttribute and how they are used to exclude APIs. The feature requires adding an opt in option to also track internal APIs unless annotated with EmbeddedAttribute. Review the analyzer code and tests to see where to add the new configuration.