https://github.com/ipfans/pre-commit-hooks
A set hooks for pre-commit manager (https://pre-commit.com/)
https://github.com/ipfans/pre-commit-hooks
Last synced: over 1 year ago
JSON representation
A set hooks for pre-commit manager (https://pre-commit.com/)
- Host: GitHub
- URL: https://github.com/ipfans/pre-commit-hooks
- Owner: ipfans
- License: mit
- Created: 2021-03-19T02:07:36.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-02T09:25:55.000Z (over 4 years ago)
- Last Synced: 2025-01-31T10:11:25.883Z (over 1 year ago)
- Language: Shell
- Size: 23.4 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pre-commit-hooks
`pre-commit-hooks` is self-managed repo for [pre-commit](https://pre-commit.com).
## Requirement
* Python 3
* pre-commit
### Dependencies (Optional with hooks)
```
go install mvdan.cc/gofumpt@latest # required by `go-fumpt`
go install golang.org/x/tools/cmd/goimports@latest # required by `go-imports`
go install github.com/fzipp/gocyclo/cmd/gocyclo@latest # required by `go-cyclo`
go install github.com/go-critic/go-critic/cmd/gocritic@latest # required by `go-critic`
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest # required by `golangci-lint`
```
## Usage
### Setup
Write `.pre-commit-config.yaml`:
```yaml
repos:
- repo: https://github.com/ipfans/pre-commit-hooks
rev: v0.3.0
hooks:
- id: go-fumpt
- id: go-imports
- id: go-vet
- id: go-cyclo
args: [-over=15]
- id: golangci-lint
- id: go-critic
- id: go-unit-tests
- id: go-build
- id: go-generate
- id: go-mod-tidy
- id: commit-msg-checker
```
### installation
```
pre-commit install
pre-commit install --hook-type commit-msg # Optional
```