Toml.Pretty

Pretty-printer document with TOML class attributes to aid in syntax-highlighting.

Annotation used to enable styling pretty-printed TOML

Render a complete TOML document using top-level table and array of table sections where possible.

Keys are sorted alphabetically. To provide a custom ordering, see prettyTomlOrdered.

Render a complete TOML document like prettyToml but use a custom key ordering. The comparison function has access to the complete key path. Note that only keys in the same table will every be compared.

This operation allows you to render your TOML files with the most important sections first. A TOML file describing a package might desire to have the [package] section first before any of the ancillary configuration sections.

The table path is the name of the table being sorted. This allows the projection to be aware of which table is being sorted.

The key is the key in the table being sorted. These are the keys that will be compared to each other.

Here's a projection that puts the package section first, the secondary section second, and then all remaining cases are sorted alphabetically afterward.

example :: [String] -> String -> Either Int String
example [] "package" = Left 1
example [] "second"  = Left 2
example _  other     = Right other

We could also put the tables in reverse-alphabetical order by leveraging an existing newtype.

reverseOrderProj :: [String] -> String -> Down String
reverseOrderProj _ = Down

Render a value suitable for assignment on the right-hand side of an equals sign. This value will always use inline table and list syntax.

Render token for human-readable error messages.

Pretty-print a section heading. The result is annotated as a TableClass.

Renders a simple-key using quotes where necessary.

Renders a dotted-key using quotes where necessary and annotated as a KeyClass.

Pretty-print as line:col: message

Pretty-print as line:col