terrastruct/d2

D2 is a modern diagram scripting language that turns text to diagrams.

d2's Issues

cli: Add issue link upon crash

If something does panic within D2, the CLI should include a link to Github issues in the terminal display in case users want to report it.

install.sh: tala support

y-centering slightly off for multi-line labels

something to do with font sizes and baselines

install.sh: Support --edge for building and installing from latest source code in release appropriate manner

like building a .deb from the latest release and installing that. See docs on --edge.

layout: Integrate DOT layout engine

install.sh: support installing specific version

install.sh: Error on incompatible flags like --version with --uninstall

cli: Maybe embed a pan&zoom script to watcher client

syntax: classes

classes should aggregate styles so you don't have to apply the same set of styles in a bunch of places

release: Add manpage

imports: transpile from Mermaid, Graphviz, PlantUML

should fonts be embedded into SVG?

Currently we base64 encode fonts (to WOFF mimetype) and include directly in the SVG. This is to ensure the SVG has reproducible appearance everywhere and regardless of network connections.

However, this can make the SVG file unwieldy:

1. Larger file sizes. Fonts can add 1MB or so.
2. Opening up the SVG has this unreadable blob.

The alternatives are:

1. Drop the "regardless of network connections" part. Fetch hosted fonts online.
2. Use a ~universal font, e.g. Times New Roman where the vast majority of machines will have installed. Downside is that it's Times New Roman.
3. ???

lib/version: Only check for new version once a week

layout: fix dagre container-child connections

dagre doesn't handle container connections so the solution is to connect to a container's child, then cut the edge at the container's border. This works well if something outside is connecting to the container, but if it is from a child/descendant, then it will show up as an edge between descendants. Perhaps we can add a dummy node outside the container, and use that for connections going to a container from a descendant.

example:

container.first -> container.second: 1->2
container -> container.second: container->2

dagre layout (incorrect edge)

tala layout

lsp: kickoff

autocomplete list of shapes, choosing objects accessible from scope, etc

dagre container label overflows

aws_s3: AWS S3 California {
    Monitoring -> California
}
aws_s3: "AWS S3 San Francisco, California" {
    California.San Francisco
}

code snippets should have 1.2 em line height

just need to figure out how to adjust textmeasure accordingly, which will take some digging

cli: Write to output path atomically

cli: Add list-layouts subcommand to list available layouts with their sources/help

By sources I mean whether it's bundled or if not, where the binary is.

renderer: Support `multiple` keyword

Makes a shape look like it has multiple, like

render connections icons

Make sure it doesn't clash with label, use a default width/height

renderer: Support `shadow` keyword

cli: Add --out-dir flag

d2 ./static/d2/*.d2 ./static/generated/*.svg

d2layout-dagre: Compile fully statically with musl libc

See https://honnef.co/posts/2015/06/statically_compiled_go_programs__always__even_with_cgo__using_musl/

layout: Integrate ELK as a layout option

https://github.com/kieler/elkjs

Should be a plugin like dagre.

cmd/d2: Add flag and env variable for all inputs

e.g. --layout and D2_THEME.

And document in help.

See #45 (comment)

d2layout-plugin: Add render API

Allow layout plugins to adjust the output SVG if they were used.

layout, syntax: Sequence diagrams

i can't find an open-source standalone renderer for sequence diagrams. There's some that are integrated into other tools, but they're coupled with their tool. Might have to build one from scratch, which shouldn't be too hard.

Will probably also have to modify syntax

Pushback arrowheads when `multiple` is set

The arrowhead position should move to avoid overlapping with the shape

markdown code blocks

Standalone code snippets are implemented, but markdown can also have code blocks that need to be brought under the fold of consistent measurements, font, syntax highlighting

doc: Mention that the Dependencies don't need to be separately installed

Should be clear that we're just documenting what the code bundles apart from the Go stdlib and our own code.

renderer: Support `3d` keyword

Only applicable for square shapes

cmd/d2: Simple manpage

install.sh: Support installation from .rpm, .deb and with brew

cli: Add keybind for watcher client to zoom out to fit diagram

d2layoutplugin: Implement --help flag on layout binaries

cli: Watcher client favicon should be red on compile errors

like how github has (it's yellow here but it's red when there's an error)

syntax: globs

e.g. parent.*.shape: oval.

Just have to watch out for ambiguous syntax

And the & symbol as a followup.

Change every circle red:

*: {
  &shape: circle
  style.fill: red
}

cli: Add a flag to include `.d2` script as comment in resulting SVG

release: Release .deb and .rpm and serve from package repositories

Windows support

just dealing with CGO

configurable syntax highlighting theme for code blocks/snippets

allow CLI to pass a flag to syntax highlighter for both standalone code snippets and markdown code blocks

themes: customize and create own themes

Not sure what the best way is. For customization, perhaps a .config extension that overrides themes colors?

whitespace padding should be configurable

Currently the renderer adds a bit of padding around the bounding box, but it should be configurable

Binary include/exclude, or number? E.g. xPadding=40 yPadding=0. Probably just binary

release: Add install.md

Like https://github.com/coder/code-server/blob/main/docs/install.md

cli: Add a loader to watcher client

Layouts might be non-instant, can throw a loading sign/animation up for larger diagrams.

d2plugin: Plugin for importing Postgres schema as CSV

Can auto-create a SQL table diagram

cli: Minify output svg

release: Docker image

cli: First load in watch mode the svg should be fully zoomed out to fit the window