Documentation
¶
Overview ¶
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. * * This product includes software developed at Datadog (https://www.datadoghq.com) Copyright 2024 Datadog, Inc.
Index ¶
- func AddExtraInfo(ctx context.Context, documents []model.Document, filePath string) []model.Document
- func ConvertKeysToString(docs []model.Document) []model.Document
- func Parse(ctx context.Context, fileContent []byte, filePath string, ...) (resolved []byte, documents []model.Document, ignoreLines []int, ...)
- func ParseWithNodeTransform(ctx context.Context, fileContent []byte, filePath string, ...) (resolved []byte, documents []model.Document, ignoreLines []int, ...)
- func ParseWithNodeTransformNoResolve(ctx context.Context, fileContent []byte, filePath string, ...) (documents []model.Document, ignoreLines []int, err error)
- func SupportedExtensions() []string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddExtraInfo ¶ added in v0.0.10
func ConvertKeysToString ¶ added in v0.0.10
convertKeysToString goes through every document to convert map[interface{}]interface{} to map[string]interface{}
func Parse ¶ added in v0.0.10
func Parse(ctx context.Context, fileContent []byte, filePath string, resolveReferences bool, maxResolverDepth int) ( resolved []byte, documents []model.Document, ignoreLines []int, resolvedFiles map[string]model.ResolvedFile, err error)
Parse parses yaml/yml file and returns it as a Document
func ParseWithNodeTransform ¶ added in v1.17.0
func ParseWithNodeTransform(ctx context.Context, fileContent []byte, filePath string, resolveReferences bool, maxResolverDepth int, fn func(node *yaml.Node)) ( resolved []byte, documents []model.Document, ignoreLines []int, resolvedFiles map[string]model.ResolvedFile, err error)
ParseWithNodeTransform parses like Parse, but applies fn to each document's root mapping node before it is converted to a model.Document. The transform sees the same nodes that line tracking is built from, so in-place value rewrites keep their original line numbers. A nil fn is equivalent to Parse.
func ParseWithNodeTransformNoResolve ¶ added in v1.17.0
func ParseWithNodeTransformNoResolve(ctx context.Context, fileContent []byte, filePath string, fn func(node *yaml.Node)) ( documents []model.Document, ignoreLines []int, err error)
ParseWithNodeTransformNoResolve is ParseWithNodeTransform without the generic file-reference resolution pass. Platforms with their own sibling-file semantics (Docker Compose extends/env_file) resolve those references themselves; the generic resolver would otherwise inline any .yaml-valued scalar as a reference target.
func SupportedExtensions ¶ added in v0.0.10
func SupportedExtensions() []string
SupportedExtensions returns extensions supported by this parser, which are yaml and yml extension
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
|
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. |
|
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
|
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. |
|
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
|
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. |
|
names
Package names holds the default Docker Compose file names as a leaf package, shared by the Compose parser and the analyzer's classifier (which sit on opposite sides of an import cycle through pkg/parser/yaml), so both agree on which files are base files and which are auto-merged overrides.
|
Package names holds the default Docker Compose file names as a leaf package, shared by the Compose parser and the analyzer's classifier (which sit on opposite sides of an import cycle through pkg/parser/yaml), so both agree on which files are base files and which are auto-merged overrides. |