How conventional-changelog/commitlint works
commitlint is a commit-message linter: users supply a message or select Git history, configuration defines the rules, and linting produces violations and a report. Its CLI is the primary interface; its API exposes reading, loading, and linting, while a separate interactive prompt helps compose convention-compliant messages. The graph also represents shared configurations and the commitizen adapter. Some CLI orchestration and configuration-loading calls are not visible in the excerpts, so those links are omitted or marked unverified rather than inferred.
Main entry points: lint.ts Lint engine · input.ts Interactive prompt · load.ts Config loader · cli.ts CLI
Components 18
Entry points
- CLI
@commitlint/cli/src/cli.ts - Git message reader
@commitlint/read/src/read.ts - Programmatic API
@commitlint/core/src/core.ts
Linting
- Lint engine
@commitlint/lint/src/lint.ts - Message parser
@commitlint/parse/src/index.ts - Ignore checks
@commitlint/is-ignored/src/is-ignored.ts - Rule implementations
@commitlint/rules/src - Report formatter
@commitlint/format/src/format.ts
Configuration
- Config loader
@commitlint/load/src/load.ts - Config inheritance
@commitlint/resolve-extends/src/index.ts - Conventional config
@commitlint/config-conventional/src/index.ts - Shared scope configs
@commitlint/config-lerna-scopes/index.js
Message authoring
- Prompt CLI
@commitlint/prompt-cli/cli.js - Interactive prompt
@commitlint/prompt/src/input.ts - Prompt builder
@commitlint/prompt/src/library/get-prompt.ts - Message formatter
@commitlint/prompt/src/library/format.ts - Commitizen adapter
@commitlint/cz-commitlint/src/index.ts
Other components
- Developer
Connections 17
- Developer → CLI: runs
README.md - CLI → Git message reader: reads commits
@commitlint/cli/src/cli.ts - Developer → Programmatic API: calls
README.md - Programmatic API → Lint engine: lints messages
- Lint engine → Ignore checks: checks ignores
@commitlint/lint/src/lint.ts - Lint engine → Message parser: parses message
@commitlint/lint/src/lint.ts - Lint engine → Rule implementations: executes rules
@commitlint/lint/src/lint.ts - Developer → Config loader: loads config
README.md - Config loader → Config inheritance: resolves extends
- Developer → Conventional config: shares config
README.md - Developer → Shared scope configs: uses shared config
README.md - Developer → Prompt CLI: starts prompt
README.md - Prompt CLI → Interactive prompt: opens prompt
- Interactive prompt → Config loader: loads rules
@commitlint/prompt/src/input.ts - Interactive prompt → Prompt builder: builds questions
@commitlint/prompt/src/input.ts - Interactive prompt → Message formatter: formats result
@commitlint/prompt/src/input.ts - Developer → Commitizen adapter: uses adapter
README.md