# 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/) in a lightweight way.
This fork of [cz-conventional-gitmoji](https://github.com/ljnsn/cz-conventional-gitmoji) adds a `simple-types` and `conventional` option to the template.
We will only have the emojis that are related to the `cz_conventional_commits` types and they will be added to `<subject>` section of the commit message.
```
init: 🎉 initial version
```
## Installation
With `pip` or any other package manager of your choice, the usual way:
```bash
pip install cz-light-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_light_gitmoji commit
```
or by setting it in your **pyproject.toml**
```toml
[tool.commitizen]
name = "cz_light_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-light-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/sasirven/cz-light-conventional-gitmoji
rev: 0.2.4
hooks:
- id: 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.
## Features
- [x] Enable conventional gitmoji commit messages via `cz commit`.
- [x] Add hook to automatically prepend the appropriate gitmoji for the commit's type.
## Inspiration
- [`cz-conventional-gitmoji`](https://github.com/ljnsn/cz-conventional-gitmoji) (Forked from)
## Author
- ljnsn (Original Author)
- Samuel Sirven
- [](https://github.com/sasirven)
- [](https://www.linkedin.com/in/samuel-sirven-b49b53211/)
Raw data
{
"_id": null,
"home_page": "https://github.com/sasirven/cz-light-conventional-gitmoji",
"name": "cz-light-conventional-gitmoji",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "sasirven",
"author_email": "77392535+sasirven@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/a6/a1/5cf35481a6d3646ac9ad0bab1ee7d0ebfdba0117a33e31f5e43af77d8a20/cz_light_conventional_gitmoji-0.3.1.tar.gz",
"platform": null,
"description": "# cz-conventional-gitmoji\n\nA [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/) in a lightweight way.\nThis fork of [cz-conventional-gitmoji](https://github.com/ljnsn/cz-conventional-gitmoji) adds a `simple-types` and `conventional` option to the template.\nWe will only have the emojis that are related to the `cz_conventional_commits` types and they will be added to `<subject>` section of the commit message.\n\n```\ninit: \ud83c\udf89 initial version\n```\n\n## Installation\n\nWith `pip` or any other package manager of your choice, the usual way:\n\n```bash\npip install cz-light-conventional-gitmoji\n```\n\n## Usage\n\nThis package can be used as a normal `commitizen` plugin, either by specifying the name on the command line\n\n```bash\ncz --name cz_light_gitmoji commit\n```\n\nor by setting it in your **pyproject.toml**\n\n```toml\n[tool.commitizen]\nname = \"cz_light_gitmoji\"\n```\n\nThis 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-light-conventional-gitmoji` or you work in a team in which some colleagues don't like gitmojis.\n\n### gitmojify\n\nApart 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.\n\n```bash\n$ gitmojify -m \"init: initial version\"\n\ud83c\udf89 init: initial version\n```\n\nTo use it as a pre-commit hook, install this packages as well as `commitizen` and put the following into your **.pre-commit-config.yaml**\n\n```yaml\nrepos:\n - repo: https://github.com/sasirven/cz-light-conventional-gitmoji\n rev: 0.2.4\n hooks:\n - id: conventional-gitmoji\n```\n\nMake sure to install the relevant pre-commit hooks with\n\n```bash\npre-commit install --install-hooks\n```\n\nCommit with a message in conventional format that contains a valid type mapped by conventional gitmoji and the gitmoji will automagically be added.\n\n## Features\n\n- [x] Enable conventional gitmoji commit messages via `cz commit`.\n- [x] Add hook to automatically prepend the appropriate gitmoji for the commit's type.\n\n## Inspiration\n\n- [`cz-conventional-gitmoji`](https://github.com/ljnsn/cz-conventional-gitmoji) (Forked from)\n\n## Author\n- ljnsn (Original Author)\n- Samuel Sirven\n - [](https://github.com/sasirven)\n - [](https://www.linkedin.com/in/samuel-sirven-b49b53211/)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A commitizen plugin that combines gitmoji and conventional commits in a lightweight way.",
"version": "0.3.1",
"project_urls": {
"Homepage": "https://github.com/sasirven/cz-light-conventional-gitmoji",
"Repository": "https://github.com/sasirven/cz-light-conventional-gitmoji"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "89c09e2a0a4ba0b66f39d56848419b696320cd634c62ca29b6d0b9554e80698c",
"md5": "52f08e7eb3ac7527985fc27f113e7b9b",
"sha256": "7c9f388bb6abde3eab4193d8e56481dc28723c2ea1000c01c1572c1682db052e"
},
"downloads": -1,
"filename": "cz_light_conventional_gitmoji-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "52f08e7eb3ac7527985fc27f113e7b9b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 11209,
"upload_time": "2024-10-21T12:52:31",
"upload_time_iso_8601": "2024-10-21T12:52:31.480886Z",
"url": "https://files.pythonhosted.org/packages/89/c0/9e2a0a4ba0b66f39d56848419b696320cd634c62ca29b6d0b9554e80698c/cz_light_conventional_gitmoji-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a6a15cf35481a6d3646ac9ad0bab1ee7d0ebfdba0117a33e31f5e43af77d8a20",
"md5": "d1ba9acba374bbc8390179760f79d50d",
"sha256": "f04dd78f42e91c1c71ded922da7a3bf3b3957c47b6f6d742edce9b8470d11e25"
},
"downloads": -1,
"filename": "cz_light_conventional_gitmoji-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "d1ba9acba374bbc8390179760f79d50d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 10229,
"upload_time": "2024-10-21T12:52:32",
"upload_time_iso_8601": "2024-10-21T12:52:32.499318Z",
"url": "https://files.pythonhosted.org/packages/a6/a1/5cf35481a6d3646ac9ad0bab1ee7d0ebfdba0117a33e31f5e43af77d8a20/cz_light_conventional_gitmoji-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-21 12:52:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sasirven",
"github_project": "cz-light-conventional-gitmoji",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cz-light-conventional-gitmoji"
}
JSON
