mix.exs

defmodule Image.MixProject do
  use Mix.Project

  @version "0.65.0"
  @app_name "image"

  def project do
    [
      app: String.to_atom(@app_name),
      version: @version,
      elixir: "~> 1.17",
      deps: deps(),
      elixirc_paths: elixirc_paths(Mix.env()),
      source_url: "https://github.com/elixir-image/image",
      docs: docs(),
      build_embedded: Mix.env() == :prod,
      start_permanent: Mix.env() == :prod,
      deps: deps(),
      description: description(),
      package: package(),
      aliases: aliases(),
      elixirc_paths: elixirc_paths(Mix.env()),
      dialyzer: [
        ignore_warnings: ".dialyzer_ignore_warnings",
        plt_add_apps: ~w(mix nx plug evision ex_unit)a
      ],
      compilers: Mix.compilers()
    ]
    |> Keyword.merge(maybe_add_preferred_cli())
  end

  defp maybe_add_preferred_cli() do
    if Version.compare(System.version(), "1.19.0-dev") == :lt do
      [preferred_cli_env: cli()]
    else
      []
    end
  end

  defp description do
    """
    An approachable image processing library primarily based upon Vix and libvips that
    is NIF-based, fast, multi-threaded, pipelined and has a low memory
    footprint.
    """
  end

  def application do
    [
      mod: {Image.Application, []},
      extra_applications: [:logger, :inets, :crypto]
    ]
  end

  defp deps do
    [
      # libvips bindings
      {:vix, "~> 0.33"},
      # {:vix, github: "akash-akya/vix", branch: "dev"},
      # {:vix, github: "akash-akya/vix"},
      # {:vix, path: "../vix"},

      # Color science: conversions, gamut mapping, parsing.
      {:color, "~> 0.4"},

      # FFmpeg bindings, used by Image.Video for video frame
      # extraction, seeking, and streaming.
      {:xav, "~> 0.10", optional: true},

      # eVision OpenCV bindings. Used by Image.QRcode and the
      # Image.to_evision/1 / Image.from_evision/1 interop helpers.
      {:evision, "~> 0.1.33 or ~> 0.2", optional: true},
      # {:evision, github: "cocoa-xu/evision"},

      # For XMP metadata parsing
      {:sweet_xml, "~> 0.7"},

      # For SVG text generation (HTML safety)
      {:phoenix_html, "~> 4.0 or ~> 3.2 or ~> 2.1"},

      # For streaming writes
      {:plug, "~> 1.13", optional: true},

      # For streaming images via Req
      {:req, "~> 0.4", optional: true},

      # Kino for rendering in Livebook
      {:kino, "~> 0.13", optional: true},

      # For Nx interchange (Image.to_nx/2, Image.from_nx/1)
      # and Scholar for k-means clustering. Image classification
      # and image generation moved to the `:image_detection`
      # package along with the `:bumblebee` dependency.
      {:nx, "~> 0.11.0", optional: true},
      {:exla, "0.11.0", optional: true},
      {:nx_image, "~> 0.1", optional: true},
      {:scholar, "~> 0.3", optional: true},
      {:rustler, "> 0.0.0", optional: true},

      # For testing and benchmarking
      {:temp, "~> 0.4", only: [:test, :dev], runtime: false},
      {:benchee, "~> 1.0", only: :dev, runtime: false, optional: true},

      # For release management
      {:ex_doc, "~> 0.18", only: [:release, :dev, :docs]},
      {:dialyxir, "~> 1.0", only: [:dev, :test], runtime: false, optional: true},

      # For testing HTTP streaming
      {:ex_aws_s3, "~> 2.3", optional: true, only: [:dev, :test]},
      {:hackney, "~> 1.18", optional: true, only: [:dev, :test]},
      {:jason, "~> 1.4", optional: true}
    ]
  end

  defp package do
    [
      maintainers: ["Kip Cole"],
      licenses: ["Apache-2.0"],
      links: links(),
      files: [
        "lib",
        "priv/fonts",
        "mix.exs",
        "README*",
        "CHANGELOG*",
        "LICENSE*"
      ]
    ]
  end

  def links do
    %{
      "GitHub" => "https://github.com/elixir-image/image",
      "Readme" => "https://github.com/elixir-image/image/blob/v#{@version}/README.md",
      "Changelog" => "https://github.com/elixir-image/image/blob/v#{@version}/CHANGELOG.md",
      "Vix" => "https://github.com/akash-akya/vix",
      "libvips" => "https://www.libvips.org",
      "eVision (OpenCV)" => "https://github.com/cocoa-xu/evision"
    }
  end

  def docs do
    [
      source_ref: "v#{@version}",
      main: "readme",
      logo: "logo.jpg",
      extra_section: "Guides",
      extras: [
        "README.md",
        "guides/thumbnailing.md",
        "guides/performance.md",
        "guides/color_migration.md",
        "livebook/image_edge_masking.livemd",
        "livebook/color_clustering.livemd",
        "LICENSE.md",
        "CHANGELOG.md"
      ],
      formatters: ["html", "markdown"],
      groups_for_modules: groups_for_modules(),
      groups_for_docs: groups_for_docs(),
      skip_undefined_reference_warnings_on: ["changelog", "CHANGELOG.md"]
    ]
  end

  @enum_modules [
    Image.BandFormat,
    Image.BlendMode,
    Image.CombineMode,
    Image.Interpretation,
    Image.Kernel,
    Image.ExtendMode
  ]

  defp groups_for_modules do
    [
      Errors: [Image.Error],
      Pixels: [Image.Pixel, Image.ICCProfile, Image.Pixels],
      Exif: [Image.Exif],
      Xmp: [Image.Xmp],
      Kino: [Image.Kino],
      Options: ~r/Image.Options.*/,
      Enums: @enum_modules
    ]
  end

  defp groups_for_docs do
    [
      "Files and streams": &(&1[:subject] == "Load and save"),
      "Basic Adjustments": &(&1[:subject] == "Basic Adjustments"),
      Operations: &(&1[:subject] == "Operation"),
      Resize: &(&1[:subject] == "Resize"),
      Crop: &(&1[:subject] == "Crop"),
      Transforms: &(&1[:subject] == "Generator"),
      Distortion: &(&1[:subject] == "Distortion"),
      "Split & Join": &(&1[:subject] == "Split and join"),
      Color: &(&1[:subject] == "Color"),
      Introspection: &(&1[:subject] == "Image info"),
      Histogram: &(&1[:subject] == "Histogram"),
      Clusters: &(&1[:subject] == "Clusters"),
      "Color Difference": &(&1[:subject] == "Color Difference"),
      Masks: &(&1[:subject] == "Mask"),
      Metadata: &(&1[:subject] == "Metadata"),
      "Nx & Evision": &(&1[:subject] == "Matrix"),
      Preview: &(&1[:subject] == "Display"),
      Kino: &(&1[:subject] == "Kino"),
      Guards: &(&1[:subject] == "Guard"),
      "libvips Configuration": &(&1[:subject] == "Configuration")
    ]
  end

  @doc false
  def cli() do
    []
  end

  def aliases do
    []
  end

  defp elixirc_paths(:test), do: ["lib", "src", "mix", "test"]
  defp elixirc_paths(:dev), do: ["lib", "src", "mix", "bench"]
  defp elixirc_paths(:release), do: ["lib", "src"]
  defp elixirc_paths(_), do: ["lib", "src"]
end