Skip to content

Commit c4f22e0

Browse files
committed
chore: docs update after copybara
1 parent 35f2cab commit c4f22e0

File tree

2 files changed

+20
-3
lines changed

2 files changed

+20
-3
lines changed

docs/aspect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Aspect CLI is a better frontend for running bazel
2424
* [aspect build](aspect_build.md) - Build the specified targets
2525
* [aspect canonicalize-flags](aspect_canonicalize-flags.md) - Present a list of bazel options in a canonical form
2626
* [aspect clean](aspect_clean.md) - Remove the output tree
27-
* [aspect configure](aspect_configure.md) - Update BUILD files for JavaScript, TypeScript, Go and Protobuf
27+
* [aspect configure](aspect_configure.md) - Auto-configure Bazel by updating BUILD files
2828
* [aspect coverage](aspect_coverage.md) - Same as 'test', but also generates a code coverage report.
2929
* [aspect cquery](aspect_cquery.md) - Query the dependency graph, honoring configuration flags
3030
* [aspect docs](aspect_docs.md) - Open documentation in the browser

docs/aspect_configure.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,28 @@ sidebar_label: "configure"
33
---
44
## aspect configure
55

6-
Update BUILD files for JavaScript, TypeScript, Go and Protobuf
6+
Auto-configure Bazel by updating BUILD files
77

88
### Synopsis
99

10-
Generates and updates BUILD files from sources for JavaScript, TypeScript, Go and Protobuf.
10+
configure generates and updates BUILD files from source code.
11+
12+
It is named after the "make configure" workflow which is typical in C++ projects, using
13+
[autoconf](https://www.gnu.org/software/autoconf/).
14+
15+
configure is non-destructive: hand-edits to BUILD files are generally preserved.
16+
You can use a `#keep` directive to force the tool to leave existing BUILD contents alone.
17+
Run 'aspect help directives' for more documentation on directives.
18+
19+
So far these languages are supported:
20+
- Go and Protocol Buffers, thanks to code from [gazelle]
21+
- JavaScript (including TypeScript)
22+
23+
configure is based on [gazelle]. We are very grateful to the authors of that software.
24+
The advantage of configure in Aspect CLI is that you don't need to compile the tooling before running it.
25+
26+
[gazelle]: https://github.com/bazelbuild/bazel-gazelle
27+
1128

1229
```
1330
aspect configure [flags]

0 commit comments

Comments
 (0)