Skip to content
Back to search

commitlint

πŸ““ Lint commit messages

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/conventional-changelog/commitlint with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/conventional-changelog/commitlint'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/conventional-changelog--commitlint/badge.svg)](/listings/conventional-changelog--commitlint)

HTML

<a href="/listings/conventional-changelog--commitlint"><img src="/api/listings/conventional-changelog--commitlint/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

git clone git@github.com:conventional-changelog/commitlint.git
cd commitlint
pnpm install
pnpm build # run build tasks
pnpm start # rebuild on change (tsc -b --watch)
node @commitlint/cli/cli.js # run CLI

For more information on how to contribute please take a look at our [contribution guide](./.github/CONTRIBUTING.md).

[0]: https://img.shields.io/badge/stability-stable-green.svg?style=flat-square [1]: https://nodejs.org/api/documentation.html#documentation_stability_index [2]: https://img.shields.io/npm/v/@commitlint/cli.svg?style=flat-square [3]: https://npmjs.org/package/@commitlint/cli [4]: https://github.com/conventional-changelog/commitlint/actions/workflows/CI.yml/badge.svg [5]: https://github.com/conventional-changelog/commitlint/actions/workflows/CI.yml [8]: https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square [9]: https://nodejs.org/api/documentation.html#documentation_stability_index [10]: https://img.shields.io/npm/v/@commitlint/cli/next.svg?style=flat-square [13]: https://img.shields.io/node/v/@commitlint/cli.svg [14]: https://nodejs.org/en/about/previous-releases

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md Β· README Β· 213 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # [Get Started](https://commitlint.js.org/guides/getting-started) | [Website](https://commitlint.js.org)
  2. > Lint commit messages
  3. <p align="center">
  4. <img width="600" src="docs/public/assets/commitlint.svg">
  5. </p>
  6. > Demo generated with [svg-term-cli](https://github.com/marionebl/svg-term-cli)
  7. >
  8. > `cat docs/assets/commitlint.json | svg-term --out docs/public/assets/commitlint.svg --frame --profile=Seti --height=20 --width=80`
  9. [![npm latest][2]][3] [![node compatibility][13]][14] [![Github Actions][4]][5]
  10. - πŸš“ Be a good `commitizen`
  11. - πŸ“¦ Share configuration via `npm`
  12. - πŸ€– Tap into `conventional-changelog`
  13. ## Contents
  14. - [Get Started | Website](#get-started--website)
  15. - [Contents](#contents)
  16. - [What is commitlint](#what-is-commitlint)
  17. - [Benefits of using commitlint](#benefits-of-using-commitlint)
  18. - [Getting started](#getting-started)
  19. - [CLI](#cli)
  20. - [Config](#config)
  21. - [Shared configuration](#shared-configuration)
  22. - [Documentation](#documentation)
  23. - [API](#api)
  24. - [Tools](#tools)
  25. - [Roadmap](#roadmap)
  26. - [Version Support and Releases](#version-support-and-releases)
  27. - [Releases](#releases)
  28. - [Related projects](#related-projects)
  29. - [License](#license)
  30. - [Development](#development)
  31. - [Install and run](#install-and-run)
  32. ---
  33. ## What is commitlint
  34. commitlint checks if your commit messages meet the [conventional commit format](https://conventionalcommits.org).
  35. In general the pattern mostly looks like this:
  36. ```sh
  37. type(scope?): subject #scope is optional; multiple scopes are supported (current delimiter options: "/", "\" and ",")
  38. ```
  39. Real world examples can look like this:
  40. ```text
  41. chore: run tests on travis ci
  42. ```
  43. ```text
  44. fix(server): send cors headers
  45. ```
  46. ```text
  47. feat(blog): add comment section
  48. ```
  49. Common types according to [commitlint-config-conventional (based on the Angular convention)](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional#type-enum) can be:
  50. - build
  51. - chore
  52. - ci
  53. - docs
  54. - feat
  55. - fix
  56. - perf
  57. - refactor
  58. - revert
  59. - style
  60. - test
  61. These can be modified by [your own configuration](#config).
  62. ### Benefits of using commitlint
  63. - [Why Use Conventional Commits?](https://www.conventionalcommits.org/en/v1.0.0-beta.2/#why-use-conventional-commits)
  64. - ["The perks of committing with conventions" (Talk slides)](https://slides.com/marionebl/the-perks-of-committing-with-conventions#/)
  65. ## Getting started
  66. - [Local setup](https://commitlint.js.org/guides/local-setup) - Lint messages on commit with husky
  67. - [CI setup](https://commitlint.js.org/guides/ci-setup) - Lint messages during CI builds
  68. ## CLI
  69. - Primary way to interact with commitlint.
  70. - `npm install --save-dev @commitlint/cli`
  71. - Packages: [cli](./@commitlint/cli)
  72. ## Config
  73. - Configuration is picked up from:
  74. - `.commitlintrc`
  75. - `.commitlintrc.json`
  76. - `.commitlintrc.yaml`
  77. - `.commitlintrc.yml`
  78. - `.commitlintrc.js`
  79. - `.commitlintrc.cjs`
  80. - `.commitlintrc.mjs`
  81. - `.commitlintrc.ts`
  82. - `.commitlintrc.cts`
  83. - `.commitlintrc.mts`
  84. - `commitlint.config.js`
  85. - `commitlint.config.cjs`
  86. - `commitlint.config.mjs`
  87. - `commitlint.config.ts`
  88. - `commitlint.config.cts`
  89. - `commitlint.config.mts`
  90. - `commitlint` field in `package.json`
  91. - `commitlint` field in [`package.yaml`](https://github.com/pnpm/pnpm/pull/1799)
  92. - Packages: [cli](./@commitlint/cli), [core](./@commitlint/core)
  93. - See [Rules](./docs/reference/rules.md) for a complete list of possible rules
  94. - An example configuration can be found at [@commitlint/config-conventional](./@commitlint/config-conventional/src/index.ts)
  95. ## Shared configuration
  96. A number of shared configurations are available to install and use with `commitlint`:
  97. - [@commitlint/config-angular](./@commitlint/config-angular)
  98. - [@commitlint/config-conventional](./@commitlint/config-conventional)
  99. - [@commitlint/config-lerna-scopes](./@commitlint/config-lerna-scopes)
  100. - [@commitlint/config-nx-scopes](./@commitlint/config-nx-scopes)
  101. - [@commitlint/config-patternplate](./@commitlint/config-patternplate)
  102. - [@commitlint/config-workspace-scopes](./@commitlint/config-workspace-scopes)
  103. - [conventional-changelog-lint-config-atom](https://github.com/erikmueller/conventional-changelog-lint-config-atom)
  104. - [conventional-changelog-lint-config-canonical](https://github.com/gajus/conventional-changelog-lint-config-canonical)
  105. > ⚠️ 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`.
  106. ## Documentation
  107. Check the [main website](https://commitlint.js.org/).
  108. ## API
  109. - Alternative, programmatic way to interact with `commitlint`
  110. - Packages:
  111. - [format](./@commitlint/format) - Format commitlint reports
  112. - [lint](./@commitlint/lint) - Lint a string against commitlint rules
  113. - [load](./@commitlint/load) - Load shared commitlint configuration
  114. - [read](./@commitlint/read) - Read commit messages from a specified range or last edit
  115. - See [API](./docs/api) for a complete list of methods and examples
  116. ## Tools
  117. - [commitizen adapter](./@commitlint/prompt)
  118. - [prompt](./@commitlint/prompt-cli)
  119. ## Roadmap
  120. `commitlint` is considered stable and is used in various projects as a development tool.
  121. > **Ideas**: [conventional-changelog/commitlint#94](https://github.com/conventional-changelog/commitlint/issues/94)
  122. ## Version Support and Releases
  123. - Node.js [LTS](https://github.com/nodejs/LTS#lts-schedule) `>= 22.12.0`
  124. - git `>= 2.13.2`
  125. ### Releases
  126. 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.\
  127. If you are stuck on an older version and need a security patch we're happy if you can provide a PR.
  128. ## Related projects
  129. - [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)
  130. Generate a changelog from conventional commit history
  131. - [commitizen](https://github.com/commitizen/cz-cli)
  132. Simple commit conventions for internet citizens
  133. - [create-semantic-module](https://github.com/jlegrone/create-semantic-module)
  134. CLI for quickly integrating commitizen and commitlint in new or existing projects
  135. ## License
  136. Copyright by @marionebl. All `commitlint` packages are released under the MIT license.
  137. ## Development
  138. `commitlint` is developed in a mono repository.
  139. ### Install and run
  140. ```sh
  141. git clone git@github.com:conventional-changelog/commitlint.git
  142. cd commitlint
  143. pnpm install
  144. pnpm build # run build tasks
  145. pnpm start # rebuild on change (tsc -b --watch)
  146. node @commitlint/cli/cli.js # run CLI
  147. ```
  148. For more information on how to contribute please take a look at our [contribution guide](./.github/CONTRIBUTING.md).
  149. [0]: https://img.shields.io/badge/stability-stable-green.svg?style=flat-square
  150. [1]: https://nodejs.org/api/documentation.html#documentation_stability_index
  151. [2]: https://img.shields.io/npm/v/@commitlint/cli.svg?style=flat-square
  152. [3]: https://npmjs.org/package/@commitlint/cli
  153. [4]: https://github.com/conventional-changelog/commitlint/actions/workflows/CI.yml/badge.svg
  154. [5]: https://github.com/conventional-changelog/commitlint/actions/workflows/CI.yml
  155. [8]: https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square
  156. [9]: https://nodejs.org/api/documentation.html#documentation_stability_index
  157. [10]: https://img.shields.io/npm/v/@commitlint/cli/next.svg?style=flat-square
  158. [13]: https://img.shields.io/node/v/@commitlint/cli.svg
  159. [14]: https://nodejs.org/en/about/previous-releases

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.