commit | 930b3527b91213940f57289bb581a8b64d3c31ee | [log] [tgz] |
---|---|---|
author | Marc Plano-Lesay <marc.planolesay@gmail.com> | Tue Oct 29 23:42:47 2019 +1100 |
committer | c-parsons <cparsons@google.com> | Tue Oct 29 08:42:47 2019 -0400 |
tree | 72fcb4402be265cb367f10f0f167b1a692ea5a78 | |
parent | 734652aa5e1585646e90dfa19add0d57a954ce56 [diff] |
Remove links to maprules (#213) This pair of rules was removed in 58068fe0cc28d8d5e0115bf0e7d80189628f35db, and the docs removed in 084758ff75463750f6c2476348ed9442e7860275 - the links were forgotten.
Skylib is a standard library that provides functions useful for manipulating collections, file paths, and other features that are useful when writing custom build rules in Bazel.
This library is currently under early development. Be aware that the APIs in these modules may change during this time.
Each of the .bzl
files in the lib
directory defines a “module”—a struct
that contains a set of related functions and/or other symbols that can be loaded as a single unit, for convenience.
Skylib also provides build rules under the rules
directory.
WORKSPACE
fileSee the WORKSPACE setup section for the current release.
If you want to use lib/unittest.bzl
from Skylib versions released in or after December 2018, then you also should add to the WORKSPACE
file:
load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace") bazel_skylib_workspace()
BUILD
and *.bzl
filesThen, in the BUILD
and/or *.bzl
files in your own workspace, you can load the modules (listed below) and access the symbols by dotting into those structs:
load("@bazel_skylib//lib:paths.bzl", "paths") load("@bazel_skylib//lib:shell.bzl", "shell") p = paths.basename("foo.bar") s = shell.quote(p)
new_sets
Steps to add a module to Skylib:
Create a new .bzl
file in the lib
directory.
Write the functions or other symbols (such as constants) in that file, defining them privately (prefixed by an underscore).
Create the exported module struct, mapping the public names of the symbols to their implementations. For example, if your module was named things
and had a function named manipulate
, your things.bzl
file would look like this:
def _manipulate(): ... things = struct( manipulate=_manipulate, )
Add unit tests for your module in the tests
directory.
bzl_library
The bzl_library.bzl
rule can be used to aggregate a set of Starlark files and its dependencies for use in test targets and documentation generation.
If you try to use unittest
and you get the following error:
ERROR: While resolving toolchains for target //foo:bar: no matching toolchains found for types @bazel_skylib//toolchains:toolchain_type ERROR: Analysis of target '//foo:bar' failed; build aborted: no matching toolchains found for types @bazel_skylib//toolchains:toolchain_type
then you probably forgot to load and call bazel_skylib_workspace()
in your WORKSPACE
file.