Google Git
Sign in
bazel / rules_kotlin / 2d517f94080244b0294792a5deaf920b1730839e
commit2d517f94080244b0294792a5deaf920b1730839e[log] [tgz]
authorHassan Syed <h.a.syed@gmail.com>Thu May 24 22:40:39 2018 +0100
committerhsyed <h.a.syed@gmail.com>Fri May 25 15:47:32 2018 +0100
treececb3dd0a8319ef14d67d7092442fd5647008b4e
parent8bb7c08f75a3a2908707de96c113ba6ff2f53dcd [diff]
issue #69 friend support
15 files changed
tree: cecb3dd0a8319ef14d67d7092442fd5647008b4e
  1. .bazelci/
  2. docs/
  3. examples/
  4. kotlin/
  5. tests/
  6. third_party/
  7. .bazelproject
  8. .bazelrc
  9. .gitignore
  10. AUTHORS
  11. BUILD
  12. CONTRIBUTING.md
  13. CONTRIBUTORS
  14. LICENSE
  15. Makefile
  16. README.md
  17. WORKSPACE
README.md

Build status

Skydoc documentation

Announcements

  • May 25, 2018. Test “friend” support. A single friend dep can be provided to kt_jvm_test which allows the test to access internal members of the module under test.
  • February 15, 2018. Toolchains for the JVM rules. Currently this allow tweaking:
    • The JVM target (bytecode level).
    • API and Language levels.
    • Coroutines, enabled by default.
  • February 9, 2018. Annotation processing.
  • February 5, 2018. JVM rule name change: the prefix has changed from kotlin_ to kt_jvm_.

Overview

These rules were initially forked from pubref/rules_kotlin. Key changes:

  • Replace the macros with three basic rules. kotlin_binary, kotlin_library and kotlin_test.
  • Use a single dep attribute instead of java_dep and dep.
  • Add support for the following standard java rules attributes:
    • data
    • resource_jars
    • runtime_deps
    • resources
    • resources_strip_prefix
    • exports
  • Persistent worker support.
  • Mixed-Mode compilation (compile Java and Kotlin in one pass).

Usage

WORKSPACE

In the project's WORKSPACE, declare the external repository and initialize the toolchains, like this:

kotlin_release_version="1.2.30"
rules_kotlin_version = "67f4a6050584730ebae7f8a40435a209f8e0b48e"

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
)

load("@io_bazel_rules_kotlin//kotlin:kotlin.bzl", "kotlin_repositories", "kt_register_toolchains")
kotlin_repositories(kotlin_release_version=kotlin_release_version)
kt_register_toolchains()

If you omit kotlin_release_version and just call kotlin_repositories() with no arguments, you'll get the current kotlin compiler version (at least as known to the rules_kotlin project).

BUILD files

In 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",
    ],
)

License

This project is licensed under the Apache 2.0 license, as are all contributions

Contributing

See the CONTRIBUTING doc for information about how to contribute to this project.