rules_graphviz

rules_graphviz is a Bazel ruleset published to the tomato-bazel registry.

bazel_dep(name = "rules_graphviz", version = "0.2.0")

View source & releases on GitHub ↗

Bazel rules for rendering Graphviz diagrams — hermetically.

The default toolchain runs @hpcc-js/wasm-graphviz (Graphviz compiled to WebAssembly, WASM inlined into one JS file) under a hermetic bun runtime (via rules_bun). No host dot required, cross-platform wherever bun runs.

Install (MODULE.bazel)

bazel_dep(name = "rules_graphviz", version = "0.2.0")

.bazelrc (fastverk registry):

common --registry=https://raw.githubusercontent.com/fastverk/bazel-registry/main/
common --registry=https://bcr.bazel.build/

Use

load("@rules_graphviz//graphviz:defs.bzl", "dot_diagram", "dot_corpus", "dot_pdf", "svg_pdf")

dot_diagram(name = "graph", src = "graph.dot")                       # dot -> svg
dot_diagram(name = "g2", src = "graph.dot", engine = "neato")        # any layout engine
dot_diagram(name = "g3", src = "graph.dot", output_format = "json")  # structured output
dot_corpus(name = "all", srcs = glob(["*.dot"]))                     # fan-out

dot_pdf(name = "graph_pdf", src = "graph.dot", engine = "twopi")     # dot -> vector PDF
svg_pdf(name = "logo_pdf", src = "logo.svg")                         # any SVG -> vector PDF

• engines: dot neato fdp sfdp twopi circo osage patchwork
• formats: svg dot canon xdot json json0 plain plain-ext gv

Vector PDF (dot_pdf / svg_pdf)

dot_pdf and svg_pdf emit vector PDF — useful for LaTeX (\includegraphics in tectonic/pdflatex), which embeds PDF but not SVG. They render to SVG with the WASM engine, then convert SVG → PDF with a vendored, self-contained bun bundle (graphviz/svg2pdf.bundle.js: pdfkit + svg-to-pdfkit, headless — no browser, no cairo, no host dot). So PDF stays as hermetic as the rest of the toolchain. The PDF page is sized to the SVG’s viewBox. See graphviz/NOTICE.svg2pdf for the bundled packages and how to regenerate the bundle.

Scope

The WASM toolchain covers every layout engine + the structured output formats. Vector PDF is available via dot_pdf / svg_pdf (SVG → PDF under bun, above). The native standalone tools (gvpr, gvpack, tred, unflatten, …) and raster output (png, which needs cairo) are not in the WASM build. Register an alternate toolchain for @rules_graphviz//graphviz:toolchain_type if you need them.

License

Apache-2.0. Vendors @hpcc-js/wasm-graphviz (Apache-2.0); see graphviz/NOTICE.

Usage#

load("@rules_graphviz//graphviz:defs.bzl", "dot_corpus", "dot_diagram", "dot_pdf", "svg_pdf")

package(default_visibility = ["//visibility:public"])

# Default engine (dot) -> svg.
dot_diagram(
    name = "sample_svg",
    src = "sample.dot",
)

# A different layout engine, hermetically (no host graphviz).
dot_diagram(
    name = "sample_neato",
    src = "sample.dot",
    engine = "neato",
)

# Structured output.
dot_diagram(
    name = "sample_json",
    src = "sample.dot",
    output_format = "json",
)

dot_corpus(
    name = "all",
    srcs = ["sample.dot"],
)

# Vector PDF straight from .dot (dot -> svg -> pdf), hermetic — no host tools.
dot_pdf(
    name = "sample_pdf",
    src = "sample.dot",
)

# Or convert an existing SVG (here, the dot_diagram output above) to PDF.
svg_pdf(
    name = "sample_svg_pdf",
    src = ":sample_svg",
)

Conformance#

Dependencies#

Depends on

Used by (1 in the registry)

Versions#

2 published versions, newest first. Each resolves to an immutable, integrity-checked archive.

Changelog#

## 1. commit the 0.2.0 changes, then tag + push
git tag v0.2.0 && git push origin v0.2.0

## 2. compute the archive integrity from the published tag tarball
URL=https://github.com/fastverk/rules_graphviz/archive/refs/tags/v0.2.0.tar.gz
curl -sL "$URL" | openssl dgst -sha256 -binary | openssl base64 -A   # -> sha256-...

## 3. add the registry entry under bazel-registry/modules/rules_graphviz/0.2.0/
##    - MODULE.bazel : copy of this repo's MODULE.bazel
##    - source.json  : { "url": "$URL", "integrity": "sha256-...",
##                       "strip_prefix": "rules_graphviz-0.2.0" }
##    and append "0.2.0" to modules/rules_graphviz/metadata.json versions,
##    then drop the local_path_override in consuming repos.

← All modules