Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/higherkindness/rules_scala

Robust and featureful Bazel rules for Scala
https://github.com/higherkindness/rules_scala

bazel bazel-rules scala

Last synced: about 2 months ago
JSON representation

Robust and featureful Bazel rules for Scala

Host: GitHub
URL: https://github.com/higherkindness/rules_scala
Owner: higherkindness
License: apache-2.0
Created: 2018-02-14T06:06:51.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2023-09-18T21:29:38.000Z (over 1 year ago)
Last Synced: 2024-04-18T12:54:31.807Z (8 months ago)
Topics: bazel, bazel-rules, scala
Language: Starlark
Homepage:
Size: 1.23 MB
Stars: 66
Watchers: 14
Forks: 28
Open Issues: 39
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # higherkindness/rules_scala

[![Build Status](https://github.com/higherkindness/rules_scala/workflows/CI/badge.svg)](https://github.com/higherkindness/rules_scala/actions)

`higherkindness/rules_scala` evolved, in part, from the need for Bazel adoption support for large, monorepo Scala projects.

Bazel is wonderful because it makes use of parallelism and caching to vastly improve build times. However, to see these benefits, a project must first be broken down into

tiny packages and make use of fine-grained dependencies. This is not always a realistic short-term goal for large, monorepo Scala projects.

`higherkindness/rules_scala` allows for the optional use of Zinc incremental compilation to provide a stepping stone for these projects as they migrate to Bazel.

`higherkindness/rules_scala` is written with maintainability and accessibility in mind. It aims to facilitate the transition to Bazel, and to satisfy use cases throughout the Scala ecosystem.

## Principles

1. Support the breadth of the Scala ecosystem.

2. Follow Bazel best practices.

3. Be accessible and maintainable.

4. Have high-quality documentation.

If the right design principles are kept, implementing additional features should be simple and straightforward.

## Features

* Simple core API modeled after Bazel's Java APIs

  * [scala_library](docs/stardoc/scala.md#scala_library)

  * [scala_binary](docs/stardoc/scala.md#scala_binary)

  * [scala_test](docs/stardoc/scala.md#scala_test)

  * [scala_import](docs/stardoc/scala.md#scala_import)

  * [scala_repl](docs/stardoc/scala.md#scala_repl)

* [Works with all sbt-compatible test frameworks](docs/scala.md#tests)

* [Advanced Dependency Detection](docs/scala.md#strict--unused-deps)

  * Errors on indirect and unused dependencies

  * Buildozer suggestions for dependency errors

* [Optional Worker strategy](docs/scala.md#workers)

* [Optional Zinc-based stateful incremental compilation](docs/stateful.md#stateful-compilation)

* [Scalafmt](docs/scalafmt.md#scalafmt) integration

* Protobuf support with ScalaPB

  * [scala_proto_library](docs/stardoc/scala_proto.md#scala_proto_library)

  * [scala_proto_toolchain](docs/stardoc/scala_proto.md#scala_proto_toolchain)

* Seamless integration with the [Bazel IntelliJ plugin](https://github.com/bazelbuild/intellij)

* [Customizable rules](docs/newdocs/phases.md#customizing-the-core-rules)

* [Multiple Scala versions in one build](docs/newdocs/scala_versions.md#specifying-the-scala-version-to-use), including Scala 3 (Dotty).

* [Optimal handling of macros and ijars](docs/newdocs/macros.md#macros-and-ijars)

* [Pass flags to Zinc compiler](docs/newdocs/zinc_flags.md)

* Modern implementation using Bazel's most idiomatic APIs

## Usage

WORKSPACE

```python

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

# Load rules scala annex

rules_scala_annex_version = "ae99fcb08bbddfc24fef00d7b13f6c065e1df8d5"

rules_scala_annex_sha256 = "1630fc7ecc7a4ffeabcdef73c7600eab9cf3fd2377db1f69b8ce1927560211ff"

http_archive(

    name = "rules_scala_annex",

    sha256 = rules_scala_annex_sha256,

    strip_prefix = "rules_scala-{}".format(rules_scala_annex_version),

    url = "https://github.com/higherkindness/rules_scala/archive/{}.zip".format(rules_scala_annex_version),

)

rules_jvm_external_tag = "2.9"

rules_jvm_external_sha256 = "e5b97a31a3e8feed91636f42e19b11c49487b85e5de2f387c999ea14d77c7f45"

http_archive(

    name = "rules_jvm_external",

    sha256 = rules_jvm_external_sha256,

    strip_prefix = "rules_jvm_external-{}".format(rules_jvm_external_tag),

    url = "https://github.com/bazelbuild/rules_jvm_external/archive/{}.zip".format(rules_jvm_external_tag),

)

load("@rules_scala_annex//rules/scala:workspace.bzl", "scala_register_toolchains", "scala_repositories")

scala_repositories()

load("@annex//:defs.bzl", annex_pinned_maven_install = "pinned_maven_install")

annex_pinned_maven_install()

scala_register_toolchains()

load("@rules_scala_annex//rules/scalafmt:workspace.bzl", "scalafmt_default_config", "scalafmt_repositories")

scalafmt_repositories()

load("@annex_scalafmt//:defs.bzl", annex_scalafmt_pinned_maven_install = "pinned_maven_install")

annex_scalafmt_pinned_maven_install()

scalafmt_default_config()

load("@rules_scala_annex//rules/scala_proto:workspace.bzl", "scala_proto_register_toolchains", "scala_proto_repositories",)

scala_proto_repositories()

load("@annex_proto//:defs.bzl", annex_proto_pinned_maven_install = "pinned_maven_install")

annex_proto_pinned_maven_install()

scala_proto_register_toolchains()

# Load bazel skylib and google protobuf

bazel_skylib_tag = "1.0.2"

bazel_skylib_sha256 = "97e70364e9249702246c0e9444bccdc4b847bed1eb03c5a3ece4f83dfe6abc44"

http_archive(

    name = "bazel_skylib",

    sha256 = bazel_skylib_sha256,

    urls = [

        "https://mirror.bazel.build/github.com/bazelbuild/bazel-skylib/releases/download/{tag}/bazel-skylib-{tag}.tar.gz".format(tag = bazel_skylib_tag),

        "https://github.com/bazelbuild/bazel-skylib/releases/download/{tag}/bazel-skylib-{tag}.tar.gz".format(tag = bazel_skylib_tag),

    ],

)

protobuf_tag = "3.10.1"

protobuf_sha256 = "678d91d8a939a1ef9cb268e1f20c14cd55e40361dc397bb5881e4e1e532679b1"

http_archive(

    name = "com_google_protobuf",

    sha256 = protobuf_sha256,

    strip_prefix = "protobuf-{}".format(protobuf_tag),

    type = "zip",

    url = "https://github.com/protocolbuffers/protobuf/archive/v{}.zip".format(protobuf_tag),

)

load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")

protobuf_deps()

# Specify the scala compiler we wish to use; in this case, we'll use the default one specified in rules_scala_annex

bind(

    name = "default_scala",

    actual = "@rules_scala_annex//src/main/scala:zinc_2_12_10",

)

```

BUILD

```python

load("@rules_scala_annex//rules:scala.bzl", "scala_library")

scala_library(

  name = "example",

  srcs = glob(["**/*.scala"])

)

```

## Further Documentation

See [contributing guidlines](CONTRIBUTING.md) for help on contributing to this project.

For all rules and attributes, see the [Stardoc](docs/stardoc).