This version of the module is deprecated: Moved to moonbit-community/diago. Use moonbit-community/diago@0.4.0 or later and update import paths.

README
- ::newCompileOptions::new
- ::with_dark_theme_idCompileOptions::with_dark_theme_id
- ::with_dark_theme_overridesCompileOptions::with_dark_theme_overrides
- ::with_directionCompileOptions::with_direction
- ::with_layout_engineCompileOptions::with_layout_engine
- ::with_layout_pluginCompileOptions::with_layout_plugin
- ::with_no_xml_tagCompileOptions::with_no_xml_tag
- ::with_omit_versionCompileOptions::with_omit_version
- ::with_output_modeCompileOptions::with_output_mode
- ::with_parse_optionsCompileOptions::with_parse_options
- ::with_route_pluginCompileOptions::with_route_plugin
- ::with_saltCompileOptions::with_salt
- ::with_scaleCompileOptions::with_scale
- ::with_target_specCompileOptions::with_target_spec
- ::with_theme_nameCompileOptions::with_theme_name
- ::with_theme_overridesCompileOptions::with_theme_overrides
T
CompletionItem
T
CompletionKind
T
LayoutEngine
- ::innerLayoutPlugin::inner
- ::newLayoutPlugin::new
- ::runLayoutPlugin::run
T
OutputMode
- ::newParseOptions::new
- ::with_base_pathParseOptions::with_base_path
- ::with_import_resolverParseOptions::with_import_resolver
- ::innerRoutePlugin::inner
- ::newRoutePlugin::new
- ::runRoutePlugin::run
V
compile
V
compile_diagram
V
compile_file
V
get_board_path_at_position
V
get_completion_items
V
get_ref_ranges
V
parse
V
parse_file

diago

A D2-compatible diagram toolkit for MoonBit with Dagre, ELK, and Railway layout engines, rendering SVG, ASCII, and Unicode outputs.

graph

Download zip

Author

Milky2018

Version

0.2.1

License

Apache-2.0

Repository

github.com/moonbit-community/diago

Last updated

7 months ago

Downloads

43K

#Diago

Diago is a MoonBit implementation of the D2 diagram language. It compiles .d2 files into SVG (and optionally ASCII/Unicode text) using multiple layout engines.

#Overview

This repository contains:

A CLI (cmd/diago) with explicit subcommands (render, fmt, validate, layout, themes, version)
A WASM-based playground (web/) deployed via GitHub Pages
Multiple layout engines: dagre, elk, and railway

#Installation

moon update
moon build

#Quick Start

moon run cmd/diago -- render diagram.d2

#CLI

Show help:

moon run cmd/diago -- --help

Common usage:

# Render SVG (default output: input.svg)
moon run cmd/diago -- render diagram.d2
moon run cmd/diago -- render diagram.d2 diagram.svg
moon run cmd/diago -- render diagram.d2 --output diagram.svg

# Choose layout engine
moon run cmd/diago -- render --layout elk diagram.d2 diagram.svg
moon run cmd/diago -- render -l dagre diagram.d2 diagram.svg

# ASCII / Unicode text
moon run cmd/diago -- render --format ascii diagram.d2 --output diagram.ascii.txt
moon run cmd/diago -- render --format unicode diagram.d2 --output diagram.unicode.txt

# Format / validate
moon run cmd/diago -- fmt diagram.d2
moon run cmd/diago -- fmt --check diagram.d2
moon run cmd/diago -- validate diagram.d2

# Watch mode
moon run cmd/diago -- render --watch diagram.d2

# Introspection
moon run cmd/diago -- layout
moon run cmd/diago -- layout elk
moon run cmd/diago -- themes
moon run cmd/diago -- version

#Example

Create a file example.d2:

server: Web Server
database: Database {
  shape: cylinder
}
cache: Cache {
  shape: oval
}

server -> database: queries
server -> cache: reads
cache -> database: fallback

Compile it:

moon run cmd/diago -- render example.d2 example.svg

#Pipeline

At a high level:

D2 Source → Lexer → Parser → AST → IR → Graph → Layout (dagre/elk/railway) → Render (SVG/ASCII/Unicode)

#Tests

moon test        # Run all tests
moon test -v     # Verbose output

#License

Apache-2.0 (see LICENSE).

DiagoError

source

pub(all) suberror DiagoError {
  ParseError(String)
  IOError(String)
  IrError(String)
  GraphError(String)
  LayoutError(String)
  RenderError(String)
  ConfigError(String)
  TargetError(String)
}

impl Eq for DiagoError

impl Show for DiagoError

CompileOptions

source

pub struct CompileOptions {
  output_mode : OutputMode
  layout_engine : LayoutEngine
  direction : @Milky2018/diago/engine_api.Direction
Direction
  target_spec : String?
  layout_plugin : LayoutPlugin?
  route_plugin : RoutePlugin?
  parse_options : ParseOptions
  theme_name : String?
  dark_theme_id : Int?
  theme_overrides : Map[String, String]
  dark_theme_overrides : Map[String, String]
  scale : Double?
  no_xml_tag : Bool?
  salt : String?
  omit_version : Bool?
}

