go-courier / husky

Husky

Husky.js like, but pure in golang

Usage

install

go install github.com/go-courier/husky/cmd/husky@latest

install git hooks

husky init

Configuration .husky.toml

.husky.yaml supported too.

# version-file which will write or read current semver
version-file = "internal/version/version"

# hook scripts
[hooks]

# after version calc,
# with use the {{ .Version }} to upgrade other files.
post-version = [
    "sed -i -e 's/\"version\": \"[^\"]*\"/\"version\": \"{{ .Version }}\"/g' testdata/package.json",
    "sed -i -e 's/version: [^\\n]*/version: {{ .Version }}/g' testdata/pubspec.yaml"
]

# git hook pre commit
pre-commit = [
    "golangci-lint run",
    "husky lint-staged",
]

# git hook commit msg
commit-msg = [
    "husky lint-commit",
]

# list staged files do some pre-process and git add
[lint-staged]
"*.go" = [
    "goimports -l -w",
    "gofmt -l -w",
]

# commit msg rule default support conventional commits
[lint-commit]
# could check if this exists
# email = "^([email protected]|[email protected])$"
# optional custom types check regex
# types = "^(feat|fix|build|chore|ci|docs|perf|refactor|revert|style|test)$"
# optional header check regex
# header = "^(?P<type>\w+)(\((?P<scope>[\w/.-]+)\))?(?P<breaking>!)?:( +)?(?P<header>.+)"

Commit msg rule follow https://www.conventionalcommits.org/en/v1.0.0/

type(scope?): header

body?

footer?

husky's Issues

How do I fail to commit

Add exit 1 to my yaml file in hook

hooks:
  pre-commit:
    - exit 1

But no effect
How do I fail to submit?

Husky init command does nothing.

Disregard. Mistake on my end.

Stack overflow error if the folder is not a git reository

Problem

Today, I installed husky and run husky init, but I forgot to run git init, so husky init was failed with the stack overflow error.

Request

As a developer, I want husky init to print a meaningful error message for the above situation instead of a stack trace.