Skip to main content

mix.exs

defmodule Paysafe.MixProject do
  use Mix.Project

  @version "1.0.0"
  @source_url "https://github.com/iamkanishka/paysafe"

  def project do
    [
      app: :paysafe,
      version: @version,
      elixir: "~> 1.14",
      elixirc_paths: elixirc_paths(Mix.env()),
      start_permanent: Mix.env() == :prod,
      deps: deps(),
      aliases: aliases(),

      # Hex
      description: "Production-grade Elixir client for the Paysafe API",
      package: package(),

      # Docs
      name: "Paysafe",
      source_url: @source_url,
      docs: docs(),

      # Test
      test_coverage: [tool: ExCoveralls],
      preferred_cli_env: [
        coveralls: :test,
        "coveralls.detail": :test,
        "coveralls.post": :test,
        "coveralls.html": :test
      ],

      # Dialyzer
      dialyzer: [
        plt_add_apps: [:ex_unit, :mix],
        plt_file: {:no_warn, "priv/plts/dialyzer.plt"},
        flags: [:error_handling, :missing_return, :underspecs]
      ]
    ]
  end

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

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

  defp deps do
    [
      # HTTP client
      {:req, "~> 0.5"},

      # JSON
      {:jason, "~> 1.4"},

      # Config validation
      {:nimble_options, "~> 1.1"},

      # Telemetry
      {:telemetry, "~> 1.2"},
      {:telemetry_metrics, "~> 1.0"},

      # Rate limiting
      {:ex_rated, "~> 2.1"},

      # Dev / test
      {:ex_doc, "~> 0.34", only: :dev, runtime: false},
      {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
      {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},
      {:excoveralls, "~> 0.18", only: :test},
      {:bypass, "~> 2.1", only: :test},
      {:mox, "~> 1.1", only: :test}
    ]
  end

  defp aliases do
    [
      lint: ["format --check-formatted", "credo --strict"],
      "test.all": ["test --cover"],
      check: ["lint", "dialyzer", "test.all"]
    ]
  end

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

  defp docs do
    [
      main: "readme",
      source_ref: "v#{@version}",
      extras: ["README.md", "CHANGELOG.md", "LICENSE"],
      groups_for_modules: [
        "Payments API": [
          Paysafe.Payments,
          Paysafe.Payments.PaymentHandles,
          Paysafe.Payments.Payments,
          Paysafe.Payments.Settlements,
          Paysafe.Payments.Refunds,
          Paysafe.Payments.Payouts,
          Paysafe.Payments.Verifications,
          Paysafe.Payments.Customers
        ],
        "Scheduler API": [
          Paysafe.Scheduler,
          Paysafe.Scheduler.Plans,
          Paysafe.Scheduler.Subscriptions
        ],
        "Applications API": [
          Paysafe.Applications
        ],
        Webhooks: [
          Paysafe.Webhooks
        ],
        Types: [
          Paysafe.Types.PaymentHandle,
          Paysafe.Types.Payment,
          Paysafe.Types.Card,
          Paysafe.Types.BillingDetails,
          Paysafe.Types.Profile,
          Paysafe.Types.ThreeDs,
          Paysafe.Types.Settlement,
          Paysafe.Types.Refund,
          Paysafe.Types.Plan,
          Paysafe.Types.Subscription
        ],
        Infrastructure: [
          Paysafe.Config,
          Paysafe.Client,
          Paysafe.Error,
          Paysafe.Telemetry,
          Paysafe.RateLimiter
        ]
      ]
    ]
  end
end