https://github.com/rife2/bld-kotlin
Kotlin Extension for bld
https://github.com/rife2/bld-kotlin
bld build-system build-tool build-tool-plugin dokka extension java kotlin
Last synced: 5 months ago
JSON representation
Kotlin Extension for bld
- Host: GitHub
- URL: https://github.com/rife2/bld-kotlin
- Owner: rife2
- License: apache-2.0
- Created: 2023-11-04T04:29:51.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-10T14:39:48.000Z (9 months ago)
- Last Synced: 2025-09-10T18:31:48.968Z (9 months ago)
- Topics: bld, build-system, build-tool, build-tool-plugin, dokka, extension, java, kotlin
- Language: Java
- Homepage:
- Size: 622 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# [Kotlin](https://kotlinlang.org/) Extension for [bld](https://rife2.com/bld)
[](https://opensource.org/licenses/Apache-2.0)
[](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)
[](https://kotlinlang.org)
[](https://rife2.com/bld)
[](https://repo.rife2.com/#/releases/com/uwyn/rife2/bld-kotlin)
[](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-kotlin)
[](https://github.com/rife2/bld-kotlin/actions/workflows/bld.yml)
To install the latest version, add the following to the `lib/bld/bld-wrapper.properties` file:
```properties
bld.extension-kotlin=com.uwyn.rife2:bld-kotlin
```
For more information, please refer to the [extensions](https://github.com/rife2/bld/wiki/Extensions) and [support](https://github.com/rife2/bld/wiki/Kotlin-Support) documentation.
## Compile Kotlin Source Code
To compile the source code located in `src/main/kotlin` and `src/test/kotlin` from the current project add the following to the build file:
```java
@BuildCommand(summary = "Compiles the Kotlin project")
public void compile() throws Exception {
new CompileKotlinOperation()
.fromProject(this)
.execute();
}
```
```console
./bld compile
```
- [View Examples Project](https://github.com/rife2/bld-kotlin/tree/main/examples/)
- [View Template Project](https://github.com/rife2/kotlin-bld-example)
Please check
the [Compile Operation documentation](https://rife2.github.io/bld-kotlin/rife/bld/extension/CompileKotlinOperation.html#method-summary)
for all available configuration options.
## Kotlin Compiler Requirement
Please make sure the Kotlin compiler is [installed](https://kotlinlang.org/docs/command-line.html#install-the-compiler).
The extension will look in common locations such as:
- `KOTLIN_HOME`
- `PATH`
- [SDKMAN!](https://sdkman.io/)
- [Homebrew](https://brew.sh/)
- [JetBrains Toolbox](https://www.jetbrains.com/toolbox-app/) (IntelliJ IDEA, Android Studio)
- etc.
You can also manually configure the Kotlin home location as follows:
```java
@BuildCommand(summary = "Compiles the Kotlin project")
public void compile() throws Exception {
new CompileKotlinOperation()
.fromProject(this)
.kotlinHome("path/to/kotlin")
.execute();
}
```
The Kotlin compiler executable can also be specified directly:
```java
@BuildCommand(summary = "Compiles the Kotlin project")
public void compile() throws Exception {
new CompileKotlinOperation()
.fromProject(this)
.kotlinc("/usr/bin/kotlinc")
.execute();
}
```
While older version of Kotlin are likely working with the extension, only version 2.0.21 or higher are officially
supported.
## Template Project
There is also a [Template Project](https://github.com/rife2/kotlin-bld-example) with support for
the [Dokka](https://github.com/rife2/bld-dokka) and [Detekt](https://github.com/rife2/bld-detekt) extensions.