automation-co / husky Goto Github PK

View Code? Open in Web Editor NEW

155.0 0.0 9.0 100 KB

git hooks made easy

Home Page: https://docs.automations.company/docs/husky/documentation

License: GNU Affero General Public License v3.0

Go 99.72% Shell 0.28%

hooks git git-hooks husky golang go

husky's Introduction

Husky

Make githooks easy!

Inspired from the husky.js

Docs

Installation

go install github.com/automation-co/husky@latest

Getting Started

You can initialise husky by $ husky init

Make sure you have git initialised

This will make the .husky folder with the hooks folder and a sample pre-commit hook

You can add hooks using

$ husky add <hook> "
  <your commands for that hook>
"

Example

$ husky add pre-commit "
  go build -v ./... 
  go test -v ./...
"

If you have made any other changes in the hooks you can apply them by using $ husky install

Blogs and Resources

Get Familiar with Git Hooks

Learn more about git hooks from these useful resources:

Other Alternatives

If you feel husky does not fulfill your needs you can also check out:

Developed by @automation-co

husky's People

Contributors

Stargazers

Forkers

vedhavyas hellosagar anikxt aarush-goyal grngxd robinsturmeit wizkaley nmalcolm saefullohmaslul

husky's Issues

Make the tool available as an aur package

Add issue templates

feat request
question
bug report

Make husky for golang projects

Add examples and use cases

[FEAT]install should config core.hooksPath, not copy to .git/hooks

Dir .git/hooks not managed by git, we should config the hooksPath

https://stackoverflow.com/questions/427207/can-git-hook-scripts-be-managed-along-with-the-repository

Describe the solution you'd like
git config core.hooksPath .husky/hooks

[FEAT] Implement unit tests

I want to learn unit tests in golang. Please assign this issue to me

[DOCS] Add a video tutorial explaining the working of husky

A video tutorial would help new developers to use husky.

[FEAT] Support yaml configuration for windows OS

Is your feature request related to a problem? Please describe.

Shell script only works with posix system, but the windows user will not be able to use this application outside cgywin app.

Describe the solution you'd like

Instead of having a shell script, have a yaml file with command as array

version: 2.0
hooks:
   pre-commit:
       - whoami

Now the install command will create the hooks in the .git/hooks based on shell, powershell or cmd prompt.

Describe alternatives you've considered

N/A

Additional context

N/A

Make a command for adding new hooks

[FEAT] Auto-update the hooks

Is your feature request related to a problem? Please describe.
Any time when any hook is updated I have to run the command husky install to update the hooks.

Describe the solution you'd like
Instead of loading the hook every time just execute the script by referencing.

[Question]. Integration with go-task ( https://github.com/go-task/task )

Explain your question here
go-task is pretty cool compared to mage and make.

i was thinking about how the the husky hooks can be integrated with go-tasks.

here is a project that uses a task files extensively: https://github.com/yomorun/yomo

https://github.com/yomorun/yomo/blob/master/Taskfile.yml is the root shows some standard ci related things.

https://github.com/yomorun/yomo/blob/master/example/1-pipeline/Taskfile.yml shows how many processes and pipelines can be kicked off. you don't need to open multiple terminals. It manages the supervisions .

SO perhaps there is merit in using go task and husky together, so that you can manage the git hooks from the go task file.