Features

- Gitmoji commit convention
- Enforces consistent commit message format
- Compatible with semantic-release

Installation

``bash
pnpm add -D @lobehub/commitlint-config @commitlint/cli
`

Usage

Create commitlint.config.js (or .commitlintrc.js) in your project root:

`js
import config from '@lobehub/commitlint-config';

export default config;
`

Or for CommonJS:

`js
module.exports = require('@lobehub/commitlint-config').default;
`

Commit Format

`
:emoji: type(scope): subject

body

footer
`

$3

`
:sparkles: feat(auth): add OAuth2 support

Implement OAuth2 authentication flow with Google and GitHub providers.

Closes #123
`

`
:bug: fix(api): resolve race condition in data fetching
`

`
:memo: docs: update installation guide
`

Setting Up Git Hooks

With Husky:

`bash
pnpm add -D husky
pnpm husky init
echo "pnpm commitlint --edit \$1" > .husky/commit-msg
``

Requirements

- Node.js >= 18
- @commitlint/cli >= 19.0.0

License

MIT © LobeHub

[github-license-link]: https://github.com/lobehub/lobe-lint/blob/master/LICENSE
[github-license-shield]: https://img.shields.io/github/license/lobehub/lobe-lint?color=white&labelColor=black&style=flat-square
[npm-downloads-link]: https://www.npmjs.com/package/@lobehub/commitlint-config
[npm-downloads-shield]: https://img.shields.io/npm/dt/@lobehub/commitlint-config?labelColor=black&style=flat-square
[npm-release-link]: https://www.npmjs.com/package/@lobehub/commitlint-config
[npm-release-shield]: https://img.shields.io/npm/v/@lobehub/commitlint-config?color=369eff&labelColor=black&logo=npm&logoColor=white&style=flat-square