# commitlint-config-emoji-convention [![npm latest][version-img]][pkg-url] [![download][download-img]][pkg-url] [![MIT][license-img]](LICENSE) Shareable commitlint configuration that enforces conventional commits and adds emoji support. Use with [commitlint](https://www.npmjs.com/package/@commitlint/cli). ## Getting Started ```sh npm install --save-dev @commitlint/cli commitlint-config-emoji-convention echo "export default { extends: ['emoji-convention'] }" > commitlint.config.js ``` The official [commitlint documentation](https://commitlint.js.org/guides/local-setup.html) recommends using [Husky](https://typicode.github.io/husky/) to validate commit messages. ```sh npm install --save-dev husky npx husky init echo "npx --no -- commitlint --edit \$1" > .husky/commit-msg ``` The above configuration will validate commit messages, but requires manual emoji inclusion. To automatically prepend emojis based on commit prefixes, perform the following steps: ```sh touch .husky/prepare-commit-msg ``` Add the following script: ```sh msg=$(cat "$1") msg=$(echo $msg | sed -e "s/^init/🎉 init/") msg=$(echo $msg | sed -e "s/^feat/✨ feat/") msg=$(echo $msg | sed -e "s/^fix/🐛 fix/") msg=$(echo $msg | sed -e "s/^docs/📚 docs/") msg=$(echo $msg | sed -e "s/^style/💎 style/") msg=$(echo $msg | sed -e "s/^refactor/📦 refactor/") msg=$(echo $msg | sed -e "s/^perf/🚀 perf/") msg=$(echo $msg | sed -e "s/^test/🚨 test/") msg=$(echo $msg | sed -e "s/^build/🛠 build/") msg=$(echo $msg | sed -e "s/^ci/⚙️ ci/") msg=$(echo $msg | sed -e "s/^chore/♻️ chore/") msg=$(echo $msg | sed -e "s/^revert/🗑 revert/") echo $msg > $1 ``` ## Format ```text ():