Discover Packages
github.com/specrig/specrig-go
flows
package
Version:
v0.1.0
Opens a new window with list of versions in this module.
Published: Oct 24, 2026
License: MIT
Opens a new window with license information.
Imports: 16
Opens a new window with list of imports.
Imported by: 0
Opens a new window with list of known importers.
Documentation
Documentation
¶
Format is what this package writes under specrig: and the newest it reads.
Assemble builds the index at path and a page per input a flow reaches beside
it, keeping the prose the index at path already has. Foreign are the files at
a record's path it took for somebody else's.
Complete says whether the suite ran whole: a narrowed run saw part of the
service, and its document would lose the rest.
Generated says whether a page is one Assemble writes.
LinkChanges says, between two versions of an index, which links between
services were lost and which appeared: the reason a page changed.
Write rewrites the document at path from what the suite traced, keeping its
prose. The cases are read from ./feature.
type Branch struct {
Sends []string `yaml:"sends,omitempty"`
Sent map[string ][]string `yaml:"sent,omitempty"`
Refusal string `yaml:"refused,omitempty"`
Description string `yaml:"description,omitempty"`
Cases []string `yaml:"cases"`
}
type Doc struct {
Specrig string `yaml:"specrig"`
Service string `yaml:"service"`
Inputs []Input `yaml:"inputs"`
Outputs []Output `yaml:"outputs,omitempty"`
Orphaned []Orphan `yaml:"orphaned,omitempty"`
}
type Flow struct {
Id string `yaml:"id"`
Title string `yaml:"title,omitempty"`
Description string `yaml:"description,omitempty"`
Entry string `yaml:"entry"`
From []string `yaml:"from,omitempty"`
Steps []string `yaml:"steps"`
}
type Index struct {
Flows []Flow `yaml:"flows"`
Links []Link `yaml:"links,omitempty"`
Untested []string `yaml:"untested,omitempty"`
Outside []string `yaml:"outside,omitempty"`
System *surface .Report `yaml:"system,omitempty"`
Orphaned []Orphan `yaml:"orphaned,omitempty"`
}
type Input struct {
Message string `yaml:"message"`
Description string `yaml:"description,omitempty"`
Fields []string `yaml:"fields,omitempty"`
Needs map[string ][]string `yaml:"needs,omitempty"`
Branches []Branch `yaml:"branches"`
}
type Link struct {
From string `yaml:"from"`
To string `yaml:"to"`
Message string `yaml:"message"`
Notes []string `yaml:"notes,omitempty"`
}
type Orphan struct {
Anchor string `yaml:"anchor"`
Title string `yaml:"title,omitempty"`
Description string `yaml:"description,omitempty"`
}
type Output struct {
Message string `yaml:"message"`
Fields []string `yaml:"fields,omitempty"`
}
Source Files
¶
Click to show internal directories.
Click to hide internal directories.