Package-level declarations

Types

Link copied to clipboard
interface AtlasGenerationTask : Task
Link copied to clipboard
@CacheableTask
abstract class CheckFileDiff : DefaultTask

Registered on each chart file generation task to confirm that its configuration hasn't changed since the last gradle atlasGenerate task run. Will throw an exception if a difference is found.

Link copied to clipboard
@CacheableTask
abstract class CollateModuleLinks : DefaultTask, TaskWithOutputFile

Registered on the root project to aggregate the results of WriteModuleLinks tasks. This will then be referenced from WriteModuleTree to draw up the full project picture. This will then be sub-charted for each module in turn.

Link copied to clipboard
@CacheableTask
abstract class CollateModuleTypes : DefaultTask, TaskWithOutputFile

Registered on the root project to aggregate the results of WriteModuleType tasks. This will then be referenced from the various Write*Chart tasks to identify and customize nodes in the chart.

Link copied to clipboard
interface TaskWithOutputFile : Task
Link copied to clipboard
@CacheableTask
abstract class WriteModuleLinks : DefaultTask, TaskWithOutputFile

Dumps all atlas.core.internal.ModuleLinks between this and any other modules to a file.

Link copied to clipboard
@CacheableTask
abstract class WriteModuleTree : DefaultTask, TaskWithOutputFile

Gathers a snapshot of the whole-project collatedLinks data to only find those modules and links relevant to thisPath. If alsoTraverseUpwards is enabled, upstream modules will be included too.

Link copied to clipboard
@CacheableTask
abstract class WriteModuleType : DefaultTask, TaskWithOutputFile

Dumps the ModuleTypeSpec of this module to a file. This will then by aggregated in CollateModuleTypes.

Link copied to clipboard
@CacheableTask
abstract class WriteReadme : DefaultTask, AtlasGenerationTask, TaskWithOutputFile

Creates or updates a README.md file to inject the generated chart/legend files. If the readme contains a block like below: