mix.exs

defmodule Vtc.MixProject do
  use Mix.Project

  alias Vtc.Source.Frames
  alias Vtc.Source.Seconds

  def project do
    [
      app: :vtc,
      version: "0.17.5",
      description: "A SMPTE timecode library for Elixir",
      source_url: "https://github.com/opencinemac/vtc-ex",
      elixir: "~> 1.12",
      elixirc_paths: elixirc_paths(Mix.env()),
      test_coverage: [tool: :covertool],
      aliases: aliases(),
      docs: [
        # The main page in the docs
        main: "readme",
        logo: "zdocs/source/assets/logo1.svg",
        extras: [
          "README.md",
          "zdocs/quickstart.cheatmd",
          "zdocs/ecto_quickstart.cheatmd",
          "zdocs/history.md",
          "zdocs/framerate_vs_timebase.md",
          "zdocs/the_rational_rationale.md",
          "CONTRIBUTING.md"
        ],
        groups_for_modules: [
          "Core API": [Vtc.Framestamp, Vtc.Framerate, Vtc.Framestamp.Range, Vtc],
          Data: [Vtc.SMPTETimecode.Sections, Vtc.Rates, Vtc.FilmFormat],
          "Frames Formats": [Frames.FeetAndFrames, Frames.SMPTETimecodeStr],
          "Seconds Formats": [Seconds.PremiereTicks, Seconds.RuntimeStr],
          "Source Protocols": [Seconds, Frames],
          "Ecto Types": [
            Vtc.Ecto.Postgres.Migrations,
            Vtc.Ecto.Postgres.PgRational,
            Vtc.Ecto.Postgres.PgRational.Migrations,
            Vtc.Ecto.Postgres.PgFramerate,
            Vtc.Ecto.Postgres.PgFramerate.Migrations,
            Vtc.Ecto.Postgres.PgFramestamp,
            Vtc.Ecto.Postgres.PgFramestamp.Migrations,
            Vtc.Ecto.Postgres.PgFramestamp.Range,
            Vtc.Ecto.Postgres.PgFramestamp.Range.Migrations
          ],
          "Test Utilities": [Vtc.TestUtils.StreamDataVtc]
        ],
        groups_for_docs: [
          Parse: &(&1[:section] == :parse),
          Manipulate: &(&1[:section] == :manipulate),
          Inspect: &(&1[:section] == :inspect),
          Compare: &(&1[:section] == :compare),
          Arithmetic: &(&1[:section] == :arithmetic),
          Convert: &(&1[:section] == :convert),
          Consts: &(&1[:section] == :consts),
          Perfs: &(&1[:section] == :perfs),
          "Ecto Migrations": &(&1[:section] == :ecto_migrations),
          "Changeset Validations": &(&1[:section] == :changeset_validators),
          Full: &(&1[:section] == :migrations_full),
          "Pg Constraints": &(&1[:section] == :migrations_constraints),
          "Pg Types": &(&1[:section] == :migrations_types),
          "Pg Casts": &(&1[:section] == :migrations_casts),
          "Pg Operators": &(&1[:section] == :migrations_operators),
          "Pg Operator Classes": &(&1[:section] == :migrations_operator_classes),
          "Pg Functions": &(&1[:section] == :migrations_functions),
          "Pg Private Functions": &(&1[:section] == :migrations_private_functions)
        ]
      ],
      build_embedded: Mix.env() == :prod,
      start_permanent: Mix.env() == :prod,
      package: package(),
      deps: deps(),
      dialyzer: [plt_add_apps: Enum.map(deps(), &elem(&1, 0)) ++ [:ex_unit]]
    ]
  end

  # Specifies which paths to compile per environment.
  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: []

  # Run "mix help deps" to learn about dependencies.
  defp deps do
    [
      # Library Dependencies
      {:decimal, "~> 2.0"},
      {:ratio, "~> 4.0"},
      {:ecto, "~> 3.10", optional: true},
      {:ecto_sql, "~> 3.10", optional: true},
      {:postgrex, ">= 0.0.0", optional: true},
      {:stream_data, "~> 1.0", optional: true},

      # Test dependencies
      {:covertool, "~> 2.0", only: [:test]},
      {:junit_formatter, "~> 3.1", only: [:test]},

      # Dev dependencies
      {:credo, "~> 1.6", only: [:dev, :test], runtime: false},
      {:dialyxir, "~> 1.0", only: [:dev, :test], runtime: false},
      {:ex_doc, "~> 0.27", only: [:dev, :test], runtime: false},
      {:styler, "~> 0.7", only: [:dev, :test], runtime: false},
      {:examples_styler, "~> 0.1", only: [:dev, :test], runtime: false}
    ]
  end

  defp package do
    [
      # This option is only needed when you don't want to use the OTP application name
      name: "vtc",
      # These are the default files included in the package
      files: ~w(lib mix.exs README.md* LICENSE*),
      licenses: ["MIT"],
      links: %{"GitHub" => "https://github.com/opencinemac/vtc-ex"}
    ]
  end

  defp aliases do
    [docs: ["docs", &copy_docs_images/1]]
  end

  # copies documentation images into the hexdox directory
  defp copy_docs_images(_), do: File.cp_r("zdocs/source/assets", "doc/assets")
end