jsMain.com.bkahlert.kommons.debug.trace.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kommons-debug Show documentation

Kommons Debug is a Kotlin Multiplatform Library for print debugging.

There is a newer version: 2.8.0

package com.bkahlert.kommons.debug

import com.bkahlert.kommons.text.LineSeparators.LF
import com.bkahlert.kommons.text.LineSeparators.isMultiline

/**
 * Helper property that supports
 * [print debugging][https://en.wikipedia.org/wiki/Debugging#Print_debugging].
 *
 * **Example**
 * ```kotlin
 * chain().of.endless().trace.breaks.print().calls()
 * ```
 * … does the same as …
 *
 * ```kotlin
 * chain().of.endless().calls()
 * ```
 * … with the only difference that the return value of
 *
 * ```kotlin
 * chain().of.endless()
 * ```
 *
 * is printed.
 */
@Suppress("DEPRECATION")
@Deprecated("Don't forget to remove after you finished debugging.", replaceWith = ReplaceWith("this"))
public inline val  T.traceJs: T get(): T = traceJs()

/**
 * Helper property that supports
 * [print debugging][https://en.wikipedia.org/wiki/Debugging#Print_debugging].
 *
 * **Example**
 * ```kotlin
 * chain().of.endless().trace.breaks.print().calls()
 * ```
 * … does the same as …
 *
 * ```kotlin
 * chain().of.endless().calls()
 * ```
 * … with the only difference that the return value of
 *
 * ```kotlin
 * chain().of.endless()
 * ```
 *
 * is printed.
 */
@Suppress("DEPRECATION")
@Deprecated("Don't forget to remove after you finished debugging.", replaceWith = ReplaceWith("this"))
public inline fun  T.traceJs(
    caption: CharSequence? = null,
    includeCallSite: Boolean = true,
    render: Renderer = { it.render() },
    noinline out: Printer? = null,
    noinline transform: Inspector? = null,
): T {

    val appendWrapped: (StringBuilder, String, Pair) -> Unit = { sb, value, (left, right) ->
        val separator = if (value.isMultiline()) LF else ' '
        sb.append(left)
        sb.append(separator)
        sb.append(value)
        sb.append(separator)
        sb.append(right)
    }

    buildString {
        if (caption != null) {
            append(caption)
            append(" ")
        }
        appendWrapped(
            this,
            render(this@traceJs),
            "⟨" to "⟩",
        )
        transform?.also {
            append(" ")
            appendWrapped(
                this,
                render(transform(this@traceJs)),
                "{" to "}",
            )
        }
    }.also {
        out?.invoke(it) ?: run {
            if (includeCallSite) console.trace(it)
            else console.log(it)
        }
    }
    return this
}