commitlint-config-git-commit-emoji
Advanced tools
Readme
Shareable commitlint config for the VS Code extension git-commit-plugin with emoji enabled.
Use with commitlint.
npm install --save-dev @commitlint/cli commitlint-config-git-commit-emoji
echo "module.exports = {extends: ['git-commit-emoji']};" > .commitlintrc.js
<emoji> <type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
✨ feat(blog): add comment section
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 is found in valuealways[
'🎉 init',
'✨ feat',
'🐞 fix',
'📃 docs',
'🌈 style',
'🦄 refactor',
'🎈 perf',
'🧪 test',
'🔧 build',
'🐎 ci',
'🐳 chore',
'↩ revert',
]
echo "foo: some message" # fails
echo "🐞 fix: some message" # passes
type is in case valuealways'lowerCase'
echo "FIX: some message" # fails
echo "🐞 fix: some message" # passes
type is emptyneverecho ": some message" # fails
echo "🐞 fix: some message" # passes
scope is in case valuealways'lowerCase'
echo "🐞 fix(SCOPE): some message" # fails
echo "🐞 fix(scope): some message" # passes
subject is in one of the cases ['sentence-case', 'start-case', 'pascal-case', 'upper-case']neverecho "🐞 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 is emptyneverecho "🐞 fix:" # fails
echo "🐞 fix: some message" # passes
subject ends with valuenever'.'
echo "🐞 fix: some message." # fails
echo "🐞 fix: some message" # passes
subject must not have a ! before the : markerneverThe 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 has value or less charactersalways72
echo "🐞 fix: some message that is way too long and breaks the line max-length by several characters" # fails
echo "🐞 fix: some message" # passes
alwaysecho "🐞 fix: some message
body" # fails
echo "🐞 fix: some message
body" # passes
alwaysecho "🐞 fix: some message
BREAKING CHANGE: It will be significant" # fails
echo "🐞 fix: some message
BREAKING CHANGE: It will be significant" # passes
MIT © Nor Cod
FAQs
Shareable commitlint config for the VS Code extension git-commit-plugin with emoji enabled
The npm package commitlint-config-git-commit-emoji receives a total of 152 weekly downloads. As such, commitlint-config-git-commit-emoji popularity was classified as not popular.
We found that commitlint-config-git-commit-emoji demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.