aalekh-gradle/com.aalekh.aalekh.gradle.task/AalekhReportTask

AalekhReportTask

@DisableCachingByDefault(because = "HTML reports should always reflect the current project state; the task also opens a browser window")

abstract class AalekhReportTask : DefaultTask(source)

Generates the interactive HTML dependency report.

The report is a single self-contained HTML file with D3.js embedded - no server, no CDN, no internet connection required at render time. It opens automatically in the default browser after generation (disable with openBrowserAfterReport.set(false) for CI environments).

Run: ./gradlew aalekhReport Output: <projectRoot>/build/reports/aalekh/index.html

When exportMetrics is true, also writes aalekh-metrics.csv alongside the HTML file.

Constructors

AalekhReportTask

constructor()

Properties

actions

open var actions: List<Action<in Task?>?>?

ant

open val ant: AntBuilder?

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

dependsOn

open val dependsOn: Set<Any?>?

description

open var description: @Nullable String?

destroyables

open val destroyables: TaskDestroyables?

didWork

open var didWork: Boolean

enabled

open var enabled: Boolean

exportMetrics

@get:Input

abstract val exportMetrics: Property<Boolean>

When true, writes aalekh-metrics.csv alongside the HTML report.

extensions

open val extensions: ExtensionContainer?

featureAllowedPairs

@get:Input

abstract val featureAllowedPairs: ListProperty<String>

featurePattern

@get:Input

abstract val featurePattern: Property<String>

finalizedBy

open val finalizedBy: TaskDependency?

forbidEntries

@get:Input

abstract val forbidEntries: ListProperty<String>

Serialized forbid { } predicate rules; mirrors AalekhCheckTask.forbidEntries.

graphJsonFile

@get:InputFile

@get:PathSensitive(value = PathSensitivity.NONE)

abstract val graphJsonFile: RegularFileProperty

group

open var group: @Nullable String?

identityPath

open val identityPath: Path?

impliesSubProjects

open var impliesSubProjects: Boolean

inputs

open val inputs: TaskInputsInternal?

isCompatibleWithConfigurationCache

open val isCompatibleWithConfigurationCache: Boolean

isEnabled

@get:Internal

open var isEnabled: Boolean

isHasCustomActions

open val isHasCustomActions: Boolean

layerEntries

@get:Input

abstract val layerEntries: ListProperty<String>

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal?

localState

open val localState: TaskLocalState?

logger

open val logger: Logger?

logging

open val logging: LoggingManager?

mustRunAfter

open val mustRunAfter: TaskDependency?

name

open val name: String?

onlyIf

open val onlyIf: Spec<in TaskInternal?>?

openBrowser

@get:Input

abstract val openBrowser: Property<Boolean>

outputFile

@get:OutputFile

abstract val outputFile: RegularFileProperty

outputs

open val outputs: TaskOutputsInternal?

path

open val path: String?

project

open val project: Project?

projectName

@get:Input

abstract val projectName: Property<String>

reachabilityEntries

@get:Input

abstract val reachabilityEntries: ListProperty<String>

Serialized reachability rules; mirrors AalekhCheckTask.reachabilityEntries.

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String?>?

reasonsNotToTrackState

open val reasonsNotToTrackState: Set<String?>?

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String?>?

requiredServices

open val requiredServices: TaskRequiredServices?

ruleEntries

@get:Input

abstract val ruleEntries: ListProperty<String>

sharedResources

open val sharedResources: List<ResourceLock?>?

shouldRunAfter

open val shouldRunAfter: TaskDependency?

sourceSetEntries

@get:Input

abstract val sourceSetEntries: ListProperty<String>

Serialized per-source-set rules; mirrors AalekhCheckTask.sourceSetEntries.

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture?

state

open val state: TaskStateInternal?

taskActions

open val taskActions: List<InputChangesAwareTaskAction?>?

taskDependencies

open val taskDependencies: TaskDependencyInternal?

taskIdentity

open val taskIdentity: TaskIdentity<*>?

teamEntries

@get:Input

abstract val teamEntries: Property<String>

Serialized team-ownership map from the teams { } DSL block. Format: "team=pat1,pat2;team2=pat3" (from TeamOwnershipConfig.toInputString). Empty string means no teams are declared and the ownership overlay stays off.

temporaryDir

open val temporaryDir: File?

temporaryDirFactory

open val temporaryDirFactory: Factory<File?>?

timeout

open val timeout: Property<Duration?>?

trendFile

@get:Internal

abstract val trendFile: RegularFileProperty

Path to the rolling trend history JSON file (build/aalekh/trend.json). Marked @Internal so it is not a CC input/output - the file is written as a side-effect and failure to read/write it is always non-fatal.