Skip to main content

Module debug

Module debug 

Source
Expand description

Debug utilities for inspecting and understanding YAML structures.

This module provides debugging tools including:

  • CST tree visualization
  • Pretty Debug formatting showing actual values
  • Visual diffs between documents
  • Deep value inspection
  • AST visualization (GraphViz output)

These functions are useful for both contributors working on yaml-edit and users debugging their YAML documents.

Structs§

PrettyDebug
Pretty-print a YAML document showing its structure and values.
ValueInspector
Value inspector for deep type analysis.
VisualDiff
Visual diff between two YAML documents.

Functions§

graphviz_dot
Generate GraphViz DOT format visualization of the CST.
print_stats
Prints statistics about a YAML document’s CST.
print_tree
Prints the CST (Concrete Syntax Tree) structure to stdout.
print_tree_indent
Prints the CST structure with a custom starting indentation.
tree_to_string
Returns a string representation of the CST structure.
validate_tree
Validates that the CST follows expected structural invariants.