Expand description
Conventional commit parsing, validation, and formatting.
standard-commit implements the
Conventional Commits specification
as a pure library — no I/O, no git operations, no terminal output.
- Parsing — extract type, scope, description, body, footers, and breaking status
- Linting — validate messages against configurable rules
- Formatting — render a
ConventionalCommitback to a well-formed message string
Structs§
- Conventional
Commit - A parsed conventional commit message.
- Footer
- A commit message footer (trailer).
- Lint
Config - Configuration for linting conventional commit messages.
- Lint
Error - A lint error found in a commit message.
Enums§
- Parse
Error - Errors that can occur when parsing a conventional commit message.
Functions§
- format
- Format a
ConventionalCommitback into a well-formed conventional commit message string. - lint
- Lint a commit message against the given configuration.
- parse
- Parse a commit message string into a
ConventionalCommit.