go-fish

command module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 21, 2021 License: MIT Imports: 7 Imported by: 0

README

go-fish

go-fish is a small tool for working with Git hooks in a project 🎣 . It is a port of Husky to Go.

go-fish is intended to be used with Go projects. However, it can theoretically be used for any project since it doesn't do anything that is specific to Go projects.

Installation

The recommended way to install go-fish is with shed.

shed install github.com/cszatmary/go-fish

Usage

Install hooks:

shed run go-fish install

This will create a .hooks folder in the root of your repository.

Adding a hook:

shed run go-fish create pre-commit

This will create a .hooks/pre-commit script. Edit this as desired to configure the hook.

Uninstall hooks:

shed run go-fish uninstall

How it works

go-fish uses the core.hooksPath config option of Git to set the hooks directory to .hooks. This allows Git hooks to be managed within the repository.

License

dot is available under the MIT License.

Contributing

Contributions are welcome. Feel free to open an issue or submit a pull request.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL