mog

command module
v1.3.0 Latest Latest
Warning

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

Go to latest
Published: Apr 22, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

README

Contributors Forks Stargazers Issues Apache-2.0 Coverage


Mog

Git Hooks management tool written in Go
Explore the docs »

· Report Bug · Request Feature

About The Project

Mog is a Git Hooks management tool that makes Git Hooks easier to use. Its features are:

  • Fast - written in Go
  • Multiple types of configuration files - support YAML, TOML and JSON

Getting Started

Installation

Go Module

You can install the latest version of Mog using Go Module.

Homebrew
brew install aw83/tap/mog

Usage

  1. Create a .mog.yml file (of course you can also choose TOML, JSON)
pre-commit:
  fail-fast: true # exit on failure
  commands:
    - name: Lint
      run: eslint --fix
    
    - name: Echo
      run: echo $TEXT
      env: # you can set environments
        - TEXT: Hello World
  1. Run mog install to install the Hook.

  2. If you want to try it out, run mog run -t pre-commit

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the Apache-2.0. See LICENSE for more information.

Contact

Project Link: https://github.com/aw83/mog

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