https://github.com/eberkund/foreplay

A pre-commit hook manager.
https://github.com/eberkund/foreplay

git go

Last synced: 5 months ago
JSON representation

A pre-commit hook manager.

• Host: GitHub
• URL: https://github.com/eberkund/foreplay
• Owner: eberkund
• License: apache-2.0
• Created: 2020-04-28T04:25:24.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-09-23T06:19:53.000Z (almost 6 years ago)
• Last Synced: 2024-06-20T05:20:32.395Z (about 2 years ago)
• Topics: git, go
• Language: Go
• Homepage:
• Size: 115 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Foreplay

![CI](https://github.com/eberkund/foreplay/workflows/CI/badge.svg)

[![codecov](https://codecov.io/gh/eberkund/foreplay/branch/master/graph/badge.svg)](https://codecov.io/gh/eberkund/foreplay)

[![Go Report Card](https://goreportcard.com/badge/github.com/eberkund/foreplay)](https://goreportcard.com/report/github.com/eberkund/foreplay)

![GitHub](https://img.shields.io/github/license/eberkund/foreplay)

[![Snap Status](https://snapcraft.io/foreplay/badge.svg)](https://snapcraft.io/foreplay)

A pre-commit hook manager.

### How is this different from pre-commit?

It makes not attempt to install pre-commit hooks for you and as a result is a lot simpler. We assume the commands you want to run ahead of each commit have already been setup.

## Two output methods

For when looks are more important than personality.

```yaml

spinners: true

```

![GitHub](./example.svg)

Github Actions inspired configuration syntax.

```yaml

hooks:

  - name: eslint

    run: |

      cd frontend

      npm lint

  - id: golangci-lint

    run: golangci-lint run

```

## Installation

### macOS

```shell script

brew tap eberkund/foreplay

brew install foreplay

```

### Linux

```shell script

snap install foreplay

```

Or download install the _.deb_ from the releases page.

### Windows

```shell script

scoop bucket add app https://github.com/eberkund/scoop-foreplay.git

scoop install foreplay

```

### Go

```shell script

go install github.com/eberkund/foreplay

```