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

GitHooksExtension

open class GitHooksExtension(repoRoot: File) : Serializable

DSL entry point, to be applied to settings.gradle.kts.

Constructors

GitHooksExtension

constructor(repoRoot: File)

constructor(settings: Settings)

Properties

repoRoot

var repoRoot: File

The git repository root. If unset, it will be searched recursively from the project root towards the filesystem root.

Functions

commitMsg

fun commitMsg(configuration: CommitMsgScriptContext.() -> Unit)

Commit-msg hook.

createHooks

fun createHooks(overwriteExisting: Boolean = false)

To be called to force the hook creation in case of necessity. If passed true, overwrites in case the script is already present and different than expected.

hook

fun hook(hookName: String, configuration: ScriptContext.() -> Unit)

Defines a new hook with an arbitrary name.

preCommit

fun preCommit(configuration: ScriptContext.() -> Unit)

Pre-commit hook.