Skip to main content

mix.exs

defmodule Snapcast.MixProject do
  use Mix.Project

  @version "0.4.6"
  @source_url "https://git.sr.ht/~sbr/snapcast"

  def project do
    [
      app: :snapcast,
      version: @version,
      elixir: "~> 1.15",
      start_permanent: Mix.env() == :prod,
      deps: deps(),
      name: "Snapcast",
      description:
        "A pure-Elixir Snapcast server: speak Snapcast's binary protocol directly to " <>
          "snapclients, owning the audio clock and timestamping every chunk (PCM or FLAC " <>
          "transport) — no external snapserver.",
      package: package(),
      docs: docs(),
      source_url: @source_url,
      aliases: aliases()
    ]
  end

  def cli do
    [preferred_envs: [precommit: :test]]
  end

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

  defp deps do
    [
      {:jason, "~> 1.2"},
      {:ex_doc, "~> 0.34", only: :dev, runtime: false},
      {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
      {:mix_audit, "~> 2.1", only: [:dev, :test], runtime: false}
    ]
  end

  # `mix precommit` (also wired into the git pre-commit hook via .githooks)
  # gates a commit on: formatting, clean compile, Credo, a dependency-vuln
  # audit, and the test suite.
  defp aliases do
    [
      precommit: [
        "format --check-formatted",
        "compile --warnings-as-errors",
        "credo",
        "deps.audit",
        "test"
      ]
    ]
  end

  defp package do
    [
      licenses: ["GPL-3.0-or-later"],
      links: %{"sourcehut" => @source_url},
      files: ~w(lib mix.exs README.md LICENSE .formatter.exs)
    ]
  end

  defp docs do
    [
      main: "Snapcast",
      extras: ["README.md"],
      source_ref: "v#{@version}",
      groups_for_modules: [
        Server: [
          Snapcast,
          Snapcast.Server,
          Snapcast.Session,
          Snapcast.Stream,
          Snapcast.Flac,
          Snapcast.Ogg,
          Snapcast.Clock,
          Snapcast.Protocol,
          Snapcast.Listener
        ],
        Discovery: [
          Snapcast.Advertiser,
          Snapcast.LocalClient
        ]
      ]
    ]
  end
end