Expose public `render` api

Open
#11 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust
Domain
api, cli, computer-graphics

Research direction

Start by tracing the existing parse → ir::build → layout::layout → render::svg::render pipeline and locate the CLI entry point. Expose the requested render_svg API, make the CLI emit SVG to stdout or a file by default, and preserve AST output behind an --ast flag.

Written by the indexing model from the issue text.

Description

enhancement

With all rendering components in place, expose a public API function like render_svg(src: &str) -> Result<String, Vec<ParseError>> that runs the full pipeline: parse the DOT source, lower to IR, run layout, and produce SVG output. This is the primary entry point for library consumers.

The CLI should be updated to produce SVG output by default, writing to stdout or a file. The existing AST debug output should remain available behind a flag like --ast for development and debugging purposes. The pipeline is: parse → ir::build → layout::layout → render::svg::render.

Dominant language
Rust
Stars
0
Forks
0
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from terror/dotgraph

All issues in terror/dotgraph

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.