Get Started | Website

Lint commit messages

Demo generated with svg-term-cli

cat docs/assets/commitlint.json | svg-term --out docs/public/assets/commitlint.svg --frame --profile=Seti --height=20 --width=80

• 🚓 Be a good commitizen
• 📦 Share configuration via npm
• 🤖 Tap into conventional-changelog

Contents

• Get Started | Website
  • Contents
  • What is commitlint
    • Benefits of using commitlint
  • Getting started
  • CLI
  • Config
  • Shared configuration
  • Documentation
  • API
  • Tools
  • Roadmap
  • Version Support and Releases
    • Releases
  • Related projects
  • License
  • Development
    • Install and run

What is commitlint

commitlint checks if your commit messages meet the conventional commit format.

In general the pattern mostly looks like this:

type(scope?): subject  #scope is optional; multiple scopes are supported (current delimiter options: "/", "\" and ",")

Real world examples can look like this:

chore: run tests on travis ci

fix(server): send cors headers

feat(blog): add comment section

Common types according to commitlint-config-conventional (based on the Angular convention) can be:

• build
• chore
• ci
• docs
• feat
• fix
• perf
• refactor
• revert
• style
• test

These can be modified by your own configuration.

Benefits of using commitlint

• Why Use Conventional Commits?
• "The perks of committing with conventions" (Talk slides)

Getting started

• Local setup - Lint messages on commit with husky
• CI setup - Lint messages during CI builds

CLI

• Primary way to interact with commitlint.
• npm install --save-dev @commitlint/cli
• Packages: cli

Config

• Configuration is picked up from:
  • .commitlintrc
  • .commitlintrc.json
  • .commitlintrc.yaml
  • .commitlintrc.yml
  • .commitlintrc.js
  • .commitlintrc.cjs
  • .commitlintrc.mjs
  • .commitlintrc.ts
  • .commitlintrc.cts
  • commitlint.config.js
  • commitlint.config.cjs
  • commitlint.config.mjs
  • commitlint.config.ts
  • commitlint.config.cts
  • commitlint field in package.json
  • commitlint field in package.yaml
• Packages: cli, core
• See Rules for a complete list of possible rules
• An example configuration can be found at @commitlint/config-conventional

Shared configuration

A number of shared configurations are available to install and use with commitlint:

• @commitlint/config-angular
• @commitlint/config-conventional
• @commitlint/config-lerna-scopes
• @commitlint/config-nx-scopes
• @commitlint/config-patternplate
• conventional-changelog-lint-config-atom
• conventional-changelog-lint-config-canonical
• commitlint-config-jira

⚠️ If you want to publish your own shareable config then make sure it has a name aligning with the pattern commitlint-config-emoji-log or commitlint-config-your-config-name — then in extend all you have to write is emoji-log or your-config-name.

Documentation

Check the main website.

API

• Alternative, programmatic way to interact with commitlint
• Packages:
  • format - Format commitlint reports
  • lint - Lint a string against commitlint rules
  • load - Load shared commitlint configuration
  • read - Read commit messages from a specified range or last edit
• See API for a complete list of methods and examples

Tools

• commitizen adapter
• prompt

Roadmap

commitlint is considered stable and is used in various projects as a development tool.

Ideas: conventional-changelog/commitlint#94

Version Support and Releases

• Node.js LTS >= 18
• git >= 2.13.2

Releases

Security patches will be applied to versions which are not yet EOL.\ Features will only be applied to the current main version.

EOL is usually after around a year.

We're not a sponsored OSS project. Therefore we can't promise that we will release patch versions for older releases in a timely manner.\ If you are stuck on an older version and need a security patch we're happy if you can provide a PR.

Related projects

• conventional-changelog Generate a changelog from conventional commit history
• commitizen Simple commit conventions for internet citizens
• create-semantic-module CLI for quickly integrating commitizen and commitlint in new or existing projects

License

Copyright by @marionebl. All commitlint packages are released under the MIT license.

Development

commitlint is developed in a mono repository.

Install and run

git clone git@github.com:conventional-changelog/commitlint.git
cd commitlint
yarn
yarn run build # run build tasks
yarn start # run tests, again on change
yarn run commitlint # run CLI

For more information on how to contribute please take a look at our contribution guide.

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

19.5.0 (2024-09-11)

Features

• cli: use special errorCode for missing rules/config #4142 (#4143) (d7070d8)

19.4.1 (2024-08-28)

Bug Fixes

