Skip to content

Commit 12a4b01

Browse files
committed
* Documentation update
Signed-off-by: Marcin Kuszczak <1508798+aartiPl@users.noreply.github.com>
1 parent 429091e commit 12a4b01

File tree

4 files changed

+48
-49
lines changed

4 files changed

+48
-49
lines changed

NEWS.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,15 @@
99
**Enhancements**
1010

1111
* New GitHub organization: [kscripting](http://github.com/kscripting)
12+
* More work on Windows shell compatibility; most functionality works on Windows as on systems with bash
1213
* Change the name of kscript package to io.github.kscripting:kscript
1314
* Final execution of script is handled by kscript, not by bash (reduces dependency on bash)
1415
* Separate library for shell execution kscripting/shell
15-
* Deprecate old annotations in kscript-annotations library
16+
* Ability to provide local artifacts path through **KSCRIPT_DIRECTORY_ARTIFACTS** or configuration file property:
17+
**scripting.directory.artifacts** (thanks to [Vsajip](https://github.com/vsajip) for initial implementation)
18+
* kscript jar is released to Maven Central: **io.github.kscripting:kscript:4.2.0**
1619
* Change the way of checking latest kscript version (simplifies releases)
20+
* Deprecate old annotations in kscript-annotations library
1721
* Improved implementation: VersionChecker, ConfigBuilder etc.
1822
* Updated Gradle and dependencies
1923
* Deprecated @file:Include in favour of @file:Import as a preparation of switch to Kotlin Scripting
@@ -22,8 +26,6 @@
2226
* Version of kscript is set by Gradle (generated BuildConfig class)
2327
* Improved DependencyResolver: aar archives are also included in classpath
2428
* When creating IntelliJ project Gradle and Idea are no more required
25-
* Ability to provide local artifacts path through **KSCRIPT_DIRECTORY_ARTIFACTS** or configuration file property:
26-
**scripting.directory.artifacts** (thanks to [Vsajip](https://github.com/vsajip) for initial implementation)
2729

2830
**Bugfixes**
2931

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![Build Status](https://github.com/holgerbrandl/kscript/actions/workflows/build.yml/badge.svg)](https://github.com/holgerbrandl/kscript/actions/workflows/build.yml)
55
[![Gitter](https://badges.gitter.im/holgerbrandl/kscript.svg)](https://gitter.im/holgerbrandl/kscript?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
66

7-
Enhanced scripting support for [Kotlin](https://kotlinlang.org/) on *nix-based systems.
7+
Enhanced scripting support for [Kotlin](https://kotlinlang.org/) on *nix-based and Windows systems.
88

99
Kotlin has some built-in support for scripting already, but it is not yet feature-rich enough to be a viable alternative
1010
in the shell.

TODO.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
1-
# kscript 4.2 features:
2-
3-
* Release kscript to Maven Central
1+
# kscript 4.3 features:
42

53
* Change a way of executing .kts files (investigate if we can get rid of reflections)
4+
* Passing additional information to scripts (args, script name, script path, kscript path etc.)
65
* Onboard on brew
76
* Deprecate KotlinOptions
87
* New package for Windows e.g. scoop
98
* Release scripts in Kotlin
109
* Windows console support requires @argfiles as kotlin/kotlinc command line might be too long to execute it from console (especially for big classpaths).
1110
* Improve Unit tests coverage
12-
* Improve batch file for Windows (currently it does not pass failed exitCode)
1311
* Use compilation option -include-runtime: https://kotlinlang.org/docs/command-line.html#create-and-run-an-application
1412
* Integration tests - more tests should be enabled;
1513
* kscript - some features might be disabled on specific OSes - handle that on code level e.g. throw exception if for some OS feature is not available.
1614
* Deprecate referencing script by $HOME and by '/' (it is handled now safely, but does it make sense to keep it?)
1715
* Compatibility with Kotlin Scripting
18-
* Consider changing a way of executing last command, so that it is not executed by shell, but is executed directly in kscript (main concern: kotlin interactive shell, but maybe this use case is not that important)
1916
* Onboard on docker etc. and other release channels
20-
* Abstraction for shell command (Command class containing e.g. environment variables)
17+
* Abstraction for shell command (Command class containing e.g. environment variables)

build.gradle.kts

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -131,45 +131,6 @@ tasks.test {
131131
useJUnitPlatform()
132132
}
133133

134-
dependencies {
135-
//compileOnly(fileTree("libs"))
136-
implementation("commons-cli:commons-cli:1.5.0")
137-
138-
implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlinVersion")
139-
implementation("org.jetbrains.kotlin:kotlin-reflect:$kotlinVersion")
140-
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4")
141-
142-
implementation("org.jetbrains.kotlin:kotlin-scripting-common:$kotlinVersion")
143-
implementation("org.jetbrains.kotlin:kotlin-scripting-jvm:$kotlinVersion")
144-
// implementation("org.jetbrains.kotlin:kotlin-scripting-dependencies:$kotlinVersion")
145-
implementation("org.jetbrains.kotlin:kotlin-scripting-dependencies-maven-all:$kotlinVersion")
146-
147-
implementation("org.apache.commons:commons-lang3:3.12.0")
148-
implementation("commons-io:commons-io:2.11.0")
149-
implementation("commons-codec:commons-codec:1.15")
150-
implementation("com.konghq:unirest-java:3.13.13")
151-
152-
implementation("net.igsoft:tablevis:0.6.0")
153-
implementation("io.arrow-kt:arrow-core:1.1.2")
154-
155-
implementation("io.github.kscripting:shell:0.5.0")
156-
157-
implementation("org.slf4j:slf4j-nop:2.0.5")
158-
159-
implementation("org.semver4j:semver4j:3.0.0")
160-
161-
162-
testImplementation("org.junit.platform:junit-platform-suite-engine:1.9.0")
163-
testImplementation("org.junit.platform:junit-platform-suite-api:1.9.0")
164-
testImplementation("org.junit.platform:junit-platform-suite-commons:1.9.0")
165-
testImplementation("org.junit.jupiter:junit-jupiter-engine:5.9.0")
166-
testImplementation("org.junit.jupiter:junit-jupiter-params:5.9.0")
167-
testImplementation("com.willowtreeapps.assertk:assertk-jvm:0.25")
168-
testImplementation("io.mockk:mockk:1.13.2")
169-
170-
testImplementation(kotlin("script-runtime"))
171-
}
172-
173134
val createKscriptLayout by tasks.register<Copy>("createKscriptLayout") {
174135
dependsOn(shadowJar)
175136

@@ -293,3 +254,42 @@ publishing {
293254
signing {
294255
sign(publishing.publications["mavenJava"])
295256
}
257+
258+
dependencies {
259+
//compileOnly(fileTree("libs"))
260+
implementation("commons-cli:commons-cli:1.5.0")
261+
262+
implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlinVersion")
263+
implementation("org.jetbrains.kotlin:kotlin-reflect:$kotlinVersion")
264+
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4")
265+
266+
implementation("org.jetbrains.kotlin:kotlin-scripting-common:$kotlinVersion")
267+
implementation("org.jetbrains.kotlin:kotlin-scripting-jvm:$kotlinVersion")
268+
// implementation("org.jetbrains.kotlin:kotlin-scripting-dependencies:$kotlinVersion")
269+
implementation("org.jetbrains.kotlin:kotlin-scripting-dependencies-maven-all:$kotlinVersion")
270+
271+
implementation("org.apache.commons:commons-lang3:3.12.0")
272+
implementation("commons-io:commons-io:2.11.0")
273+
implementation("commons-codec:commons-codec:1.15")
274+
implementation("com.konghq:unirest-java:3.13.13")
275+
276+
implementation("net.igsoft:tablevis:0.6.0")
277+
implementation("io.arrow-kt:arrow-core:1.1.2")
278+
279+
implementation("io.github.kscripting:shell:0.5.0")
280+
281+
implementation("org.slf4j:slf4j-nop:2.0.5")
282+
283+
implementation("org.semver4j:semver4j:3.0.0")
284+
285+
286+
testImplementation("org.junit.platform:junit-platform-suite-engine:1.9.0")
287+
testImplementation("org.junit.platform:junit-platform-suite-api:1.9.0")
288+
testImplementation("org.junit.platform:junit-platform-suite-commons:1.9.0")
289+
testImplementation("org.junit.jupiter:junit-jupiter-engine:5.9.0")
290+
testImplementation("org.junit.jupiter:junit-jupiter-params:5.9.0")
291+
testImplementation("com.willowtreeapps.assertk:assertk-jvm:0.25")
292+
testImplementation("io.mockk:mockk:1.13.2")
293+
294+
testImplementation(kotlin("script-runtime"))
295+
}

0 commit comments

Comments
 (0)