Google Git
Sign in
pigweed / third_party / github / aspect-build / bazel-lib / f242667058d52aa5c2dc67304f0c51e224591675
commitf242667058d52aa5c2dc67304f0c51e224591675[log] [tgz]
authorAlex Eagle <alex@aspect.dev>Fri Oct 21 15:49:25 2022 -0700
committerAlex Eagle <alex@aspect.dev>Fri Oct 21 15:54:13 2022 -0700
tree32a53a6ec5521669731ed05b0901a92f9817ed21
parent1ec71cdcb5b52889f48290108137a99284d21c96 [diff]
chore: declare bzlmod repository

This is needed to match what's in the upstream BCR now
1 file changed
tree: 32a53a6ec5521669731ed05b0901a92f9817ed21
  1. .aspect/
  2. .bcr/
  3. .circleci/
  4. .github/
  5. docs/
  6. e2e/
  7. lib/
  8. platforms/
  9. shlib/
  10. tools/
  11. .bazelignore
  12. .bazelrc
  13. .bazelversion
  14. .gitattributes
  15. .gitignore
  16. .pre-commit-config.yaml
  17. .prettierignore
  18. BUILD.bazel
  19. CONTRIBUTING.md
  20. internal_deps.bzl
  21. LICENSE
  22. MODULE.bazel
  23. README.md
  24. renovate.json
  25. WORKSPACE
README.md

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.
  • stamping Support version stamping in custom rules.

Generating documentation

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