gradle-pre-commit-git-hooks/org.danilopianini.gradle.git.hooks/CommitMsgScriptContext

CommitMsgScriptContext

class CommitMsgScriptContext : CommonScriptContext

Specialized hook context for commit-msg.

Constructors

constructor()

Properties

name

open override val name: String

Hook name.

script

override var script: String

Script content. To be fetched only when the configuration is complete.

Functions

appendScript

open override fun appendScript(script: () -> String)

Appends the result of the provided function to the existing script.

conventionalCommits

fun conventionalCommits(configuration: ConventionalCommitsContext.() -> Unit = { defaultTypes() })

Pre-configures the commit-msg script to check for a valid conventional commit message.

from

override fun from(shebang: String? = "#!/usr/bin/env bash", script: () -> String)

Generates a script with either the provided shebang or with a shebang invoking bash, and with the result of the provided function.

open fun from(file: File)

Generates a script from the provided file.

open fun from(url: URL)

open fun from(url: String)

Generates a script from the provided url.

tasks

override fun tasks(first: Any, vararg others: Any, requireSuccess: Boolean = true)

open fun tasks(name: String, vararg otherNames: String, requireSuccess: Boolean = true)

open fun tasks(task: Task, vararg otherTasks: Task, requireSuccess: Boolean = true)

open fun tasks(task: TaskProvider<*>, vararg otherTasks: TaskProvider<*>, requireSuccess: Boolean = true)

Adds the provided tasks to the script, by invoking ./gradlew <taskname>. By default, a failure of the task implies a failure of the commit. To run a task without considering the failure critical, pass [requireSuccess] = false.