You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP β†’
Socket
Socket
Sign inDemoInstall

commitlint-config-git-commit-emoji

Package Overview
Dependencies
0
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

commitlint-config-git-commit-emoji

Shareable commitlint config for the VS Code extension git-commit-plugin with emoji enabled


Version published
Maintainers
1
Created

Readme

Source

commitlint-config-git-commit-emoji

npm latest download MIT

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: type is 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: type is in case value
  • rule: always
  • value
'lowerCase'
echo "FIX: some message" # fails
echo "🐞 fix: some message" # passes
type-empty
  • condition: type is empty
  • rule: never
echo ": some message" # fails
echo "🐞 fix: some message" # passes
scope-case
  • condition: scope is in case value
  • rule: always
'lowerCase'
echo "🐞 fix(SCOPE): some message" # fails
echo "🐞 fix(scope): some message" # passes
subject-case
  • condition: subject is 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: subject is empty
  • rule: never
echo "🐞 fix:" # fails
echo "🐞 fix: some message" # passes
subject-full-stop
  • condition: subject ends with value
  • rule: never
  • value
'.'
echo "🐞 fix: some message." # fails
echo "🐞 fix: some message" # passes
subject-exclamation-mark
  • condition: subject must 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: header has value or 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
  • 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

License

MIT Β© Nor Cod

Keywords

FAQs

Package last updated on 12 Dec 2021

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚑️ by Socket Inc