Skip to content

Add suppressor support for dotnet format #48512

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

sailro
Copy link

@sailro sailro commented Apr 16, 2025

Context:

Microsoft.Unity.Analyzers is able to add Unity-specific diagnostics or to remove general C# diagnostics that do not apply to Unity projects (through diagnostic suppressors).

One common usage is to run the dotnet format command on a unity solution to ensure projects obey the .editorconfig linting rules:

dotnet format --verify-no-changes --severity warn

But currently this command does not support diagnostic suppressors, which implies a lack of consistency with our IDEs and command-line build tools, which now manage suppressors.

See microsoft/Microsoft.Unity.Analyzers#387 for a minimal repro.

Other scenarios are likely to be similar, such as the linting of test projects (NUnit and XUnit make use of diagnostic suppressors).

For this PR we tried to have a minimal impact, by just registering local project suppressors, when running the
code-style phase.

Added unit tests as well.

fixes dotnet/format#1998
fixes microsoft/Microsoft.Unity.Analyzers#387
fixes #44867

@Copilot Copilot AI review requested due to automatic review settings April 16, 2025 07:20
@sailro sailro requested a review from a team as a code owner April 16, 2025 07:20
@dotnet-issue-labeler dotnet-issue-labeler bot added the untriaged Request triage from a team member label Apr 16, 2025
Copy link

I couldn't figure out the best area label to add to this PR. If you have write-permissions please help me learn by adding exactly one area label.

1 similar comment
Copy link

I couldn't figure out the best area label to add to this PR. If you have write-permissions please help me learn by adding exactly one area label.

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

@sailro sailro changed the title Add suppressor support for dotnet-format Add suppressor support for dotnet-format Apr 16, 2025
@sailro sailro changed the title Add suppressor support for dotnet-format Add suppressor support for dotnet format Apr 16, 2025
@sailro sailro force-pushed the dotnet-format-suppressor-support branch from 457ef9e to 119a5ee Compare April 16, 2025 08:05
@sailro sailro force-pushed the dotnet-format-suppressor-support branch from 119a5ee to 4940ff7 Compare April 16, 2025 12:28
@sailro
Copy link
Author

sailro commented Apr 16, 2025

Pinging @dotnet-cli @jbevain @sharwell for visibility. Thanks !

@sailro sailro force-pushed the dotnet-format-suppressor-support branch 2 times, most recently from dd365ae to cca26de Compare April 17, 2025 13:00
@sailro sailro force-pushed the dotnet-format-suppressor-support branch from cca26de to 92a8b0d Compare April 17, 2025 21:21
@sailro
Copy link
Author

sailro commented Apr 18, 2025

cc @tmat

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
untriaged Request triage from a team member
Projects
None yet
1 participant