@spec disable(
  String.t(),
  keyword()
) :: {:ok, String.t()} | {:error, :not_found | :invalid_hook | term()}

Removes the executable bit from a hook (chmod -x).

Options

• :config - a Git.Config struct (default: Git.Config.new())

Returns {:ok, path} or {:error, :not_found}. Returns {:error, :invalid_hook} if the hook name is not valid.

@spec enable(
  String.t(),
  keyword()
) :: {:ok, String.t()} | {:error, :not_found | :invalid_hook | term()}

Makes a hook executable (chmod +x).

Options

• :config - a Git.Config struct (default: Git.Config.new())

Returns {:ok, path} or {:error, :not_found}. Returns {:error, :invalid_hook} if the hook name is not valid.

@spec enabled?(
  String.t(),
  keyword()
) :: {:ok, boolean()} | {:error, :invalid_hook | term()}

Checks whether a hook file exists and is executable.

Options

• :config - a Git.Config struct (default: Git.Config.new())

Returns {:ok, boolean()}. Returns {:error, :invalid_hook} if the hook name is not valid.

@spec exists?(
  String.t(),
  keyword()
) :: {:ok, boolean()} | {:error, :invalid_hook | term()}

Checks whether a hook file exists.

Options

• :config - a Git.Config struct (default: Git.Config.new())

Returns {:ok, boolean()}. Returns {:error, :invalid_hook} if the hook name is not valid.

@spec list(keyword()) ::
  {:ok, [%{name: String.t(), enabled: boolean(), path: String.t()}]}
  | {:error, term()}

Lists installed hooks in the repository.

Returns a list of maps with :name, :enabled, and :path keys. A hook is considered enabled if it has the executable bit set. Only files matching valid hook names are included (.sample files are skipped).

Options

• :config - a Git.Config struct (default: Git.Config.new())

Examples

{:ok, hooks} = Git.Hooks.list()
# => [%{name: "pre-commit", enabled: true, path: "/repo/.git/hooks/pre-commit"}]

@spec read(
  String.t(),
  keyword()
) :: {:ok, String.t()} | {:error, :not_found | :invalid_hook | term()}

Reads the content of a hook file.

Options

• :config - a Git.Config struct (default: Git.Config.new())

Returns {:ok, content} or {:error, :not_found}. Returns {:error, :invalid_hook} if the hook name is not valid.

@spec remove(
  String.t(),
  keyword()
) :: :ok | {:error, :not_found | :invalid_hook | term()}

Deletes a hook file.

Options

• :config - a Git.Config struct (default: Git.Config.new())

Returns :ok or {:error, :not_found}. Returns {:error, :invalid_hook} if the hook name is not valid.

@spec valid_hooks() :: [String.t()]

Returns the list of valid git hook names.

@spec write(String.t(), String.t(), keyword()) ::
  {:ok, String.t()} | {:error, :invalid_hook | term()}

Writes a hook file.

By default the file is made executable. Pass executable: false to skip setting the executable bit.

Options

• :config - a Git.Config struct (default: Git.Config.new())
• :executable - whether to chmod +x the file (default: true)

Returns {:ok, path} or {:error, reason}. Returns {:error, :invalid_hook} if the hook name is not valid.