YAMLGuard Documentation

The Auto-Fix Engine

Unlike basic formatters, YAMLGuard scans for semantic and structural issues that technically follow syntax rules but often cause deployment failures:

• Odd Indentation: Automatically aligns staggered indentation to even-spaced standards.
• Boolean Ambiguity: Detects unquoted "yes" or "no" values and wraps them in quotes to prevent parsers from converting them to true/false.
• Missing Colons: Identifies and suggests fixes for key-value pairs missing the delimiter.

Advanced Formatting

Prepare your YAML for production or readability:

• Indentation Control: Toggle between 2-space and 4-space indent levels.
• Minification: Squashes the YAML into a compact, single-document payload for API delivery.
• Tree View Exploration: Navigate complex, nested structures with a collapsible interactive tree.

Secure Validation

Validate manifests and configs without exposing environment secrets:

• Zero Global Egress: All parsing is done via js-yaml in the browser.
• Real-time Syntax Guard: Instant feedback on parser errors with line-number highlights for fast debugging.
• Duplicate Key Detection: Flags redundant keys that would lead to "Last-In-Wins" data loss.

Interoperability

Convert your YAML data into other standard formats for cross-language support:

• YAML to JSON: Clean mapping for use in JavaScript/Node.js environments.
• YAML to XML: Generates hierarchical XML structures for legacy enterprise integrations.

Structural Analytics

The **Analytics** tool provides a high-level view of your document's complexity:

• Metric Counts: Total key-value pairs, maximum nesting depth, and array frequency.
• Type Breakdown: Tables showing the distribution of strings, numbers, booleans, and nulls.
• Anomaly Detection: Detects potential data inconsistencies like "magic numbers" or unusual string lengths.

Frequently Asked Questions