Commitizen adapter formatting commit messages using emojis.
cz-emoji allows you to easily use emojis in your commits using commitizen.
? Select the type of change you are committing: (Use arrow keys)
β― feature π A new feature
fix π A bug fix
docs π Documentation change
refactor π¨ A code refactoring change
chore π© A chore changeGlobally
npm install --global cz-emoji
# set as default adapter for your projects
echo '{ "path": "cz-emoji" }' > ~/.czrcLocally
npm install --save-dev cz-emojiAdd this to your package.json:
"config": {
"commitizen": {
"path": "cz-emoji"
}
}βΉοΈ pnpm requires you to specify node_modules/cz-emoji.
$ git czBy default cz-emoji comes ready to run out of the box. Uses may vary, so there are a few configuration options to allow fine tuning for project needs.
Configuring cz-emoji can be handled in the users home directory (~/.czrc) for changes to impact all projects or on a per project basis (package.json). Simply add the config property as shown below to the existing object in either of the locations with your settings for override.
{
"config": {
"cz-emoji": {}
}
}By default cz-emoji comes preconfigured with the Gitmoji types.
An Inquirer.js choices array:
{
"config": {
"cz-emoji": {
"types": [
{
"emoji": "π",
"code": ":star2:",
"description": "A new feature",
"name": "feature"
}
]
}
}
}An Inquirer.js choices array:
{
"config": {
"cz-emoji": {
"scopes": ["home", "accounts", "ci"]
}
}
}A boolean value that allows for an using a unicode value rather than the default of Gitmoji markup in a commit message. The default for symbol is false.
{
"config": {
"cz-emoji": {
"symbol": true
}
}
}An array of questions you want to skip:
{
"config": {
"cz-emoji": {
"skipQuestions": ["scope", "issues"]
}
}
}You can skip the following questions: scope, body, issues, and breaking. The type and subject questions are mandatory.
An object that contains overrides of the original questions:
{
"config": {
"cz-emoji": {
"questions": {
"body": "This will be displayed instead of original text"
}
}
}
}The maximum length you want your subject has
{
"config": {
"cz-emoji": {
"subjectMaxLength": 200
}
}
}Commitlint can be set to work with this package with the following configuration:
commitlint.config.js
const pkg = require('./package.json')
// Check if the user has configured the package to use conventional commits.
const isConventional = pkg.config ? pkg.config['cz-emoji']?.conventional : false
// Regex for default and conventional commits.
const RE_DEFAULT_COMMIT = /^(?::.*:|(?:\u00a9|\u00ae|[\u2000-\u3300]|\ud83c[\ud000-\udfff]|\ud83d[\ud000-\udfff]|\ud83e[\ud000-\udfff]))\s(?<emoji>\((?<scope>.*)\)\s)?.*$/gm
const RE_CONVENTIONAL_COMMIT = /^^(?<type>\w+)(?:\((?<scope>\w+)\))?\s(?<emoji>:.*:|(?:\u00a9|\u00ae|[\u2000-\u3300]|\ud83c[\ud000-\udfff]|\ud83d[\ud000-\udfff]|\ud83e[\ud000-\udfff]))\s.*$/gm
module.exports = {
rules: {
'cz-emoji': [2, 'always']
},
plugins: [
{
rules: {
'cz-emoji': ({ raw }) => {
const isValid = isConventional
? RE_CONVENTIONAL_COMMIT.test(raw)
: RE_DEFAULT_COMMIT.test(raw)
const message = isConventional
? `Your commit message should follow conventional commit format.`
: `Your commit message should be: <emoji> (<scope>)?: <subject>`
return [isValid, message]
}
}
}
]
}Let me know if you are interested in having the above configuration published
as a commitlint plugin.
- Fauda: configuration made simple.
- Commitizen Emoji: Commitizen adapter formatting commit messages using emojis.
- Reading Time: Medium's like reading time estimation.
MIT Β© Nicolas Gryman
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
![greenkeeper[bot] avatar](https://avatars.githubusercontent.com/in/505?v=4 "greenkeeper[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent