GitHooks
Configure git hooks in your Elixir projects.
Main features are:
- Simplicity: Automatic or manually install the configured git hook actions.
- Flexibility: You choose what to use to define the git hooks actions:
- Bash commands
- Executable files
- Elixir modules
- No limits: Any git hook is and will be supported out of the box, you can check here the git hooks list available.
Table of Contents
Installation
Add to dependencies:
def deps do
[{:git_hooks, "~> 0.6.1", only: [:test, :dev], runtime: false}]
end
Then install and compile the dependencies:
mix deps.get && mix deps.compile
Backup current hooks
This library will backup automatically your current git hooks before overwriting them.
The backup files will have the file extension .pre_git_hooks_backup
.
Automatic installation
This library will install automatically the configured git hooks in your
config.exs
file.
See configuration to disable the automatic install.
Manual installation
You can manually install the configured git hooks at any time by running:
mix git_hooks.install
Configuration
One or more git hooks can be configured, those hooks will be the ones installed in your git project.
Currently there are supported two configuration options:
- tasks: A list of the commands that will be executed when running a git hook. See types of tasks for more info.
- verbose: If true, the output of the mix tasks will be visible. This can be configured globally or per git hook.
Disable auto install
To disable the automatic install of the git hooks set the configuration key auto_install
to
false
.
Example config
In config/config.exs
use Mix.Config
# somewhere in your config file
if Mix.env() != :prod do
config :git_hooks,
auto_install: true,
verbose: true,
hooks: [
pre_commit: [
tasks: [
{:cmd, "mix format --check-formatted"}
]
],
pre_push: [
verbose: false,
tasks: [
{:cmd, "mix dialyzer"},
{:cmd, "mix test --color"},
{:cmd, "echo 'success!'"}
]
]
]
end
Type of tasks
For more information, check the module documentation for each of the different supported tasks.
Mix task
This is the preferred option to run mix tasks, as it will provide the best execution feedback.
Just add in your config the mix tasks you want to run. You can also set the args to be used by the mix task:
config :git_hooks,
verbose: true,
hooks: [
commit_msg: [
tasks: [
{:mix_task, :test},
{:mix_task, :format, ["--dry-run"]}
]
]
]
Command
To run a simple command you can either declare a string or a tuple with the
command you want to run. For example, having "mix test"
and {:cmd, "mix test"}
in the hook tasks
will be equivalent.
If you want to forward the git hook arguments, add the option
include_hook_args: true
.
config :git_hooks,
verbose: true,
hooks: [
commit_msg: [
tasks: [
{:cmd, "echo 'test'"},
{:cmd, "elixir ./priv/test_task.ex", include_hook_args: true},
]
]
]
Executable file
The following configuration uses a script file to be run with a git hook. If you
want to forward the git hook arguments, add the option include_hook_args: true
.
config :git_hooks,
verbose: true,
hooks: [
commit_msg: [
tasks: [
{:file, "./priv/test_script"},
{:file, "./priv/test_script_with_args", include_hook_args: true},
]
]
]
The script file executed will receive the arguments from git, so you can use them as you please.
Elixir module
It is also possible to use Elixir modules to execute actions for a given git hook.
Just add in your config the
MFA ({module, function, arity}
) definition:
config :git_hooks,
verbose: true,
hooks: [
commit_msg: [
tasks: [
{MyModule, :execute, 2}
]
]
]
To check how many args you function should expect check the git documentation to know which parameters are being sent on each hook.
Removing a hook
When a git hook configuration is removed, the installed hook will automatically delete it.
Any backup done at the moment will still be kept.
Execution
Automatic execution
The configured mix tasks will run automatically for each git hook.
Manual execution
You can also run manually any configured git hook as well.
The following example will run the pre_commit configuration:
mix git_hooks.run pre_commit
It is also possible to run all the configured hooks:
mix git_hooks.run all