Packages

A terminal UI framework for Elixir with a Zig NIF text engine.

Current section

Files

Jump to
Raw

mix.exs

defmodule ElixirOpentui.MixProject do
  use Mix.Project

  @version "0.2.0"
  @source_url "https://github.com/jyooi/elixir-opentui"

  def project do
    [
      app: :elixir_opentui,
      version: @version,
      elixir: "~> 1.19",
      start_permanent: Mix.env() == :prod,
      deps: deps(),
      aliases: aliases(),
      package: package(),
      description: "A terminal UI framework for Elixir with a Zig NIF text engine.",
      name: "ElixirOpentui",
      source_url: @source_url,
      docs: docs()
    ]
  end

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

  defp aliases do
    [
      setup: &setup/1
    ]
  end

  defp setup(_args) do
    Application.ensure_all_started(:inets)
    :httpc.set_options(ipfamily: :inet)
    Mix.Task.run("zig.get")
  end

  defp package do
    [
      licenses: ["MIT"],
      links: %{
        "GitHub" => @source_url,
        "OpenTUI (upstream Zig)" => "https://github.com/anomalyco/opentui"
      },
      files: ~w(lib zig .formatter.exs mix.exs README.md LICENSE CHANGELOG.md),
      exclude_patterns: ["zig/opentui/tests"]
    ]
  end

  defp docs do
    [
      main: "readme",
      extras: ["README.md", "guides/getting-started.md"],
      source_ref: "v#{@version}",
      groups_for_modules: [
        Widgets: ~r/Widgets\./,
        Animation: ~r/Animation\./,
        Core: [
          ElixirOpentui.Element,
          ElixirOpentui.View,
          ElixirOpentui.Component,
          ElixirOpentui.Style
        ],
        Rendering: [
          ElixirOpentui.Renderer,
          ElixirOpentui.Buffer,
          ElixirOpentui.Painter,
          ElixirOpentui.ANSI
        ],
        Layout: [ElixirOpentui.Layout],
        Terminal: [ElixirOpentui.Input, ElixirOpentui.Capabilities]
      ]
    ]
  end

  defp deps do
    [
      {:ex_doc, "~> 0.35", only: :dev, runtime: false},
      {:zigler, "~> 0.15.2", runtime: false},
      {:makeup_elixir, "~> 1.0", optional: true},
      {:makeup_ts, "~> 0.2", optional: true},
      {:earmark_parser, "~> 1.4"}
    ]
  end
end