e is a zero-dependency micro library for dealing with errors on JVM. It aims to unify error handling across different JVM applications by providing an error model, ways to encode/decode errors and ways to use errors throughout your codebase.

It consists of different modules for different needs. You can find details, instructions and documentation about each of them on their own pages.

1. Modules
2. Installation
3. Examples and Use Cases
4. Development and Testing
5. Documentation
6. Dependencies
7. Releases
8. Contributing
9. License

• Replace [MODULE] with a module name and [SCALA_VERSION] with your project's Scala version (if applicable)
• If you use SBT, add following to your build.sbt for each module you want to use

libraryDependencies ++= Seq(
  // Scala modules
  "dev.akif" %% "[MODULE]" % "1.1.2",

  // Java/Kotlin modules
  "dev.akif" % "[MODULE]" % "1.1.2"
)

• If you use Maven, add following to your pom.xml for each module you want to use

<dependencies>
  <!-- Scala modules -->
  <dependency>
    <groupId>dev.akif</groupId>
    <artifactId>[MODULE]_[SCALA_VERSION]</artifactId>
    <version>1.1.2</version>
  </dependency>

  <!-- Java/Kotlin modules -->
  <dependency>
    <groupId>dev.akif</groupId>
    <artifactId>[MODULE]</artifactId>
    <version>1.1.2</version>
  </dependency>
</dependencies>

• If you use Gradle, add following to your project's build.gradle for each module you want to use

dependencies {
  // Scala modules
  implementation('dev.akif:[MODULE]_[SCALA_VERSION]:1.1.2'),

  // Java/Kotlin modules
  implementation('dev.akif:[MODULE]:1.1.2')
}

There are some example projects using e and some documented use cases where e can be helpful. You can find them in examples folder.

e is built with SBT. You can use clean, compile, test tasks for development and testing.

Documentation is managed with mdoc, check out docs folder for editing.

Versions of Scala, SBT, plugins and external dependencies are kept up-to-date by scala-steward.

e packages are published to Maven Central and they are versioned according to semantic versioning. Release process is managed by sbt-release.

All contributions are welcome, including requests to feature your project utilizing e. Please feel free to send a pull request. Thank you.

e is licensed with MIT License.