@ballcat/commitlint-config-gitmoji v1.1.0

@ballcat/commit-config-gitmoji

English | 中文

Shareable commitlint config enforcing gitmoji.
Use with @commitlint/cli and @commitlint/prompt-cli.

Getting started

install commitlint and commit-config-gitmoji

# For Windows:
npm install --save-dev @ballcat/commitlint-config-gitmoji @commitlint/cli

# Configure commitlint to use conventional config
echo "module.exports = {extends: ['./node_modules/@ballcat/commitlint-config-gitmoji']}" > commitlint.config.js

To lint commits before they are created you can use Husky's commit-msg hook:

install husky v8

npx husky-init && npm install       # npm
npx husky-init && yarn              # Yarn 1
yarn dlx husky-init --yarn2 && yarn # Yarn 2+
pnpm dlx husky-init && pnpm install # pnpm

add hook

npx husky add .husky/commit-msg 'npx --no -- commitlint --edit "$1"'

Commit Message Format

<type> [scope] <subject>

[body]

[footer]

• type(required): An emoji from the list.
• scope(optional): A string wrapped in parentheses that adds contextual information for the scope of the change.
• subject(required): A brief explanation of the change.
• body(required): Detailed description of the change.
• footer(required): Links and operation issues or PR, eg.Closes #392

Rules

Problems

The following rules are considered problems for @ballcat/commit-config-gitmoji 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
• level: error
• value: emoji code list, see gitmoji list

echo ":no: some message" # fails
echo ":bug: some message" # passes

type-case

• description: type is in case value
• rule: always
• level: error
• value

  'lowerCase'

echo ":BUG: some message" # fails
echo ":bug: some message" # passes

type-empty

• condition: type is empty
• rule: never
• level: error

echo "some message" # fails
echo ":bug: some message" # passes

subject-case

• condition: subject is in one of the cases ['sentence-case', 'start-case', 'pascal-case', 'upper-case']
• rule: always
• level: error

echo ":bug: Some message" # fails
echo ":bug: Some Message" # fails
echo ":bug: SomeMessage" # fails
echo ":bug: SOMEMESSAGE" # fails
echo ":bug: some message" # passes
echo ":bug: some Message" # passes

subject-empty

• condition: subject is empty
• rule: never
• level: error

echo ":bug:" # fails
echo ":bug: some message" # passes

subject-full-stop

• condition: subject ends with value
• rule: never
• level: error
• value

'.'

echo ":bug: some message." # fails
echo ":bug: some message" # passes

header-max-length

• condition: header has value or less characters
• rule: always
• level: error
• value

72

echo ":bug: some message that is way too long and breaks the line max-length by several characters" # fails
echo ":bug: some message" # passes

footer-leading-blank

• condition: footer should have a leading blank line
• rule: always
• level: error

echo ":bug: some message
BREAKING CHANGE: It will be significant" # error

echo ":bug: some message

BREAKING CHANGE: It will be significant" # passes

body-leading-blank

• condition: body should have a leading blank line
• rule: always
• level: error

echo ":bug: some message
body" # error

echo ":bug: some message

body" # passes

Gitmoji List

see gitmojis.json or gitmoji.dev