Crate conventional_commits_linter_lib

source ·
Expand description

Conventional Commits Linter Library

Documentation crates.io Pipeline Status Conventional Commits License

A tooling and language agnostic library to lint Git commits against the Conventional Commits specification.

Content

Usage

Usage - Logging

The crate log is used to provide logging. The environment variable RUST_LOG can be used to set the logging level. See https://crates.io/crates/log for more detailed documentation.

Issues/Feature Requests

To report an issue or request a new feature use https://gitlab.com/DeveloperC/conventional_commits_linter/-/issues.

Structs

  • Commits
    A representation of a range of commits within a Git repository.
  • LintingErrors
    A representation of the linting errors within the range of commits.

Enums

  • GitHistoryMode
    The mode to use when transversing the Git commit history of the Git commit range, to collect the Git commit messages to use in calculating the next semantic version.
  • LintingError
    The representation of a singular linting error a commit message can have.