Skip to content

Commit

Permalink
chore: docgen
Browse files Browse the repository at this point in the history
  • Loading branch information
alexeagle committed Oct 21, 2023
1 parent e1b9ff2 commit 0320f3c
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 15 deletions.
2 changes: 1 addition & 1 deletion cmd/aspect/root/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ go_library(
"//cmd/aspect/sync",
"//cmd/aspect/test",
"//cmd/aspect/version",
"//docs/help/topics",
"//pkg/aspect/root/flags",
"//pkg/ioutils",
"//pkg/plugin/system",
"//docs/cli/help",
"@com_github_fatih_color//:color",
"@com_github_mattn_go_isatty//:go-isatty",
"@com_github_spf13_cobra//:cobra",
Expand Down
2 changes: 1 addition & 1 deletion cmd/aspect/root/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ import (
"aspect.build/cli/cmd/aspect/sync"
"aspect.build/cli/cmd/aspect/test"
"aspect.build/cli/cmd/aspect/version"
help_docs "aspect.build/cli/docs/help"
help_docs "aspect.build/cli/docs/help/topics"
"aspect.build/cli/pkg/aspect/root/flags"
"aspect.build/cli/pkg/ioutils"
"aspect.build/cli/pkg/plugin/system"
Expand Down
1 change: 1 addition & 0 deletions docs/aspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Aspect CLI is a better frontend for running bazel
* [aspect info](aspect_info.md) - Display runtime info about the bazel server
* [aspect init](aspect_init.md) - Create a new Bazel workspace
* [aspect license](aspect_license.md) - Prints the license of this software.
* [aspect lint](aspect_lint.md) - Run configured linters over the dependency graph.
* [aspect outputs](aspect_outputs.md) - Print paths to declared output files
* [aspect print](aspect_print.md) - Print syntax elements from BUILD files
* [aspect query](aspect_query.md) - Query the dependency graph, ignoring configuration flags
Expand Down
32 changes: 32 additions & 0 deletions docs/aspect_lint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
sidebar_label: "lint"
---
## aspect lint

Run configured linters over the dependency graph.

### Synopsis

Run linters and collect the reports they produce. See documentation on https://github.com/aspect-build/rules_lint

```
aspect lint <target patterns> [flags]
```

### Options

```
-h, --help help for lint
```

### Options inherited from parent commands

```
--aspect:config string User-specified Aspect CLI config file. /dev/null indicates that all further --aspect:config flags will be ignored.
--aspect:interactive Interactive mode (e.g. prompts for user input)
```

### SEE ALSO

* [aspect](aspect.md) - Aspect CLI

13 changes: 0 additions & 13 deletions docs/bazelrc/correctness.bazelrc
Original file line number Diff line number Diff line change
Expand Up @@ -60,16 +60,3 @@ query --experimental_allow_tags_propagation
# https://github.com/bazelbuild/bazel/issues/10076.
# Docs: https://bazel.build/reference/command-line-reference#flag--incompatible_default_to_explicit_init_py
build --incompatible_default_to_explicit_init_py

# Set default value of `allow_empty` to `False` in `glob()`. This prevents a common mistake when
# attempting to use `glob()` to match files in a subdirectory that is opaque to the current package
# because it contains a BUILD file. See https://github.com/bazelbuild/bazel/issues/8195.
# Docs: https://bazel.build/reference/command-line-reference#flag--incompatible_disallow_empty_glob
common --incompatible_disallow_empty_glob

# Always download coverage files for tests from the remote cache. By default, coverage files are not
# downloaded on test result cahce hits when --remote_download_minimal is enabled, making it impossible
# to generate a full coverage report.
# Docs: https://bazel.build/reference/command-line-reference#flag--experimental_fetch_all_coverage_outputs
# detching remote cache results
test --experimental_fetch_all_coverage_outputs
1 change: 1 addition & 0 deletions docs/command_list.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ COMMAND_LIST = [
"info",
"init",
"license",
"lint",
"outputs",
"print",
"query",
Expand Down

0 comments on commit 0320f3c

Please sign in to comment.