Current section
Files
Jump to
Current section
Files
mix.exs
defmodule Grove.MixProject do
use Mix.Project
@version "0.2.0"
@source_url "https://gitlab.com/tristanperalta/grove"
def project do
[
app: :grove,
version: @version,
elixir: "~> 1.20",
start_permanent: Mix.env() == :prod,
deps: deps(),
aliases: aliases(),
dialyzer: dialyzer(),
# Documentation
name: "Grove",
description: "Conflict-free Replicated Tree CRDTs for Elixir",
source_url: @source_url,
docs: docs(),
package: package()
]
end
def cli do
[
preferred_envs: [precommit: :test]
]
end
# Run "mix help compile.app" to learn about applications.
def application do
[
extra_applications: [:logger],
mod: {Grove.Application, []}
]
end
# Run "mix help deps" to learn about dependencies.
defp deps do
[
# Optional: Phoenix integrations
{:phoenix_pubsub, "~> 2.1", optional: true},
{:phoenix_live_view, "~> 1.0", optional: true},
# Dev/Test dependencies
{:ex_doc, "~> 0.38", only: :dev, runtime: false},
{:stream_data, "~> 1.0", only: [:test, :dev]},
{:credo, "~> 1.7", only: [:dev, :test], runtime: false},
{:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},
{:benchee, "~> 1.0", only: :dev, runtime: false}
]
end
defp aliases do
[
precommit: [
"compile --warnings-as-errors",
"deps.unlock --unused",
"format",
"credo --strict",
"dialyzer",
"test"
]
]
end
defp dialyzer do
[
plt_add_apps: [:ex_unit]
]
end
defp docs do
[
main: "readme",
source_ref: "v#{@version}",
extra_section: "GUIDES",
extras: extras(),
groups_for_extras: groups_for_extras(),
before_closing_body_tag: &before_closing_body_tag/1
]
end
defp extras do
[
"README.md",
"LICENSE",
"guides/getting-started.md",
"guides/concepts.md",
"guides/use-cases.md",
"guides/architecture.md",
"guides/benchmarks.md",
"guides/roadmap.md"
]
end
defp groups_for_extras do
[
Guides: ~r/guides\/.*/
]
end
defp before_closing_body_tag(:html) do
"""
<script src="https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.min.js"></script>
<script>
document.addEventListener("DOMContentLoaded", function () {
mermaid.initialize({
startOnLoad: false,
theme: document.body.className.includes("dark") ? "dark" : "default"
});
let id = 0;
for (const codeEl of document.querySelectorAll("pre code.mermaid")) {
const preEl = codeEl.parentElement;
const graphDefinition = codeEl.textContent;
const graphEl = document.createElement("div");
const graphId = "mermaid-graph-" + id++;
mermaid.render(graphId, graphDefinition).then(({svg, bindFunctions}) => {
graphEl.innerHTML = svg;
bindFunctions?.(graphEl);
preEl.insertAdjacentElement("afterend", graphEl);
preEl.remove();
});
}
});
</script>
"""
end
defp before_closing_body_tag(_), do: ""
defp package do
[
licenses: ["MIT"],
files: ~w(lib guides mix.exs README.md LICENSE CHANGELOG.md .formatter.exs),
links: %{
"GitLab" => @source_url,
"Changelog" => "#{@source_url}/-/blob/main/CHANGELOG.md"
}
]
end
end