Skip to content

A highly customisable CLI tool for writing conventional commits

License

Notifications You must be signed in to change notification settings

Crocmagnon/meteor

 
 

Repository files navigation

️☄ meteor ☄

Meteor is a simple, highly customisable CLI tool that helps you to write conventional commits with git.

You can call meteor where you'd normally type git commit. All flags supported in git commit will still work.

Demo

Installation

Homebrew

brew tap stefanlogue/tools
brew install meteor

Go

Install with Go (1.21+):

go install github.com/stefanlogue/meteor@latest

Or grab a binary from the latest release.

Customisation

You can customise the options available by creating a .meteor.json file anywhere in the directory tree (at or above the current working directory). The config file closest to the current working directory will be preferred. This enables you to have different configs for different parent directories, such as one for your personal work, one for your actual work, one for open source work etc.

Demo with boards

The content should be in the following format:

{
  "boards": [
    { "name": "COMP" },
    { "name": "PERS" }
  ],
  "coauthors": [
    { "name": "John Doe", "email": "[email protected]" }
  ],
  "prefixes": [
    { "title":  "feat", "description":  "a new feature"},
    { "title":  "fix", "description":  "a bug fix"},
    { "title":  "bug", "description":  "introducing a bug"}
  ],
}

If you use boards (Jira etc) but need a way to have commits without one, add the following to the boards array:

{
  "boards": [
    { "name": "COMP" },
    { "name": "NONE" }
  ]
}

About

A highly customisable CLI tool for writing conventional commits

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 88.0%
  • Python 7.9%
  • Shell 3.4%
  • Makefile 0.7%