Package com.diffplug.spotless

Class GitPrePushHookInstaller

java.lang.Object

com.diffplug.spotless.GitPrePushHookInstaller

Direct Known Subclasses:

GitPrePushHookInstallerGradle, GitPrePushHookInstallerMaven

public abstract class GitPrePushHookInstaller
extends Object

Abstract class responsible for installing a Git pre-push hook in a repository. This class ensures that specific checks and logic are run before a push operation in Git. Subclasses should define specific behavior for hook installation by implementing the required abstract methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GitPrePushHookInstaller.Executor
static interface	GitPrePushHookInstaller.GitPreHookLogger

Field Summary

Fields

Modifier and Type	Field	Description
protected final GitPrePushHookInstaller.GitPreHookLogger	logger	Logger for recording informational and error messages during the installation process.
protected final File	root	The root directory of the Git repository where the hook will be installed.

Constructor Summary

Constructors

Constructor	Description
GitPrePushHookInstaller(GitPrePushHookInstaller.GitPreHookLogger logger, File root)	Constructor to initialize the GitPrePushHookInstaller with a logger and repository root path.

Method Summary

Modifier and Type	Method	Description
void	install()	Installs the Git pre-push hook into the repository.
protected abstract String	preHookContent()	Provides the content of the hook that should be inserted into the pre-push script.
protected String	preHookTemplate(GitPrePushHookInstaller.Executor executor, String commandCheck, String commandApply)	Generates a pre-push template script that defines the commands to check and apply changes using an executor and Spotless.

Methods inherited from class java.lang.Object

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

Field Details

logger

protected final GitPrePushHookInstaller.GitPreHookLogger logger

Logger for recording informational and error messages during the installation process.

root

protected final File root

The root directory of the Git repository where the hook will be installed.

Constructor Details

GitPrePushHookInstaller

public GitPrePushHookInstaller(GitPrePushHookInstaller.GitPreHookLogger logger,
 File root)

Constructor to initialize the GitPrePushHookInstaller with a logger and repository root path.

Parameters:

logger - The logger for recording messages.

root - The root directory of the Git repository.

Method Details

install

public void install()
             throws Exception

Installs the Git pre-push hook into the repository.

This method checks for the following:

• Ensures Git is installed and the `.git/config` file exists.
• Checks if an executor required by the hook is available.
• Creates and writes the pre-push hook file if it does not exist.
• Skips installation if the hook is already installed.

If an issue occurs during installation, error messages are logged.

Throws:

Exception - if any error occurs during installation.

preHookContent

protected abstract String preHookContent()

Provides the content of the hook that should be inserted into the pre-push script.

Returns:

A string representing the content to include in the pre-push script.

preHookTemplate

protected String preHookTemplate(GitPrePushHookInstaller.Executor executor,
 String commandCheck,
 String commandApply)

Generates a pre-push template script that defines the commands to check and apply changes using an executor and Spotless.

Parameters:

executor - The tool to execute the check and apply commands.

commandCheck - The command to check for issues.

commandApply - The command to apply corrections.

Returns:

A string template representing the Spotless Git pre-push hook content.