From 0320f3ca104e5fb1a2efed81c43f864ff9034c2c Mon Sep 17 00:00:00 2001 From: Alex Eagle Date: Fri, 20 Oct 2023 17:32:56 -0700 Subject: [PATCH] chore: docgen --- cmd/aspect/root/BUILD.bazel | 2 +- cmd/aspect/root/root.go | 2 +- docs/aspect.md | 1 + docs/aspect_lint.md | 32 ++++++++++++++++++++++++++++++++ docs/bazelrc/correctness.bazelrc | 13 ------------- docs/command_list.bzl | 1 + 6 files changed, 36 insertions(+), 15 deletions(-) create mode 100755 docs/aspect_lint.md diff --git a/cmd/aspect/root/BUILD.bazel b/cmd/aspect/root/BUILD.bazel index 9904c56f4..22f1e553b 100644 --- a/cmd/aspect/root/BUILD.bazel +++ b/cmd/aspect/root/BUILD.bazel @@ -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", diff --git a/cmd/aspect/root/root.go b/cmd/aspect/root/root.go index ad67415dd..559e4d532 100644 --- a/cmd/aspect/root/root.go +++ b/cmd/aspect/root/root.go @@ -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" diff --git a/docs/aspect.md b/docs/aspect.md index 04f10a14e..a2cee2ae6 100644 --- a/docs/aspect.md +++ b/docs/aspect.md @@ -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 diff --git a/docs/aspect_lint.md b/docs/aspect_lint.md new file mode 100755 index 000000000..a1f096ebe --- /dev/null +++ b/docs/aspect_lint.md @@ -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 [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 + diff --git a/docs/bazelrc/correctness.bazelrc b/docs/bazelrc/correctness.bazelrc index a599f6d85..56fad5fd5 100644 --- a/docs/bazelrc/correctness.bazelrc +++ b/docs/bazelrc/correctness.bazelrc @@ -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 diff --git a/docs/command_list.bzl b/docs/command_list.bzl index 69af9def4..38d9d5c67 100644 --- a/docs/command_list.bzl +++ b/docs/command_list.bzl @@ -15,6 +15,7 @@ COMMAND_LIST = [ "info", "init", "license", + "lint", "outputs", "print", "query",