Remove third_party checked in jars, and properly pull maven dependencies. (#279)
* Convert all dependencies to the modern equivalents.
* Introduce maven_install for all maven third_party dependencies
* Collected all http_* downloads into downloads.bzl, and configuration in setup.bzl. Simplifies example setup.
* Remove checked in jars, fixed build references.
* Fix kapt test by referencing the underlying maven jav and not using the generated jvm_import rule. There is a strange interaction with jvm_import and java_test.data.
Issue: bazelbuild/rules_kotlin/issues/275
Issue: bazelbuild/rules_kotlin/issues/269
* Correct the examples to reference the dev dependencies properly.
* Correct the examples to reference the dev dependencies properly.
* Documentation fixes.
* Fix comment spelling and revert define_kt_toolchain removal. Whoops. We should have tests for that.
* fix spaces
Current release: legacy-1.3.0
Main branch: master
legacy-1.3.0-rc4)For older news, please see Changelog
rules_kotlin supports the basic paradigm of *_binary, *_library, *_test of other Bazel language rules. It also supports jvm, android, and js flavors, with the prefix kt_jvm and kt_js, and kt_android typically applied to the rules (the exception being kt_android_local_test, which doesn't exist. Use an android_local_test that takes a kt_android_library as a dependency).
Limited “friend” support is available, in the form of tests being friends of their library for the system under test, allowing internal access to types and functions.
Also, kt_jvm_* rules support the following standard java_* rules attributes:
dataresource_jarsruntime_depsresourcesresources_strip_prefixexportsAndroid rules also support custom_package for R.java generation, manifest=, resource_files, etc.
Other features:
Javascript is reported to work, but is not as well maintained (at present)
Generated API documentation is available at https://bazelbuild.github.io/rules_kotlin/.
WORKSPACEIn the project's WORKSPACE, declare the external repository and initialize the toolchains, like this:
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") rules_kotlin_version = "legacy-1.3.0" rules_kotlin_sha = "4fd769fb0db5d3c6240df8a9500515775101964eebdf85a3f9f0511130885fde" http_archive( name = "io_bazel_rules_kotlin", urls = ["https://github.com/bazelbuild/rules_kotlin/archive/%s.zip" % rules_kotlin_version], type = "zip", strip_prefix = "rules_kotlin-%s" % rules_kotlin_version, sha256 = rules_kotlin_sha, ) load("@io_bazel_rules_kotlin//kotlin:kotlin.bzl", "kotlin_repositories", "kt_register_toolchains") kotlin_repositories() # if you want the default. Otherwise see custom kotlinc distribution below kt_register_toolchains() # to use the default toolchain, otherwise see toolchains below
BUILD filesIn your project's BUILD files, load the Kotlin rules and use them like so:
load("@io_bazel_rules_kotlin//kotlin:kotlin.bzl", "kt_jvm_library") kt_jvm_library( name = "package_name", srcs = glob(["*.kt"]), deps = [ "//path/to/dependency", ], )
To enable a custom toolchain (to configure language level, etc.) do the following. In a <workspace>/BUILD.bazel file define the following:
load("@io_bazel_rules_kotlin//kotlin:kotlin.bzl", "define_kt_toolchain") define_kt_toolchain( name = "kotlin_toolchain", api_version = KOTLIN_LANGUAGE_LEVEL, # "1.1", "1.2", or "1.3" jvm_target = JAVA_LANGUAGE_LEVEL, # "1.6", "1.8", "9", "10", "11", or "12", language_version = KOTLIN_LANGUAGE_LEVEL, # "1.1", "1.2", or "1.3" )
and then in your WORKSPACE file, instead of kt_register_toolchains() do
register_toolchains("//:kotlin_toolchain")
kotlinc distribution (and version)To choose a different kotlinc distribution (only 1.3 variants supported), do the following in your WORKSPACE file (or import from a .bzl file:
load("@io_bazel_rules_kotlin//kotlin:kotlin.bzl", "kotlin_repositories") KOTLIN_VERSION = "1.3.31" KOTLINC_RELEASE_SHA = "107325d56315af4f59ff28db6837d03c2660088e3efeb7d4e41f3e01bb848d6a" KOTLINC_RELEASE = { "urls": [ "https://github.com/JetBrains/kotlin/releases/download/v{v}/kotlin-compiler-{v}.zip".format(v = KOTLIN_VERSION), ], "sha256": KOTLINC_RELEASE_SHA, } kotlin_repositories(compiler_release = KOTLINC_RELEASE)
(e.g. Maven artifacts)
Third party (external) artifacts can be brought in with systems such as rules_jvm_external or bazel_maven_repository or bazel-deps, but make sure the version you use doesn't naively use java_import, as this will cause bazel to make an interface-only (ijar), or ABI jar, and the native ijar tool does not know about kotlin metadata with respect to inlined functions, and will remove method bodies inappropriately. Recent versions of rules_jvm_external and bazel_maven_repository are known to work with Kotlin.
To use the rules directly from the rules_kotlin workspace (i.e. not the release artifact) additional dependency downloads are required.
In the project's WORKSPACE, change the setup:
load("//kotlin:dependencies.bzl", "kt_download_local_dev_dependencies") kt_download_local_dev_dependencies() rules_kotlin_version = "legacy-1.3.0-rc4" rules_kotlin_sha = "fe32ced5273bcc2f9e41cea65a28a9184a77f3bc30fea8a5c47b3d3bfc801dff" http_archive( name = "io_bazel_rules_kotlin", urls = ["https://github.com/bazelbuild/rules_kotlin/archive/%s.zip" % rules_kotlin_version], type = "zip", strip_prefix = "rules_kotlin-%s" % rules_kotlin_version, sha256 = rules_kotlin_sha, ) load("@io_bazel_rules_kotlin//kotlin:kotlin.bzl", "kotlin_repositories", "kt_register_toolchains") kotlin_repositories() # if you want the default. Otherwise see custom kotlinc distribution below kt_register_toolchains() # to use the default toolchain, otherwise see toolchains below
Examples can be found in the examples directory, including usage with Android, Dagger, Node-JS, etc.
These rules were initially forked from pubref/rules_kotlin, and then re-forked from bazelbuild/rules_kotlin. They were merged back into this repository in October, 2019.
This project is licensed under the Apache 2.0 license, as are all contributions
See the CONTRIBUTING doc for information about how to contribute to this project.