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

Add a CreateAvailRoot to be created in the rootsDirectory.

includeAvailLibDependency

fun includeAvailLibDependency(name: String, dependency: String)

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

includeStdAvailLibDependency

fun includeStdAvailLibDependency(configure: AvailStandardLibrary.() -> Unit)

This function informs the plugin to include the Avail Standard Library as a root from a Maven repository.

projectRoot

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

Add an Avail root with the provided name and URI.

rootJar

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

Add an Avail root with the provided name and URI.

Properties

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.

printableConfig

val printableConfig: String

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

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.