commitlint v0.1.1

View Source Commitlint (commitlint v0.1.1)

Documentation for Commitlint.

Link to this section Summary

Types

lint_result()

Functions

lint!(input)

Lint the commit message.

Link to this section Types

Link to this type

lint_result()

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

Link to this section Functions

Link to this function

lint!(input)

View Source 
@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