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.