Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// GroupByNamespace controls whether tasks in the same namespace are grouped together
// in the graphviz output. Namespace is defined by a common prefix prior to a colon (`:`).
GroupByNamespace bool `json:"groupByNamespace,omitempty" yaml:"groupByNamespace,omitempty"`
// Graphviz is the configuration for the Graphviz output.
Graphviz *Graphviz `json:"graphviz"`
// DotPath is the path to the dot executable, or the folder containing it.
// If not specified, dot will be looked up on the PATH.
DotPath string `json:"dotPath,omitempty" yaml:"dotPath,omitempty"`
}
type Graphviz ¶
type Graphviz struct {
// Font is the font used for labels in the Graphviz output. It can be any valid Graphviz font.
// https://graphviz.org/docs/attrs/fontname/
Font string `json:"font,omitempty" yaml:"font,omitempty"`
// FontSize is the font size used in the Graphviz output, in points.
// https://graphviz.org/docs/attrs/fontsize/
FontSize int `json:"fontSize,omitempty" yaml:"fontSize,omitempty"`
// DependencyEdges is the presentation for dependency edges between tasks
DependencyEdges *GraphvizEdge `json:"dependencyEdges,omitempty" yaml:"dependencyEdges,omitempty"`
// CallEdges is the presentation for call edges between tasks
CallEdges *GraphvizEdge `json:"callEdges,omitempty" yaml:"callEdges,omitempty"`
// TaskNodes is the presentation for task nodes
TaskNodes *GraphvizNode `json:"taskNodes,omitempty" yaml:"taskNodes,omitempty"`
// NodeStyleRules are additional style rules applied to matching task nodes, in order.
// All matching rules are applied; in case of conflicts, the last matching rule wins.
NodeStyleRules []GraphvizStyleRule `json:"nodeStyleRules,omitempty" yaml:"nodeStyleRules,omitempty"`
// HighlightColor is the fill color used for highlighted task nodes (from --highlight flag).
// Defaults to "yellow" when not specified.
HighlightColor string `json:"highlightColor,omitempty" yaml:"highlightColor,omitempty"`
}
type GraphvizEdge ¶
type GraphvizEdge struct {
// Color is the color of the edge. It can be any valid Graphviz color.
// https://graphviz.org/docs/attrs/color/
Color string `json:"color,omitempty" yaml:"color,omitempty"`
// Width is the width of the edge. It can be any positive integer.
Width int `json:"width,omitempty" yaml:"width,omitempty"`
// Style is the style of the edge. It can be any valid Graphviz style.
// https://graphviz.org/docs/attr-types/style/
Style string `json:"style,omitempty" yaml:"style,omitempty"`
}
type GraphvizNode ¶
type GraphvizNode struct {
// Color is the color of the node border. It can be any valid Graphviz color.
// https://graphviz.org/docs/attrs/color/
Color string `json:"color,omitempty" yaml:"color,omitempty"`
// FillColor is the fill/background color of the node. It can be any valid Graphviz color.
// https://graphviz.org/docs/attrs/fillcolor/
FillColor string `json:"fillColor,omitempty" yaml:"fillColor,omitempty"`
// Style is the style of the node (e.g., "filled", "dashed", "bold").
// https://graphviz.org/docs/attr-types/style/
Style string `json:"style,omitempty" yaml:"style,omitempty"`
// FontColor is the color of the label text. It can be any valid Graphviz color.
// https://graphviz.org/docs/attrs/fontcolor/
FontColor string `json:"fontColor,omitempty" yaml:"fontColor,omitempty"`
}
type GraphvizStyleRule ¶
type GraphvizStyleRule struct {
// Match is the pattern used to match task names. Supports wildcards (* and ?).
Match string `json:"match,omitempty" yaml:"match,omitempty"`
// Color is the color of the node border. It can be any valid Graphviz color.
// https://graphviz.org/docs/attrs/color/
Color string `json:"color,omitempty" yaml:"color,omitempty"`
// FillColor is the fill/background color of the node. It can be any valid Graphviz color.
// https://graphviz.org/docs/attrs/fillcolor/
FillColor string `json:"fillColor,omitempty" yaml:"fillColor,omitempty"`
// Style is the style of the node (e.g., "filled", "dashed", "bold").
// https://graphviz.org/docs/attr-types/style/
Style string `json:"style,omitempty" yaml:"style,omitempty"`
// FontColor is the color of the label text. It can be any valid Graphviz color.
// https://graphviz.org/docs/attrs/fontcolor/
FontColor string `json:"fontColor,omitempty" yaml:"fontColor,omitempty"`
}
GraphvizStyleRule defines a style rule that is applied to task nodes whose names match the given pattern.
Click to show internal directories.
Click to hide internal directories.