ketraterm-completion/io.github.ketraterm.completion.api/TerminalGradleTask

TerminalGradleTask

data class TerminalGradleTask @JvmOverloads constructor(val path: String, val description: String = "", val projectDirectory: String? = null)

One imported Gradle task returned by a host completion loader.

path is the canonical Gradle task path, including its leading colon. Hosts may provide projectDirectory relative to the terminal working directory so the shared source can scope -p and --project-dir task completion without accessing the filesystem.

Throws

IllegalArgumentException

if path is not a canonical non-root Gradle task path or projectDirectory is present but blank.

Constructors

TerminalGradleTask

@JvmOverloads

constructor(path: String, description: String = "", projectDirectory: String? = null)

Properties

description

val description: String

optional task documentation from the imported Gradle model.

path

val path: String

canonical Gradle task path, such as :app:run.

projectDirectory

val projectDirectory: String?

optional normalized project directory relative to the terminal working directory; the root project is represented by ..