• rules: handle blank commit message in signed-off-by check (#4124) (7ab4bab)

19.4.0 (2024-08-07)

Features

• support command line options from a file (#4109) (a20e890)
• support linting from the last tag (#4110) (4b204ec)

19.3.1 (2024-05-13)

Bug Fixes

• prompt: prompt does not respect [body-leading-blank] setting (#4066) (3f1f44d)
• update dependency ajv to v8.13.0 (#4057) (4e5957f)
• update dependency import-meta-resolve to v4.1.0 (#4055) (6cd9d76)
• update dependency inquirer to v9.2.20 (#4047) (b2a75c8)
• update dependency semver to v7.6.2 (#4080) (de28f20)
• update dependency tar-fs to v3.0.6 (#4048) (4003205)

Features

• container: add arm64 build (#4049) (28bed3f), closes #3926

19.3.0 (2024-04-23)

Bug Fixes

• update dependency inquirer to v9.2.19 (#4031) (84126c1)

Features

• container: added @commitlint/config-nx-scopes for nx monorepos (#3913) (aa4df36)
• format: print full commit message for valid commits if -V (#4026) (a7bbc49)

19.2.2 (2024-04-14)

Bug Fixes

• is-ignored: ignore "amend!" commits (#4024) (90078f6)
• update dependency inquirer to v9.2.17 (#3996) (44d0fcc)
• update dependency inquirer to v9.2.18 (#4025) (52d7edc)

19.2.1 (2024-03-19)

Bug Fixes

• config-nx-scopes: include file extension in nx imports (#3979) (583250b)

19.2.0 (2024-03-15)

Bug Fixes

• update dependency inquirer to v9.2.16 (#3972) (ea1ab9c)

Features

• cli: introduce new --last flag, to stop recommending HEAD~1 (#3916) (99f4f3f)
• load: update cosmiconfig to v9 to add support for package.yaml config (#3976) (94eab40)

19.1.0 (2024-03-12)

Bug Fixes

• add main and types keys in package.json (#3953) (7ddaad4)
• add missing conditions param for moduleResolve (#3962) (67baff9)
• add missing cjs entry in package (#3967) (9cea6fd)
• update dependency @pnpm/read-project-manifest to v5.0.11 (#3932) (2525d14)
• update dependency tmp to v0.2.3 (#3945) (25bab59)

Features

• add CJS export for cz-commitlint (#3963) (6ae3c6a), closes /github.com/conventional-changelog/commitlint/pull/3850#issuecomment-1984932236 #3949

19.0.3 (2024-02-28)

Bug Fixes

• mark @types/conventional-commits-parser as dep for @commitlint/types (#3944) (5a01f59), closes #3929 #3942

19.0.2 (2024-02-28)

Bug Fixes

• fallback to resolve-from for Yarn P'n'P (#3941) (1eb9b5f), closes #3936

19.0.1 (2024-02-27)

Bug Fixes

• drop resolve-from, resolve-global and import-fresh, resolve global packages correctly (#3939) (8793c63), closes #3938

19.0.0 (2024-02-27)

• feat!: migrate to pure ESM (#3850) (3423735), closes #3850

Reverts

• Revert "chore: update tools version to v20" (53fc619)
• Revert "chore!: minimum node version v20" (2816783)
• Revert "ci: add codeQuality job to run lint and format tasks (#3922)" (8bb94ca), closes #3922
• Revert "ci: update node version to v20" (8a24546)

BREAKING CHANGES

• migrate to pure ESM

• feat: migrate to pure ESM

• chore: update snapshot

• fix: load parserPreset with another await

• test: migrate to vitest

• test: remove no replacement --runInBand test-ci script

• chore: fix code reviews

• refactor(load): rewrite resolve logic

• fix(config-nx-scopes): fix syntax error

• feat(resolve-extends): add resolveFrom and loadParserPreset

• feat(load): use resolveFrom and loadParserPreset from resolve-extends

• test: include only @commitlint/* packages src in coverage

• test: explicit import vitest utilities

• test: remove @jest/globals from dependencies

• fix(resolve-extends): resolveFrom output should be platform aware

• test: restore NO_COLOR to test script

• chore: fix linting issues

• fix: should use fileURLToPath instead of pathname for Windows compatibility

• Apply suggestions from code review

• fix: should reuse cli instead call yargs()

• feat(cli): set terminalWidth as wrap to avoid work break on help

• Update .eslintrc.cjs

• feat: migrate @commitlint/config-conventional to pure ESM

18.6.3 (2024-03-11)

Bug Fixes

• add missing entry wrapper.mjs (#3966) (c2c3c7c), closes #3958

18.6.2 (2024-02-14)

Bug Fixes

• config-conventional: use default export (#3911) (bc48408)

18.6.1 (2024-02-13)

Bug Fixes

• update dependency semver to v7.6.0 (#3900) (df33003)
• update dependency tar-fs to v3.0.5 (#3903) (79d77c9)

18.6.0 (2024-01-25)

Features

• rules: add header-trim rule (#3199) (#3871) (331579a)

18.5.1 (2024-01-22)

Bug Fixes

• config-nx-scopes: replace import with require (#3865) (#3867) (3ede3e0)

18.5.0 (2024-01-22)

Bug Fixes

• config-nx-scopes: restore compatibility with nx 17.2.0 and higher (#3855) (1e08a17), closes #3820

Features

• cli: print-config now can be configured to print a json in stdout (#3863) (6381a2d), closes #3819

18.4.4 (2024-01-04)

Bug Fixes

• @commitlint/load: Remove unused @types/node dependency (#3801) (7b3f8b3)
• read: remove fs-extra usage and use fs/promises (#3803) (714be66)
• subject-full-stop false positive when using ellipsis (#3839) (b4246d6)
• update dependency fs-extra to v11.2.0 (#3799) (abb4da2)
• utils: remove fs-extra usage (#3804) (92f2237)

18.4.3 (2023-11-21)

Bug Fixes

• update dependency read-pkg to v9.0.1 (#3777) (88c4b8a)

18.4.2 (2023-11-16)

Bug Fixes

• update dependency @types/fs-extra to v11.0.4 (#3767) (f6c4696)
• update dependency @types/tmp to v0.2.6 (#3769) (bc849bc)

18.4.1 (2023-11-12)

Bug Fixes

• update cosmiconfig to specific version (#3755) (636b8b1)

18.4.0 (2023-11-10)

Bug Fixes

• update dependency fast-glob to v3.3.2 (#3740) (b3bf1f2)
• update dependency read-pkg to v9 (#3734) (722f518)
• update dependency tar-fs to v3 (#3718) (afb04dd)

Features

• bump cosmiconfig version and conditionally support mjs config (#3747) (a2b65fc)

18.3.0 (2023-10-26)

Bug Fixes

• update dependency @types/node to v18.18.7 (#3726) (dcc0424)

Features

• config-nx-scopes: support latest nx version (#3728) (22e6f74)

18.2.0 (2023-10-26)

Features

• load: use cosmiconfig-typescript-loader v5 to remove ts-node dependency for @commitlint/load (#3722) (1ff49ea)

18.1.0 (2023-10-25)

Bug Fixes

• update dependency read-pkg to v8 (#3717) (326f497)

Features

• [scope-enum] [scope-case] allow space after comma as scope delimiter (#3577) (13c4bfc), closes #3576

18.0.0 (2023-10-20)

• chore!: minimum node version v18 (#3644) (5b4aeaf), closes #3644

BREAKING CHANGES

• drop node v14 and v16 support

• chore: remove unused types

• docs: prepare node update and new release

• chore!: minimum TS version v5

• drop TS v4 support

• ci: remove node v14/16 checks

• chore: adjust node types to minimal supported version

• chore!: further major versions of other deps

• upgrade conventional-changelog-conventionalcommits, conventional-commits-parser, conventional-changelog-atom,

• docs: simplify releases and remove roadmap

17.8.1 (2023-10-20)

Note: Version bump only for package @commitlint/root

17.8.0 (2023-10-14)

Bug Fixes

• chore(container): add pullrequest event to container build workflow trigger (8e30bec)
• update dependency @types/fs-extra to v11.0.2 (#3681) (5c6f087)
• update dependency @types/tmp to v0.2.4 (#3682) (f9d7029)
• update dependency cosmiconfig-typescript-loader to v4.4.0 (#3688) (4bcb0c6)

Features

• lazy load cosmiconfig-typescript-loader (#3694) (b058c7c)

17.7.2 (2023-09-28)

Bug Fixes

• update dependency @types/node to v20.5.1 (#3653) (cd8b775)

17.7.1 (2023-08-10)

Reverts

• Revert "feat(load): use cosmiconfig-typescript-loader v5 to remove ts-node dependency for @commitlint/load (#3633)" (8e41897), closes #3633

17.7.0 (2023-08-09)

Features

• load: use cosmiconfig-typescript-loader v5 to remove ts-node dependency for @commitlint/load (#3633) (4aa46d7)

Reverts

• eslint-config-prettier to v8 (f279ff7)
• prettier to v2 to not break lerna v6 publish (cd854cb)

17.6.7 (2023-07-19)

Note: Version bump only for package @commitlint/root

17.6.6 (2023-06-24)

Note: Version bump only for package @commitlint/root

17.6.5 (2023-05-30)

Bug Fixes

• add named export to @commitlint/parse (#3614) (2cd236b)

17.6.4 (2023-05-07)

Note: Version bump only for package @commitlint/root

17.6.3 (2023-05-04)

Bug Fixes

• config-lerna-scopes: add missing dependency (#3607) (2fff094)
• update dependency semver to v7.5.0 (#3604) (01e35e0)
• update dependency yargs to v17.7.2 (#3602) (c1c7338)

17.6.2 (2023-05-03)

Bug Fixes

• lerna package.json resolution (#3600) (6c5cd53)
• update dependency cosmiconfig to v8.1.3 (#3591) (44b57a5)
• update dependency fs-extra to v11.1.1 (#3592) (d6ec0d9)

17.6.1 (2023-04-14)

Bug Fixes

• rules: avoid processing strings with case-less Letter category symbols in subject-case (#3586) (70a4450), closes #3585

17.6.0 (2023-04-13)

Features

• rules: expand Latin-only characters limitation for subject-case with Unicode support (#3575) (5f83423)

17.5.1 (2023-03-28)

Note: Version bump only for package @commitlint/root

17.5.0 (2023-03-22)

Bug Fixes

• config-pnpm-scopes: refactor to remove peer dependencies (#3564) (f1f3bd5), closes #3556
• update dependency cosmiconfig to v8.1.0 (#3548) (7d01b2e)
• update dependency yargs to v17.7.0 (#3542) (f14990f)
• update dependency yargs to v17.7.1 (#3546) (9f37c11)

Features

• GitHubCI: add (#3549) (d973611)
• support typescript 5.0 (#3566) (c0a27ff)

17.4.4 (2023-02-17)

Bug Fixes

• parse: allow setting fieldPattern in parserOpts (#3538) (ea23c65)

17.4.3 (2023-02-13)

Bug Fixes

• subject-full-stop rule bugfix (#3531) (5d3d529)
• update dependency minimist to v1.2.8 (#3532) (1f57f98)

17.4.2 (2023-01-12)

Bug Fixes

• load: fixes a bug when a ts commitlint config is compiled twice (#3499) (dc2c899)
• update dependency @types/fs-extra to v11 (#3494) (8f553c7)
• update dependency @types/fs-extra to v11.0.1 (#3496) (f9a013c)

17.4.1 (2023-01-09)

Note: Version bump only for package @commitlint/root

17.4.0 (2023-01-04)

Bug Fixes

• stop truncating the body in presence of dashes (#3476) (02a61be)
• update dependency ajv to v8.11.2 (#3440) (7829151)
• update dependency ajv to v8.12.0 (#3482) (0a53d97)
• update dependency cosmiconfig to v8 (#3459) (ee732fe)
• update dependency cosmiconfig-typescript-loader to v4.3.0 (#3448) (86b632e)
• update dependency fs-extra to v11 (#3460) (a437923)
• update dependency semver to v7.3.8 (#3441) (7599ad6)
• update dependency typescript to v4.9.4 (#3449) (bf86c7d)
• update dependency yargs to v17.6.2 (#3450) (8a43a05)

Features

• support config .cts extension (#3461) (85ad18b)

17.3.0 (2022-11-21)

Features

• config-pnpm-scopes: implement config-pnpm-scopes (#3427) (ca3ae8b)

17.2.1 (2022-11-01)

Note: Version bump only for package @commitlint/root

17.2.0 (2022-10-31)

Bug Fixes

• update dependency cosmiconfig-typescript-loader to v4.1.0 (#3386) (9abd75f)

Features

• cli: add strict mode (#3384) (#3385) (fdff2be)
• config-nx-scopes: add nx version ^15.0.0 as peerDependency (#3416) (f529a3f)

17.1.2 (2022-08-29)

Bug Fixes

• load: add ts-node as direct dependency (#3351) (3b66891)
• update dependency cosmiconfig-typescript-loader to v4 (#3346) (5a9d80f)

17.1.1 (2022-08-27)

Bug Fixes

• load: peer-dep version #3345 (2dd7b50)

17.1.0 (2022-08-27)

Bug Fixes

• update dependency cosmiconfig-typescript-loader to v3 (#3253) (4e87d14)
• update dependency cosmiconfig-typescript-loader to v3.1.1 (#3282) (550ab3d)
• update dependency cosmiconfig-typescript-loader to v3.1.2 (#3343) (4213e9c)

Features

• commitlint: add additional git log args (#3334) (229c65b)

17.0.3 (2022-06-25)

Bug Fixes

• update dependency cosmiconfig-typescript-loader to v2.0.2 (#3250) (dfe69b0)

17.0.2 (2022-06-01)

Bug Fixes

• update dependency conventional-changelog-conventionalcommits to v5 (#3201) (c20fd19)
• update dependency cosmiconfig-typescript-loader to v2.0.1 (#3202) (9cf4b71)

17.0.1 (2022-05-25)

Bug Fixes

• cli: use core.commentChar from git config with --edit flag (#3191) (e5fee05), closes #3190 #3190 #3190

17.0.0 (2022-05-16)

Bug Fixes

• update dependency yargs to v17.5.1 (#3183) (8db72f0)

• chore!: minimum node version v14 (#3128) (ac5f9b4), closes #3128

BREAKING CHANGES

• drop node v12 support

• chore: rename circleci windows job

node version is not defned by the name anyways (i think)

16.3.0 (2022-05-14)

Bug Fixes

• update dependency cosmiconfig-typescript-loader to v2 (#3154) (20122e8)
• update dependency yargs to v17.5.0 (#3171) (0e6542b)

Features

• add ability to filter Nx projects in @commitlint/config-nx-scopes (#3155) (e595693), closes #3152

16.2.4 (2022-04-28)

Bug Fixes

• rules: footer-leading-blank should work with body comments (#3139) (7dd88c9)
• update dependency cosmiconfig to v7.0.1 (#3138) (407837d)
• update dependency cosmiconfig-typescript-loader to v1.0.7 (#3102) (d0f2b3f)
• update dependency cosmiconfig-typescript-loader to v1.0.9 (#3106) (d91e70d)
• update dependency fs-extra to v10.1.0 (#3124) (482613f)
• update dependency semver to v7.3.6 (#3112) (ad886fd)
• update dependency semver to v7.3.7 (#3119) (c9c49b2)
• update dependency yargs to v17.4.0 (#3080) (1477d7c)
• update dependency yargs to v17.4.1 (#3116) (69bf135)

16.2.3 (2022-03-16)

Bug Fixes

• update dependency @types/fs-extra to v9.0.13 (#3054) (4c7dd7c)
• update dependency cosmiconfig-typescript-loader to v1.0.6 (#3059) (256e194)
• update dependency fs-extra to v10.0.1 (#3041) (1236c83)
• update dependency git-raw-commits to v2.0.11 (#3055) (d5089f1)

16.2.2 (2022-02-14)

Note: Version bump only for package @commitlint/root

16.2.1 (2022-02-13)

Bug Fixes

• update dependency cosmiconfig-typescript-loader to v1.0.5 (#3020) (2d431a6)
• update dependency jest-environment-node to v27.5.0 (#3012) (a546128)
• update dependency jest-environment-node to v27.5.1 (#3018) (0cbf652)
• update dependency read-pkg to v7.1.0 (#3015) (3b7b680)
• load: satisfy @types/node peer dependency for cosmiconfig-loader-typescript (#3008) (338180c), closes #3007

16.2.0 (2022-01-25)

Bug Fixes

• update dependency cosmiconfig-typescript-loader to v1.0.4 (#2991) (043a059)

Features

• add support for Nx monorepos via @commitlint/config-nx-scopes (#2995) (11879ad)

16.1.0 (2022-01-20)

Features

• load: accept functions as parser presets (#2982) (420e8d6), closes #2964 #2964

16.0.3 (2022-01-19)

Bug Fixes

• commit body should be empty by default (#2980) (e6582e0)

16.0.2 (2022-01-09)

Bug Fixes

• update dependency conventional-changelog-conventionalcommits to v4.6.3 (#2938) (0231f4b)
• update dependency conventional-commits-parser to v3.2.4 (#2939) (a484a9a)
• update dependency cosmiconfig-typescript-loader to v1.0.3 (#2956) (cc6e6cd)
• update dependency jest-environment-node to v27.4.6 (#2957) (62a0867)

16.0.1 (2021-12-28)

Bug Fixes

• update dependency @types/tmp to v0.2.3 (#2928) (8eeb1f4)
• update dependency conventional-changelog-conventionalcommits to v4.6.2 (#2934) (a239b9e)
• update dependency cosmiconfig-typescript-loader to v1.0.2 (#2929) (04cc88c)
• update dependency yargs to v17.3.1 (#2935) (8e099af)

16.0.0 (2021-12-26)

Bug Fixes

• is-ignored: ignore merge tag commit messages (#2920) (914782a)
• update dependency @types/tmp to v0.2.2 (#2903) (d2f146c)
• update dependency conventional-commits-parser to v3.2.3 (#2904) (3a98d3c)
• cz-commitlint: combine commit body with issuesBody/breakingBody when body has an empty string (#2915) (a038b41)
• docs: minor changes to guides (#2913) (499efd1)
• update dependency conventional-changelog-conventionalcommits to v4.6.1 (#2906) (1d1ccfa)
• update dependency cosmiconfig to v7.0.1 (#2905) (2c33c98)
• update dependency jest-environment-node to v27.4.2 (#2907) (c3b29ba)
• update dependency yargs to v17.3.0 (#2908) (a387494)

Features

• config-rush-scopes: add config for rush monorepo (#2878) (befa677)
• cz-commitlint: support select scope with radio list by setting disableMultipleScopes (#2911) (9d8d73f), closes #2782
• config validation (#2412) (c717202), closes #327

BREAKING CHANGES

• cz-commitlint: users who is using multiple scopes need to set enableMultipleScopes to true

15.0.0 (2021-11-17)

Bug Fixes

• prompt: correct import kind in prompt package (#2852) (45bf394)
• prompt: correct version of internal dependencies in prompt package #2697 (#2851) (b1155ca)
• types: fix signature of QualifiedRuleConfig for async configurations (#2868) (#2869) (c7f355b)

Features

• simplify config resolution (#2398) (8a8384f), closes #327

Tests

• config-lerna-scopes: reuse npm bootstrap to simplify tests (#2479) (9a7a43a), closes #2447

BREAKING CHANGES

• config-lerna-scopes: upgrade to lerna v4

Co-authored-by: Renovate Bot bot@renovateapp.com Co-authored-by: escapedcat github@htmlcss.de

• test(config-lerna-scopes): reuse npm bootstrap to simplify tests

• test(config-lerna-scopes): reuse npm bootstrap to simplify tests

• test: fix issue after merge

• test: one more fix after merge

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Renovate Bot bot@renovateapp.com Co-authored-by: escapedcat github@htmlcss.de

8.3.6 (2021-11-17)

Note: Version bump only for package @commitlint/root

chore: update lodash to 4.17.21 SECURITY: CVE-2021-23337 in package lodash https://nvd.nist.gov/vuln/detail/CVE-2021-23337

14.2.0 (2021-11-06)

Features

• prompt: rewrite codebase to use inquirer - UPDATED with current master (#2697) (5105f43)

14.1.0 (2021-11-01)

Features

• extend helpUrl from shareable config (#2846) (d7e2e2b)
• load: add support for .commitlintrc.cjs and commitlint.config.cjs files (#2797) (fabb495)

14.0.0 (2021-10-26)

• support multiple scopes and multiple cases & fix sentence-case is not consistent with commitlint/cli (#2806) (2c71a7e), closes #2806 #2782

BREAKING CHANGES

• add prompt.settings configuration

13.2.1 (2021-10-09)

Bug Fixes

• load: added a direct dependency on typescript (#2785) (9c17f8d), closes EndemolShineGroup/cosmiconfig-typescript-loader#147 #2779

13.2.0 (2021-09-28)

Bug Fixes

• parse: enforce secure version of conventional-commits-parser (#2776) (a351801)
• update dependency read-pkg to v7 (#2721) (7d9a3b1)
• types: prompt messages key (4825a52)
• types: prompt messages props optional (0bd0592)
• types: user config prompt (6d7a1c4)

Features

• load: add cosmiconfig typescript loader (b65aced)

13.1.0 (2021-07-24)

Bug Fixes

• cz-commitlint: fix minor formatting issues (99d8881)
• types: adds TargetCaseType[] for CaseRuleConfig (c3bef38)
• update dependency import-from to v4 (#2629) (5bcb604)
• cli: remove hard coded comment char with linting COMMIT_EDIT_MSG (#2618) (5badf6d), closes #2351

Features

• rules: allow body-case to accept an array of cases (5383c9e), closes #2631

13.0.0 (2021-05-24)

Bug Fixes

• update dependency chalk to v4.1.1 (#2608) (f41b123)
• update dependency yargs to v17.0.1 (#2609) (afbfd10)

Features

• add subject-exclamation-mark rule to improve error messages (#2593) (be701bd)

• rules: add trailer-exists rule (#2578) (cd3816d)

• chore!: remove node 10 support (#2596) (4db4ba1), closes #2596

BREAKING CHANGES

• minimum node version is 12

12.1.3 (2021-05-12)

Bug Fixes

• update dependency fs-extra to v10 (#2575) (d47d2b5)
• update dependency yargs to v17 (#2574) (81c38dd)

12.1.2 (2021-04-29)

Bug Fixes

• rules: fix subject-full-stop rule config value type (#2534) (2ab3c57)
• types: update chalk import (#2535) (89f9a6d)

12.1.1 (2021-04-02)

Bug Fixes

• update dependency read-pkg to v6 (#2530) (d38a2ad)
• config-lerna-scopes: ignore packages without names (#2514) (df3bf71)
• update dependency semver to v7.3.5 (#2519) (5113f22)
• prompt: modify the entry point to pass commitizen's function check (#2501) (0173fb7), closes /github.com/conventional-changelog/commitlint/issues/2486#issuecomment-791682272 /github.com/conventional-changelog/commitlint/issues/2486#issuecomment-791682272

12.1.0 (2021-03-06)

Features

• config-lerna-scopes: keep supporting lerna v3 (51b0f4a)

12.0.1 (2021-02-23)

Bug Fixes

• update dependency conventional-commits-parser to v3.2.1 (#2459) (8bcc4f0)
• load: use Rule | AsyncRule | SyncRule as rule value type in Plugin (#2146) (75b67b8)
• types: correct chalkColor type (#2420) (ef8bdad)
• update dependency throat to v6 (#2417) (6f7db1b)

12.0.0 (2021-01-18)

Bug Fixes

• remove unnecessary react babel transforms (#2399) (78f02fd)
• utils: update code to allow it to be executed (#982) (52696d0)
• update dependency @types/fs-extra to v9.0.2 (#2250) (a10fa0b)
• update dependency @types/fs-extra to v9.0.5 (#2360) (3266712)
• update dependency conventional-changelog-angular to v5.0.12 (#2361) (5766b39)
• update dependency conventional-changelog-conventionalcommits to v4.4.0 (#2115) (bccc9f5)
• update dependency conventional-changelog-conventionalcommits to v4.5.0 (#2362) (01c78bf)
• update dependency execa to v4.1.0 (#2251) (b5743dd)
• update dependency execa to v5 (#2341) (f349df9)
• update dependency git-raw-commits to v2.0.7 (#2116) (ef969f3)
• update dependency git-raw-commits to v2.0.8 (#2364) (3371715)
• update dependency meow to v8 (#2245) (890961b)
• update dependency meow to v8.1.0 (#2380) (0fbadcf)
• update dependency pkg-dir to v5 (#2168) (b9d1c84)
• update dependency semver to v7.3.4 (#2336) (790b61a)
• update dependency tar-fs to v2.1.1 (#2261) (a04f24f)
• is-ignored: ignore azure devops messages (#2230) (fe29ce7)
• update dependency yargs to v16 (204f36d)
• update dependency yargs to v16.1.0 (#2252) (6478d07)
• resolve-extends: extends field should be resolved from left to right (#2070) (c0a86f5)

Features

• cli: implement print-config cli flag (#2391) (8626883)
• config-lerna-scopes: support yarn workspaces (#2149) (b244246)
• load: allow specifying helpUrl via config (#2180) (d6795a3)
• rules: add body-full-stop rule (#2144) (7767ca2)

BREAKING CHANGES

• resolve-extends: The order of the extends resolution is changed from right-to-left to left-to-right

11.0.0 (2020-09-05)

Bug Fixes

• cli: remove default value from edit option #2065 (3d4116d)
• rules: ignore comments in signed-off-by (#2098) (b610bcd)

• update dependency @types/fs-extra to ^9.0.1 (#2088) (cb1028e)

• refactor!: drop support for lerna v2 (59667b3)

BREAKING CHANGES

• remove lerna v2 support and tests

10.0.0 (2020-08-16)

Bug Fixes

• update dependency (#1993) (32667e8)
• update dependency cosmiconfig to v7 (#2044) (f4db933)
• update dependency execa to v4 (#1936) (8efb441)
• update dependency find-up to v5 (#2060) (25d42f4)
• update dependency fs-extra to v9 (#1018) (2df49fa)

• update dependency get-stdin to v8 (#1938) (f94a5c8)

• refactor!: drop support for node 8 (#1999) (751f39f), closes #1999

BREAKING CHANGES

• remove node 8 from circle-ci checks

also remove node 13 because we do not support experimental versions

• docs: update node v10 to latest LTS 10 version

Co-authored-by: Cedric van Putten me@bycedric.com

Co-authored-by: Cedric van Putten me@bycedric.com

9.1.2 (2020-07-13)

Note: Version bump only for package @commitlint/root

9.1.1 (2020-06-30)

Bug Fixes

• load: resolve plugins from extended configs (#1976) (d0f0eb9)
• mark internal packages as private #972 (#1970) (2351124)

9.1.0 (2020-06-21)

Bug Fixes

• update dependency chalk to v4 (#1275) (a5d8fa1)
• update dependency conventional-changelog-conventionalcommits to v4.3.0 (#1816) (f99aeda)
• update dependency regenerator-runtime to v0.13.5 (#1017) (9c4fdf1)
• update dependency semver to v7.3.2 (#1369) (3c09722)
• update dependency tar-fs to v2.1.0 (#1103) (7882036)
• update dependency tmp to v0.2.1 (#1817) (0ff72f4)

Features

• add local plugins support (#1692) (7b29c48)
• enable multiple scopes in scope-enum and scope-case rules (#901) (73632ce)

9.0.1 (2020-05-26)

Bug Fixes

• add missing @babel/runtime dep #1738 (#1754) (09afcd6)

9.0.0 (2020-05-21)

Bug Fixes

• cli: add missing regenerator-runtime to dependencies (#919) (ee5eac9)
• #840 add caret to lodash versions (#843) (ffc0bac)
• drop support for 'improvement' type (#899) (b27ab08)
• config-lerna-scopes: correct lerna in peerDependencies (#980) (f88f00d)
• ignore empty commit messages #615 (#676) (c3eb1a7)
• incorrect use of when in getForcedCaseFn (#993) (34c11b8)
• update dependency semver to v7.1.3 (#995) (4ee307a)

Features

• add async promise based rules methods into lint (#976) (4443062)
• add possibility to extend from string (#865) (056c6fe)
• passdown argv to lint command (#891) (c49a57c)
• config-conventional: footer/body-max-line (#436) (8b394c9)
• config-conventional: increase header-max-length to 100 (#860) (ff11998), closes #859

BREAKING CHANGES

• 'improvement' type will now be rejected by this config.

8.3.5 (2020-01-15)

Bug Fixes

• is-ignored: move types to dev dependencies (#897) (aabc549)
• resolve-extends: move node types to dev dependencies (#883) (b131a18), closes #874

8.3.4 (2020-01-03)

Bug Fixes

• commitlint: use new read pkg syntax (#888) (6b3b9a9)

8.3.1 (2019-10-16)

Bug Fixes

• load: resolve nested parser preset factories (#831) (73a7df7)

8.3.0 (2019-10-16)

Features

• cli: add helpurl flag (#789) (75cef4e)
• config-conventional: use parser with short breaking change support (#821) (4b5300a)
• resolve-extends: accept absolute path in extends (#825) (ecac29f)

8.2.0 (2019-09-16)

This release is versioned as minor change because some of the core components are rewritten to TypeScript. It's part of the full port to TypeScript, currently in progress at #659.

Bug Fixes

• pass defaultIgnores from configuration in @commitlint/cli (#771) (a259014)

8.1.0 (2019-07-15)

This release is versioned as minor change because some of the core components are rewritten to TypeScript. It's part of the full port to TypeScript, currently in progress at #659.

Bug Fixes

• add explicit dependency on chalk (#687) (9075844)
• pass ignores from configuration in @commitlint/cli (#668) (da99aaa)

8.0.0

Breaking Changes

• fix: avoid excessive help text #606 (#637) The commitlint default formatter is now silent for reports without warnings or errors. Scripts relying on the success output of commitlint can restore the former output by specifying the --verbose flag.

7.6.2

• Republish packages with out of sync artifacts

7.6.1 (2019-05-09)

Bug Fixes

• ensure format() is available as commonjs default export #645 (ec3da92)
• handle absolute config paths correctly #647 (49b3a77)

7.6.0 (2019-05-06)

Bug Fixes

• add @lerna/project to repository dependencies (#598) (56f03ee)
• address security warnings for dev dependencies (3e0d824)
• avoid excessive help text #606 (#637) (8f3c3b1)
• don't merge array properties with custom opts (#616) (f321647), closes #594
• remove unneeded dev dependency (6ccaf79)
• update cosmiconfig to safe >=5 #599 (f186fcb)
• use sander.readFile correctly (#448) (#630) (8e47985)

Features

• resolve-extends: accept short scoped package names in extends (#597) (ba90e8e)
• adds support for plugins (#228) (#588) (cea4564)
• config based is-ignored overrides (#595) (2434d71)

7.5.2 (2019-02-11)

Bug Fixes

• failing sentence-case for subjects with slashes (#574) (48a8602)
• cli: replace old links with new organisation links (#578) (4075903)

7.5.1 (2019-02-09)

Bug Fixes

• is-ignored: ignore bitbuckets automatic merge (#573) (e5bdc5c)

7.5.0 (2019-01-31)

Bug Fixes

• sentence-case allow upper-case characters in first word (#531) (5a6a4a8), closes #211
• resolve-extends: override array on extending rules (#470) (#539) (b35000c)
• all broken website references (#564) (82eeb5a)
• cleanup message for input with no config (#519) (7d9e760)
• cli: avoid linebreak in empty input (#523) (3141882)
• mark optional parameter with undefined (#553) (6720284)
• replace all repository references with conventional changelog (#561) (6c3afcd)
• replace all website references with conventional changelog (#563) (6b86fb1)
• replace old require-uncached with import-fresh (#533) (b636e8c)
• resolve path to commit message for git submodules (83b1a47)
• slash in scope #291 (#529) (b2b63e5)
• store concatenated array to problems variable (#551) (434a70f)

Features

• add support for git submodules (cc575fa)
• rule-header-length: show current header length (6d61c4f)

7.4.0 (2019-01-27)

Bug Fixes

• correction to need help link (#540) (fa6168a)

Features

• rules: create header-case and header-full-stop rules (#547) (4c36cbd)

7.3.2 (2019-01-15)

Bug Fixes

• move loadsh to dependencies (1bb66a4)

7.3.1 (2019-01-11)

Note: Version bump only for package @commitlint/root

7.3.0 (2019-01-11)

Bug Fixes

• format: add new line to result (#518) (f1d443b), closes #504
• add fallback with husky git params to deprecation handling (#498) (5a34b8c)
• avoid truncated output on macOS (#503) (3192368)
• fall back to conventional commit-parser settings for missing keys (#496) (831a141), closes #399
• respect String.protoype.repeat API contract (f27e7ac)
• update to security-patched dependency versions (97c033b)
• use correct label for failing empty subjects (#481) (2e7e34d), closes #476

Features

• check stage before entering prompt (#495) (3b3667a), closes #51 #51
• warn on empty config (#491) (b6bd36e), closes #107 #107

7.2.1 (2018-10-11)

Bug Fixes

• improve format module resolving (#464) (baed8b1)

7.2.0 (2018-10-05)

Bug Fixes

• rules: include possible body offset in footer leading blank (ff0111a)
• handle case rules for numerics correctly (cadcfed)
• ignore merge messages with text after newline (b32bc93)
• use grouped regex to ignore merge commits (#439) (905e9d5)

Features

• cli: add format option for report output (1ecf097)
• load: add formatter option with default value (b0e63d9)

7.1.2 (2018-09-04)

Note: Version bump only for package @commitlint/root

7.1.0 (2018-08-29)

Features

• wildcards: add new wildcard patterns #315 (e9ea17f)
• add max line length to body/footer (542f50e)

6.2.0 (2018-05-01)

Features

• print commit message when the message is invalid (86c34f1), closes #222
• rules: support array for scope-case and type-case (#312) (1f46b9f), closes #307

6.1.1 (2018-02-22)

Bug Fixes

• ensure: ignore word delimiters for case matching #291 (fa69299)

6.1.0 (2018-02-03)

Bug Fixes

• parse: default to angular preset for empty parserOpts (#265) (ccb03b4), closes #262

Features

• add "--config" option (#261) (2c03ec6)

6.0.5 (2018-01-31)

Bug Fixes

• remove utils from prod dependencies (4fb858a)

6.0.4 (2018-01-31)

Bug Fixes

• remove faulty bin entry #259 (beafbc6)

6.0.3 (2018-01-31)

Bug Fixes

• update dependency cosmiconfig to ^4.0.0 (#234) (7f94ac5)
• update dependency semver to v5.5.0 (#236) (6c52bd9)

6.0.2 (2018-01-12)

Bug Fixes

• ignore branch merges with multiple newlines (#227) (1f0c5ca)
• remove typo in error message of type-case (cb577cb)

6.0.1 (2018-01-09)

Note: Version bump only for package @commitlint/root

6.0.0 (2018-01-09)

Bug Fixes

• allow [0] shorthand (84cf938)
• correctly resolve parserOpts #115 #95 (1353dd5)
• ignore branch merges with newlines (#214) (c94c4dc)
• sanitize ensure.case #211 (#217) (03aeefc)

Styles

• validate rule configuration (edf7187)

BREAKING CHANGES

• Due to additional validation while reading commitlint config, previously ignored rule settings are now considered critical errors when starting the CLI. The new behaviour is designed to help developers find issues with their configuration quicker.

5.2.6 (2017-12-21)

Bug Fixes

• ignore semver commits with chore type (cdbb085), closes #198

5.2.5 (2017-12-08)

Bug Fixes

• core: use correct report message #192 (e3a78bc)

5.2.4 (2017-12-08)

Note: Version bump only for package @commitlint/root

5.2.3 (2017-12-05)

Bug Fixes

• cli: add support for GIT_PARAMS on windows (c62bd41), closes #103 #175

5.2.2 (2017-11-30)

Bug Fixes

• travis-cli: read push commits directly (9bc56c6)

5.2.1 (2017-11-30)

Bug Fixes

• travis-cli: lint ranges only for pr builds (85b201f)

5.2.0 (2017-11-30)

Bug Fixes

• consider pull requests from forks (4653c2c)

Features

• babel-preset-commitlint: add jsx tranform (#163) (5190241)

5.1.3 (2017-11-24)

Bug Fixes

• config-conventional: add missing applicable attribute to type-enum (a8db0b1)

5.1.2 (2017-11-24)

Bug Fixes

• prompt: apply forced cases properly (3a569a7), closes #145

5.1.1 (2017-11-24)

Bug Fixes

• set access for npm (8aeaec2)

5.1.0 (2017-11-24)

Bug Fixes

• update dependency concurrently to v3.5.1 (#147) (a809d0f)
• config-conventional: remove unneeded dependency (d0e62fd)

Features

• prompt: add description for build, ci and revert (#148) (ee6ec6e)
• travis-cli: add reusable travis command line interface (3e6e6a8)
• add conventional-changelog package (8bb0a85)

5.0.1 (2017-11-19)

Bug Fixes

• core: fall back to globally installed config if available (#127) (8612eb3)

5.0.0 (2017-11-18)

Bug fixes

• core: interprets array values for subject-case correctly

Features

• config-angular: disallow subject with uppercase first character, #114
• config-angular-type-enum: remove chore type

BREAKING CHANGE

TL;DR

• chore is no longer a valid commit type
• subject with leading capitalized letter are forbidden now

Angular has removed the chore type from their conventions as of January 2017

See angular/angular@dff6ee for reference

This removes the previous chore type from the list of allowed types.

Projects using the Angular commit convention will identify commits with chore type as faulty.

Also, formerly working commit messages are now considered problems:

• type: SOME MESSAGE
• type: SomeMessage
• type: Some Message

4.3.0 (2017-11-08)

Bug Fixes

• core: deprecate nlp rules (bbab1d8), closes #54
• core: ignore comments (f3beda1), closes #78

Features

• add references-empty rule (4fc8d5d)