Current section
Files
Jump to
Current section
Files
mix.exs
defmodule Shmex.Mixfile do
use Mix.Project
@version "0.5.2"
@github_url "https://github.com/membraneframework/shmex"
def project do
[
app: :shmex,
version: @version,
elixir: "~> 1.12",
compilers: [:bundlex] ++ Mix.compilers(),
description: "Elixir bindings for shared memory",
package: package(),
name: "Shmex",
source_url: @github_url,
docs: docs(),
deps: deps(),
dialyzer: dialyzer(),
aliases: [docs: ["docs", &append_llms_links/1]]
]
end
def application do
[
extra_applications: [:logger]
]
end
defp package do
[
maintainers: ["Membrane Team"],
licenses: ["Apache-2.0"],
files: ["lib", "c_src", "mix.exs", "README*", "LICENSE*", ".formatter.exs", "bundlex.exs"],
links: %{
"GitHub" => @github_url,
"Membrane Framework Homepage" => "https://membraneframework.org"
}
]
end
defp docs do
[
main: "readme",
extras: ["README.md", "LICENSE"],
source_ref: "v#{@version}"
]
end
defp deps() do
[
{:bundlex, "~> 1.0"},
{:bunch_native, "~> 0.5.0"},
{: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]
]
if System.get_env("CI") == "true" do
# Store PLTs in cacheable directory for CI
[plt_local_path: "priv/plts", plt_core_path: "priv/plts"] ++ opts
else
opts
end
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