https://github.com/goto1134/structurizr-d2-exporter

Export structurizr views to D2 diagrams
https://github.com/goto1134/structurizr-d2-exporter

d2 structurizr

Last synced: 3 months ago
JSON representation

Export structurizr views to D2 diagrams

• Host: GitHub
• URL: https://github.com/goto1134/structurizr-d2-exporter
• Owner: goto1134
• License: apache-2.0
• Created: 2022-12-10T18:37:02.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-03-03T13:46:58.000Z (3 months ago)
• Last Synced: 2025-03-03T14:34:34.996Z (3 months ago)
• Topics: d2, structurizr
• Language: D2
• Homepage: https://docs.structurizr.com/cli/export
• Size: 2.07 MB
• Stars: 17
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Structurizr D2 Exporter

[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/goto1134/structurizr-d2-exporter/badge)](https://securityscorecards.dev/viewer/?uri=github.com/goto1134/structurizr-d2-exporter)

[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8243/badge)](https://www.bestpractices.dev/projects/8243)

[![CodeQL](https://github.com/goto1134/structurizr-d2-exporter/actions/workflows/codeql.yml/badge.svg?branch=main&event=push)](https://github.com/goto1134/structurizr-d2-exporter/actions/workflows/codeql.yml)

[![Maven Central](https://img.shields.io/maven-central/v/io.github.goto1134/structurizr-d2-exporter.svg)](https://search.maven.org/artifact/io.github.goto1134/structurizr-d2-exporter)

The [D2Exporter](/lib/src/main/kotlin/io/github/goto1134/structurizr/export/d2/D2Exporter.kt) class provides a way

to export Structurizr views to diagram definitions that are compatible with [D2](https://d2lang.com).

This library is developed to be included in the [Structurizr CLI](https://github.com/structurizr/cli),

and is available on Maven Central, for inclusion in your own Java applications:

- groupId: `io.github.goto1134`

- artifactId: `structurizr-d2-exporter`

![amazon.png](examples/amazon.png)

# Table of Content

* [Structurizr D2 Exporter](#structurizr-d2-exporter)

* [Table of Content](#table-of-content)

* [Customization](#customization)

  * [`d2.title_position`](#d2title_position)

  * [`d2.animation`](#d2animation)

  * [`d2.animated`](#d2animated)

  * [`d2.fill_pattern`](#d2fill_pattern)

# Customization

## `d2.title_position`

* Entity: [`views`, `view`](https://github.com/structurizr/dsl/blob/master/docs/language-reference.md#views)

* Values: `top-left`, `top-center`, `top-right`, `center-left`, `center-right`, `bottom-left`, `bottom-center`, `bottom-right`

* Default: `top-center`

Specifies diagram title position. For more details, see [d2 near](https://d2lang.com/tour/positions/#near).

### Example:

Source: [title-position/workspace.dsl](lib/src/test/resources/title-position/workspace.dsl)

`bottom-left` title:

![title-position.png](examples/title-position.png)

## `d2.animation`

* Entity: [`views`, `view`](https://github.com/structurizr/dsl/blob/master/docs/language-reference.md#views)

* Values: `d2`, `frames`, `no`

* Default: `d2`

Specifies animation variant for [animated structurizr views](https://github.com/structurizr/dsl/blob/master/docs/language-reference.md#animation).

* `d2` is for [d2 steps animation](https://d2lang.com/tour/steps) that allows you

to produce animated images.

* `frames` is for structurizr default frame animation.

Unfortunately, it is not exportable yet.

* `no` can be used in case you have animation steps, but do not want the animation.

### Example:

![amazon-animated.svg](examples/amazon-animated.svg)

## `d2.animated`

* Entity:  [`relationship` style](https://github.com/structurizr/dsl/blob/master/docs/language-reference.md#relationship-style)

* Values: `true`, `false`

* Default: `false`

### Example

Source: [animated-relation/workspace.dsl](lib/src/test/resources/animated-relation/workspace.dsl)

![animated-relation.svg](examples/animated-relation.svg)

**Hint:** Do not forget to provide [`--animate-interval` flag](https://d2lang.com/tour/composition-formats/) when

producing SVG to see the animation.

## `d2.fill_pattern`

* Entity: [`views`, `view`](https://github.com/structurizr/dsl/blob/master/docs/language-reference.md#views) ,[`element` style](https://github.com/structurizr/dsl/blob/master/docs/language-reference.md#element-style)

* Values: `dots`, `lines`, `grain`

* Default: –

When set on `views` or `view`, adds a [fill pattern](https://d2lang.com/tour/style/#fill-pattern) to the background.

When set on an `element` style, adds [fill pattern](https://d2lang.com/tour/style/#fill-pattern) to its body.

### Example

Source: [fill-pattern/workspace.dsl](lib/src/test/resources/fill-pattern/workspace.dsl)

![fill-pattern.png](examples/fill-pattern.png)

## `d2.use_c4_person` (experimental)

* Entity: [`views`, `view`](https://github.com/structurizr/dsl/blob/master/docs/language-reference.md#views)

* Values: `true`, `false`

* Default: `false`

Uses d2 `c4_person` shape for structurizr `Person` and `Robot`.

**Hint:**

* Verify if your d2 version supports `c4_person`, see https://github.com/terrastruct/d2/pull/2397.

* In structurizr `Person` elements' default shape is `Box`. Use a custom style for a `Person` shape:

```

  views {

      styles {

          # structurizr uses retangle shapes for Person by default

          element "Person" {

              shape Person

          }

      }

  }

```