GitHooks

Installs git hooks that will run in Elixir project.

Table of Contents

• Installation
  • Backup
  • Automatic
  • Manual
• Configuration
• Execution
  • Automatic
  • Manual

Installation

Add to dependencies:

def deps do
  [{:git_hooks, "~> 0.1.0"}]
end

The install the dependencies:

mix deps.get

Backup current hooks

This project will backup your current git hooks files copying the files and adding the extension .pre_git_hooks_backup.

Automatic installation

This library will install automatically the configured git hooks in your file.

Manual installation

You can install manually the configured git hooks by running:

mix git_hooks.install

Configuration

One or more git hooks can be configured, those git hooks will be the ones installed for your project.

Currently there are supported two configuration options:

• mix_tasks: A list of the mix tasks that will run for the git hook
• verbose: The output of the mix tasks will be visible. This can be configured globally or per git hook.

config :git_hooks,
  verbose: true,
  git_hooks: [
    pre_commit: [
      mix_tasks: [
        "format"
      ]
    ],
    pre_push: [
      verbose: false,
      mix_tasks: [
        "dialyzer",
        "test"
      ]
    ]
  ]

Execution

Automatic execution

The git hooks will run automatically for each git step.

Manual execution

You can run manually any configured git hook as well.

For example, to run the pre_commit configuration:

mix git_hooks.run pre_commit