commitlint-config-non-conventional

commitlint-config-non-conventional

Shared commitlint config to enforce a good commit message

This config disllows the usage of conventinal style commits. Sometimes all you need is just a proper commit messages with rules enforced.

Rules

A commit message or commit title should

• not be empty
• be sentence cased
• contain atleast 10 characters
• not exceed 50 characters
• not end with full stop

If the commit message has a body and footer. They should have 2 blank leading lines and should not exceed 72 characters. The description(body) should be sentence cased.

Installation

npm i -D @commitlint/cli commitlint-config-non-conventional

Usage

// commitlint.config.js

module.exports = {
  extends: 'non-conventional',
};

Configuring with husky

# Install husky
npm i -D husky

# Activate husky hooks
npx husky install

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

Checkout the husky documentation on how to automatically install git hooks post installation.

Useful links

• How to Write a Git Commit Message