Packages

Render map images on the server: tiles, markers and attribution, fitted to bounds and served from signed, cacheable URLs.

Current section

Files

Jump to
staticmaps mix.exs
Raw

mix.exs

defmodule StaticMaps.MixProject do
  use Mix.Project

  @version "0.1.0"
  @source_url "https://gitlab.com/tristanperalta/staticmaps"

  def project do
    [
      app: :staticmaps,
      version: @version,
      elixir: "~> 1.15",
      elixirc_paths: elixirc_paths(Mix.env()),
      start_permanent: Mix.env() == :prod,
      deps: deps(),
      description:
        "Render map images on the server: tiles, markers and attribution, " <>
          "fitted to bounds and served from signed, cacheable URLs.",
      package: package(),
      docs: docs(),
      source_url: @source_url,
      homepage_url: @source_url
    ]
  end

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

  defp package do
    [
      licenses: ["MIT"],
      links: %{
        "GitLab" => @source_url,
        "Changelog" => "#{@source_url}/-/blob/main/CHANGELOG.md"
      },
      files: ~w(lib guides mix.exs README.md LICENSE CHANGELOG.md)
    ]
  end

  defp docs do
    [
      main: "readme",
      source_ref: "v#{@version}",
      extras: [
        "README.md",
        "guides/tile-providers.md",
        "guides/ARCHITECTURE.md",
        "guides/ROADMAP.md",
        "CHANGELOG.md",
        "LICENSE"
      ],
      groups_for_extras: [Guides: ~r{guides/}],
      # These guides are for contributors and name internal modules on purpose.
      skip_undefined_reference_warnings_on: ["guides/ARCHITECTURE.md", "guides/ROADMAP.md"],
      groups_for_modules: [
        "Tile sources": [
          StaticMaps.Source,
          StaticMaps.Source.HTTP,
          StaticMaps.Source.OSM,
          StaticMaps.Source.Template
        ],
        "Tile cache": [StaticMaps.TileCache, StaticMaps.TileCache.ETS],
        "Serving over HTTP": [StaticMaps.Plug],
        Errors: [StaticMaps.TileError, StaticMaps.UnavailableError]
      ]
    ]
  end

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

  defp deps do
    [
      {:vix, "~> 0.42"},
      {:req, "~> 0.7"},
      {:plug, "~> 1.16", optional: true},
      {:bandit, "~> 1.13", only: :test},
      {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
      {:ex_doc, "~> 0.40", only: :dev, runtime: false},
      {:stream_data, "~> 1.1", only: [:dev, :test]}
    ]
  end
end