Library Integrations

Internal Modules

The core of PureConfig eschews unnecessary dependencies. Separate modules exist to support types which are not part of the standard Scala and Java libraries:

• pureconfig-akka provides converters for Akka data types;
• pureconfig-akka-http provides converters for Akka-Http models;
• pureconfig-cats provides converters for Cats data structures and Cats typeclass instances;
• pureconfig-cats-effect uses cats-effect to load and save configurations in a side-effect free manner;
• pureconfig-circe provides converters for Circe’s Json AST;
• pureconfig-cron4s provides converters for Cron4s types;
• pureconfig-enum provides converters for enums generated by julienrf’s enum library;
• pureconfig-enumeratum provides converters for enums generated by Enumeratum;
• pureconfig-fs2 provides support for reading configuration from and writing to fs2 streams;
• pureconfig-hadoop provides converters for Hadoop types;
• pureconfig-http4s provides converters for Http4s types;
• pureconfig-ip4s provides converters for Ip4s types;
• pureconfig-javax provides converters for classes in javax packages;
• pureconfig-joda provides configurable converters for Joda-Time types;
• pureconfig-magnolia provides an alternative way to derive readers and writers for case classes and sealed traits using Magnolia;
• pureconfig-scala-xml provides support for XML via scala-xml;
• pureconfig-scalaz provides converters for Scalaz data structures and Scalaz typeclass instances;
• pureconfig-squants provides converters for Squants’s beautiful types representing units of measure;
• pureconfig-sttp provides converters for sttp types;
• pureconfig-yaml provides support for reading YAML files as configurations.
• pureconfig-zio-config provides converters given instances of ZIO Config ConfigDescriptor.

External Integrations

A non-comprehensive list of other libraries which have integrated with PureConfig to provide a richer experience include:

• refined-pureconfig allows PureConfig to play nicely with refined’s type refinements;
• coulomb-pureconfig enables PureConfig configurations to include coulomb Quantity values.