Crate pretty_yaml

pretty_yaml is a semi-tolerant and configurable YAML formatter.

Basic Usage

You can format source code string by using format_text function.

use pretty_yaml::{config::FormatOptions, format_text};

let options = FormatOptions::default();
assert_eq!("- a\n- b\n", &format_text("-  a\n-     b", &options).unwrap());

For detailed documentation of configuration, please refer to Configuration.

If there’re syntax errors in source code, it will return Err:

use pretty_yaml::{config::FormatOptions, format_text};

let options = FormatOptions::default();
assert!(format_text("{", &options).is_err());

Print Syntax Tree

If you have already parsed the syntax tree with yaml_parser, you can use print_tree to print it.

use pretty_yaml::{config::FormatOptions, print_tree};
use yaml_parser::{ast::{AstNode, Root}, parse};

let input = "-  a\n-     b";
let tree = parse(input).unwrap();
let root = Root::cast(tree).unwrap();

let options = FormatOptions::default();
assert_eq!("- a\n- b\n", &print_tree(&root, &options));

Modules

• config
  Types about configuration.

Functions

• format_text
  Format the given source input.
• print_tree
  Print the given concrete syntax tree. You may use this when you already have the parsed CST.