avail-plugin/avail.plugin/AvailExtension

AvailExtension

open class AvailExtension(project: Project, plugin: AvailPlugin)

AvailExtension is a Gradle extension for the AvailPlugin which is where a user can configure Avail.

Author

Richard Arriaga

Constructors

AvailExtension

constructor(project: Project, plugin: AvailPlugin)

Properties

availVersion

var availVersion: String

The version of the Avail VM used when launching Anvil.

buildPlan

val buildPlan: AvailArtifactBuildPlan

Create an AvailArtifactBuildPlan from the packageAvailArtifact.

moduleHeaderCommentBody

var moduleHeaderCommentBody: String

Raw module header comment. This is typically for a copyright. Will be wrapped in comment along with file name. If comment body is empty (default), will only provide the file name in the header comment.

moduleHeaderCommentBodyFile

var moduleHeaderCommentBodyFile: String

The absolute path to a file containing the text for the moduleHeaderCommentBody. This will be ignored if moduleHeaderCommentBodyFile is not empty.

name

var name: String

The name of the Avail project. Defaults to Project.getName.

projectDescription

var projectDescription: String

The description of the project that is included in the Avail artifact.

repositoryDirectory

var repositoryDirectory: AvailLocation

The AvailLocation directory where the Avail roots repositories exist.

rootsDirectory

var rootsDirectory: AvailLocation

The AvailLocation directory where the project's Avail roots exist, not imported libraries. By default, this is in AvailProject.ROOTS_DIR at the top level of the project.

targetOutputJar

val targetOutputJar: String

The absolute path to the jar file that will be created.

Functions

artifact

fun artifact(configure: PackageAvailArtifact.() -> Unit)

Configures the PackageAvailArtifact which is used to create the Avail artifact.

createArtifact

fun createArtifact()

Create the Avail Artifact configured by artifact.

createProject

fun createProject(): AvailProject

Create a new AvailProject.

createProjectRoot

fun createProjectRoot(name: String, availModuleExtensions: MutableList<String> = mutableListOf("avail"), entryPoints: MutableList<String> = mutableListOf(), description: String = ""): CreateAvailRoot

Add a CreateAvailRoot to be created in the rootsDirectory.

includeAvailLibDependency

fun includeAvailLibDependency(rootName: String, rootNameInJar: String, dependency: String)

Add an Avail library as a root from a Maven repository for the provided dependency string.

printableConfig

fun printableConfig(libMetadata: List<AvailArtifactMetadata>): String

Create a printable view of this entire AvailExtension's current configuration state.

projectRoot

fun projectRoot(name: String, availModuleExtensions: MutableList<String> = mutableListOf("avail"), entryPoints: MutableList<String> = mutableListOf(), description: String = "", initializer: (AvailRoot) -> Unit = {})

Add an Avail root with the provided name and URI.

rootJar

fun rootJar(name: String, jarFileName: String, availModuleExtensions: MutableList<String> = mutableListOf("avail"), entryPoints: MutableList<String> = mutableListOf(), description: String = "", initializer: (AvailRoot) -> Unit = {})

Add an Avail root with the provided name and URI.