icerockdev / moko-utils

Utilities for mobile (android & ios) Kotlin Multiplatform development

Mobile Kotlin utils

This is a Kotlin MultiPlatform library that ...

Table of Contents

• Features
• Requirements
• Installation
• Usage
• Samples
• Set Up Locally
• Contributing
• License

Features

...

Requirements

• Gradle version 6.8+
• Android API 16+
• iOS version 11.0+

Installation

root build.gradle

allprojects {
    repositories {
        mavenCentral()
    }
}

project build.gradle

dependencies {
    commonMainApi("dev.icerock.moko:utils:0.3.0")
}

Usage

...

Samples

More examples can be found in the sample directory.

Set Up Locally

• In utils directory contains utils library;
• In sample directory contains samples on android, ios & mpp-library connected to apps.

Contributing

All development (both new features and bug fixes) is performed in develop branch. This way master sources always contain sources of the most recently released version. Please send PRs with bug fixes to develop branch. Fixes to documentation in markdown files are an exception to this rule. They are updated directly in master.

The develop branch is pushed to master during release.

More detailed guide for contributers see in contributing guide.

License

Copyright 2021 IceRock MAG Inc

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

moko-utils's Issues

Support iosSimulatorArm64 target

Add utils-napier module with common additions for Napier

Android logcat logger:

class LogCatAntilog(private val defaultTag: String) : Antilog() {
    override fun performLog(
        priority: Napier.Level,
        tag: String?,
        throwable: Throwable?,
        message: String?
    ) {
        val lcLevel: Int = priority.logcatLevel
        val lcTag: String = tag ?: defaultTag

        if (message != null) Log.println(lcLevel, lcTag, message)
        throwable?.printStackTrace(PrintWriter(LogcatOutputStream(lcLevel, lcTag)))
    }

    private class LogcatOutputStream(
        private val level: Int,
        private val tag: String
    ) : OutputStream() {
        private var mem: StringBuffer = StringBuffer()

        override fun write(byte: Int) {
            if (byte.toChar() == '\n') {
                flush()
                return
            }

            mem = mem.append(byte.toChar())
        }

        override fun flush() {
            Log.println(level, tag, mem.toString())
            mem = StringBuffer()
        }
    }

    private val Napier.Level.logcatLevel: Int
        get() = when (this) {
            Napier.Level.VERBOSE -> Log.VERBOSE
            Napier.Level.DEBUG -> Log.DEBUG
            Napier.Level.INFO -> Log.INFO
            Napier.Level.WARNING -> Log.WARN
            Napier.Level.ERROR -> Log.ERROR
            Napier.Level.ASSERT -> Log.ASSERT
        }
}

update to kotlin 1.5.20

and gradle 7

publish to mavenCentral