tupol / scala-utils

Basic tools and utilities for Scala projects

GitHub

Scala Utils

Maven Central   GitHub   Travis (.org)   Codecov   Javadocs Gitter   Twitter  

Description

This project contains some basic utilities that can help setting up a Scala project.

The main utilities available:

Attention! The Configuration framework might be deprecated, as the PureConfig framework is much more mature and provides a better overall solution.

Prerequisites

  • Java 8 or higher (matching the Scala version)
  • Scala 2.12

Getting Scala Utils

Scala Utils is published to Sonatype OSS and Maven Central, where the latest artifacts can be found.

Usage with SBT, adding a dependency to the latest version of scala utils to your sbt build definition file:

  libraryDependencies += "org.tupol" %% "scala-utils" % "1.0.0-RC01"

The Sonatype snapshots repo needs to be added as well:

  resolvers += "Sonatype OSS Snapshots" at "https://oss.sonatype.org/content/repositories/snapshots"

Usage

Some config-z usage examples can be found under config-z/src/test/scala/examples.

What's new?

1.0.0-RC01 Effort Started

This new major version aims to bring a new and hopefully cleaner project structure. The scalaz based configuration is moved to a different module to isolate better from the core. In the future a cats based version will be added as well.

More core utilities were added and the old ones were brushed up for better consistency and clarity.

Attention! This version is no longer cross compiling across Scala 2.11 and 2.12. Only Scala 2.12 is supported at the moment.

The previous versions are still available and can evolve independently on the 0.2.x branch.

For previous versions please consult the release notes.

License

This code is open source software licensed under the MIT License.