CompileOptions::new

source

fn CompileOptions::new() -> CompileOptions

CompileOptions::with_dark_theme_id

source

fn CompileOptions::with_dark_theme_id(self : CompileOptions, dark_theme_id : Int?) -> CompileOptions

CompileOptions::with_dark_theme_overrides

source

fn CompileOptions::with_dark_theme_overrides(self : CompileOptions, dark_theme_overrides : Map[String, String]) -> CompileOptions

CompileOptions::with_direction

source

fn CompileOptions::with_direction(self : CompileOptions, direction : @Milky2018/diago/engine_api.Direction
Direction) -> CompileOptions

CompileOptions::with_layout_engine

source

fn CompileOptions::with_layout_engine(self : CompileOptions, layout_engine : LayoutEngine) -> CompileOptions

CompileOptions::with_layout_plugin

source

fn CompileOptions::with_layout_plugin(self : CompileOptions, layout_plugin : LayoutPlugin?) -> CompileOptions

CompileOptions::with_no_xml_tag

source

fn CompileOptions::with_no_xml_tag(self : CompileOptions, no_xml_tag : Bool?) -> CompileOptions

CompileOptions::with_omit_version

source

fn CompileOptions::with_omit_version(self : CompileOptions, omit_version : Bool?) -> CompileOptions

CompileOptions::with_output_mode

source

fn CompileOptions::with_output_mode(self : CompileOptions, output_mode : OutputMode) -> CompileOptions

CompileOptions::with_parse_options

source

fn CompileOptions::with_parse_options(self : CompileOptions, parse_options : ParseOptions) -> CompileOptions

CompileOptions::with_route_plugin

source

fn CompileOptions::with_route_plugin(self : CompileOptions, route_plugin : RoutePlugin?) -> CompileOptions

CompileOptions::with_salt

source

fn CompileOptions::with_salt(self : CompileOptions, salt : String?) -> CompileOptions

CompileOptions::with_scale

source

fn CompileOptions::with_scale(self : CompileOptions, scale : Double?) -> CompileOptions

CompileOptions::with_target_spec

source

fn CompileOptions::with_target_spec(self : CompileOptions, target_spec : String?) -> CompileOptions

CompileOptions::with_theme_name

source

fn CompileOptions::with_theme_name(self : CompileOptions, theme_name : String?) -> CompileOptions

CompileOptions::with_theme_overrides

source

fn CompileOptions::with_theme_overrides(self : CompileOptions, theme_overrides : Map[String, String]) -> CompileOptions

CompletionItem

source

pub struct CompletionItem {
  label : String
  kind : CompletionKind
  detail : String
  insert_text : String
}

impl Eq for CompletionItem

impl Show for CompletionItem

CompletionKind

source

pub(all) enum CompletionKind {
  Keyword
  Style
  Shape
  Value
}

impl Eq for CompletionKind

impl Show for CompletionKind

LayoutEngine

source

pub(all) enum LayoutEngine {
  Auto
  Dagre
  Elk
  Railway
}

impl Eq for LayoutEngine

impl Show for LayoutEngine

LayoutPlugin

source

pub type LayoutPlugin (@Milky2018/diago/graph.GraphInput
GraphInput, @Milky2018/diago/engine_api.LayoutConfig
LayoutConfig, @Milky2018/diago/engine_api.Direction
Direction) -> Result[@Milky2018/diago/graph.GraphInput
GraphInput, String]

LayoutPlugin::inner

source

#deprecated("Use `struct T(A)` to declare a newtype and use `.0` access the underlying type instead.")
fn LayoutPlugin::inner(self : LayoutPlugin) -> ((@Milky2018/diago/graph.GraphInput
GraphInput, @Milky2018/diago/engine_api.LayoutConfig
LayoutConfig, @Milky2018/diago/engine_api.Direction
Direction) -> Result[@Milky2018/diago/graph.GraphInput
GraphInput, String])

Convert newtype to its underlying type, automatically derived.

LayoutPlugin::new

source

fn LayoutPlugin::new(f : (@Milky2018/diago/graph.GraphInput
GraphInput, @Milky2018/diago/engine_api.LayoutConfig
LayoutConfig, @Milky2018/diago/engine_api.Direction
Direction) -> Result[@Milky2018/diago/graph.GraphInput
GraphInput, String]) -> LayoutPlugin

LayoutPlugin::run

source

fn LayoutPlugin::run(self : LayoutPlugin, graph : @Milky2018/diago/graph.GraphInput
GraphInput, config : @Milky2018/diago/engine_api.LayoutConfig
LayoutConfig, direction : @Milky2018/diago/engine_api.Direction
Direction) -> Result[@Milky2018/diago/graph.GraphInput
GraphInput, String]

OutputMode

source

pub(all) enum OutputMode {
  Svg
  Ascii
  Unicode
}

impl Eq for OutputMode

impl Show for OutputMode

ParseOptions

source

pub struct ParseOptions {
  base_path : String?
  import_resolver : @Milky2018/diago/ir.ImportResolver
ImportResolver?
}

ParseOptions::new

