| # 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](https://github.com/bazelbuild/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: |
| |
| - _Need help?_ This ruleset has support provided by https://aspect.dev. |
| - See our other Bazel rules: https://github.com/aspect-build |
| |
| ## Installation |
| |
| Installation instructions are included on each release: |
| <https://github.com/aspect-build/bazel-lib/releases> |
| |
| # Public API |
| |
| ## Copying files |
| |
| - [copy_directory](docs/copy_directory.md) Copies directories to another package. |
| - [copy_file](docs/copy_file.md) Copies files to another package. |
| - [copy_to_bin](docs/copy_to_bin.md) Copies a source file to output tree at the same workspace-relative path. |
| - [copy_to_directory](docs/copy_to_directory.md) Copies and arranges files and directories into a new directory. |
| - [write_source_files](docs/write_source_files.md) 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](docs/jq.md) A toolchain and custom rule for running [jq](https://stedolan.github.io/jq/), a tool that is "like sed for json". |
| - [yq](docs/yq.md) A toolchain and custom rule for running [yq](https://github.com/mikefarah/yq), a "YAML, JSON and XML processor". |
| |
| ## Manipulating paths |
| |
| - [directory_path](docs/directory_path.md) Provide a label to reference some path within a directory, via DirectoryPathInfo. |
| - [output_files](docs/output_files.md) Forwards a subset of the files (via the DefaultInfo provider) from a given target's DefaultInfo or OutputGroupInfo. |
| |
| ## Writing rules |
| |
| - [expand_make_vars](docs/expand_make_vars.md) Perform make variable and location substitions in strings and templates. |
| - [paths](docs/paths.md) Useful path resolution methods. |
| - [transitions](docs/transitions.md) Transition sources to a provided platform. |
| - [utils](docs/utils.md) Various utils for labels and globs. |
| - [params_file](docs/params_file.md) Generate encoded params file from a list of arguments. |
| - [repo_utils](docs/repo_utils.md) Useful methods for repository rule implementations. |
| - [run_binary](docs/run_binary.md) Like skylib's run_binary but adds directory output support. |
| - [stamping](docs/stamping.md) Support version stamping in custom rules. |
| |
| ## Generating documentation |
| |
| - [docs](docs/docs.md) Rules for generating docs and stamping tests to ensure they are up to date. |
