2
0
Fork 0
mirror of https://github.com/bazel-contrib/bazel-lib synced 2024-11-28 21:33:48 +00:00
Common useful functions for writing BUILD files and Starlark macros/rules
Find a file
2022-06-16 12:06:35 -07:00
.bazelci fix: fix yq windows issues by bumping version 2022-05-31 11:07:14 -07:00
.github/workflows chore: create a pull request against our bcr fork on successful release 2022-06-16 12:06:35 -07:00
docs feat: add allow_overwrites attribute to copy_to_directory and disable overwrites as the default behavior on linux and macos (#153) 2022-06-14 10:52:40 -07:00
e2e fix: buildifier lint errors 2022-06-02 18:15:24 -07:00
lib fix: fix a bug where two copy_to_bin actions couldn't copy the same file 2022-06-16 11:49:09 -07:00
tools
.bazelignore feat: add to_output_relative_path 2022-06-13 12:55:22 -07:00
.bazelrc fix: fix a bug where write_source_files diff_test fails on windows when 2022-06-16 09:10:30 -07:00
.bazelversion
.gitattributes
.gitignore
.pre-commit-config.yaml
.prettierignore test: add test coverage for docs rules 2022-04-27 17:34:45 -07:00
BUILD.bazel fix: fix a bug where yq failed to build in the root package 2022-05-02 20:35:59 -07:00
CONTRIBUTING.md
internal_deps.bzl chore(deps): update dependency io_bazel_rules_go to v0.33.0 2022-06-10 17:45:32 -07:00
LICENSE
MODULE.bazel fix: buildifier lint errors 2022-06-02 18:15:24 -07:00
README.md add bzlmod usage instructions (#129) 2022-06-06 11:19:37 -07:00
renovate.json chore(deps): add renovate.json (#135) 2022-06-10 12:49:41 -07:00
WORKSPACE feat: add to_output_relative_path 2022-06-13 12:55:22 -07:00

Aspect's Bazel helpers library

Base Starlark libraries and basic Bazel rules which are useful for constructing rulesets and BUILD files.

This module depends on bazel-skylib. In theory all these utilities could be upstreamed to bazel-skylib, but the declared scope of that project is narrow and it's very difficult to get anyone's attention to review PRs there.

bazel-lib is just a part of what Aspect provides:

Installation

Installation instructions are included on each release: https://github.com/aspect-build/bazel-lib/releases

Public API

Copying files

  • copy_directory Copies directories to another package.
  • copy_file Copies files to another package.
  • copy_to_bin Copies a source file to output tree at the same workspace-relative path.
  • copy_to_directory Copies and arranges files and directories into a new directory.
  • write_source_files Write to one or more files or folders in the source tree. Stamp out tests that ensure the sources exist and are up to date.

Transforming files

  • jq A toolchain and custom rule for running jq, a tool that is "like sed for json".
  • yq A toolchain and custom rule for running yq, a "YAML, JSON and XML processor".

Manipulating paths

  • directory_path Provide a label to reference some path within a directory, via DirectoryPathInfo.
  • output_files Forwards a subset of the files (via the DefaultInfo provider) from a given target's DefaultInfo or OutputGroupInfo.

Writing rules

  • expand_make_vars Perform make variable and location substitions in strings and templates.
  • paths Useful path resolution methods.
  • transitions Transition sources to a provided platform.
  • utils Various utils for labels and globs.
  • params_file Generate encoded params file from a list of arguments.
  • repo_utils Useful methods for repository rule implementations.
  • run_binary Like skylib's run_binary but adds directory output support.

Generating documentation

  • docs Rules for generating docs and stamping tests to ensure they are up to date.