Moduletomland-1.3.3.3Haskell2010

Toml.Type.Printer

SPDX-License-Identifier : MPL-2.0 Maintainer : Kowainik xrom.xkov@gmail.com Stability : Stable Portability : Portable

Contains functions for pretty printing toml types.

2 types
4 values

Packagetomland-1.3.3.3
Exports6
LanguageHaskell2010
LicenceMPL-2.0
SourcePrinter.hs

datadata PrintOptions

Configures the pretty printer.

Constructors

PrintOptions
- printOptionsSorting :: !Maybe (Key -> Key -> Ordering)
  How table keys should be sorted, if at all.
- printOptionsIndent :: !Int
  Number of spaces by which to indent.
- printOptionsLines :: !Lines
  How to print Array. OneLine:
```
     foo = [a, b]
     
```
  MultiLine:
```
     foo =
         [ a
         , b
         ]
     
```
  Default is OneLine.

datadata Lines

OneLine MultiLine

valuedefaultOptions :: PrintOptions

Default printing options.

Sorts all keys and tables by name.
Indents with 2 spaces.

valuepretty :: TOML -> Text

Converts TOML type into Text (using defaultOptions).

For example, this

TOML
    { tomlPairs  = HashMap.fromList
          [("title", AnyValue $ Text "TOML example")]
    , tomlTables = PrefixTree.fromList
          [( "example" <| "owner"
           , mempty
                 { tomlPairs  = HashMap.fromList
                       [("name", AnyValue $ Text Kowainik)]
                 }
           )]
    , tomlTableArrays = mempty
    }

will be translated to this

title = "TOML Example"

[example.owner]
  name = "Kowainik"

valueprettyOptions :: PrintOptions -> TOML -> Text

Converts TOML type into Text using provided PrintOptions

valueprettyKey :: Key -> Text

Converts a key to text