Packages

Utilities for introspecting Membrane pipelines in Livebook

Current section

Files

Jump to
Raw

mix.exs

defmodule KinoMembrane.Mixfile do
use Mix.Project
@version "0.3.1"
@github_url "https://github.com/membraneframework/kino_membrane"
def project do
[
app: :kino_membrane,
version: @version,
elixir: "~> 1.13",
elixirc_paths: elixirc_paths(Mix.env()),
start_permanent: Mix.env() == :prod,
deps: deps(),
dialyzer: dialyzer(),
aliases: [
setup: ["cmd npm ci --prefix assets", "deps.get"],
build: ["cmd npm run build --prefix assets", "compile"],
docs: ["docs", &append_llms_links/1]
],
# hex
description: "Utilities for introspecting Membrane pipelines in Livebook",
package: package(),
# docs
name: "Kino Membrane",
source_url: @github_url,
docs: docs()
]
end
def application do
[
extra_applications: []
]
end
defp elixirc_paths(:test), do: ["lib", "test/support"]
defp elixirc_paths(_env), do: ["lib"]
defp deps do
[
{:membrane_core, "~> 1.0"},
{:kino, "~> 0.13.2"},
{:kino_vega_lite, "~> 0.1.9"},
{:ex_doc, ">= 0.40.0", only: :dev, runtime: false},
{:dialyxir, ">= 0.0.0", only: :dev, runtime: false},
{:credo, ">= 0.0.0", only: :dev, runtime: false}
]
end
defp dialyzer() do
opts = [
flags: [:error_handling],
ignore_warnings: ".dialyzer_ignore.exs"
]
if System.get_env("CI") == "true" do
# Store PLTs in cacheable directory for CI
File.mkdir_p!(Path.join([__DIR__, "priv", "plts"]))
[plt_local_path: "priv/plts", plt_core_path: "priv/plts"] ++ opts
else
opts
end
end
defp package do
[
maintainers: ["Membrane Team"],
licenses: ["Apache-2.0"],
links: %{
"GitHub" => @github_url,
"Membrane Framework Homepage" => "https://membraneframework.org"
},
files:
Path.wildcard("assets/{src,precompiled}/**") ++
Path.wildcard(
"assets/{.fingerprint,calc_fingerprint.sh,package.json,package-lock.json}",
match_dot: true
) ++
~w(lib LICENSE mix.exs README.md .formatter.exs)
]
end
defp docs do
[
main: "readme",
extras: ["README.md", "LICENSE"] ++ Path.wildcard("examples/**"),
groups_for_extras: [Examples: ~r/examples\/*/],
source_ref: "v#{@version}",
nest_modules_by_prefix: [KinoMembrane]
]
end
defp append_llms_links(_args) do
output_dir = docs()[:output] || "doc"
path = Path.join(output_dir, "llms.txt")
if File.exists?(path) do
existing = File.read!(path)
footer = """
## See Also
- [Membrane Framework AI Skill](https://hexdocs.pm/membrane_core/skill.md)
- [Membrane Core](https://hexdocs.pm/membrane_core/llms.txt)
"""
File.write!(path, String.trim_trailing(existing) <> footer)
else
IO.warn("#{path} not found — llms.txt was not generated, check your ex_doc configuration")
end
end
end