@nesvel/commitlint-config
v1.0.3
Published
Shared commitlint configuration for enterprise NestJS monorepos with Conventional Commits and Commitizen support
Maintainers
Readme
@nesvel/commitlint-config
Shared commitlint configuration for the Nesvel monorepo. Enforces Conventional Commits specification.
Installation
pnpm add -D @commitlint/cli @nesvel/commitlint-configUsage
Create commitlint.config.js in your project root:
export default {
extends: ['@nesvel/commitlint-config'],
};Or in commitlint.config.json:
{
"extends": ["@nesvel/commitlint-config"]
}Commit Message Format
<type>(<scope>): <subject>
[optional body]
[optional footer]Types
- feat: New feature
- fix: Bug fix
- docs: Documentation changes
- style: Code style changes (formatting, semicolons, etc.)
- refactor: Code refactoring (no feat/fix)
- perf: Performance improvements
- test: Adding or updating tests
- build: Build system or dependency changes
- ci: CI/CD configuration changes
- chore: Maintenance tasks
- revert: Revert previous commit
- release: Release commits
Scopes
- api: API application
- admin: Admin application
- shared: Shared packages
- tools: Tool packages (eslint, jest, etc.)
- config: Configuration changes
- deps: Dependency updates
- monorepo: Monorepo-wide changes
- release: Release-related changes
Examples
feat(api): add user authentication endpoint
fix(admin): resolve dashboard loading issue
docs(readme): update installation instructions
chore(deps): upgrade nestjs to v10
refactor(shared): simplify error handling logic
test(api): add unit tests for auth service
ci(github): update workflow to use pnpm
perf(api): optimize database queriesRules
- Header max length: 100 characters
- Subject must be lowercase
- Subject must not end with a period
- Type and scope must be lowercase
- Type is required
- Scope is required (for better monorepo organization)
