CommitLint Config

A CommitLint configuration for writing well-formatted and consistent Git commits.

Installation

pnpm add -D @theholocron/commitlint-config @commitlint/cli

@commitlint/cli is required to run commitlint directly (e.g., in git hooks or CI). @commitlint/config-conventional is a peer dependency resolved automatically by your package manager.

Usage

In your project commitlint.config.js:

export default {
  extends: ["@theholocron/commitlint-config"],
};

Rules

type-enum

Type must be one of: build, ci, chore, docs, feat, fix, perf, refactor, revert, style, test.

echo "foo: some message" | commitlint   # fails
echo "fix: some message" | commitlint   # passes

type-case — lowercase

echo "FIX: some message" | commitlint   # fails
echo "fix: some message" | commitlint   # passes

type-empty — never empty

echo ": some message" | commitlint      # fails
echo "fix: some message" | commitlint   # passes

scope-case — lowercase

echo "fix(SCOPE): message" | commitlint  # fails
echo "fix(scope): message" | commitlint  # passes

subject-case — not sentence-case, start-case, pascal-case, or upper-case

echo "fix(scope): Some message" | commitlint   # fails
echo "fix(scope): some message" | commitlint   # passes

subject-empty — never empty

echo "fix:" | commitlint               # fails
echo "fix: some message" | commitlint  # passes

subject-full-stop — no trailing period

echo "fix: some message." | commitlint  # fails
echo "fix: some message" | commitlint   # passes

header-max-length — 72 characters max

echo "fix: a very long message that exceeds the limit by quite a few characters" | commitlint  # fails
echo "fix: some message" | commitlint                                                           # passes