Packages
PreCommitHook provides hook in ".git/hooks/pre-commit" which helps you to build elixir project with these checks: * code must compile * code must pass basic linting (.credo.exs will be copied if it doesn't exist) * code must pass test * code must pass docs generation * code must pass format check
Current section
Files
Jump to
Current section
Files
pre_commit_hook
README.md
README.md
# PreCommitHook
**TODO: Add description**
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `pre_commit_hook` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:pre_commit_hook, "~> 0.1.0"}]
end
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/pre_commit_hook](https://hexdocs.pm/pre_commit_hook).