Export helpers from rules_lint

makes writing aspects for internal tooling easier

CMK-26168

Change-Id: Ifce499f62af9f99f32f30f100055a3ce931962a9

Author: Synss

MODULE.bazel

@@ -121,6 +121,8 @@ single_version_override(
         # https://github.com/aspect-build/rules_lint/pull/747
         "//bazel/patches:rules_lint-no_copy.patch",
         "//bazel/patches:rules_lint-clippy_fail_on_violation.patch",
+        # For astrein and other internal tooling.
+        "//bazel/patches:rules_lint_export_helpers.patch",
     ],
     version = "2.0.0",
 )

bazel/patches/rules_lint_export_helpers.patch

@@ -0,0 +1,17 @@
+diff --git a/lint/defs.bzl b/lint/defs.bzl
+new file mode 100644
+index 0000000..5ec52f8
+--- /dev/null
++++ b/lint/defs.bzl
+@@ -0,0 +1,11 @@
++"""Make helpers available to internal tooling."""
++
++load("//lint/private:lint_aspect.bzl", _filter_srcs = "filter_srcs")
++load("//lint/private:lint_aspect.bzl", _noop_lint_action = "noop_lint_action")
++load("//lint/private:lint_aspect.bzl", _output_files = "output_files")
++load("//lint/private:lint_aspect.bzl", _should_visit = "should_visit")
++
++filter_srcs = _filter_srcs
++noop_lint_action = _noop_lint_action
++output_files = _output_files
++should_visit = _should_visit

bazel/tools/lint_astrein.bzl

@@ -1,115 +1,11 @@
 """Astrein linter aspect for aspect_rules_lint framework"""
 
-_MNEMONIC = "AspectRulesLintAstrein"
-
-# Taken from https://github.com/aspect-build/rules_lint/blob/main/lint/private/lint_aspect.bzl
-# to avoid imports from private modules
-def should_visit(rule, allow_kinds, allow_filegroup_tags = []):
-    """Determine whether a rule is meant to be visited by a linter aspect
-
-    A target with the "no-lint" tag will not be visited.
+load("@aspect_rules_lint//lint:defs.bzl", "filter_srcs", "noop_lint_action", "output_files", "should_visit")
 
-    Args:
-        rule: a [rules_attributes](https://bazel.build/rules/lib/builtins/rule_attributes.html) object
-        allow_kinds (list of string): return true if the rule's kind is in the list
-        allow_filegroup_tags (list of string): return true if the rule is a filegroup and has a tag in this list
-
-    Returns:
-        whether to apply the aspect on this rule
-    """
-    if "no-lint" in rule.attr.tags:
-        return False
-
-    if rule.kind in allow_kinds:
-        return True
-    if rule.kind == "filegroup":
-        for allow_tag in allow_filegroup_tags:
-            if allow_tag in rule.attr.tags:
-                return True
-    return False
-
-# Taken from https://github.com/aspect-build/rules_lint/blob/main/lint/private/lint_aspect.bzl
-# to avoid imports from private modules
-def filter_srcs(rule):
-    if "lint-genfiles" in rule.attr.tags:
-        return rule.files.srcs
-    else:
-        return [s for s in rule.files.srcs if s.is_source and s.owner.workspace_name == ""]
+_MNEMONIC = "AspectRulesLintAstrein"
 
 OUTFILE_FORMAT = "{label}.{mnemonic}.{suffix}"
 
-# Taken from https://github.com/aspect-build/rules_lint/blob/main/lint/private/lint_aspect.bzl
-# to avoid imports from private modules
-def output_files(mnemonic, target, ctx):
-    """Declare linter output files.
-
-    Args:
-        mnemonic: used as part of the filename
-        target: the target being visited by a linter aspect
-        ctx: the aspect context
-
-    Returns:
-        tuple of struct() of output files, and the OutputGroupInfo provider that the rule should return
-    """
-    human_out = ctx.actions.declare_file(OUTFILE_FORMAT.format(label = target.label.name, mnemonic = mnemonic, suffix = "out"))
-
-    # NB: named ".report" as there are existing callers depending on that
-    machine_out = ctx.actions.declare_file(OUTFILE_FORMAT.format(label = target.label.name, mnemonic = mnemonic, suffix = "report"))
-
-    # The exit codes should instead be provided as action outputs so the build succeeds.
-    # Downstream tooling like `aspect lint` will be responsible for reading the exit codes
-    # and interpreting them.
-    human_exit_code = ctx.actions.declare_file(OUTFILE_FORMAT.format(label = target.label.name, mnemonic = mnemonic, suffix = "out.exit_code"))
-    machine_exit_code = ctx.actions.declare_file(OUTFILE_FORMAT.format(label = target.label.name, mnemonic = mnemonic, suffix = "report.exit_code"))
-
-    human_outputs = [f for f in [human_out, human_exit_code] if f]
-    machine_outputs = [f for f in [machine_out, machine_exit_code] if f]
-    return struct(
-        human = struct(
-            out = human_out,
-            exit_code = human_exit_code,
-        ),
-        machine = struct(
-            out = machine_out,
-            exit_code = machine_exit_code,
-        ),
-    ), OutputGroupInfo(
-        rules_lint_human = depset(human_outputs),
-        rules_lint_machine = depset(machine_outputs),
-        # Legacy name used by existing callers.
-        # TODO(2.0): remove
-        rules_lint_report = depset(machine_outputs),
-        # Always cause the action to execute, even if the output isn't requested
-        _validation = depset([human_out]),
-    )
-
-# Inspired by https://github.com/aspect-build/rules_lint/blob/main/lint/private/lint_aspect.bzl
-def noop_lint_action(ctx, outputs):
-    """Generates an action that creates empty outputs when no files need linting.
-
-    Args:
-        ctx: Bazel context
-        outputs: Output files struct
-    """
-    ctx.actions.write(
-        output = outputs.human.out,
-        content = "",
-    )
-    if outputs.human.exit_code:
-        ctx.actions.write(
-            output = outputs.human.exit_code,
-            content = "0\n",
-        )
-    ctx.actions.write(
-        output = outputs.machine.out,
-        content = "",
-    )
-    if outputs.machine.exit_code:
-        ctx.actions.write(
-            output = outputs.machine.exit_code,
-            content = "0\n",
-        )
-
 def astrein_action(ctx, executable, srcs, stdout, exit_code, format, astrein_runfiles):
     """Run astrein linter on source files.