defmodule PhoenixKitReferrals.MixProject do
use Mix.Project
@version "0.2.0"
@source_url "https://github.com/BeamLabEU/phoenix_kit_referrals"
def project do
[
app: :phoenix_kit_referrals,
version: @version,
elixir: "~> 1.18",
elixirc_paths: elixirc_paths(Mix.env()),
start_permanent: Mix.env() == :prod,
deps: deps(),
aliases: aliases(),
# Hex
description:
"Referral codes module for PhoenixKit — issue, track, and apply referral codes at signup",
package: package(),
# Dialyzer
dialyzer: [plt_add_apps: [:phoenix_kit]],
# Docs
name: "PhoenixKitReferrals",
source_url: @source_url,
docs: docs()
]
end
def application do
[
extra_applications: [:logger, :phoenix_kit]
]
end
# Only lib/ is compiled (and published). The current suite is pure-unit and
# needs no shared support modules; add a `test/support` clause here if/when
# DB-backed integration tests arrive (see phoenix_kit_hello_world for the
# DataCase / TestRepo / LiveCase template).
defp elixirc_paths(_), do: ["lib"]
defp aliases do
[
quality: ["format", "credo --strict", "dialyzer"],
"quality.ci": ["format --check-formatted", "credo --strict", "dialyzer"],
precommit: [
"compile --force --warnings-as-errors",
"deps.unlock --check-unused",
# Scan for retired Hex deps. Run via `cmd` so Hex bootstraps in a fresh
# process — the hex.* archive tasks aren't resolvable via Mix.Task.run
# inside an alias.
"cmd mix hex.audit",
"quality.ci"
]
]
end
# phoenix_kit deps resolve from Hex by default. For cross-repo work against a
# local checkout, export <APP>_PATH — e.g. PHOENIX_KIT_PATH=../phoenix_kit.
# Unset => the published pin, so mix hex.publish is unaffected.
defp pk_dep(app, requirement, opts \\ []) do
env_var = String.upcase(Atom.to_string(app)) <> "_PATH"
case System.get_env(env_var) do
nil when opts == [] -> {app, requirement}
nil -> {app, requirement, opts}
path -> {app, [path: path, override: true] ++ opts}
end
end
defp deps do
[
# PhoenixKit provides the Module behaviour, Settings API, and the users +
# referral-code tables this module reads/writes.
#
# pk_dep/3 keeps a plain Hex pin by default (so published builds + CI are
# unchanged) but swaps in a local path dep when PHOENIX_KIT_PATH is set —
# see the helper above. This matches the sibling modules + the template.
pk_dep(:phoenix_kit, "~> 1.7"),
# LiveView is needed for the admin pages.
{:phoenix_live_view, "~> 1.1"},
# Optional: add ex_doc for generating documentation
{:ex_doc, "~> 0.34", only: :dev, runtime: false},
# Code quality
{:credo, "~> 1.7", only: [:dev, :test], runtime: false},
{:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},
# HTML parser for Phoenix.LiveViewTest in LiveView smoke tests
{:lazy_html, ">= 0.1.0", only: :test}
]
end
defp package do
[
licenses: ["MIT"],
links: %{"GitHub" => @source_url},
files: ~w(lib priv .formatter.exs mix.exs README.md CHANGELOG.md LICENSE)
]
end
defp docs do
[
main: "PhoenixKitReferrals",
source_ref: @version
]
end
end