Moduletoml-parser-2.0.0.0Haskell2010

Toml.Semantics.Ordered

This module can help build a key ordering projection given an existing TOML file. This could be useful for applying a transformation to a TOML file before pretty-printing it back in something very close to the original order.

When using the computed order, table keys will be remembered in the order they appeared in the source file. Any key additional keys added to the tables will be ordered alphabetically after all the known keys.

demo =
 do txt <- readFile "demo.toml"
    let Right exprs = Toml.Parser.parseRawToml txt
        to          = extractTableOrder exprs
        Right toml  = semantics exprs
        projection  = projectKey to
    print (prettyTomlOrdered projection toml)

2 types
3 values

Packagetoml-parser-2.0.0.0
Exports5
LanguageHaskell2010
LicenceISC
SourceOrdered.hs

newtypenewtype TableOrder

Summary of the order of the keys in a TOML document.

valueextractTableOrder :: [Expr a] -> TableOrder

Extract a TableOrder from the output of Toml.Parser.parseRawToml to be later used with projectKey.

valueprojectKey

:: TableOrder
table order
-> [Text]
table path
-> Text
key
-> ProjectedKey
type suitable for ordering table keys

Generate a projection function for use with prettyTomlOrdered

newtypenewtype ProjectedKey

Opaque type used by projectKey

Instances2Eq, Ord

Eq ProjectedKeyDefined in toml-parser-2.0.0.0 · Toml.Semantics.Ordered
Ord ProjectedKeyDefined in toml-parser-2.0.0.0 · Toml.Semantics.Ordered

valuedebugTableOrder :: TableOrder -> String

Render a white-space nested representation of the key ordering extracted by extractTableOrder. This is provided for debugging and understandability.