mix.exs

defmodule Nostrum.Mixfile do
  @moduledoc false
  use Mix.Project

  def project do
    [
      app: :nostrum,
      appup: "appup.ex",
      compilers: Mix.compilers() ++ [:appup],
      version: "0.11.0-dev",
      elixir: "~> 1.15",
      elixirc_paths: elixirc_paths(Mix.env()),
      build_embedded: Mix.env() == :prod,
      start_permanent: Mix.env() == :prod,
      description: "An Elixir Discord library",
      package: package(),
      name: "nostrum",
      source_url: "https://github.com/Kraigie/nostrum",
      homepage_url: "https://github.com/Kraigie/nostrum",
      deps: deps(),
      docs: docs(),
      dialyzer: dialyzer(),
      aliases: aliases(),
      test_coverage: test_coverage()
    ]
  end

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

  def application do
    [
      extra_applications: [:logger, :inets, mnesia: :optional],
      mod: {Nostrum.Application, []}
    ]
  end

  # "How to" shamelessly copied from the nerves project.
  # https://github.com/nerves-project/nerves/tree/master/docs
  def docs do
    [
      main: "intro",
      extras: extras(),
      logo: "assets/icon.png",
      groups_for_modules: groups_for_modules(),
      groups_for_docs: groups_for_docs(),
      groups_for_extras: [
        Introduction: ~r"/introduction/",
        Functionality: ~r"/functionality/",
        Configuration: ~r"/configuration/",
        Advanced: ~r"/advanced/",
        "Cheat Sheets": ~r"/cheat-sheets/"
      ],
      source_ref: "master",
      assets: %{"guides/assets" => "assets"},
      nest_modules_by_prefix: [
        Nostrum.Api,
        Nostrum.Cache,
        Nostrum.Cache.ChannelGuildMapping,
        Nostrum.Cache.GuildCache,
        Nostrum.Cache.MemberCache,
        Nostrum.Cache.PresenceCache,
        Nostrum.Cache.UserCache,
        Nostrum.Constants,
        Nostrum.Store,
        Nostrum.Store.GuildShardMapping,
        Nostrum.Store.UnavailableGuild,
        Nostrum.Struct,
        Nostrum.Struct.Event
      ]
    ]
  end

  def extras do
    # We manually move the `intro.md` document to the top of the list so it
    # remains first on the navigation sidebar
    ["guides/intro/intro.md"] ++
      (Path.wildcard("guides/**/*.{md,cheatmd}") -- ["guides/intro/intro.md"])
  end

  def groups_for_modules do
    [
      "Bot management": [
        ~r/Nostrum.Bot/
      ],
      Api: [
        ~r/Nostrum.Api/,
        ~r/Nostrum.Consumer/,
        ~r/Nostrum.(Permission|Voice)$/
      ],
      Cache: [
        ~r/Nostrum.Cache.\w+$/
      ],
      Structs: [
        ~r/Nostrum.Struct/
      ],
      Constants: [
        ~r/Nostrum.Constants/
      ],
      Utilities: [
        ~r/Nostrum.(Snowflake|Token|Util)/
      ],
      Stores: [
        ~r/Nostrum.Store.\w+$/
      ],
      "Pluggable caches & stores": [
        ~r/Nostrum.Cache.\w+.\w+$/,
        ~r/Nostrum.Store.\w+.\w+$/
      ],
      "Internal modules": [
        ~r/Nostrum.Api.Ratelimiter/,
        ~r/Nostrum.Shard/,
        ~r/^Nostrum\.StateMachineTranslator$/,
        ~r/Nostrum.Voice.Crypto.\w+$/
      ]
    ]
  end

  defp groups_for_docs,
    do: []

  def aliases do
    [
      lint: [
        "compile --force",
        "format --check-formatted",
        "credo --strict --ignore 'TagTODO'",
        "dialyzer"
      ],
      check: ["lint", "test"]
    ]
  end

  defp test_coverage do
    [
      ignore_modules: [
        :nostrum_test_api_server,
        DummyConsumer,
        DummySupervisor,
        MyApp.MyStruct,
        NostrumTest.Stubs
      ]
    ]
  end

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

  def package do
    [
      name: :nostrum,
      licenses: ["MIT"],
      files: [
        "appup.ex",
        "examples",
        "lib",
        ".formatter.exs",
        "mix.exs",
        "README*",
        "LICENSE*",
        "src"
      ],
      maintainers: ["Craig Dazey", "Johannes Christ", "Joe Banks"],
      links: %{
        "GitHub" => "https://github.com/Kraigie/nostrum/",
        "Docs" => "https://kraigie.github.io/nostrum/"
      }
    ]
  end

  defp deps do
    [
      # Please cease usage of this library if writing new nostrum code,
      # we should use json_polyfill, but mix doesn't quite seem to be
      # able to work with the `beam` file? Or is it my old rebar version?
      {:jason, "~> 1.4"},
      # Replacement for Jason, remove once we required OTP 27+
      # {:json_polyfill, "~> 0.2"},
      {:gun, "~> 2.0"},
      {:salchicha, "~> 0.3"},
      {:certifi, "~> 2.13"},
      {:mime, "~> 1.6 or ~> 2.0"},
      {:ezstd, "~> 1.1", optional: true},
      {:telemetry, "~> 1.0", optional: true},
      {:castle, "~> 0.3.0", runtime: false},
      {:ex_doc, "~> 0.37", only: :dev, runtime: false},
      {:credo, "~> 1.7.7", only: [:dev, :test], runtime: false},
      {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},
      {:benchee, "~> 1.1", only: :dev, runtime: false},
      {:recon, "~> 2.5", only: :dev, optional: true},
      # Temporary dependency for the source code migration tool.
      {:sourceror, "~> 1.7"}
    ]
  end

  def dialyzer do
    [
      plt_add_deps: :app_tree,
      plt_add_apps: [:mix, :mnesia],
      # "-Wmissing_return", "-Wno_return", "-Wunmatched_returns", "-Wunderspecs", "-Woverspecs", "-Wunknown"
      flags: [:extra_return, :error_handling]
    ]
  end
end