Add inspection for missing Optional default values
#797
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
If a dev.kord.common.entity.optional.Optional is used in a @serializable class, it should always have a default value so that deserialization works if the value is missing in the JSON. Until now this was easy to forget which could lead to deserialization errors down the line. By introducing a KSP processor that looks at all primary constructor parameters of @serializable classes, there is now a static check executed at build time that verifies the default value is not forgotten in any place.
|
ksp is nice, a compiler plugin with just 50 lines :) |
|
This makes me think of other possible inspections |
DRSchlaubi
reviewed
Mar 28, 2023
ksp-processors/src/main/kotlin/inspection/OptionalDefaultInspectionProcessor.kt
Show resolved
Hide resolved
DRSchlaubi
approved these changes
Mar 29, 2023
lukellmann
added a commit
that referenced
this pull request
Mar 31, 2023
If a dev.kord.common.entity.optional.Optional is used in a @serializable class, it should always have a default value so that deserialization works if the value is missing in the JSON. Until now this was easy to forget which could lead to deserialization errors down the line. By introducing a KSP processor that looks at all primary constructor parameters of @serializable classes, there is now a static check executed at build time that verifies the default value is not forgotten in any place.
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.
If a
dev.kord.common.entity.optional.Optionalis used in a@Serializableclass, it should always have a default value so that deserialization works if the value is missing in the JSON.Until now this was easy to forget which could lead to deserialization errors down the line.
By introducing a KSP processor that looks at all primary constructor parameters of
@Serializableclasses, there is now a static check executed at build time that verifies the default value is not forgotten in any place.