mix.exs

defmodule ElvenGard.Network.MixProject do
  use Mix.Project

  @app_name "ElvenGard.Network"
  @version "0.1.1"
  @github_link "https://github.com/ImNotAVirus/elvengard_network"

  def project do
    [
      app: :elvengard_network,
      version: @version,
      elixir: "~> 1.13",
      name: @app_name,
      description: "Game server toolkit written in Elixir # Network",
      elixirc_paths: elixirc_paths(Mix.env()),
      package: package(),
      docs: docs(),
      deps: deps(),
      test_coverage: [tool: ExCoveralls],
      preferred_cli_env: [
        coveralls: :test,
        "coveralls.detail": :test,
        "coveralls.post": :test,
        "coveralls.html": :test
      ]
    ]
  end

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

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

  # Run "mix help deps" to learn about dependencies.
  defp deps do
    [
      {:ranch, "~> 2.1"},
      {:ex_doc, "~> 0.34", only: :dev, runtime: false},
      {:excoveralls, "~> 0.18", only: :test, runtime: false},
      {:credo, "~> 1.7", only: [:dev, :test], runtime: false}
    ]
  end

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

  defp docs do
    [
      main: @app_name,
      source_ref: "v#{@version}",
      source_url: @github_link,
      # logo: "path/to/logo.png",
      extra_section: "GUIDES",
      extras: extras(),
      groups_for_extras: groups_for_extras(),
      groups_for_modules: groups_for_modules()
    ]
  end

  defp extras() do
    Enum.concat(
      ["README.md": [title: "Overview"]],
      [
        "CHANGELOG.md",
        "guides/introduction/network_protocol.md",
        "guides/introduction/getting_started.md",
        "guides/introduction/endpoint.md",
        "guides/introduction/protocol.md",
        "guides/introduction/types_and_subpackets.md",
        "guides/introduction/packet_definitions.md",
        "guides/introduction/network_codec.md",
        "guides/introduction/packet_views.md",
        "guides/introduction/packet_handler.md"
      ]
    )
  end

  defp groups_for_extras() do
    [
      Introduction: ~r/(README.md|guides\/introduction\/.?)/
    ]
  end

  defp groups_for_modules() do
    # Ungrouped Modules:
    #
    # ElvenGard.Network
    # ElvenGard.Network.Socket
    # ElvenGard.Network.Type
    # ElvenGard.Network.View

    [
      Endpoint: [
        ElvenGard.Network.Endpoint,
        ElvenGard.Network.Endpoint.Protocol,
        ElvenGard.Network.NetworkCodec,
        ElvenGard.Network.PacketHandler,
        ElvenGard.Network.PacketSerializer
      ]
    ]
  end
end