analytics/mix.exs

defmodule Plausible.MixProject do
  use Mix.Project

  def project do
    [
      name: "Plausible",
      source_url: "https://github.com/plausible/analytics",
      docs: docs(),
      app: :plausible,
      version: System.get_env("APP_VERSION", "0.0.1"),
      elixir: "~> 1.14",
      elixirc_paths: elixirc_paths(Mix.env()),
      start_permanent: Mix.env() == :prod,
      aliases: aliases(),
      deps: deps(),
      test_coverage: [
        tool: ExCoveralls
      ],
      releases: [
        plausible: [
          include_executables_for: [:unix],
          applications: [plausible: :permanent],
          steps: [:assemble, :tar]
        ]
      ],
      dialyzer: [
        plt_file: {:no_warn, "priv/plts/dialyzer.plt"},
        plt_add_apps: [:mix, :ex_unit]
      ]
    ]
  end

  # Configuration for the OTP application.
  #
  # Type `mix help compile.app` for more information.
  def application do
    [
      mod: {Plausible.Application, []},
      extra_applications: [
        :logger,
        :runtime_tools,
        :tls_certificate_check,
        :opentelemetry_exporter
      ]
    ]
  end

  # Specifies which paths to compile per environment.
  defp elixirc_paths(env) when env in [:test, :dev],
    do: ["lib", "test/support", "extra/lib"]

  defp elixirc_paths(env) when env in [:small_test],
    do: ["lib", "test/support"]

  defp elixirc_paths(:small), do: ["lib"]
  defp elixirc_paths(_), do: ["lib", "extra/lib"]

  # Specifies your project dependencies.
  #
  # Type `mix help deps` for examples and options.
  defp deps do
    [
      {:bamboo, "~> 2.2"},
      {:bamboo_phoenix, "~> 1.0.0"},
      {:bamboo_postmark, git: "https://github.com/plausible/bamboo_postmark.git", branch: "main"},
      {:bamboo_smtp, "~> 4.1"},
      {:bcrypt_elixir, "~> 3.0"},
      {:bypass, "~> 2.1", only: [:dev, :test, :small_test]},
      {:cachex, "~> 3.4"},
      {:ecto_ch, "~> 0.1.10"},
      {:cloak, "~> 1.1"},
      {:cloak_ecto, "~> 1.2"},
      {:combination, "~> 0.0.3"},
      {:connection, "~> 1.1", override: true},
      {:cors_plug, "~> 3.0"},
      {:credo, "~> 1.5", only: [:dev, :test], runtime: false},
      {:csv, "~> 2.3"},
      {:dialyxir, "~> 1.0", only: [:dev, :test], runtime: false},
      {:double, "~> 0.8.0", only: [:test, :small_test]},
      {:ecto, "~> 3.10.0"},
      {:ecto_sql, "~> 3.10.0"},
      {:envy, "~> 1.1.1"},
      {:ex_machina, "~> 2.3", only: [:dev, :test, :small, :small_test]},
      {:excoveralls, "~> 0.10", only: :test},
      {:finch, "~> 0.16.0"},
      {:floki, "~> 0.34.3", only: [:dev, :test, :small, :small_test]},
      {:fun_with_flags, "~> 1.9.0"},
      {:fun_with_flags_ui, "~> 0.8"},
      {:locus, "~> 2.3"},
      {:gen_cycle, "~> 1.0.4"},
      {:hackney, "~> 1.8"},
      {:hammer, "~> 6.0"},
      {:httpoison, "~> 1.4"},
      {:jason, "~> 1.3"},
      {:kaffy, "~> 0.10.2", only: [:dev, :test, :staging, :prod]},
      {:location, git: "https://github.com/plausible/location.git"},
      {:mox, "~> 1.0", only: [:test, :small_test]},
      {:nanoid, "~> 2.0.2"},
      {:nimble_totp, "~> 1.0"},
      {:oauther, "~> 1.3"},
      {:oban, "~> 2.12.0"},
      {:observer_cli, "~> 1.7"},
      {:opentelemetry, "~> 1.1"},
      {:opentelemetry_api, "~> 1.1"},
      {:opentelemetry_ecto, "~> 1.0.0"},
      {:opentelemetry_exporter, "~> 1.2.0"},
      {:opentelemetry_phoenix, "~> 1.0"},
      {:opentelemetry_oban, "~> 0.2.0-rc.5"},
      {:phoenix, "~> 1.7.0"},
      {:phoenix_view, "~> 2.0"},
      {:phoenix_ecto, "~> 4.0"},
      {:phoenix_html, "~> 3.3", override: true},
      {:phoenix_live_reload, "~> 1.2", only: [:dev, :small]},
      {:phoenix_pubsub, "~> 2.0"},
      {:phoenix_live_view, "~> 0.18"},
      {:php_serializer, "~> 2.0"},
      {:plug, "~> 1.13", override: true},
      {:plug_cowboy, "~> 2.3"},
      {:prom_ex, "~> 1.8"},
      {:public_suffix, git: "https://github.com/axelson/publicsuffix-elixir"},
      {:ref_inspector, "~> 1.3"},
      {:referrer_blocklist, git: "https://github.com/plausible/referrer-blocklist.git"},
      {:sentry, "~> 8.0"},
      {:siphash, "~> 3.2"},
      {:timex, "~> 3.7"},
      {:ua_inspector, "~> 3.0"},
      {:ex_doc, "~> 0.28", only: :dev, runtime: false},
      {:ex_money, "~> 5.12"},
      {:mjml_eex, "~> 0.9.0"},
      {:mjml, "~> 1.5.0"},
      {:heroicons, "~> 0.5.0"},
      {:zxcvbn, git: "https://github.com/techgaun/zxcvbn-elixir.git"},
      {:open_api_spex, "~> 3.18"},
      {:joken, "~> 2.5"},
      {:paginator, git: "https://github.com/duffelhq/paginator.git"},
      {:scrivener_ecto, "~> 2.0"},
      {:esbuild, "~> 0.7", runtime: Mix.env() in [:dev, :small]},
      {:tailwind, "~> 0.2.0", runtime: Mix.env() in [:dev, :small]},
      {:ex_json_logger, "~> 1.3.0"}
    ]
  end

  defp aliases do
    [
      setup: ["deps.get", "ecto.setup", "assets.setup", "assets.build"],
      "ecto.setup": ["ecto.create", "ecto.migrate", "run priv/repo/seeds.exs"],
      "ecto.reset": ["ecto.drop", "ecto.setup"],
      test: ["ecto.create --quiet", "ecto.migrate", "test", "clean_clickhouse"],
      sentry_recompile: ["compile", "deps.compile sentry --force"],
      "assets.setup": ["tailwind.install --if-missing", "esbuild.install --if-missing"],
      "assets.build": [
        "tailwind default",
        "esbuild default"
      ],
      "assets.deploy": ["tailwind default --minify", "esbuild default --minify", "phx.digest"]
    ]
  end

  defp docs do
    [
      main: "readme",
      logo: "priv/static/images/icon/plausible_favicon.png",
      extras:
        Path.wildcard("guides/**/*.md") ++
          [
            "README.md": [filename: "readme", title: "Introduction"],
            "CONTRIBUTING.md": [filename: "contributing", title: "Contributing"]
          ],
      groups_for_extras: [
        Features: Path.wildcard("guides/features/*.md")
      ],
      before_closing_body_tag: fn
        :html ->
          """
          <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
          <script>mermaid.initialize({startOnLoad: true})</script>
          """

        _ ->
          ""
      end
    ]
  end
end