summary | Enhanced printing to console with support for semantic writing like title, subtitle, url, error, etc with colors |
jar | kiit.common.jar |
package | kiit.common.console |
artifact | dev.kiit:kiit-common |
sources | src/common/common/src/main/kotlin/kiit/common/console |
example | src/lib/kotlin/slate-examples/src/main/kotlin/slatekit/examples/Example_Console.kt |
dependency | kiit-results |
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"
}
// required
import kiit.common.console.*
// optional
import kiit.results.Try
import kiit.results.Success
n/a
// ConsoleWriter with semantic ( title, url, error, success, highlight ) writing.
val writer = SemanticConsole()
// Case 1: Title - prints text in title format ( CAPS + Color Cyan )
writer.title("title is in CAPS")
// Case 2: Subtitle ( Color Cyan )
writer.subTitle("subtitle is in color cyan")
// Case 3: Url ( Color blue )
writer.url("url is in blue")
// Case 4: Highlight ( Color Yellow )
writer.highlight("highlight is in color")
// Case 5: Subtitle ( Color Red )
writer.important("important is red")
// Case 6: Subtitle ( Color Red )
writer.failure("error shown in red")
// Case 7: Subtitle ( Color Green )
writer.success("success is in green")
// Case 8: Subtitle ( Color Green )
writer.text("normal text")
// Case 9: Tab
writer.tab()
// Case 10: New line
writer.line()
// Case 11: Label "Key :"
writer.label("Key")
// Case 12: Key/Value = "Name : Superman"
writer.keyValue("Name", "Superman")
writer.lines(2)
// Case 13: List of items ( unordered and ordered )
writer.list( listOf( 1, true , "www.slatekit.com", DateTime.now(), 12.34 ), true)
writer.list( listOf( 2, false, "www.codehelix.co", DateTime.now(), 56.78 ), true)
// Case 14: Supply a list of items to print specifying the semantic mode ( title, url, etc )
writer.writeItems(listOf(
SemanticOutput(SemanticText.Title , "About App" , true),
SemanticOutput(SemanticText.Subtitle , "Example of Console component", true),
SemanticOutput(SemanticText.Url , "http://www.slatekit.com" , true),
SemanticOutput(SemanticText.Highlight , "visit us for more info" , true)
))
TITLE IS IN CAPS
subtitle is in color cyan
url is in blue
highlight is in color
important is red
error shown in red
success is in green
Key
Name = Superman
ABOUT APP
Example of Console component
http://www.slatekit.com
visit us for more info