Packages

Production-grade Elixir SDK for the complete Revolut Developer API — Merchant, Business, Open Banking, Crypto Ramp, and Crypto Exchange.

Current section

Files

Jump to
Raw

mix.exs

defmodule RevolutClient.MixProject do
use Mix.Project
@version "1.0.0"
@source_url "https://github.com/iamkanishka/revolut_client"
def project do
[
app: :revolut_client,
version: @version,
elixir: "~> 1.18",
elixirc_paths: elixirc_paths(Mix.env()),
start_permanent: Mix.env() == :prod,
deps: deps(),
aliases: aliases(),
# Hex
package: package(),
description: description(),
# Docs
name: "RevolutClient",
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_file: {:no_warn, "priv/plts/dialyzer.plt"},
flags: [:error_handling, :missing_return, :underspecs]
]
]
end
def application do
[
mod: {RevolutClient.Application, []},
extra_applications: [:logger, :crypto]
]
end
defp elixirc_paths(:test), do: ["lib", "test/support"]
defp elixirc_paths(_), do: ["lib"]
defp deps do
[
# HTTP
{:req, "~> 0.5"},
# JSON
{:jason, "~> 1.4"},
# Telemetry
{:telemetry, "~> 1.2"},
# Dev / test
{:bypass, "~> 2.1", only: :test},
{:excoveralls, "~> 0.18", only: :test},
{:mox, "~> 1.1", only: :test},
# Dev tooling
{:ex_doc, "~> 0.40", only: :dev, runtime: false},
{:credo, "~> 1.7", only: [:dev, :test], runtime: false},
{:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false}
]
end
defp aliases do
[
lint: ["credo --strict", "dialyzer"],
"test.all": ["test --cover"]
]
end
defp description do
"Production-grade Elixir SDK for the complete Revolut Developer API — " <>
"Merchant, Business, Open Banking, Crypto Ramp, and Crypto Exchange."
end
defp package do
[
name: "revolut_client",
licenses: ["MIT"],
links: %{
"GitHub" => @source_url,
"Revolut Developer Docs" => "https://developer.revolut.com"
},
maintainers: ["Kanishka"],
files: ~w(lib .formatter.exs mix.exs README.md LICENSE CHANGELOG.md)
]
end
defp docs do
[
main: "readme",
source_ref: "v#{@version}",
source_url: @source_url,
# 👈 add this
extras: ["README.md", "CHANGELOG.md", "LICENSE"],
groups_for_modules: [
Core: [RevolutClient, RevolutClient.Client, RevolutClient.Config],
"API Clients": [
RevolutClient.Merchant,
RevolutClient.Business,
RevolutClient.OpenBanking,
RevolutClient.CryptoRamp,
RevolutClient.CryptoExchange
],
Webhooks: [RevolutClient.Webhook, RevolutClient.Webhook.Crypto],
"Types & Errors": [RevolutClient.Types, RevolutClient.Error]
]
]
end
end