Packages

Versioce provides a mix task for version bumping of your project.

Current section

Files

Jump to
versioce lib Changelog Formatters behaviour.ex
Raw

lib/Changelog/Formatters/behaviour.ex

defmodule Versioce.Changelog.Formatter do
@moduledoc """
Behaviour for formatters in versioce
"""
alias Versioce.Changelog.DataGrabber.Version
@doc """
Formats the `[Versioce.Changelog.DataGrabber.Version.t()]` data for changelog
"""
@callback format(versions :: [Version.t()]) :: {:ok, String.t()} | {:error, any}
@doc """
Formats the `Versioce.Changelog.DataGrabber.Version.t()` data for changelog
"""
@callback version_to_str(version :: Version.t()) :: String.t()
end