source

fn ParseOptions::new() -> ParseOptions

ParseOptions::with_base_path

source

fn ParseOptions::with_base_path(self : ParseOptions, base_path : String?) -> ParseOptions

ParseOptions::with_import_resolver

source

fn ParseOptions::with_import_resolver(self : ParseOptions, import_resolver : @Milky2018/diago/ir.ImportResolver
ImportResolver?) -> ParseOptions

RoutePlugin

source

pub type RoutePlugin (@Milky2018/diago/graph.GraphInput
GraphInput) -> Result[@Milky2018/diago/graph.GraphInput
GraphInput, String]

RoutePlugin::inner

source

#deprecated("Use `struct T(A)` to declare a newtype and use `.0` access the underlying type instead.")
fn RoutePlugin::inner(self : RoutePlugin) -> ((@Milky2018/diago/graph.GraphInput
GraphInput) -> Result[@Milky2018/diago/graph.GraphInput
GraphInput, String])

Convert newtype to its underlying type, automatically derived.

RoutePlugin::new

source

fn RoutePlugin::new(f : (@Milky2018/diago/graph.GraphInput
GraphInput) -> Result[@Milky2018/diago/graph.GraphInput
GraphInput, String]) -> RoutePlugin

RoutePlugin::run

source

fn RoutePlugin::run(self : RoutePlugin, graph : @Milky2018/diago/graph.GraphInput
GraphInput) -> Result[@Milky2018/diago/graph.GraphInput
GraphInput, String]

compile

source

fn compile(source : String, options? : CompileOptions) -> String raise DiagoError

compile_diagram

source

fn compile_diagram(source : String, options? : CompileOptions) -> @Milky2018/diago/diagram.Diagram
Diagram raise DiagoError

compile_file

source

fn compile_file(file_path : String, options? : CompileOptions) -> String raise DiagoError

get_board_path_at_position

source

fn get_board_path_at_position(source : String, line : Int, column : Int) -> Array[String]

get_completion_items

source

fn get_completion_items(source : String, line : Int, column : Int) -> Array[CompletionItem]

get_ref_ranges

source

fn get_ref_ranges(source : String, key : String, board_path? : Array[String], options? : ParseOptions) -> Array[@Milky2018/diago/lexer.Range
Range] raise DiagoError

parse

source

fn parse(source : String, options? : ParseOptions) -> @Milky2018/diago/ir.Map
Map raise DiagoError

parse_file

source

fn parse_file(file_path : String, options? : ParseOptions) -> @Milky2018/diago/ir.Map
Map raise DiagoError

Source Files

Site source Report issue Packages Build queue Skills Statistics

diago

#Diago

#Overview

#Installation

#Quick Start

#CLI

#Example

#Pipeline

#Tests

#License

#DiagoError

#CompileOptions

#CompileOptions::new

#CompileOptions::with_dark_theme_id

#CompileOptions::with_dark_theme_overrides

#CompileOptions::with_direction

#CompileOptions::with_layout_engine

#CompileOptions::with_layout_plugin

#CompileOptions::with_no_xml_tag

#CompileOptions::with_omit_version

#CompileOptions::with_output_mode

#CompileOptions::with_parse_options

#CompileOptions::with_route_plugin

#CompileOptions::with_salt

#CompileOptions::with_scale

#CompileOptions::with_target_spec

#CompileOptions::with_theme_name

#CompileOptions::with_theme_overrides

#CompletionItem

#CompletionKind

#LayoutEngine

#LayoutPlugin

#LayoutPlugin::inner

#LayoutPlugin::new

#LayoutPlugin::run

#OutputMode

#ParseOptions

#ParseOptions::new

#ParseOptions::with_base_path

#ParseOptions::with_import_resolver

#RoutePlugin

#RoutePlugin::inner

#RoutePlugin::new

#RoutePlugin::run

#compile

#compile_diagram

#compile_file

#get_board_path_at_position

#get_completion_items

#get_ref_ranges

#parse

#parse_file

Source Files

DiagoError

CompileOptions

CompileOptions::new

CompileOptions::with_dark_theme_id

CompileOptions::with_dark_theme_overrides

CompileOptions::with_direction

CompileOptions::with_layout_engine

CompileOptions::with_layout_plugin

CompileOptions::with_no_xml_tag

CompileOptions::with_omit_version

CompileOptions::with_output_mode

CompileOptions::with_parse_options

CompileOptions::with_route_plugin

CompileOptions::with_salt

CompileOptions::with_scale

CompileOptions::with_target_spec

CompileOptions::with_theme_name

CompileOptions::with_theme_overrides

CompletionItem

CompletionKind

LayoutEngine

LayoutPlugin

LayoutPlugin::inner

LayoutPlugin::new

LayoutPlugin::run

OutputMode

ParseOptions

ParseOptions::new

ParseOptions::with_base_path

ParseOptions::with_import_resolver

RoutePlugin

RoutePlugin::inner

RoutePlugin::new

RoutePlugin::run

compile

compile_diagram

compile_file

get_board_path_at_position

get_completion_items

get_ref_ranges

parse

parse_file