Small library for translating between HOCON, Java properties, and JSON documents and circe's JSON AST. Forked from circe-config to allow for Scala JS and Scala Native support via sconfig. All credit goes towards the original developers.
At a high-level it can be used as a circe powered front-end for the sconfig library to enable boilerplate free loading of settings into Scala types. More generally it provides parsers and printers for interoperating with Typesafe config's JSON AST.
To use this library configure your sbt project with the following line:
libraryDependencies += "io.github.unganisha" %% "circe-sconfig" % "0.8.0"
Please refer to the original library documentation here. This is to reduce the maintenance burden of this library.
Currently, the supported platforms include the JVM and Scala.js.
In the case of platforms other than a Java Virtual Machine, only a subset of the API is available. Specifically any
methods that make use of java.io.File
and/or java.net.URL
are not currently supported. Additionally, an
implementation of the java.time
API must also be included, such as sjavatime
for example.
Please refer to the original library examples here.
Contributions are very welcome. Please see instructions on how to create issues and submit patches.
circe-config 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.