circe-generic-extras

This library provides configurable generic derivation and other functionality extending the generic derivation mechanisms provided in Circe's circe-generic module. The circe-generic-extras module used to be included in the core Circe repository, but it was moved to this separate repository after 0.12.1, in preparation for Circe's 1.0.0 release.

This library is experimental and its development is primarily community-supported.

Usage

This library as functionality to parse JSON in different cased formats such as snake_case, kebab-case, PascalCase or SCREAMING_SNAKE_CASE.

You can enable different case modes by making a custom configuration.

{
  "foo-bar": "foobar"
}

import io.circe.generic.extras.semiauto._
import io.circe.generic.extras.Configuration

case class Foo(fooBar: String)

implicit val customConfig: Configuration = Configuration.default.withKebabCaseMemberNames

implicit val fooEncoder: Encoder[Foo] = deriveConfiguredEncoder
implicit val fooDecoder: Decoder[Foo] = deriveConfiguredDecoder

Versioning

This library releases at a different cadence than Circe, any apparent relationship between the Circe version numbers and generic-extras version numbers are a coincidence and NOT intentional. Please use the following table for determining capability with the corresponding Circe versions.

Circe Generic Extras Version	Circe	Scala 2	Scala 3	Scala JVM	Scala.JS	Scala Native
0.14.3 and later	0.14.x	✅	❌	✅	✅	✅
0.14.2	0.14.x	✅	❌	✅	✅	❌️
0.14.1	0.14.x	✅	❌	✅	✅	❌️
0.14.0	0.14.x	✅	❌	✅	✅	❌️

Contributors and participation

All Circe projects support the Scala code of conduct and we want all of their channels (Gitter, GitHub, etc.) to be welcoming environments for everyone.

Please see the Circe contributors' guide for details on how to submit a pull request.

License

circe-generic-extras is licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.