mix.exs

defmodule EnvConfig.MixProject do
  use Mix.Project

  @version "1.0.0"
  @source_url "https://github.com/m1dnight/env_config"

  def project do
    [
      app: :env_config,
      version: @version,
      elixir: "~> 1.17",
      start_permanent: Mix.env() == :prod,
      description: description(),
      package: package(),
      source_url: @source_url,
      deps: deps(),
      docs: docs(),
      aliases: aliases(),
      # EnvConfig.Macros only contains macros, whose bodies expand and run at
      # compile time. `mix test --cover` instruments at runtime, so it can never
      # attribute coverage to this module even though its branches are exercised
      # by test/macro_test.exs. Exclude it so the report reflects reality.
      test_coverage: [ignore_modules: [EnvConfig.Macros]]
    ]
  end

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

  defp description do
    "A library for declaratively reading, validating, and casting environment " <>
      "variables into their proper Elixir types in runtime.exs."
  end

  defp package do
    [
      maintainers: ["Christophe De Troyer"],
      licenses: ["MIT"],
      links: %{"GitHub" => @source_url},
      files: ~w(lib mix.exs README.md LICENSE .formatter.exs)
    ]
  end

  defp aliases do
    [
      precommit: [
        "compile --warnings-as-errors",
        "deps.unlock --unused",
        "dialyzer",
        "credo --strict",
        "format",
        "test"
      ]
    ]
  end

  def docs do
    # The main page in the docs
    [
      main: "EnvConfig",
      logo: "assets/logo.png",
      source_url: @source_url,
      source_ref: "v#{@version}"
    ]
  end

  # Run "mix help compile.app" to learn about applications.
  def application do
    [
      extra_applications: [:logger]
    ]
  end

  # Run "mix help deps" to learn about dependencies.
  defp deps do
    [
      {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},
      {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
      {:ex_doc, "~> 0.16", only: :dev, runtime: false}
    ]
  end
end