Commit 1da586c

imbanankoligee

authored and

committed

Add script documentation for kotlin-shell and kotlinx-html

1 parent 1f96764 commit 1da586cCopy full SHA for 1da586c

File tree

+40

-1

lines changed

+40

-1

lines changed

Lines changed: 7 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -12,3 +12,10 @@ allprojects {`
`12`	`12`	`}`
`13`	`13`	`}`
`14`	`14`
	`15`	`+dependencies {`
	`16`	`+ // adding these dependencies here just to have it locally available after gradle project import`
	`17`	`+ // can be useful when running performance tests for .main.kts scripts`
	`18`	`+ implementation("org.jetbrains.kotlinx:kotlinx-html-jvm:0.8.0")`
	`19`	`+ implementation("eu.jrie.jetbrains:kotlin-shell-core:0.2.1")`
	`20`	`+}`
	`21`	`+`

Lines changed: 21 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,26 @@`
`1`	`1`	`#!/usr/bin/env kotlin`
`2`	`2`
	`3`	`+/**`
	`4`	`+ * A command-line utility script that provides directory listing and word counting functionality.`
	`5`	`+ *`
	`6`	`+ * Usage:`
	`7`	+ * - Without arguments: Lists files in the current directory (equivalent to `ls -l`)
	`8`	+ * - With file argument: Performs word count analysis (similar to `wc` command)
	`9`	+ * Shows both custom implementation and system `wc` command results
	`10`	`+ *`
	`11`	`+ * Example usage:`
	`12`	+ * ```
	`13`	`+ * ./kotlin-shell.main.kts # Lists directory contents`
	`14`	`+ * ./kotlin-shell.main.kts file.txt # Counts lines, words, and characters in file.txt`
	`15`	+ * ```
	`16`	`+ *`
	`17`	`+ * Dependencies:`
	`18`	`+ * - kotlin-shell-core:0.2.1`
	`19`	`+ *`
	`20`	`+ * @param args - command line arguments. If provided, the first argument should be a file path`
	`21`	`+ */`
	`22`	`+`
	`23`	`+`
`3`	`24`	`@file:DependsOn("eu.jrie.jetbrains:kotlin-shell-core:0.2.1")`
`4`	`25`	`@file:CompilerOptions("-Xopt-in=kotlin.RequiresOptIn")`
`5`	`26`	`@file:OptIn(kotlinx.coroutines.ExperimentalCoroutinesApi::class)`

Lines changed: 12 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,17 @@`
`1`	`1`	`#!/usr/bin/env kotlin`
`2`	`2`
	`3`	`+/**`
	`4`	`+ * A demonstration script showing HTML generation using kotlinx.html DSL.`
	`5`	`+ * This script creates and prints a simple HTML document with a "Hello, World!" heading.`
	`6`	`+ *`
	`7`	`+ * Usage:`
	`8`	`+ * - Run the script to generate HTML output`
	`9`	`+ * - No command line arguments needed`
	`10`	`+ *`
	`11`	`+ * Dependencies:`
	`12`	`+ * - kotlinx-html-jvm:0.8.0`
	`13`	`+ */`
	`14`	`+`
`3`	`15`	`@file:DependsOn("org.jetbrains.kotlinx:kotlinx-html-jvm:0.8.0")`
`4`	`16`
`5`	`17`	`import kotlinx.html.*`
`@@ -12,4 +24,3 @@ print(createHTML().html {`
`12`	`24`	`h1 { +"Hello, $addressee!" }`
`13`	`25`	`}`
`14`	`26`	`})`
`15`		`-`

Comments

(0)