Commitlint configuration with emoji support and custom nx scope resolution.
npm install collide-commitlintCommitlint configuration with emoji support and NX workspace scope resolution.
- 🎨 Emoji prefixes in commit messages
- 🔍 Automatic NX workspace scope validation
- 📋 Based on conventional commits
- 💬 Interactive commit prompts with Commitizen
``bashnpm
npm install --save-dev collide-commitlint
> 💡 Note: Install as a dev dependency since commitlint is a development tool used for validating commit messages during development and in CI/CD pipelines.
🚀 Quick Start
Create
in your project root:`typescript
import { commitlint } from 'collide-commitlint';export default commitlint();
`📖 Usage
$3
typescript
import { commitlint } from 'collide-commitlint';export default commitlint({
// Your custom commitlint rules
rules: {
'subject-max-length': [2, 'always', 100],
},
});
`$3
By default, emojis are enabled. Commits will look like:
text
✨ feat(auth): add login functionality
🐛 fix(api): handle null responses
📚 docs(readme): update installation guide
`Disable emojis:
typescript
export default commitlint({
emoji: {
enabled: false,
},
});
`Custom emoji mappings:
typescript
export default commitlint({
emoji: {
customEmojis: {
feat: '🎉',
fix: '🔥',
docs: '📝',
},
},
});
`$3
Automatically validates commit scopes against your NX project names:
typescript
export default commitlint({
nxScopes: {
// Add custom scopes beyond NX projects
customScopes: ['workspace', 'deps'], // Filter which NX projects are valid scopes
filter: project => {
return project.projectType === 'library';
},
// Trim scoped package names
// "@scope/my-package" → "my-package"
trimProjectPrefix: true,
},
});
`Default Emojis
| Type | Emoji | Description |
| -------- | ----- | ------------------------ |
| feat | ✨ | New feature |
| fix | 🐛 | Bug fix |
| docs | 📚 | Documentation |
| style | 💎 | Code style changes |
| refactor | ♻️ | Code refactoring |
| perf | 🚀 | Performance improvements |
| test | 🧪 | Tests |
| build | 🏗️ | Build system |
| ci | 👷 | CI configuration |
| chore | 🔧 | Maintenance tasks |
| revert | ⏪ | Revert previous commit |
Interactive Commits
Create a
file in your project root:`json
{
"path": "@commitlint/cz-commitlint"
}
`Then use Commitizen for interactive commit prompts:
bash
npx cz
`The prompts will include emoji selection and scope validation based on your commitlint configuration.
Advanced API
$3
typescript
import { createEmojiParser, createEmojiEnum } from 'collide-commitlint';const parser = await createEmojiParser({
customEmojis: { feat: '🎉' },
});
`$3
typescript
import { createNxScopesRule } from 'collide-commitlint';const scopeRule = createNxScopesRule({
customScopes: ['workspace'],
trimProjectPrefix: true,
});
`TypeScript Support
Full TypeScript support with exported types:
typescript
import type {
ICommitlintConfigOptions,
IEmojiConfig,
INxScopesConfig,
INxProjectFilter,
TEmojiType,
} from 'collide-commitlint';
``MIT