emd

package

v0.10.2-alpha.0...-d05ecc4 Latest Latest Go to latest Published: Aug 16, 2018 License: BSD-3-Clause Imports: 4 Imported by: 3

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func ToGraphViz(emdString string) string

ToGraphViz turns EMD into a GraphViz digraph which can be used to generate images of the event storming described by the EMD input

type Command struct {
	Name       string
	Parameters []Parameter
}

Command in Event Markdown language Example: "Place Order-> // orderId, placedDate, deliveryDate"

type Comment struct {
	Text string
}

A Comment in Event Markdown Example: "Order Placed"

type Document struct {
	Name       string
	Properties []Property
}

Document describes an emd read model document

type Emd struct {
	Lines  []Item
	Errors []EmdValidationError `yaml:"Errors"` // The presence of errors means that no conversion to

}

Emd is a specification written in Event Markdown.

func Parse(emdInput []string) (Emd, error)

Parse Event Markdown to Event Markup Language

type EmdValidationError struct {
	ErrorID string
	Message string
}

A EmdValidationError means that the event markdown structure cannot be used to generate event markup.

type Event struct {
	Name       string
	Properties []Property
}

Event describes an emd event

type Item interface {
}

Item is a line item in an Event Markdown file.

type Parameter struct {
	Name string
}

A Parameter for an emd command

type Property struct {
	Name string
}

A Property of an emd event