dotnet/roslyn
View on GitHubroslyn-analyzers/README.md does not discuss NuGet packages for Microsoft.CodeAnalysis, Microsoft.CodeAnalysis.CSharp, et cetera
Open
#68,891 opened on Jul 5, 2023
Documentationhelp wanted
Repository metrics
- Stars
- (20,414 stars)
- PR merge metrics
- (Avg merge 6d 17h) (256 merged PRs in 30d)
Description
Describe the bug
The current README.md file has a comparison table of the older analyzer NuGet packages, but it does not yet discuss the other non-deprecated Microsoft.CodeAnalysis NuGet packages:
- https://www.nuget.org/packages/Microsoft.CodeAnalysis
- https://www.nuget.org/packages/Microsoft.CodeAnalysis.Compilers
- https://www.nuget.org/packages/Microsoft.CodeAnalysis.CSharp
- https://www.nuget.org/packages/Microsoft.CodeAnalysis.CSharp.Workspaces
- https://www.nuget.org/packages/Microsoft.CodeAnalysis.VisualBasic
- https://www.nuget.org/packages/Microsoft.CodeAnalysis.VisualBasic.Workspaces
All of the above packages link to https://aka.ms/roslyn-packages - which then redirects to this repo's README, but the README doesn't mention those NuGet packages at all.
Steps To Reproduce
- Visit https://www.nuget.org/packages/Microsoft.CodeAnalysis
- Follow the link to https://aka.ms/roslyn-packages mentioned in the package's readme.
- ...but the linked article doesn't mention
Microsoft.CodeAnalysis. - ...so how should I know if my project should reference
Microsoft.CodeAnalysisor not?
Expected behavior
- I expected https://github.com/dotnet/roslyn-analyzers/blob/main/README.md to list all Microsoft-authored NuGet packages with "Analysis" in their name with over 1m total downloads and describe their use-cases in comparison to each other.
Actual behavior
- No mention is made.
Additional context
- None