AtlasExtension

Main entry point for configuring the plugin from your Gradle script.

Properties

Link copied to clipboard
abstract val alsoTraverseUpwards: Property<Boolean>

Set to true if you want module charts to also show modules that depend on the one in question. This will traverse the graph both directions and show all upstream and downstream modules. Defaults to false.

Link copied to clipboard
abstract val checkOutputs: Property<Boolean>

Set to true to attach a diffing task to gradle check. It will verify that your generated charts match the current state of the project layout, failing if not with a useful error message. Defaults to true.

Link copied to clipboard
abstract val displayLinkLabels: Property<Boolean>

Set to true to attach a string label on each module link, showing which configuration caused the link to be created. Defaults to false. When true, the LinkTypeSpec.name property will be shown.

Link copied to clipboard
abstract val generateOnSync: Property<Boolean>

When enabled, syncing your IntelliJ IDE (including Android Studio) will automatically trigger regeneration of your module diagrams. Defaults to false.

Link copied to clipboard
abstract val groupModules: Property<Boolean>

Set to true if you want module charts to gather together groups of modules into bordered containers. E.g. a graph with ":a", ":b" and ":c" won't be grouped at all because they don't share any path segments, but ":a:b" and "a:c" will be grouped together.

Link copied to clipboard
abstract val ignoredConfigs: SetProperty<String>

Use this to configure Gradle org.gradle.api.artifacts.Configurations to block from consideration when collating module diagrams. Defaults to "debug", "kover", "ksp", "test".

Link copied to clipboard
abstract val ignoredModules: SetProperty<Regex>

Use this to block modules from inclusion in your module charts, based on their path string. E.g. a module at ":path:to:my:module" will be ignored if I add ".*:to:my:.*".toRegex() to this property.

Link copied to clipboard

Configure the set of LinkTypeSpecs to use when identifying links between your modules.

Link copied to clipboard

Configure the set of ModuleTypeSpecs to use when identifying modules in your project.

Link copied to clipboard

Configures any string transformations to apply to module paths when displaying them in the generated charts.

Link copied to clipboard
abstract val printFilesToConsole: Property<Boolean>

Set to true to print the absolute path of any generated files to the Gradle console output. Defaults to false.

Functions

Link copied to clipboard
abstract fun pathTransforms(action: Action<PathTransformSpec>)