Skip to content
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

[STAL-2925] feat: ignore auto-generated C# files #515

Merged
merged 1 commit into from
Sep 25, 2024

Conversation

amaanq
Copy link
Collaborator

@amaanq amaanq commented Sep 25, 2024

What problem are you trying to solve?

Currently, we do not handle auto-generated C# files. Someone reached out to us about violations appearing on autogenerated C# files when they shouldn't be.

What is your solution?

We should ignore autogenerated C# files like we do for several other languages. The heuristics used come from the C# Roslyn analyzer and compiler itself, and a summary of what these heuristics are can be found on this slack thread from 2020, which points to this file in Roslyn for handling autogenerated file detection.

The heuristics are:

  • if the file contains <autogenerated or <auto-generated
  • if the filename starts with TemporaryGeneratedFile_ (case insensitive)
  • if the filename without the extension ends with .designer, .generated, .g, or .g.i (case insensitive, e.g. foo.designer.cs)

Alternatives considered

What the reviewer should know

The failing CI for the regression checks w.r.t. C# repos is expected, there are some files we no longer process now as a result of the changes in this PR.

@amaanq amaanq requested a review from a team as a code owner September 25, 2024 19:21
@amaanq amaanq merged commit 64e2ced into main Sep 25, 2024
68 of 70 checks passed
@jasonforal jasonforal deleted the amaan.qureshi/STAL-2925 branch November 8, 2024 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants