dotnet/roslyn

Custom BannedSymbols file name and extension

Open

#78,124 opened on Apr 11, 2025

View on GitHub
 (1 comment) (1 reaction) (0 assignees)C# (4,257 forks)batch import
Area-IDEhelp wanted

Repository metrics

Stars
 (20,414 stars)
PR merge metrics
 (Avg merge 6d 17h) (256 merged PRs in 30d)

Description

I am trying to use the Microsoft.CodeAnalysis.BannedApiAnalyzers package in Unity.

The problem I have is that Unity requires that the name has to have a specific format and the extension is .additionalfile so it will not work correctly because it will not be able to call BannedSymbols.txt.

https://docs.unity3d.com/Manual/roslyn-analyzers-additional-files.html

That is why I would like to configure the format of the name and extension to be discovered by this package so that it can work with Unity and incidentally to be more customizable and not have the restriction that the name and extension has to be a specific one.

Contributor guide

Research direction
Investigate the BannedApiAnalyzers source code to identify where the file name 'BannedSymbols.txt' is hardcoded. Then propose a configuration mechanism (e.g., editorconfig option or analyzer parameter) to allow custom file name and extension.
Tech stack
csharp
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#Roslyn
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60