Skip to main content

mix.exs

defmodule PhoenixExRatatui.MixProject do
  use Mix.Project

  @description "Run ExRatatui apps inside Phoenix LiveView"
  @source_url "https://github.com/mcass19/phoenix_ex_ratatui"
  @changelog_url @source_url <> "/blob/main/CHANGELOG.md"
  @version "0.2.0"

  def project do
    [
      app: :phoenix_ex_ratatui,
      description: @description,
      version: @version,
      elixir: "~> 1.17",
      elixirc_paths: elixirc_paths(Mix.env()),
      start_permanent: Mix.env() == :prod,
      aliases: aliases(),
      deps: deps(),
      package: package(),
      name: "PhoenixExRatatui",
      homepage_url: @source_url,
      source_url: @source_url,
      docs: docs(),
      test_coverage: [
        summary: [threshold: 100],
        ignore_modules: [
          # Test fixtures — exercised by tests, not production surface.
          PhoenixExRatatui.TestApp,
          PhoenixExRatatui.FailingMountApp,
          PhoenixExRatatui.TestLive,
          PhoenixExRatatui.TestLive.Runtime,
          PhoenixExRatatui.ReducerTestLive,
          PhoenixExRatatui.ReducerTestLive.Runtime,
          PhoenixExRatatui.FailingTestLive,
          PhoenixExRatatui.FailingTestLive.Runtime,
          PhoenixExRatatui.TestComponent,
          PhoenixExRatatui.TestComponent.Runtime,
          PhoenixExRatatui.FailingTestComponent,
          PhoenixExRatatui.FailingTestComponent.Runtime,
          PhoenixExRatatui.TestParentLive,
          PhoenixExRatatui.TestCallbacksLive,
          PhoenixExRatatui.TestCallbacksLive.Runtime,
          PhoenixExRatatui.TestCallbacksComponent,
          PhoenixExRatatui.TestCallbacksComponent.Runtime,
          PhoenixExRatatui.TestReducerComponent,
          PhoenixExRatatui.TestReducerComponent.Runtime,
          PhoenixExRatatui.TestEndpoint,
          PhoenixExRatatui.TestErrorHTML
        ]
      ],
      dialyzer: [
        plt_local_path: "plts",
        plt_core_path: "plts/core"
      ]
    ]
  end

  def application do
    [
      extra_applications: [:logger, :telemetry]
    ]
  end

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

  defp aliases do
    [
      "assets.install": ["cmd --cd assets npm install"],
      "assets.build": ["cmd --cd assets npm run build"]
    ]
  end

  defp deps do
    [
      {:ex_ratatui, "~> 0.10"},
      {:phoenix, "~> 1.7"},
      {:phoenix_live_view, "~> 1.1"},
      {:telemetry, "~> 1.0"},
      {:jason, "~> 1.4"},

      # Test
      {:lazy_html, "~> 0.1", only: :test},
      {:stream_data, "~> 1.1", only: :test},

      # Dev
      {:ex_doc, "~> 0.35", only: :dev, runtime: false},
      {:credo, "~> 1.7", only: :dev, runtime: false},
      {:dialyxir, "~> 1.4", only: :dev, runtime: false}
    ]
  end

  defp package do
    [
      licenses: ["MIT"],
      links: %{
        "GitHub" => @source_url,
        "Changelog" => @changelog_url
      },
      keywords: ~w(phoenix liveview tui terminal ratatui ex_ratatui),
      files: ~w(lib guides package.json .formatter.exs mix.exs README.md LICENSE CHANGELOG.md)
    ]
  end

  defp docs do
    [
      main: "readme",
      source_ref: "v#{@version}",
      extras: [
        "README.md": [title: "Overview"],
        "guides/getting_started.md": [title: "Getting Started"],
        "guides/telemetry.md": [title: "Telemetry"],
        "CONTRIBUTING.md": [title: "Contributing"],
        "CHANGELOG.md": [title: "Changelog"]
      ],
      groups_for_extras: [
        Guides: Path.wildcard("guides/*.md")
      ],
      groups_for_modules: [
        Components: [
          PhoenixExRatatui,
          PhoenixExRatatui.LiveView,
          PhoenixExRatatui.LiveComponent
        ],
        Internals: [
          PhoenixExRatatui.Renderer.Html,
          PhoenixExRatatui.Telemetry,
          PhoenixExRatatui.Transport
        ]
      ]
    ]
  end
end