Package com.diffplug.gradle.spotless

Class SpotlessInstallPrePushHookTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

com.diffplug.gradle.spotless.SpotlessInstallPrePushHookTask

All Implemented Interfaces:

Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, Named, ExtensionAware, Task, org.gradle.util.Configurable<Task>

@DisableCachingByDefault(because="not worth caching")
public abstract class SpotlessInstallPrePushHookTask
extends DefaultTask

A Gradle task responsible for installing a Git pre-push hook for the Spotless plugin. This hook ensures that Spotless formatting rules are automatically checked and applied before performing a Git push operation.

The task leverages GitPrePushHookInstallerGradle to implement the installation process.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Named

Named.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor	Description
SpotlessInstallPrePushHookTask()

Method Summary

Modifier and Type	Method	Description
protected abstract ExecOperations	getExecOperations()
void	performAction()	Installs the Spotless pre-push hook for a supported Git repository.

Methods inherited from class org.gradle.api.DefaultTask

compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Methods inherited from class org.gradle.api.internal.AbstractTask

acceptServiceReferences, appendParallelSafeAction, doNotTrackState, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getLoggingManager, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, setImpliesSubProjects

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gradle.api.Task

doNotTrackState, notCompatibleWithConfigurationCache

Constructor Details

SpotlessInstallPrePushHookTask

public SpotlessInstallPrePushHookTask()

Method Details

getExecOperations

@Inject
protected abstract ExecOperations getExecOperations()

performAction

public void performAction()
                   throws Exception

Installs the Spotless pre-push hook for a supported Git repository.

The task runs only for the root project. It asks Git to resolve the effective hook path, validates the destination, and delegates the actual installation to GitPrePushHookInstallerGradle. Unsupported repositories or destinations are logged and skipped.

Throws:

Exception - if resolving the hook path or installing the hook fails