commit | f83cb8dd6f5658bc574ccd873e25197055265d1c | [log] [tgz] |
---|---|---|
author | Chris Parsons <cparsons@google.com> | Mon Nov 26 18:03:22 2018 -0500 |
committer | Chris Parsons <cparsons@google.com> | Mon Nov 26 18:03:22 2018 -0500 |
tree | d665e2f876117eebe087812bc3e7c4969810279e | |
parent | 810059ca0f0cd4a12908386329c651d52db6dfcc [diff] |
appended new line to Args section
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.
Add the following to your WORKSPACE
file to import the Skylib repository into your workspace. Replace the version number in the tag
attribute with the version you wish to depend on:
git_repository( name = "bazel_skylib", remote = "https://github.com/bazelbuild/bazel-skylib.git", tag = "0.1.0", # change this to use a different release )
Then, 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.