Prefer readonly struct analyzer and codefix #657
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Introduced a new analyzer class `PreferReadonlyStructAnalyzer` to enforce the use of `readonly struct`. Applys to `struct` and `record struct`
Introduce a new code fix provider class `MakeStructReadonlyCodeFixProvider` to automatically make structs readonly when the diagnostic created by `PreferReadonlyStructAnalyzer` is triggered.
…yCodeFixProvider.
Added a new rule to the `AnalyzerReleases.Unshipped.md` file: - **Rule ID**: VOG033 - **Category**: Usage - **Severity**: Info - **Notes**: UseReadonlyStructInsteadOfStructAnalyzer
SteveDunn
approved these changes
Aug 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Classification
New feature to enforce the use of
readonlystructs in C# code. #603PR Summary
Introduces a new code fix provider and analyzer to ensure structs are marked as
readonlywhen appropriate.MakeStructReadonlyCodeFixProvider.cs: Added a newCodeFixProviderto apply thereadonlymodifier to structs.AnalyzerReleases.Unshipped.md: Added rule entryVOG033for the new analyzer.RuleIdentifiers.cs: Added constantUseReadonlyStructInsteadOfStructfor ruleVOG033.PreferReadonlyStructAnalyzer.cs: Added a newDiagnosticAnalyzerto report diagnostics for non-readonlystructs.PreferReadonlyStructsAnalyzerTests.cs: Added tests to verify the analyzer's behavior.