Skip to content

Add defs.bzl with core rules and notice about evolving APIs #955

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 29, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions scala/defs.bzl
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
"""
Starlark rules for building Scala projects.

These are the core rules under active development. Their APIs are
not guaranteed stable and we anticipate some breaking changes.

We do not recommend using these APIs for production codebases. Instead,
use the stable rules exported by scala.bzl:

```
load(
"@io_bazel_rules_scala//scala:scala.bzl",
"scala_library",
"scala_binary",
"scala_test"
)
```

"""

load(
"@io_bazel_rules_scala//scala/private:rules/scala_binary.bzl",
_make_scala_binary = "make_scala_binary",
)
load(
"@io_bazel_rules_scala//scala/private:rules/scala_library.bzl",
_make_scala_library = "make_scala_library",
)
load(
"@io_bazel_rules_scala//scala/private:rules/scala_test.bzl",
_make_scala_test = "make_scala_test",
)

make_scala_library = _make_scala_library
Copy link
Contributor Author

@andyscott andyscott Jan 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe these 6 APIs should be exported.

Right now it's the same exact thing exported by scala.bzl + the advance usage helpers, but they will likely deviate as we explore adding new functionality.

make_scala_binary = _make_scala_binary
make_scala_test = _make_scala_test

scala_library = _make_scala_library()
scala_binary = _make_scala_binary()
scala_test = _make_scala_test()
27 changes: 27 additions & 0 deletions test/v2/BUILD
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
load(
"//scala:defs.bzl",
"scala_binary",
"scala_library",
"scala_test",
)

scala_binary(
name = "binary",
srcs = ["binary.scala"],
main_class = "test.v2.Binary",
deps = [":library"],
)

scala_library(
name = "library",
srcs = ["library.scala"],
deps = [],
)

scala_test(
name = "test",
srcs = ["test.scala"],
deps = [
":library",
],
)
7 changes: 7 additions & 0 deletions test/v2/binary.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package test.v2

object Binary {
def main(args: Array[String]): Unit = {
println(s"${Library.method1} ${Library.method2}")
}
}
6 changes: 6 additions & 0 deletions test/v2/library.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
package test.v2

object Library {
def method1(): String = "hello"
def method2(): String = "world"
}
13 changes: 13 additions & 0 deletions test/v2/test.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
package test.v2

import org.scalatest.FunSuite

class Test extends FunSuite {
test("method1") {
assert(Library.method1 == "hello")
}

test("method2") {
assert(Library.method2 == "world")
}
}