commit | d999d80b27c722d263edf90444376eca7c6eee1d | [log] [tgz] |
---|---|---|
author | Chris Parsons <cparsons@rodete-desktop-imager.corp.google.com> | Fri Jul 27 11:00:52 2018 -0400 |
committer | Chris Parsons <cparsons@rodete-desktop-imager.corp.google.com> | Fri Jul 27 11:00:52 2018 -0400 |
tree | 6c10882a25e90f21ad7bf44df633720a774d46c2 | |
parent | 6301f974f02350fe973d8631cf1bb87ab8d2a2bd [diff] |
initial checkin of skydoc skylark rule
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. The top-level file lib.bzl
acts as an index from which the other modules can be imported.
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) from lib.bzl
and access the symbols by dotting into those structs:
load("@bazel_skylib//:lib.bzl", "paths", "shell") p = paths.basename("foo.bar") s = shell.quote(p)
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 a line to lib.bzl
to make the new module accessible from the index:
load("@bazel_skylib//lib:things.bzl", "things")
Clients can then use the module by loading it from lib.bzl
:
load("@bazel_skylib//:lib.bzl", "things") things.manipulate()
Add unit tests for your module in the tests
directory.
skylark_library
The skylark_library.bzl
rule can be used to aggregate a set of Skylark files and its dependencies for use in test targets and documentation generation.