Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/swellaby/captain-githook

git hook utility for Go codebases
https://github.com/swellaby/captain-githook

git git-hooks githook githooks-plugin go golang hook-manager hooks

Last synced: about 2 months ago
JSON representation

git hook utility for Go codebases

Awesome Lists containing this project

README 

        
# captain-githook 

Cross-platform, configurable, git hook utility geared for Go codebases.  



****** Functional, but still in Beta ****** 



[![Linux CI Badge][linux-ci-badge]][linux-ci-url]

[![Mac CI Badge][mac-ci-badge]][mac-ci-url]

[![Windows CI Badge][windows-ci-badge]][windows-ci-url]  



[![Test Results Badge][tests-badge]][sonar-tests-url]

[![Coverage Badge][coverage-badge]][coverage-url]

[![Sonar Quality Gate Badge][sonar-quality-gate-badge]][sonar-url]  



## Contents

* [About](#about)

* [Installation](#installation)

* [Getting Started](#getting-started)

* [Configure](#configure)

    * [Supported Git Hooks][supported-hooks-section]

    * [Allowed Config File Names][config-file-names-section]

* [Remove](#remove)



## About

Git hooks are scripts/commands that git can execute on certain events which helps you automate tasks, enforce quality and consistency in your code, and more. `captain-githook` allows you to utilize any and all git hooks in your repository (`commit-msg`, `pre-commit`, `pre-push`, etc.) via a simple configuration file. 



Yes, there are other git hook utilities out there (in fact we love, recommend, and use [husky][husky-url] in our JavaScript/TypeScript projects that use [npm][npm-url]). However, we made `captain-githook` because we wanted a git hook utility for our Go codebases that was cross-platform, easily configurable, and that wasn't *dependent* on another, non-Go framework/runtime.



## Installation

We'll be adding binary releases shortly, but for now you'll need to have your [Go][go-download-url] environment setup and use `go get` i.e.:



```sh

go get -u github.com/swellaby/captain-githook

```



Note that the latest `captain-githook` version requires Go 1.12 or higher. If you need to use `captain-githook` on Go 1.11 and earlier, make sure you use the `v0.0.7` tag:



```sh

go get -u github.com/swellaby/[email protected]

```



This will ensure that the captain-githook executable is available on your system for initializing your repositories (creating git hook and config files) as well as for executing your defined hook scripts.



## Getting Started

Run the `init` sub-command within a git repository to create the git hook files and create the `captain-githook` config file:



```sh

captain-githook init

```



If you'd prefer to use a different name for the config file, you can specify your desired config file name as a flag (`--config-filename` or `--f`) on the `init` command. For example:



```sh

captain-githook init --config-filename .captain-githookrc.json

```



See [allowed config file names][config-file-names-section] below for info on what config file names you can use.



## Configure

You specify which scripts/commands you want to run for each git hook in the `captain-githook` configuration file included in your repository.



The captain-githook config is a json formatted file (we'll consider supporting other formats like yaml or toml if there's enough interest) and must be named with one of the [allowed file names][config-file-names-section].  



Just ensure there's a `hooks` object key, and then for every git hook you want to run, add a key with the hook name (see [supported hooks][supported-hooks-section] for allowed hook names) and the script/command you want to run.



```json

// captaingithook.json

{

    "hooks": {

        "pre-commit": "golint ./...",

        "pre-push": "go test ./..."

    }

}

```



### Supported Hooks

`captain-githook` supports all the below git hooks:



- `applypatch-msg`

- `pre-applypatch`

- `post-applypatch`

- `pre-commit`

- `prepare-commit-msg`

- `commit-msg`

- `post-commit`

- `pre-rebase`

- `post-checkout`

- `post-merge`

- `pre-receive`

- `update`

- `post-receive`

- `post-update`

- `pre-auto-gc`

- `post-rewrite`

- `pre-push`



### Config File Names

There are several supported names you can use for your config file:



- `captaingithook.json`

- `.captaingithook.json`

- `captaingithookrc`

- `.captaingithookrc`

- `captaingithookrc.json`

- `.captaingithookrc.json`

- `captain-githook.json`

- `.captain-githook.json`

- `captain-githookrc`

- `.captain-githookrc`

- `captain-githookrc.json`

- `.captain-githookrc.json`



## Remove

Not yet implemented




  



[Back to top][top-section]



[githooks-docs-url]: https://git-scm.com/docs/githooks

[go-download-url]: https://golang.org/dl/

[husky-url]: https://www.npmjs.com/package/husky

[npm-url]: https://www.npmjs.com/get-npm

[config-file-names-section]: #config-file-names

[supported-hooks-section]: #supported-hooks

[top-section]: #captain-githook

[linux-ci-badge]: https://img.shields.io/azure-devops/build/swellaby/opensource/123/master.svg?label=linux%20build&style=flat-square

[linux-ci-url]: https://dev.azure.com/swellaby/OpenSource/_build/latest?definitionId=123

[mac-ci-badge]: https://img.shields.io/azure-devops/build/swellaby/opensource/124/master.svg?label=mac%20build&style=flat-square

[mac-ci-url]: https://dev.azure.com/swellaby/OpenSource/_build/latest?definitionId=124

[windows-ci-badge]: https://img.shields.io/azure-devops/build/swellaby/opensource/125/master.svg?label=windows%20build&style=flat-square

[windows-ci-url]: https://dev.azure.com/swellaby/OpenSource/_build/latest?definitionId=125

[coverage-badge]: https://img.shields.io/azure-devops/coverage/swellaby/opensource/123/master.svg?style=flat-square

[coverage-url]: https://codecov.io/gh/swellaby/captain-githook

[tests-badge]: https://img.shields.io/azure-devops/tests/swellaby/opensource/123/master.svg?label=unit%20tests&style=flat-square

[sonar-quality-gate-badge]: https://img.shields.io/sonar/quality_gate/swellaby:captain-githook?server=https%3A%2F%2Fsonarcloud.io&style=flat-square

[sonar-url]: https://sonarcloud.io/dashboard?id=swellaby%3Acaptain-githook

[sonar-tests-url]: https://sonarcloud.io/component_measures?id=swellaby%3Acaptain-githook&metric=tests