@tomjs/commitlint-config

English | 中文

Configuration for commit message conventions in projects using commitlint.

Usage

• Installation

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

• Modify commitlint.config.{js,mjs,ts,mts} configuration

export default {
  extends: ['@tomjs/commitlint-config'],
};

• Combine with other libraries

Used in conjunction with simple-git-hooks and lint-staged.

pnpm add -D simple-git-hooks lint-staged

scripts of package.json added prepare

{
  "scripts": {
    "prepare": "simple-git-hooks"
  }
}

Version Dependencies

@tomjs/commitlint-config	@commitlint/cli	node
^1.0.0	^21.2.2	>=22.12.0