craftdot's Introduction

Craftdot

Get pretty diagram for your architecture/services with an easy way.

Features

nest group
custom attributes with list or key/vaule
include from file
custom style
support wildcards *

Install

$ npm install craftdot

Usage

Render crafdot file and open it on browser by default.

$ craftdot example/example.craftdot
rebuilding...
server listening on http://127.0.0.1:3200

Example

Comment

// this is a comment

Node

single node

node1

node with attributes

the attributes is compatible with Graphviz, so you can use any attribute exist in Graphviz.

node1[fillcolor: skyblue, style:filled]

node with details

list {
    hosts:
        - 172.16.1.4
        - 172.16.1.5
}

key-vaule {
    domain: "https://service.localdomain"
}

both {
    hosts:
        - 172.16.1.10
        - 172.16.1.11
    domain: "https://service.localdomain"
}

with-attributes [fillcolor: skyblue, style:filled]{
    domain: "https://service.localdomain"
}

apply attributes to mutiple nodes with wildcrads *

node1
node2
other

node*[fillcolor: skyblue, style:filled]

group

one group must contain at least one node or one group.

group cluster1 {
    node1
    node2
}

nest groups

group cluster1 {
    node1
    node2
    group sub-cluster1 {
        node1
        node2
    }
}

edge

node1
node2
node1 -> node2

mutiple edge in one line

node1
node2
node3

node1 -> node2,node3

edge with attributes

same as node, the attributes is compatible with Graphviz, so you can use any attribute exist in Graphviz.

node1
node2

node1 -> node2 [label: "hi", color: "red"]

apply attributes to mutiple edges with wildcrads *

node1
node2
node3
db

node1,node2,node3 -> db
* -> db [color: red]

include

// node.craftdot
node1
node2

// edge.craftdot
node1 -> node2

// include.craftdot
include {"node.craftdot"}
include {"edge.craftdot"}

craftdot's People

Contributors

Stargazers

Watchers

craftdot's Issues

Feature: Support mutiple flows in one line

Old style:

a -> b
b -> c
c -> d

New style:

a -> b -> c -> d
// or
a -> b
  -> c
  -> d

filter child element in group doesn't work

easier grammar

craftdot use yaml as it's config file now. it's good but I still want to see if there is a grammar can be easier than yaml.

yaml:

dc-1:
  type: group
  sub-dc-1:
    type: group
    service-3:
      hosts:
        - host-5 172.0.0.5
  service-1:
    domains:
      - 1.example.com
    ports:
      - 8000
    hosts:
      - host-1 172.0.0.1
      - host-2 172.0.0.2
dc-2:
  type: group
  service-2:
    domains:
      - 2.example.com
    ports:
      - 8000
    hosts:
      - host-3 172.0.0.3
      - host-4 172.0.0.4

flows:
  - service-1 -> service-2
  - service-2 -> service-3

new grammar:

group dc-1{
    service-1 {
        domains {
            1.example.com
        }
        ports {
            8000
        }
        hosts {
            host-1 172.0.0.1
            host-2 172.0.0.2
        }
    }
    group sub-dc-1 {
        service-3 {
            hosts {
                host-5 172.0.0.5
            }
        }
    }
}

group dc-2 {
    service-2 {
        domains {
            2.example.com
        }
        ports {
            8000
        }
        hosts {
            host-3 172.0.0.3
            host-4 172.0.0.4
        }
    }
}

service-1 -> service-2
service-2 -> service-3

Recommend Projects