Skip to content
This repository has been archived by the owner on Jun 16, 2021. It is now read-only.

Commit

Permalink
feat: ✨ gitmoji => opt-in flag feature (non-breaking)
Browse files Browse the repository at this point in the history
Add as an opt-in (non-breaking change) to out of the box customize
`git-cz` without incurring overhead on custom implementations (if you
use this at scale).
  • Loading branch information
JeromeFitz committed Feb 28, 2021
1 parent ac7eaba commit 95ce74c
Show file tree
Hide file tree
Showing 13 changed files with 724 additions and 9 deletions.
3 changes: 2 additions & 1 deletion .git-cz.json
@@ -1,4 +1,5 @@
{
"disableEmoji": false,
"format": "{type}{scope}: {emoji}{subject}"
"format": "{type}{scope}: {emoji}{subject}",
"gitmoji": false
}
2 changes: 1 addition & 1 deletion .husky/prepare-commit-msg
Expand Up @@ -2,4 +2,4 @@

yarn pretty-quick --staged
exec < /dev/tty
node ./lib/cli.js --hook || true
node ./lib/cli.js --hook --gitmoji || true
3 changes: 2 additions & 1 deletion .npmignore
Expand Up @@ -22,4 +22,5 @@ yarn.lock
# fork
.env
.github/
.husky/
.husky/
scripts/
17 changes: 14 additions & 3 deletions README.md
@@ -1,9 +1,11 @@
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

# git-cz

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

![image](https://user-images.githubusercontent.com/9773803/49760520-fa6c6f00-fcc4-11e8-84c4-80727f071487.png)

## Install

### Without installation

```shell
Expand Down Expand Up @@ -69,6 +71,7 @@ Below is default config:
module.exports = {
disableEmoji: false,
format: '{type}{scope}: {emoji}{subject}',
gitmoji: false,
list: ['test', 'feat', 'fix', 'chore', 'docs', 'refactor', 'style', 'ci', 'perf'],
maxMessageLength: 64,
minMessageLength: 3,
Expand Down Expand Up @@ -229,7 +232,15 @@ Select the packages the commit affected.

The footer is the place to reference any tasks related to this commit.

## Why this Fork?
### gitmoji

Some people prefer [gitmoji](https://gitmoji.dev/) and `git-cz` provides an **override** that allows you to plug in

#### Please Note

This is further customizable via your own `changelog.config.js`. Feel free to look at this example at how to customize your own `changelog.config.js`.

## Why this Fork

```bash
npm i -g git-cz
Expand Down

0 comments on commit 95ce74c

Please sign in to comment.