Draft
Add SW003: Enforce [JsonConverter(typeof(JsonStringEnumConverter))] on enums#1
Conversation
Co-authored-by: cliedeman <3578740+cliedeman@users.noreply.github.com> Agent-Logs-Url: https://github.com/stackworx-dotnet/Stackworx.Analyzers/sessions/8cb492e0-2d54-4781-8a94-e44306b70123
Copilot created this pull request from a session on behalf of
cliedeman
March 25, 2026 07:05
View session
This file contains hidden or 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
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.
Enums without
[JsonConverter(typeof(JsonStringEnumConverter))]serialize as integers underSystem.Text.Json, producing brittle, unreadable API contracts. SW003 flags any user-defined enum missing this annotation.Changes
EnumJsonStringEnumConverterAnalyzer.cs— New analyzer (ID:SW003, Category:Serialization, Severity:Warning)System.Text.Jsonis not referencedJsonStringEnumConverter(non-generic) andJsonStringEnumConverter<TEnum>(.NET 8+)OriginalDefinitionequality (not inheritance walk) for the sealed converter typeEnumJsonStringEnumConverterAnalyzerTests.cs— 4 test cases: missing attribute, correct attribute, wrong converter type, non-enum typessw003-enum-json-string-enum-converter.md— Rule documentationExample