https://github.com/ljnsn/cz-conventional-gitmoji
A commitizen plugin that combines gitmoji and conventional commits.
https://github.com/ljnsn/cz-conventional-gitmoji
commitizen conventional-commits git gitmoji semantic-versioning semver
Last synced: 16 days ago
JSON representation
A commitizen plugin that combines gitmoji and conventional commits.
- Host: GitHub
- URL: https://github.com/ljnsn/cz-conventional-gitmoji
- Owner: ljnsn
- Created: 2022-12-24T18:34:08.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-22T17:33:00.000Z (6 months ago)
- Last Synced: 2025-06-20T14:57:57.140Z (5 months ago)
- Topics: commitizen, conventional-commits, git, gitmoji, semantic-versioning, semver
- Language: Python
- Homepage:
- Size: 449 KB
- Stars: 27
- Watchers: 1
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# cz-conventional-gitmoji
A [commitizen](https://github.com/commitizen-tools/commitizen) plugin that combines [gitmoji](https://gitmoji.dev/) and [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).
## Installation
With `pip` or any other package manager of your choice, the usual way:
```bash
pip install cz-conventional-gitmoji
```
## Usage
This package can be used as a normal `commitizen` plugin, either by specifying the name on the command line
```bash
cz --name cz_gitmoji commit
```
or by setting it in your **pyproject.toml**
```toml
[tool.commitizen]
name = "cz_gitmoji"
```
This will make `commitizen` use the commit message parsing rules defined by this plugin, which are 100% compatible with [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). As such, the gitmojis are completely optional and all commands will continue to validate commit messages in conventional format just fine. This is useful if you're transitioning an existing repo to `cz-conventional-gitmoji` or you work in a team in which some colleagues don't like gitmojis.
### gitmojify
Apart from the conventional-gitmoji rules, this package provides the `gitmojify` command which is also available as a pre-commit hook. The command reads a commit message either from cli or a commit message file and prepends the correct gitmoji based on the type. If the message already has a gitmoji, it is returned as is.
```bash
$ gitmojify -m "init: initial version"
🎉 init: initial version
```
To use it as a pre-commit hook, install this packages as well as `commitizen` and put the following into your **.pre-commit-config.yaml**
```yaml
repos:
- repo: https://github.com/ljnsn/cz-conventional-gitmoji
rev: 0.7.0 # double-check the latest version (or run pre-commit autoupdate)
hooks:
- id: conventional-gitmoji
```
To use `commitizen` hooks with `conventional-gitmoji`, you need to add the package as an extra dependency.
```yaml
- repo: https://github.com/commitizen-tools/commitizen
rev: v3.29.0
hooks:
- id: commitizen
additional_dependencies: [cz-conventional-gitmoji]
```
Make sure to install the relevant pre-commit hooks with
```bash
pre-commit install --install-hooks
```
Commit with a message in conventional format that contains a valid type mapped by conventional gitmoji and the gitmoji will automagically be added.
### Type mappings
Types to gitmojis
| Type | Emoji |
|------|-------|
| `fix` | 🐛 |
| `feat` | ✨ |
| `docs` | 📝 |
| `style` | 🎨 |
| `refactor` | ♻️ |
| `perf` | ⚡️ |
| `test` | ✅ |
| `build` | 👷 |
| `ci` | 💚 |
| `revert` | ⏪️ |
| `dump` | 🔥 |
| `hotfix` | 🚑️ |
| `deploy` | 🚀 |
| `ui` | 💄 |
| `init` | 🎉 |
| `security` | 🔒️ |
| `secret` | 🔐 |
| `bump` | 🔖 |
| `fix`-lint | 🚨 |
| `wip` | 🚧 |
| `dep-drop` | ⬇️ |
| `dep-bump` | ⬆️ |
| `pin` | 📌 |
| `analytics` | 📈 |
| `dep-add` | ➕ |
| `dep-rm` | ➖ |
| `config` | 🔧 |
| `script` | 🔨 |
| `lang` | 🌐 |
| `typo` | ✏️ |
| `poop` | 💩 |
| `merge` | 🔀 |
| `package` | 📦️ |
| `external` | 👽️ |
| `resource` | 🚚 |
| `license` | 📄 |
| `boom` | 💥 |
| `asset` | 🍱 |
| `accessibility` | ♿️ |
| `source-docs` | 💡 |
| `beer` | 🍻 |
| `text` | 💬 |
| `db` | 🗃️ |
| `logs-add` | 🔊 |
| `logs-rm` | 🔇 |
| `people` | 👥 |
| `ux` | 🚸 |
| `arch` | 🏗️ |
| `design` | 📱 |
| `mock` | 🤡 |
| `egg` | 🥚 |
| `ignore` | 🙈 |
| `snap` | 📸 |
| `experiment` | ⚗️ |
| `seo` | 🔍️ |
| `types` | 🏷️ |
| `seed` | 🌱 |
| `flag` | 🚩 |
| `catch` | 🥅 |
| `animation` | 💫 |
| `deprecation` | 🗑️ |
| `auth` | 🛂 |
| `fix-simple` | 🩹 |
| `exploration` | 🧐 |
| `dead` | ⚰️ |
| `test-fail` | 🧪 |
| `logic` | 👔 |
| `health` | 🩺 |
| `infra` | 🧱 |
| `devxp` | 🧑💻 |
| `money` | 💸 |
| `threading` | 🧵 |
| `validation` | 🦺 |
| `chore` | 🧹1 |
1 This is an addition to the original Gitmojis.
## Features
- [x] Enable conventional gitmoji commit messages via `cz commit`.
- [x] Add hook to automatically prepend the appropriate gitmoji for the commit's type.
- [ ] Add `--simple-emojis` option to use only the emojis relating to `cz_conventional_commits` types.
- [ ] Add `--simple-types` option to use only the types used by `cz_conventional_commits`.
- [ ] Add `--conventional` option to put the emoji in the commit message, making it compatible with `cz_conventional_commits`.
## Inspiration
- [`commitizen-emoji`](https://github.com/marcelomaia/commitizen-emoji)