feat: implement JsonCodecConfiguration for scala 3 and explicitEmptyCollections for JsonCodecConfiguration #1193
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
feat: implement explicitEmptyCollections for JsonCodecConfiguration
ThijsBroersen
force-pushed
the
feat/explicit-empty-collections-config
branch
from
a9181d0 to
793367e
Compare
ThijsBroersen
commented
Nov 28, 2024
| @@ -575,7 +590,8 @@ object DeriveJsonEncoder extends Derivation[JsonEncoder] { self => | |||
| }) | |||
| .toArray | |||
|
|
|||
| val explicitNulls = ctx.annotations.exists(_.isInstanceOf[jsonExplicitNull]) | |||
| val explicitNulls = config.explicitNulls || ctx.annotations.exists(_.isInstanceOf[jsonExplicitNull]) | |||
| val explicitEmptyCollections = config.explicitEmptyCollections || ctx.annotations.exists(_.isInstanceOf[jsonExplicitEmptyCollection]) | |||
There was a problem hiding this comment.
I see some inconsistencies on the priority of JsonCodecConfiguration vs annotations, sometimes the config take priority (e.g. explicit nulls), sometimes the annotations (e.g. discriminator).
For the new config I chose to use the same pattern as explicitNulls as it also has to do with missing values. But I think it would make more sense if annotations take priority. The config first is nicer because it can overwrite conditionally.
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 for implementing JsonCodecConfiguration for Scala 3. Comments say it depends on softwaremill/magnolia#296 but I think it works fine like this.
This PR #932 also tries to fix this issue (I only noticed it when I was almost done). Why was that PR not finished?
closes #943
This PR also contains a new config for JsonCodecConfiguration called
explicitEmptyCollections. This should make it possible to leave out empty collections or objects. I found the need for this config while working on zio-sbt when generating ci.yaml json objects which contained empty parameter maps.The value defaults to true and that should make it fully backwards compatible.