View Source Commitlint (commitlint v0.1.0)

Documentation for Commitlint.

Link to this section Summary

Functions

Lint the commit message.

Link to this section Types

@type lint_result() :: :ok | {:error, String.t()}

Link to this section Functions

@spec lint!(String.t()) :: :ok

Lint the commit message.

examples

Examples

iex> Commitlint.lint!("feat: add linting to commit messages")
:ok

iex> Commitlint.lint!("inexistent: add a test commit")
** (Commitlint.LintException) Invalid commit type: inexistent