Skip to content

Black-Kamelia/Sprinkler

Repository files navigation

Sprinkler logo Sprinkler logo

A non-intrusive set of extensions sprinkled over the Kotlin standard library.

Jenkins Jenkins Tests Jenkins Coverage

Summary

What is it?

Sprinkler is an open-source set of extensions to the Kotlin standard library, in the same vein as projects such as kotlinx, that is mainly used in Black Kamelia.

Modules and Documentation

Click the name of a module to go to its documentation.

  • ReadOnly Collections: Cast-safe read-only collections for Kotlin
  • Binary Transcoders: Composable binary encoders and decoders builders
  • Utils: Various utilities for Kotlin (and Java+Kotlin)
  • JVM Bridge: Utilities for JVM interoperability (Java+Kotlin)
  • i18n: Internationalization for the JVM

Integration

Do replace {module} with the module you want and {latest-version} with the latest version available on maven-central

The available modules are:

Maven

<dependencies>
  <dependency>
    <groupId>com.black-kamelia.sprinkler</groupId>
    <artifactId>{module}</artifactId>
    <version>{latest-version}</version>
  </dependency>
</dependencies>

Gradle

Kotlin DSL

repositories {
  mavenCentral()
}

dependencies {
  implementation("com.black-kamelia.sprinkler:{module}:{latest-version}")
}

Groovy DSL

repositories {
  mavenCentral()
}

dependencies {
  implementation 'com.black-kamelia.sprinkler:{module}:{latest-version}'
}

License

MIT License