gradle-plugin/dev.zacsweers.metro.gradle.analysis/GenerateGraphHtmlTask

GenerateGraphHtmlTask

@CacheableTask

abstract class GenerateGraphHtmlTask : DefaultTask(source)

Generates interactive HTML visualizations of Metro dependency graphs using ECharts.

The generated HTML files are self-contained and can be opened directly in a browser. They use Apache ECharts for beautiful, interactive graph visualization with the following features:

Force-directed layout: Automatic node positioning with physics simulation
Interactive: Drag nodes, zoom, pan, hover tooltips
Search & filter: Find bindings by name, filter by type
Focus mode: Click a node to highlight its connections
Legend: Color-coded by binding kind with toggle visibility
Responsive: Adapts to window size
Beautiful defaults: Gradient backgrounds, smooth animations, professional styling

One HTML file is generated per dependency graph, plus an index page.

Constructors

GenerateGraphHtmlTask

constructor()

Properties

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

@get:InputFile

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val analysisFile: RegularFileProperty

Analysis report JSON file from AnalyzeGraphTask. Analysis metrics (fan-in/out, centrality, dominator count) are included in the visualization.

open val ant: AntBuilder

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

open val dependsOn: Set<Any>

open var description: @Nullable String?

open val destroyables: TaskDestroyables

open var didWork: Boolean

open var enabled: Boolean

open val extensions: ExtensionContainer

open val finalizedBy: TaskDependency

open var group: @Nullable String?

open val identityPath: Path

impliesSubProjects

open var impliesSubProjects: Boolean

@get:InputFile

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val inputFile: RegularFileProperty

The aggregated graph metadata JSON file to visualize.

open val inputs: TaskInputsInternal

isCompatibleWithConfigurationCache

open val isCompatibleWithConfigurationCache: Boolean

@get:Internal

open var isEnabled: Boolean

isHasCustomActions

open val isHasCustomActions: Boolean

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal

open val localState: TaskLocalState

open val logger: Logger

open val logging: LoggingManager

open val mustRunAfter: TaskDependency

open val name: String

open val onlyIf: Spec<in TaskInternal>

outputDirectory

@get:OutputDirectory

abstract val outputDirectory: DirectoryProperty

The output directory for HTML files (one per graph).

open val outputs: TaskOutputsInternal

open val path: String

open val project: Project

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String>

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String>

requiredServices

open val requiredServices: TaskRequiredServices

sharedResources

open val sharedResources: List<ResourceLock>

open val shouldRunAfter: TaskDependency

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture

open val state: TaskStateInternal

open val taskActions: List<InputChangesAwareTaskAction>

taskDependencies

open val taskDependencies: TaskDependencyInternal

open val taskIdentity: TaskIdentity<*>

open val temporaryDir: File

temporaryDirFactory

open val temporaryDirFactory: Factory<File>

open val timeout: Property<Duration>

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task>)

open operator fun compareTo(otherTask: Task): Int

open fun configure(closure: Closure<*>): Task

open fun dependsOn(vararg paths: Any): Task

open fun doFirst(action: Closure<*>): Task

open fun doFirst(action: Action<in Task>): Task

open fun doFirst(actionName: String, action: Action<in Task>): Task

open fun doLast(action: Closure<*>): Task

open fun doLast(action: Action<in Task>): Task

open fun doLast(actionName: String, action: Action<in Task>): Task

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String)

open fun finalizedBy(vararg paths: Any): Task

open fun hasProperty(propertyName: String): Boolean

open fun hasTaskActions(): Boolean

open fun mustRunAfter(vararg paths: Any): Task

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String)

open fun onlyIf(onlyIfClosure: Closure<*>)

open fun onlyIf(spec: Spec<in Task>)

open fun onlyIf(onlyIfReason: String, spec: Spec<in Task>)

prependParallelSafeAction

open fun prependParallelSafeAction(action: Action<in Task>)

open fun property(propertyName: String): Any

open fun setDependsOn(dependsOn: Iterable<*>)

open fun setFinalizedBy(finalizedByTasks: Iterable<*>)

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<*>)

open fun setOnlyIf(onlyIfClosure: Closure<*>)

open fun setOnlyIf(spec: Spec<in Task>)

open fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>)

open fun setProperty(name: String, value: Any)

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<*>)

open fun shouldRunAfter(vararg paths: Any): TaskDependency

open fun usesService(service: Provider<out BuildService<*>>)