Add support for inhibiting clippy and rustfmt aspect actions (#3080)

Author: UebelAndre

docs/src/rust_prost.md

@@ -142,6 +142,25 @@ register_toolchains("//toolchains:prost_toolchain")
 ---
 ---
 
+<a id="rust_prost_library"></a>
+
+## rust_prost_library
+
+<pre>
+rust_prost_library(<a href="#rust_prost_library-name">name</a>, <a href="#rust_prost_library-proto">proto</a>)
+</pre>
+
+A rule for generating a Rust library using Prost.
+
+**ATTRIBUTES**
+
+
+| Name  | Description | Type | Mandatory | Default |
+| :------------- | :------------- | :------------- | :------------- | :------------- |
+| <a id="rust_prost_library-name"></a>name |  A unique name for this target.   | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required |  |
+| <a id="rust_prost_library-proto"></a>proto |  A `proto_library` target for which to generate Rust gencode.   | <a href="https://bazel.build/concepts/labels">Label</a> | required |  |
+
+
 <a id="rust_prost_toolchain"></a>
 
 ## rust_prost_toolchain
@@ -173,22 +192,3 @@ Rust Prost toolchain rule.
 | <a id="rust_prost_toolchain-tonic_runtime"></a>tonic_runtime |  The Tonic runtime crates to use.   | <a href="https://bazel.build/concepts/labels">Label</a> | optional |  `None`  |
 
 
-<a id="rust_prost_library"></a>
-
-## rust_prost_library
-
-<pre>
-rust_prost_library(<a href="#rust_prost_library-name">name</a>, <a href="#rust_prost_library-kwargs">kwargs</a>)
-</pre>
-
-A rule for generating a Rust library using Prost.
-
-**PARAMETERS**
-
-
-| Name  | Description | Default Value |
-| :------------- | :------------- | :------------- |
-| <a id="rust_prost_library-name"></a>name |  The name of the target.   |  none |
-| <a id="rust_prost_library-kwargs"></a>kwargs |  Additional keyword arguments for the underlying `rust_prost_library` rule.   |  none |
-
-

extensions/prost/defs.bzl

@@ -147,27 +147,5 @@ load(
     _rust_prost_toolchain = "rust_prost_toolchain",
 )
 
-def rust_prost_library(name, **kwargs):
-    """A rule for generating a Rust library using Prost.
-
-    Args:
-        name (str): The name of the target.
-        **kwargs (dict): Additional keyword arguments for the underlying
-            `rust_prost_library` rule.
-    """
-
-    # Clippy and Rustfmt will attempt to run on these targets.
-    # This is not correct and likely a bug in target detection.
-    tags = kwargs.pop("tags", [])
-    if "no-clippy" not in tags:
-        tags.append("no-clippy")
-    if "no-rustfmt" not in tags:
-        tags.append("no-rustfmt")
-
-    _rust_prost_library(
-        name = name,
-        tags = tags,
-        **kwargs
-    )
-
+rust_prost_library = _rust_prost_library
 rust_prost_toolchain = _rust_prost_toolchain

extensions/prost/private/prost.bzl

@@ -275,6 +275,13 @@ def _rust_prost_aspect_impl(target, ctx):
         build_info = dep_variant_info.build_info,
     ))
 
+    # Avoid running clippy or rustfmt on these targets the outputs
+    # are all generated sources with no guarantee to be compliant.
+    inhibit_output_groups = {
+        "clippy_checks": depset(),
+        "rustfmt_checks": depset(),
+    }
+
     return [
         ProstProtoInfo(
             dep_variant_info = dep_variant_info,
@@ -285,6 +292,7 @@ def _rust_prost_aspect_impl(target, ctx):
         OutputGroupInfo(
             rust_generated_srcs = [lib_rs],
             proto_descriptor_set = [proto_info.direct_descriptor_set],
+            **inhibit_output_groups
         ),
     ]
 

rust/private/clippy.bzl

@@ -77,6 +77,7 @@ def _get_clippy_ready_crate_info(target, aspect_ctx = None):
         ignore_tags = [
             "no_clippy",
             "no_lint",
+            "nolint",
             "noclippy",
         ]
         for tag in aspect_ctx.rule.attr.tags:
@@ -92,6 +93,12 @@ def _get_clippy_ready_crate_info(target, aspect_ctx = None):
         return None
 
 def _clippy_aspect_impl(target, ctx):
+    # Exit early if a target already has a clippy output group. This
+    # can be useful for rules which always want to inhibit clippy.
+    if OutputGroupInfo in target:
+        if hasattr(target[OutputGroupInfo], "clippy_checks"):
+            return []
+
     crate_info = _get_clippy_ready_crate_info(target, ctx)
     if not crate_info:
         return [ClippyInfo(output = depset([]))]

rust/private/rustfmt.bzl

@@ -98,6 +98,12 @@ def _perform_check(edition, srcs, ctx):
     return marker
 
 def _rustfmt_aspect_impl(target, ctx):
+    # Exit early if a target already has a rustfmt output group. This
+    # can be useful for rules which always want to inhibit rustfmt.
+    if OutputGroupInfo in target:
+        if hasattr(target[OutputGroupInfo], "rustfmt_checks"):
+            return []
+
     crate_info = _get_rustfmt_ready_crate_info(target)
 
     if not crate_info: