Documentation
¶
Index ¶
- Constants
- func RenderInlineProvenance(yamlData any, ctx *m.MergeContext, atmosConfig *schema.AtmosConfiguration) string
- func RenderInlineProvenanceWithStackFile(yamlData any, ctx *m.MergeContext, atmosConfig *schema.AtmosConfiguration, ...) (output string)
- func RenderSideBySide(yamlData any, ctx *m.MergeContext, atmosConfig *schema.AtmosConfiguration, ...) (result string)
- func RenderTree(ctx *m.MergeContext, atmosConfig *schema.AtmosConfiguration, ...) string
- type FileTreeNode
- type ProvenanceItem
- type YAMLLineInfo
Constants ¶
const ( // SymbolDefined indicates value defined at this level. SymbolDefined = "●" // U+25CF BLACK CIRCLE // SymbolInherited indicates value inherited/imported. SymbolInherited = "○" // U+25CB WHITE CIRCLE // SymbolComputed indicates a computed/templated value. SymbolComputed = "∴" )
Variables ¶
This section is empty.
Functions ¶
func RenderInlineProvenance ¶
func RenderInlineProvenance(yamlData any, ctx *m.MergeContext, atmosConfig *schema.AtmosConfiguration) string
RenderInlineProvenance renders YAML with provenance as inline comments. Deprecated: Use RenderInlineProvenanceWithStackFile instead.
func RenderInlineProvenanceWithStackFile ¶
func RenderInlineProvenanceWithStackFile(yamlData any, ctx *m.MergeContext, atmosConfig *schema.AtmosConfiguration, stackFile string) (output string)
RenderInlineProvenanceWithStackFile renders YAML with provenance as inline comments. The stackFile parameter is the stack manifest file being described (e.g., "orgs/acme/plat/dev/us-east-2.yaml"). Values from this file will be marked with ● (defined), while values from other files show ○ (inherited).
func RenderSideBySide ¶
func RenderSideBySide(yamlData any, ctx *m.MergeContext, atmosConfig *schema.AtmosConfiguration, leftWidth int) (result string)
RenderSideBySide renders YAML on the left and provenance tree on the right.
func RenderTree ¶
func RenderTree(ctx *m.MergeContext, atmosConfig *schema.AtmosConfiguration, allowedPaths map[string]bool) string
RenderTree renders provenance information as a tree structure.
Types ¶
type FileTreeNode ¶
type FileTreeNode struct {
File string
Items []ProvenanceItem
}
FileTreeNode represents provenance items grouped by file.
type ProvenanceItem ¶
type ProvenanceItem struct {
Symbol string // ● ○ ∴
Line int // Line number in source file
Path string // vars.name
}
ProvenanceItem represents a single provenance entry for rendering.
type YAMLLineInfo ¶
type YAMLLineInfo struct {
Path string // JSONPath for this line (e.g., "vars.enabled")
IsKeyLine bool // true if this line contains a key
IsContinuation bool // true if this is a continuation of a multi-line value
}
YAMLLineInfo contains information about a YAML line for provenance tracking.
Source Files