:atlas-core/atlas.core

Package-level declarations

Types

AtlasDsl

@DslMarker

annotation class AtlasDsl

DSL for the Atlas Gradle plugins.

AtlasExtension

interface AtlasExtension

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

AtlasPlugin

abstract class AtlasPlugin : Plugin<Project>

Base plugin, implemented by the framework modules. This plugin will be applied to the root module by the user, then it will auto-apply itself to all child subprojects internally.

AtlasSpec

interface AtlasSpec

Base interface for a framework-specific configuration.

IntEnum

interface IntEnum

InternalAtlasApi

annotation class InternalAtlasApi

LinkStyle

interface LinkStyle : StringEnum

LinkType

@Serializable

data class LinkType(val configuration: String, val style: String? = null, val color: String? = null, val displayName: String = configuration, val properties: Map<String, String> = emptyMap()) : Serializable

LinkTypeSpec

interface LinkTypeSpec : PropertiesSpec

ModuleType

@Serializable

data class ModuleType(val name: String, val color: String?, val properties: Map<String, String> = emptyMap()) : Serializable

ModuleTypeSpec

interface ModuleTypeSpec : PropertiesSpec

NamedLinkTypeContainer

interface NamedLinkTypeContainer<T : LinkTypeSpec> : NamedDomainObjectContainer<T>

Used to configure expected link "types" between your modules. The majority of the time, these are only ever going to be NamedLinkTypeContainer.api or NamedLinkTypeContainer.implementation, hence those being listed for easier access. Configure like:

NamedModuleTypeContainer

interface NamedModuleTypeContainer<T : ModuleTypeSpec> : NamedDomainObjectContainer<T>

Represents a category of module that you can use to match against those in your project. You can use some of the built-in example types like below:

PathTransformSpec

interface PathTransformSpec

API for modifying module names when inserting them into any generated diagrams. For example if your modules are within a heavily-nested "modules" directory in your project's root, you might want to call something like:

PropertiesSpec

interface PropertiesSpec

Used to configure custom properties into a Map. This will be implemented by a few other more specific interfaces depending on the use case, but you will have the ability to call put to manually add custom properties to the map. This might be useful if a new release of the chart framework adds a property before this plugin gets updated to support it.

Replacement

@Serializable

class Replacement(val pattern: Regex, val replacement: String) : Serializable

Model class for a PathTransformSpec.

StringEnum

interface StringEnum