How gastrodon/psyduck works
High-Level Components
• CLI / Entrypoint (main.go)
• Configuration Loader & DSL Parser (configure/*)
• Core Pipeline Builder & Runner (core/*)
• Plugin Registry & Standard Library (stdlib/*)
• Example Usage (examples/*) – ancillary, for reference only
Public Functions to Components
a. CLI / Entrypoint (main.go)
– main()
– init() (if any)
b. configure package
– Read(path string) (reads HCL or YAML)
– Parse(raw []byte) (returns AST / pipeline model)
– EvalContext(model *Model) (prepares evaluation context)
– Pipelines(model *Model) ([]*PipelineSpec)
– PluginLoader(files []string) (discovers & loads compiled plug-ins)
c. core package
– Build(pipelines []*PipelineSpec) (*BuiltPipeline)
– Run(bp *BuiltPipeline) error
– decodeAttributes(node *NodeSpec) (called inside Build)
– decodeBody(node *NodeSpec)
– validateNode(node *NodeSpec)
d. stdlib package
Subpackages and their factory functions:
– produce/Constant(name, value) ProducerFunc
– produce/Increment(name, start) ProducerFunc
– transform/Inspect(name, field) TransformerFunc
– transform/Sprintf(name, fmtStr) TransformerFunc
– transform/Transpose(name, key, value) TransformerFunc
– transform/Zoom(name, factor) TransformerFunc
– consume/Trash(name) ConsumerFunc
– plugin.go: RegisterStdlib()
Call Relationships
main → configure.Read → configure.Parse → configure.EvalContext
configure.EvalContext → configure.Pipelines → core.Build
core.Build → decodeAttributes, decodeBody, validateNode
core.Build → stdlib.plugin.RegisterStdlib (register built-in plug-ins)
core.Run → each pipeline’s node.RunFunc (producer/transformer/consumer)
node.RunFunc → appropriate stdlib function (e.g., produce.Constant)
Architectural Patterns
• Plug-in architecture: show stdlib.plugin.RegisterStdlib hooking into the core’s library registry.
• DSL → AST → in-memory model → pipeline graph (clearly annotate parse → model → Build stages).
• Pipeline as a directed graph: indicate many-to-many producers, transformers, consumers.