Method InstallHook

git/git.go:215–241

InstallHook installs the prepare-commit-msg hook if it doesn't already exist. It retrieves the hooks directory path, checks if the hook file exists, and writes the hook file with executable permissions.

(ctx context.Context)

// InstallHook installs the prepare-commit-msg hook if it doesn't already exist.
// It retrieves the hooks directory path, checks if the hook file exists, and writes the hook file with executable permissions.
func (c *Command) InstallHook(ctx context.Context) error {
	hookPath, err := c.hookPath(ctx).Output()
	if err != nil {
		return err
	}

	target := path.Join(strings.TrimSpace(string(hookPath)), HookPrepareCommitMessageTemplate)
	if exists, err := file.IsFile(target); err != nil {
		if !os.IsNotExist(err) {
			return err
		}
	} else if exists {
		return errors.New("hook file prepare-commit-msg exist")
	}

	content, err := util.GetTemplateByBytes(HookPrepareCommitMessageTemplate, nil)
	if err != nil {
		return err
	}

	// Write the hook file with executable permissions (0o755)
	return os.WriteFile(
		target,
		content,
		0o755,
	) //nolint:gosec // hook file needs executable permissions
}

// UninstallHook removes the prepare-commit-msg hook if it exists.
// It retrieves the hooks directory path, checks if the hook file exists, and removes the hook file.