mix.exs

defmodule ExRoseTree.MixProject do
  use Mix.Project

  @description "A Rose Tree and Zipper in Elixir with a slew of navigation primitives."
  @source_url "https://github.com/metacode-io/ex-rose-tree"
  @version "0.1.3"

  def project do
    [
      app: :ex_rose_tree,
      version: @version,
      elixir: "~> 1.14",
      elixirc_paths: elixirc_paths(Mix.env()),
      start_permanent: Mix.env() == :prod,
      name: "ExRoseTree",
      description: @description,
      package: package(),
      deps: deps(),
      docs: docs(),
      source_url: @source_url,
      test_coverage: [tool: ExCoveralls],
      preferred_cli_env: [
        coveralls: :test
      ]
    ]
  end

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

  defp elixirc_paths(:test), do: ["lib", "dev", "test/support"]
  defp elixirc_paths(:dev), do: ["lib", "dev"]
  defp elixirc_paths(_env), do: ["lib"]

  defp docs() do
    [
      source_url: @source_url,
      source_ref: "v#{@version}",
      language: "en",
      formatters: ["html"],
      main: "ExRoseTree",
      groups_for_modules: [
        Tree: [
          ExRoseTree
        ],
        Zipper: [
          ExRoseTree.Zipper,
          ExRoseTree.Zipper.Location
        ],
        Util: [
          ExRoseTree.Util
        ],
        "Dev Support": [
          ExRoseTree.Support.Generators,
          ExRoseTree.Support.Trees,
          ExRoseTree.Support.Zippers
        ]
      ],
      groups_for_docs: [
        Guards: &(&1[:section] == :guards),
        "Basic Functionality": &(&1[:section] == :basic),
        Term: &(&1[:section] == :term),
        Children: &(&1[:section] == :children),
        "Common Traversal": &(&1[:section] == :traversal),
        "Path Traversal": &(&1[:section] == :path_traversal),
        "Breadth-first Traversal": &(&1[:section] == :breadth_first),
        "Depth-first Traversal": &(&1[:section] == :depth_first),
        "Direct Ancestors": &(&1[:section] == :ancestors),
        "Direct Descendants": &(&1[:section] == :descendants),
        Siblings: &(&1[:section] == :siblings),
        "Niblings: Nieces & Nephews": &(&1[:section] == :niblings),
        "Piblings: Aunts & Uncles": &(&1[:section] == :piblings),
        "First Cousins": &(&1[:section] == :first_cousins),
        "Second Cousins": &(&1[:section] == :second_cousins),
        "Extended Cousins": &(&1[:section] == :extended_cousins),
        Special: &(&1[:section] == :special)
      ],
      extras: []
    ]
  end

  defp package() do
    [
      maintainers: ["Matthew Caldwell"],
      licenses: ["Apache-2.0"],
      files:
        ~w(CHANGELOG.md CODE_OF_CONDUCT.md CONTRIBUTING.md .formatter.exs lib dev LICENSE* mix.exs README.md),
      links: %{"GitHub" => @source_url}
    ]
  end

  # Run "mix help deps" to learn about dependencies.
  defp deps do
    [
      {:credo, "~> 1.6.4", only: [:dev, :test], runtime: false},
      {:dialyxir, "~> 1.0", only: [:dev], runtime: false},
      {:excoveralls, "~> 0.14.5", only: :test},
      {:ex_doc, "~> 0.29", only: :dev, runtime: false},
      {:benchee, "~> 1.1", only: :dev}
    ]
  end
end