Utilities

Overview

Kiit Utilities supplement the existing Kotlin standard library by offering a powerful set of general purpose Kotlin components that can be used for any application. Many of these components are located in the kiit-common project. However, there are a few components located in other projects. Refer to each utility component for more info.

Setup

Use the following settings in gradle for installing this component.

    
    buildscript {
        // Kotlin version currently being used
        ext.kotlin_version = '1.8.22'

        // Reference version 
        ext.kiit_version = '3.1.0'

        // ...
    }

    repositories {
        // Currently stored in Git Hub Packages.
        maven {
            url "https://maven.pkg.github.com/slatekit/kiit"
            credentials {
                username = System.getenv('GIT_PACKAGES_INSTALL_ACTOR')
                password = System.getenv('GIT_PACKAGES_INSTALL_TOKEN')
            }
        }

        // ...
    }

    dependencies {
        // Other dependencies ...
        implementation "dev.kiit:kiit-common:$kiit_version"
    }
    



Module

Links to this modules info. Click on any component icon below for example on how to use it.

Jar kiit.common.jar
Package kiit.common
Sources /src/common/common/
Example All Examples
Requires See build.gradle for more info.

Several Utilities

Many pre-built utilities to support your Server application or Android client.

Args

A lexical command line arguments parser

Auth

Easily access authentication information

Config

Java props with types, lists, encryption, and more

Console

Console writer with semantics and colors

DateTime

Easier Java 8 DateTime and Timezone usage

Encrypt

AES encryption and decryption support and utilities

Env

Environment selector ( dev, qa, stg, prod )

Folders

Standardized runtime app folders and structure.

Info

Useful information about app, host, runtime

Lex

A light-weight lexer to parse text into tokens

Logs

Simple, extensible, customizable logger

Model

Builts schemas to map models and generate code

Random

Random generator for strings, numbers, alpha, guids

Request

Abstracts and represents HTTP and CLI requests

Smart Strings

Store, validate, describe strongly formatted strings

Templates

A micro templating system for emails, sms and short messages

Notes

Typesafe, programmatic approach to marking Notes/Todos in code

Utils

Several other smaller utilities and components

Validations

Functional validation, RegEx patterns, and helpers

Extensions

Extension methods for various Kotlin types and classes