Add a detection sample (#126)

* Turn `TerminalInfo` into a `data class`

This allows to easily compare instances and benefit from an
auto-generated `toString()` representation.

The downside is that `width` and `height` could now be set from the
outside after construction, but that is probably not too much of an
issue as arbitrary values could also have been passed via the
constructor initially anyway.

* Add a basic sample to show information for issue reports

Later on printing of selected environment variables or similar useful
output could be added.

mordant/src/commonMain/kotlin/com/github/ajalt/mordant/terminal/TerminalInfo.kt

@@ -9,11 +9,11 @@ import com.github.ajalt.mordant.rendering.AnsiLevel
  * [width] and [height] don't automatically change if the terminal is resized. Call
  * [updateTerminalSize] to get the latest values.
  */
-class TerminalInfo(
+data class TerminalInfo(
     /** The terminal width, in cells */
-    width: Int,
+    var width: Int,
     /** The terminal height, in cells */
-    height: Int,
+    var height: Int,
     /** The level of ANSI codes to use when printing to the terminal */
     var ansiLevel: AnsiLevel,
     /** If true, ANSI hyperlink codes can be used */
@@ -34,14 +34,6 @@ class TerminalInfo(
      */
     val crClearsLine: Boolean,
 ) {
-    /** The terminal width, in cells */
-    var width: Int = width
-        private set
-    /** The terminal height, in cells */
-    var height: Int = height
-        private set
-
-
     /** Return true if both input and output are interactive */
     val interactive: Boolean get() = inputInteractive && outputInteractive
 

samples/detection/README.md

@@ -0,0 +1,3 @@
+# Detection Sample
+
+This sample shows the detected terminal, e.g. to collect information for issue reports.

samples/detection/build.gradle.kts

@@ -0,0 +1,35 @@
+import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget
+
+plugins {
+    kotlin("multiplatform")
+    application
+}
+
+kotlin {
+    jvm {
+        withJava()
+    }
+
+    macosX64()
+    linuxX64()
+    mingwX64()
+
+    targets.filterIsInstance<KotlinNativeTarget>().forEach { target ->
+        target.binaries.executable {
+            entryPoint = "com.github.ajalt.mordant.samples.main"
+        }
+    }
+
+    sourceSets {
+        val commonMain by getting {
+            dependencies {
+                implementation(project(":mordant"))
+            }
+        }
+    }
+}
+
+application {
+    mainClass.set("com.github.ajalt.mordant.samples.MainKt")
+    applicationDefaultJvmArgs = listOf("-Dfile.encoding=utf-8")
+}

samples/detection/src/commonMain/kotlin/com/github/ajalt/mordant/samples/main.kt

@@ -0,0 +1,17 @@
+package com.github.ajalt.mordant.samples
+
+import com.github.ajalt.mordant.rendering.Theme
+import com.github.ajalt.mordant.terminal.Terminal
+
+fun main() {
+    val terminal = Terminal()
+    terminal.println(Theme.Default.info(terminal.info.toString()))
+    terminal.println(
+        "Theme colors: " +
+                "${Theme.Default.success("success")}, " +
+                "${Theme.Default.danger("danger")}, " +
+                "${Theme.Default.warning("warning")}, " +
+                "${Theme.Default.info("info")}, " +
+                "${Theme.Default.muted("muted")}"
+    )
+}

settings.gradle.kts

@@ -1,4 +1,5 @@
 include("mordant")
+include("samples:detection")
 include("samples:markdown")
 include("samples:progress")
 include("samples:table")