mirror of
https://github.com/bazelbuild/bazel-skylib
synced 2024-11-30 10:41:18 +00:00
bc97abb33e
* Move Gazelle extension to //gazelle/bzl and change package name This fixes an issue with importing bazel-skylib into google3. Currently, Glaze (internal Go build file generator) attempts to generate a target (//gazelle:gazelle) that conflicts with one that's already declared here. I think the right solution is actually to move the package into a subdirectory. In the future (bazelbuild/bazel-gazelle#5), Gazelle's Go extension will generate target names similar to what Glaze does, so the same conflict will happen in open source. I think it's also logical to have a directory of packages in case more need to be added in the future, and for the extension to have a package name matching the language it works with. This is an incompatible change, but the //gazelle directory isn't part of a tagged release yet, so hopefully it won't break anyone. * fix runfiles access in test * Fix gazelle package names. Co-authored-by: Jay Conrod <jayconrod@google.com>
14 lines
551 B
Markdown
14 lines
551 B
Markdown
# Gazelle
|
|
|
|
Gazelle is a `BUILD` file generator for Bazel. This directory contains a
|
|
language extension for the Gazelle generator that allows it to automatically
|
|
parse valid `bzl_library` targets for all `.bzl` files in a repo in which it
|
|
runs. It will additionally include a `deps` entry tracking every `.bzl` that is
|
|
`load`ed into the primary file.
|
|
|
|
This can be used, for example, to generate
|
|
[`stardoc`](https://github.com/bazelbuild/stardoc) documentation for your
|
|
`.bzl` files, both simplify the task of and improve the quality of
|
|
documentation.
|
|
|