Shareable commitlint config for the VS Code extension git-commit-plugin with emoji enabled
Package: commitlint-config-git-commit-emoji
Created by: ccnnde
Last modified: Wed, 27 Apr 2022 14:24:27 GMT
Version: 1.0.0
License: MIT
Downloads: 1,709
Repository: https://github.com/ccnnde/commitlint-config-git-commit-emoji
Install
npm install commitlint-config-git-commit-emoji
yarn add commitlint-config-git-commit-emoji
commitlint-config-git-commit-emoji
Shareable commitlint config for the VS Code extension git-commit-plugin with emoji enabled.
Use with commitlint.
Getting started
npm install --save-dev @commitlint/cli commitlint-config-git-commit-emoji
echo "module.exports = {extends: ['git-commit-emoji']};" > .commitlintrc.js
Format
<emoji> <type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
Example
✨ feat(blog): add comment section
Rules
Problems
The following rules are considered problems for commitlint-config-git-commit-emoji and will yield a non-zero exit code when not met.
Consult docs/rules for a list of available rules.
type-enum
- condition:
typeis found in value - rule:
always - value
[
'🎉 init',
'✨ feat',
'🐞 fix',
'📃 docs',
'🌈 style',
'🦄 refactor',
'🎈 perf',
'🧪 test',
'🔧 build',
'🐎 ci',
'🐳 chore',
'↩ revert',
]
echo "foo: some message" # fails
echo "🐞 fix: some message" # passes
type-case
- description:
typeis in casevalue - rule:
always - value
'lowerCase'
echo "FIX: some message" # fails
echo "🐞 fix: some message" # passes
type-empty
- condition:
typeis empty - rule:
never
echo ": some message" # fails
echo "🐞 fix: some message" # passes
scope-case
- condition:
scopeis in casevalue - rule:
always
'lowerCase'
echo "🐞 fix(SCOPE): some message" # fails
echo "🐞 fix(scope): some message" # passes
subject-case
- condition:
subjectis in one of the cases['sentence-case', 'start-case', 'pascal-case', 'upper-case'] - rule:
never
echo "🐞 fix(SCOPE): Some message" # fails
echo "🐞 fix(SCOPE): Some Message" # fails
echo "🐞 fix(SCOPE): SomeMessage" # fails
echo "🐞 fix(SCOPE): SOMEMESSAGE" # fails
echo "🐞 fix(scope): some message" # passes
echo "🐞 fix(scope): some Message" # passes
subject-empty
- condition:
subjectis empty - rule:
never
echo "🐞 fix:" # fails
echo "🐞 fix: some message" # passes
subject-full-stop
- condition:
subjectends withvalue - rule:
never - value
'.'
echo "🐞 fix: some message." # fails
echo "🐞 fix: some message" # passes
subject-exclamation-mark
- condition:
subjectmust not have a!before the:marker - rule:
never
The angular commit
convention
dose not use a ! to define a breaking change in the commit subject. If you
want to use this feature please consider using the conventional commit
config.
header-max-length
- condition:
headerhasvalueor less characters - rule:
always - value
72
echo "🐞 fix: some message that is way too long and breaks the line max-length by several characters" # fails
echo "🐞 fix: some message" # passes
body-leading-blank
- condition: Body should have a leading blank line
- rule:
always
echo "🐞 fix: some message
body" # fails
echo "🐞 fix: some message
body" # passes
footer-leading-blank
- condition: Footer should have a leading blank line
- rule:
always
echo "🐞 fix: some message
BREAKING CHANGE: It will be significant" # fails
echo "🐞 fix: some message
BREAKING CHANGE: It will be significant" # passes
Thanks
- Header regex pattern modified from @gitmoji/parser-opts
- Most of the rules come from @commitlint/config-angular
License
MIT © Nor Cod
