https://github.com/ahamez/pre-commit-elixir-hooks
Elixir hooks for pre-commit
https://github.com/ahamez/pre-commit-elixir-hooks
elixir git-hooks pre-commit-hooks
Last synced: 2 months ago
JSON representation
Elixir hooks for pre-commit
- Host: GitHub
- URL: https://github.com/ahamez/pre-commit-elixir-hooks
- Owner: ahamez
- License: mit
- Created: 2022-12-28T09:54:26.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-07T20:32:04.000Z (8 months ago)
- Last Synced: 2025-01-26T09:42:04.073Z (4 months ago)
- Topics: elixir, git-hooks, pre-commit-hooks
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pre-commit-elixir-hooks
Git hooks for Elixir using [pre-commit](https://pre-commit.com).
## Usage
First, make sure that `pre-commit` is installed and that `mix` is available in `PATH`.
Configure hooks as follows:
```yaml
repos:
- repo: https://github.com/ahamez/pre-commit-elixir-hooks.git
rev: v1.0.0
hooks:
- id: elixir-mix-format
- id: elixir-mix-credo
- id: elixir-mix-deps-check-unused
- id: elixir-mix-dialyzer
- id: elixir-mix-test
args: ["--exclude", "some_tag"]
```
Then, install hooks:
```sh
pre-commit install
```
## Usage with different stages
As some actions are slow to perform (like `mix dialyzer`), you can confine them to specific stages, like `pre-push`:
```yaml
repos:
- repo: https://github.com/ahamez/pre-commit-elixir-hooks.git
rev: v1.0.0
hooks:
- id: elixir-mix-format
stages: [commit]
- id: elixir-mix-credo
stages: [commit]
- id: elixir-mix-deps-check-unused
stages: [push]
- id: elixir-mix-dialyzer
stages: [push]
- id: elixir-mix-test
args: ["--exclude", "some_tag"]
stages: [push]
```
Then, install hooks:
```sh
pre-commit install && pre-commit install -t pre-push
```