dotnet/roslyn

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

Open

Aperta il 29 lug 2025

Vedi su GitHub
 (1 commento) (1 reazione) (0 assegnatari)C# (20.414 star) (4257 fork)batch import
Area-AnalyzersArea-IDEhelp wanted

Descrizione

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.

Guida contributor

Tech stack
csharp
Dominio
apideveloper experience
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 days
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
fresh
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
C#Roslyn analyzersInternalsVisibleTo
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
55
Direzione di ricerca
Esamina la cartella PublicApiAnalyzers nel repository dotnet/roslyn per comprendere come vengono attualmente tracciate le API pubbliche. Cerca attributi esistenti come EmbeddedAttribute e come vengono utilizzati per escludere le API. La funzionalità richiede l'aggiunta di un'opzione opt in per tracciare anche le API interne a meno che non siano annotate con EmbeddedAttribute. Rivedi il codice dell'analizzatore e i test per vedere dove aggiungere la nuova configurazione.