Kommons

About

Kommons is a family of the following Kotlin—most of them multiplatform libraries:

• Kommons BOM … Bill of Materials
• Kommons Core … for runtime information, simple byte and string operations
• Kommons Debug … for print debugging
• Kommons Exec … to execute command lines and shell scripts
• Kommons IO … for simpler IO handling on the JVM
• Kommons Kaomoji … Japanese style emoticon constants
• Kommons Logging … for simple logging (only logging-core included by default)
• Kommons Test … to ease testing
• Kommons Text … for Unicode-aware text operations
• Kommons Time … KotlinX multiplatform date/time library extension
• Kommons URI … for handling (Data) URIs

The modules in bold are included in the Kommons module.
The other modules need to be added individually to use them.

Installation / Setup

This library is hosted on GitHub with releases provided on Maven Central.

To use a module individually, see the corresponding instructions linked in About.

The following dependency adds the core, debug, exec, io, logging-core, text, and uri module:

• Gradle implementation("com.bkahlert.kommons:kommons:2.8.0")

• Maven

  <dependency>
      <groupId>com.bkahlert.kommons</groupId>
      <artifactId>kommons</artifactId>
      <version>2.8.0</version>
  </dependency>

Please read the corresponding documentation for instructions on how to use them.

Development

Project structure

The project is structured as follows:

• kommons-* … feature modules
• kommons … umbrella module with dependencies to all feature modules
• kommons-bom … bill of materials, that is, a POM file that lists all modules and their versions
• buildSrc … custom build logic

Contributing

Want to contribute? Awesome! The most basic way to show your support is to star the project or to raise issues. You can also support this project by making a PayPal donation to ensure this journey continues indefinitely!

Thanks again for your support, it's much appreciated! 🙏

License

MIT. See LICENSE for more details.