Enable type resolution for Detekt behind the enable_type_resolution attr

Author: ryanulep

MODULE.bazel

@@ -11,6 +11,7 @@ detekt = use_extension("//detekt:extensions.bzl", "detekt")
 use_repo(detekt, "detekt_cli_all")
 
 bazel_dep(name = "rules_java", version = "9.0.3")
+bazel_dep(name = "rules_android", version = "0.7.1")
 bazel_dep(name = "rules_proto", version = "7.1.0")
 bazel_dep(name = "rules_jvm_external", version = "6.9")
 bazel_dep(name = "bazel_worker_api", version = "0.0.10")
@@ -22,7 +23,7 @@ maven.install(
     name = "rules_detekt_dependencies",
     artifacts = [
         "junit:junit:4.13.2",
-        "io.gitlab.arturbosch.detekt:detekt-formatting:1.23.1",
+        "io.gitlab.arturbosch.detekt:detekt-formatting:1.23.8",
     ],
     fail_if_repin_required = True,
     lock_file = "//:maven_install.json",

README.md

@@ -9,7 +9,7 @@ for the [Bazel build system](https://bazel.build).
 - HTML, text, XML, Markdown, and SARIF reports;
 - [plugins](https://detekt.dev/docs/extensions/extensions/);
 - customizable Detekt version and JVM flags;
-- [persistent workers](https://blog.bazel.build/2015/12/10/java-workers.html) support;
+- [type resolution](https://detekt.dev/docs/gettingstarted/type-resolution/) with JVM and Android classpath support;
 - baseline generation via `detekt_create_baseline`;
 - configuration options via [attributes](docs/attrs.md).
 
@@ -127,15 +127,15 @@ and it supports standard Bazel test flags such as `--test_output=all`.
 
 ### `detekt` vs `detekt_test`
 
-|                     | `detekt`                  | `detekt_test`                          |
-| ------------------- | ------------------------- | -------------------------------------- |
-| Bazel rule type     | build rule                | test rule                              |
-| Run with            | `bazel build`             | `bazel test`                           |
-| Included in         | `bazel build //...`       | `bazel test //...`                     |
-| Violation behaviour | build action fails        | test fails; build action always passes |
-| Text report         | printed when action fails | printed to test output when test fails |
-| Result caching      | yes                       | yes                                    |
-| Bazel test flags    | n/a                       | yes (`--test_output`, etc.)            |
+|                     | `detekt`                  | `detekt_test`                                                         |
+| ------------------- | ------------------------- |-----------------------------------------------------------------------|
+| Bazel rule type     | build rule                | test rule                                                             |
+| Run with            | `bazel build`             | `bazel test`                                                          |
+| Included in         | `bazel build //...`       | `bazel test //...`                                                    |
+| Violation behavior  | build action fails        | test fails; build action always passes even if violations are present |
+| Text report         | printed when action fails | printed to test output when test fails                                |
+| Result caching      | yes                       | yes                                                                   |
+| Bazel test flags    | n/a                       | yes (`--test_output`, etc.)                                           |
 
 Use `detekt` when you want violations to block builds the same way a compiler error does. Use
 `detekt_test` when you want Detekt to run alongside your test suite and report results through
@@ -177,8 +177,9 @@ detekt_test(
 
 ### Configuration Options
 
-All three rules share the same configuration options. In addition to `srcs`, `cfgs`, `baseline`, `plugins`,
-and report options, most attributes correspond directly to
+All three rules share the same configuration options. In addition to `srcs`, `deps`, `cfgs`,
+`baseline`, `plugins`, `enable_type_resolution`, `is_android`, and report options, most attributes
+correspond directly to
 [Detekt CLI flags](https://detekt.dev/docs/1.23.8/gettingstarted/cli/#use-the-cli) and pass them
 through when explicitly set.
 
@@ -187,7 +188,7 @@ More information can be found in the [attributes](docs/attrs.md).
 ### Reports
 
 A plain-text report (`{name}_detekt_report.txt`) is **always** generated. Other report formats are
-available for opt-in via configuration options..
+available for opt-in via attributes.
 
 ## Advanced Configuration
 
@@ -207,7 +208,7 @@ detekt.detekt_version(
 use_repo(detekt, "detekt_cli_all")
 ```
 
-To download Detekt from a custom location (e.g. an internal mirror), use the `url_templates` parameter:
+To download Detekt from a custom location (e.g., an internal mirror), use the `url_templates` parameter:
 
 ```python
 detekt = use_extension("@rules_detekt//detekt:extensions.bzl", "detekt")
@@ -252,17 +253,27 @@ rules_detekt_dependencies(
 
 Each template may contain `{version}` which will be replaced with the version string.
 
-### JVM Flags
+### Toolchain
+
+The detekt toolchain controls JVM flags, the JVM bytecode target version, and the Kotlin language
+version compatibility. The defaults are:
+
+| Setting            | Default  |
+| ------------------ | -------- |
+| `jvm_flags`        | `-Xms16m -Xmx128m` |
+| `jvm_target`       | `1.8`    |
+| `language_version` | `2.0`    |
 
-The default toolchain uses `-Xms16m -Xmx128m`. To customize JVM flags, define your own toolchain
-in a `BUILD` file:
+To override any of these, define a custom toolchain in a `BUILD` file:
 
 ```python
 load("@rules_detekt//detekt:toolchain.bzl", "detekt_toolchain")
 
 detekt_toolchain(
     name = "my_detekt_toolchain_impl",
     jvm_flags = ["-Xms16m", "-Xmx512m"],
+    jvm_target = "11",
+    language_version = "1.9",
 )
 
 toolchain(
@@ -354,49 +365,45 @@ detekt_test(
 )
 ```
 
-### JVM Target
-
-Use `jvm_target` to set the JVM bytecode target version that matches what was used during compilation.
-This defaults to `1.8` if not explicitly set:
+### Type Resolution
 
-```python
-detekt_test(
-    name = "my_detekt",
-    srcs = glob(["src/main/kotlin/**/*.kt"]),
-    jvm_target = "11",
-)
-```
+Type resolution enables more advanced static analysis by giving Detekt access to the full
+compilation classpath — including return types, nullability, and symbol information. Rules
+requiring it are annotated with `@RequiresFullAnalysis` in Detekt's source.
 
-### Language Version
+Type resolution is **disabled by default** (`enable_type_resolution = False`), meaning only
+syntax-based rules are applied and no classpath is passed to Detekt.
 
-Detekt will report errors for any language features introduced after the specified version if
-`language_version` is specified. When unset, no compatibility restriction is applied:
+To enable type resolution, set `enable_type_resolution = True`. When enabled, the appropriate
+bootclasspath (JDK or Android SDK) is always included. To also include your project's library
+dependencies on the classpath, pass them via `deps`:
 
 ```python
+load("@rules_detekt//detekt:defs.bzl", "detekt_test")
+
 detekt_test(
     name = "my_detekt",
     srcs = glob(["src/main/kotlin/**/*.kt"]),
-    language_version = "2.0",
+    enable_type_resolution = True,
+    deps = [":my_library"],  # provides the classpath for type resolution
 )
 ```
 
-### Type Resolution
-
-Type resolution enables more advanced static analysis by giving Detekt access to the full compilation classpath,
-including return types, nullability, and symbol information — capabilities that match those of the Kotlin compiler
-itself. Rules requiring it are annotated with `@RequiresFullAnalysis` in Detekt's source.
-
-Use `jvm_target` and `language_version` to match the compilation settings of your project:
+For **Android targets**, set `is_android = True` to include the Android SDK jar in the classpath:
 
 ```python
 detekt_test(
     name = "my_detekt",
     srcs = glob(["src/main/kotlin/**/*.kt"]),
-    jvm_target = "11",
-    language_version = "2.0",
+    enable_type_resolution = True,
+    deps = [":my_android_library"],
+    is_android = True,
 )
 ```
 
+`jvm_target` and `language_version` are toolchain-level settings — see
+[Toolchain](#toolchain) for how to configure them.
+
 ### Reports
 
 By default, Detekt generates a text report internally (used for console output). To export reports as build outputs,

WORKSPACE.bazel

@@ -37,7 +37,7 @@ maven_install(
     name = "rules_detekt_dependencies",
     artifacts = [
         "junit:junit:4.13.2",
-        "io.gitlab.arturbosch.detekt:detekt-formatting:1.23.1",
+        "io.gitlab.arturbosch.detekt:detekt-formatting:1.23.8",
     ],
     fail_if_repin_required = True,
     maven_install_json = "//:maven_install.json",
@@ -52,9 +52,9 @@ pinned_maven_install()
 
 ## Skylib
 
-skylib_version = "1.4.1"
+skylib_version = "1.8.2"
 
-skylib_sha = "b8a1527901774180afc798aeb28c4634bdccf19c4d98e7bdd1ce79d1fe9aaad7"
+skylib_sha = "6e78f0e57de26801f6f564fa7c4a48dc8b36873e416257a92bbb0937eeac8446"
 
 http_archive(
     name = "bazel_skylib",
@@ -70,9 +70,9 @@ bazel_skylib_workspace()
 
 ## Stardoc
 
-stardoc_version = "0.5.3"
+stardoc_version = "0.7.2"
 
-stardoc_sha = "3fd8fec4ddec3c670bd810904e2e33170bedfe12f90adf943508184be458c8bb"
+stardoc_sha = "0e1ed4a98f26e718776bd64d053d02bb34d98572ccd03d6ba355112a1205706b"
 
 http_archive(
     name = "io_bazel_stardoc",

WORKSPACE.bzlmod

@@ -0,0 +1,3 @@
+# This file intentionally left empty.
+# It tells Bazel not to process WORKSPACE.bazel when this repo is loaded
+# as an http_archive in a project using Bzlmod (MODULE.bazel).