makiftutuncu / e

A zero-dependency micro library to deal with errors

Version Matrix

e 🐞

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.

Latest Version of e Java Version Scala Versions Kotlin Version
2.0.0 1.8 2.12.12, 2.13.2 1.4.0

Table of Contents

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

Modules

Name Platform Details Documentation
e-scala Scala Scala implementation
e-kotlin Kotlin Kotlin implementation
e-java Java Java implementation
e-circe Scala Extras for circe
e-play-json Scala Extras for play-json
e-zio Scala Extras for ZIO
e-gson Java Extras for gson

Examples and Use Cases

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

Development and Testing

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

Documentation

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

Dependencies

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

Releases

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

Contributing

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

License

e is licensed with MIT License.