FancyGit

A clean and structured way to make git commits.

Features

• Commit message formatting
• NPM versioning
• Pushing to remote
• Committing staged changes
• Committing untracked files
• Committing uncommitted changes

Default Commit Message Format

{
  "clean": "[type]: [message] -- [description]",
  "compact": "[type] - [message] -- [description]",
  "modern": "<type> | [message] -- [description]"
}

These are the default commit message formats that are used when formatting a commit message. You can create your own custom formats by running fancygit format add <name>.

Another option is to create a formats.json file in the .fancygit directory and specify your custom formats there. This can be especially useful if you want to use the same format for multiple projects.

Demo formats:

{
  "fancy": {
    "feat": "🎉 feat:",
    "fix": "🔧 fix:",
    "chore": "🧹 chore:",
    "docs": "📄 docs:",
    "style": "🖍️ style:",
    "refactor": "🔄 refactor:",
    "test": "⌛ test:"
  },
  "chunky": {
    "feat": "/feat/",
    "fix": "/fix/",
    "chore": "/chore/",
    "docs": "/docs/",
    "style": "/style/",
    "refactor": "/refactor/",
    "test": "/test/"
  }
}

Installation

npm install -g fancygit

Usage

To initialize the fancygit configuration, run the following command:

fancygit init

This will create a .fancygit directory in your project, which will contain the configuration files.

Currently you can create custom formats for your commit messages and activate or deactivate Settings via the settings command.

The list of features will be expanded in the future. Feel free to contribute!

Commit

fancygit run

Format

fancygit format add <name>
fancygit format remove <name>
fancygit format export <name>
fancygit format export-all

Settings

fancygit settings get
fancygit settings update

Contributing

Contributions are welcome! Please open an issue or submit a pull request if you have any suggestions or improvements.

License

This project is licensed under the MIT License.