Google Git
Sign in
bazel / rules_kotlin / 92a3cfc08f7f7551ddc1bf92cdc6defb1080b5ff
commit92a3cfc08f7f7551ddc1bf92cdc6defb1080b5ff[log] [tgz]
authorHassan Syed <h.a.syed@gmail.com>Tue Sep 18 18:33:45 2018 -0400
committerGitHub <noreply@github.com>Tue Sep 18 18:33:45 2018 -0400
treec2649a755a9b5d024b22c43f3b26592adac6b14b
parent9c60df03b096a306515c23029667a6691e12d766 [diff]
refactor the testbench mocks so they are  more composeable (#148)

* refactor the testbench mocks so they are  more composeable. 

* Add sources and output jar normalization tests
14 files changed
tree: c2649a755a9b5d024b22c43f3b26592adac6b14b
  1. .bazelci/
  2. docs/
  3. examples/
  4. kotlin/
  5. scripts/
  6. src/
  7. third_party/
  8. .bazelproject
  9. .bazelrc
  10. .gitignore
  11. AUTHORS
  12. BUILD
  13. CONTRIBUTING.md
  14. CONTRIBUTORS
  15. LICENSE
  16. Makefile
  17. README.md
  18. WORKSPACE
README.md

Build status

Skydoc documentation

Announcements

  • August 14, 2018. Js support. No documentation yet but see the nested example workspace examples/node.
  • August 14, 2018. Android support. No documentation but it's a simple integration. see kotlin/internal/jvm/android.bzl.
  • Jun 29, 2018. The commits from this date forward are compatible with bazel >=0.14. JDK9 host issues were fixed as well some other deprecations. I recommend skipping 0.15.0 if you are on a Mac.
  • 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. kt_jvm_binary, kt_jvm_library and kt_jvm_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).

Quick Guide

This section just contains a quick overview. Consult the generated documentation. Note: Skydoc documentation is no longer being generated. Comprehensive documentation will have to wait till the new documentation generation tool is ready. A contribution to port the documentation to the RST format like rules_go has would be very welcome !

WORKSPACE

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

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()
kt_register_toolchains()

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.