clarion

defmodule Clarion.MixProject do
  use Mix.Project

  @version "0.1.0"
  @source_url "https://github.com/singlefleck/clarion"

  def project do
    [
      app: :clarion,
      version: @version,
      elixir: "~> 1.16",
      start_permanent: Mix.env() == :prod,
      deps: deps(),
      description: description(),
      package: package(),
      name: "Clarion",
      source_url: @source_url,
      docs: docs(),
      dialyzer: [
        plt_add_apps: [:logger],
        plt_file: {:no_warn, "priv/plts/dialyzer.plt"},
        flags: [:error_handling, :underspecs]
      ]
    ]
  end

  def application do
    [
      extra_applications: [:logger]
    ]
  end

  defp deps do
    [
      {:ex_doc, "~> 0.31", only: :dev, runtime: false},
      {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
      {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false}
    ]
  end

  defp description do
    "Correct structured/report-style logging for library authors: readable in dev, " <>
      "fully queryable in prod, without a report_cb ever destroying the raw report."
  end

  defp package do
    [
      licenses: ["MIT"],
      links: %{
        "GitHub" => @source_url
      }
    ]
  end

  defp docs do
    [
      main: "readme",
      source_url: @source_url,
      source_ref: "v#{@version}",
      extras: [
        "README.md",
        "docs/how_logging_actually_works.md",
        "docs/comparison.md",
        "docs/getting_started.md",
        "docs/design_decisions.md",
        "CONTRIBUTING.md",
        "LICENSE"
      ]
    ]
  end
end