@next-friday/commitlint-config-friday
v3.0.0
Published
Deterministic Commitlint configuration for Next Friday projects.
Maintainers
Readme
@next-friday/commitlint-config-friday
One strict Conventional Commit contract that keeps repository history predictable, machine-readable, and automation-friendly.
- Scope is explicit and required.
- Commit shape is deterministic instead of team-dependent.
- The package owns policy; repositories remain free to choose their hook and CI integration.
Usage
Extend the config directly:
{
"extends": ["@next-friday/commitlint-config-friday"]
}Or re-export it from an ESM config:
import fridayCommitlint from "@next-friday/commitlint-config-friday";
export default fridayCommitlint;The package defines policy only. Hook and CI integration remain owned by the consuming repository.
Commit contract
<type>(<scope>): <subject>Examples:
feat(api): add booking endpoint
fix(ui): handle empty state
docs(readme): clarify usageScope is required and lowercase. Subject is required, limited to 50 characters, may not end in a period, and may not use ! breaking-change syntax.
Allowed types:
build · chore · ci · docs · feat · fix · perf · refactor · revert · style · test
Commit bodies and footers are not allowed.
Enforced rules
| Rule | Requirement |
| :------------------------- | :--------------------------------------- |
| body-empty | Commit body must be empty |
| footer-empty | Commit footer must be empty |
| scope-case | Scope must be lowercase |
| scope-empty | Scope is required |
| subject-empty | Subject is required |
| subject-exclamation-mark | ! breaking-change syntax is prohibited |
| subject-max-length | Subject is at most 50 characters |
| type-case | Type must be lowercase |
| type-empty | Type is required |
| type-enum | Type must be one of the allowed values |
The extended Conventional Commits preset also rejects disallowed subject capitalization, trailing periods, oversized headers, and leading or trailing header whitespace.
Compatibility
| Surface | Supported contract |
| :-------------- | :----------------- |
| Node.js | >=24.15.0 |
| @commitlint/cli | >=19.0.0 |
| Module format | ESM |
License
MIT © Next Friday
