typesafe-config-scala

KO | EN

gitlite — search

#python #ai #golang #android #linux #nodejs #macos #windows #awesome #awesome-list #vue #security #ios #openai

typesafe-config-scala

(★ 9)

Little scala extension to Typesafe Config

typesafe-config-scala Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Typesafe Config (little scala wrapper)

[![Build Status](https://github.com/andyglow/typesafe-config-scala/actions/workflows/ci.yml/badge.svg)]()
[![codecov](https://codecov.io/gh/andyglow/typesafe-config-scala/branch/master/graph/badge.svg?token=iqtc5BQRAp)](https://codecov.io/gh/andyglow/typesafe-config-scala)
[![mvn](https://img.shields.io/badge/dynamic/json.svg?label=mvn&query=%24.response.docs%5B0%5D.latestVersion&url=https%3A%2F%2Fsearch.maven.org%2Fsolrsearch%2Fselect%3Fq%3Dtypesafe-config-scala_2.13%26start%3D0%26rows%3D1)](https://search.maven.org/artifact/com.github.andyglow/typesafe-config-scala_2.13/)

Little scala extension to Typesafe Config

## Usage

### build.sbt
```
libraryDependencies += "com.github.andyglow" %% "typesafe-config-scala" % ${LATEST_VERSION} % Compile
```

### Code
Import it
```scala
import com.github.andyglow.config._
```

And then you will be able to
#### Get value by specifying needed type
```scala
val v1 = config.get[String]("path")
val v2 = config.get[Int]("path")
val v3 = config.get[FiniteDuration]("path")

```
#### Get rid of `if hasPath this else that` by leveraging notion of options
```scala
// optional value
val val1: Option[String] = config.get[Option[String]]("path")
val val2: String         = config.getOrElse[String]("path", "default")
```

#### Have more flexible api for working with multi-values
```scala
val list1     = config.get[List[String]]("path")
val set2      = config.get[Set[Int]]("path")
val iterator3 = config.get[Iterator[ConfigMemorySize]]("path")
```

### Supported types
- `String`
- `Int`
- `Boolean`
- `Double`
- `Long`
- `Bytes` (file size, etc...)
- `Duration` (java.time)
- `Duration` (scala)
- `FiniteDuration`
- `ConfigList`
- `Config`
- `ConfigObject`
- `ConfigMemorySize`
- `Date` (java.util)
- `Date` (java.sql)
- `Time` (java.sql)
- `Timestamp` (java.sql)
- `LocalDate` (java.time)
- `LocalTime` (java.time)
- `LocalDateTime` (java.time)
- `OffsetDateTime` (java.time)
- `ZonedDateTime` (java.time)
- `DayOfWeek` (java.time)
- `Month` (java.time)
- `Year` (java.time)
- `Option[T]` where `T` is one of the supported types
- scala collections. `Seq[T]`, etc. 
  Any sort of collection types which has corresponding `CanBuildFrom`

### Extending
Also this can be extended by providing implementations for `FromConf` and/or `ConfType` 
(used for collections and might be implicitly reused for `FromConf`)
For example take a look at `com.github.andyglow.config.ConfType#juDateT` implementation 
and spec at `com.github.andyglow.config.JavaUtilDateExtSpec`

### Flatten
Often we need to transform configs into some more trivial structures like Maps or java Properties.
For these sort or problems we provide `Flatten` function.
It map take `Config` or `ConfigValue` and produce either Properties or Map.
Example:
```scala
val conf: Config = ???

// for config
val properties = Flatten[java.util.Properties](conf)
val stringMap = Flatten[Map[String, String]](conf)

// for value
val properties = Flatten[java.util.Properties](conf.getValue("some-prop"))
val stringMap = Flatten[Map[String, String]](conf.getValue("some-prop"))

// also you can flatten config into already initialized instance of either Properties of Map
val propertiesWithConfig = Flatten(conf.getValue("some-prop"), properties)
val stringMapWithConfig = Flatten(conf.getValue("some-prop"), stringMap)
```

typesafe-config-scala

typesafe-config-scala Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

typesafe-config-scala

typesafe-config-scala Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README