Dhall.Util

Shared utility functions

Documentation

snip :: Text -> Text

Utility function to cut out the interior of a large text block

snipDoc :: Doc Ann -> Doc a

Like snip, but for Docs

Note that this has to be opinionated and render ANSI color codes, but that should be fine because we don't use this in a non-interactive context

insert :: Pretty a => a -> Doc Ann

Function to insert an aligned pretty expression

_ERROR :: IsString string => string

Prefix used for error messages

data Censor

Set to Censor if you want to censor error text that might include secrets

Constructors

NoCensor

Censor

data Input

Path to input

Constructors

StandardInput

InputFile FilePath

data OutputMode

Some command-line subcommands can either Write their input or Check that the input has already been modified. This type is shared between them to record that choice.

Constructors

Write

Check

data Output

Path to output

Constructors

StandardOutput

OutputFile FilePath

getExpression :: Censor -> Input -> IO (Expr Src Import)

Convenient utility for retrieving an expression

getExpressionAndHeader :: Censor -> Input -> IO (Header, Expr Src Import)

Convenient utility for retrieving an expression along with its header

getExpressionAndHeaderFromStdinText :: Censor -> Text -> IO (Header, Expr Src Import)

Convenient utility for retrieving an expression along with its header from | text already read from STDIN (so it's not re-read)

newtype Header

A header corresponds to the leading comment at the top of a Dhall file.

The header includes comment characters but is stripped of leading spaces and trailing newlines

Constructors

Header Text

Instances

Show Header

Defined in Dhall.Parser

Methods

showsPrec :: Int -> Header -> ShowS

show :: Header -> String

showList :: [Header] -> ShowS

data CheckFailed

Exception thrown when the --check flag to a command-line subcommand fails

Constructors

CheckFailed

Fields

• command :: Text
• modified :: Text

Instances

Show CheckFailed

Defined in Dhall.Util

Methods

showsPrec :: Int -> CheckFailed -> ShowS

show :: CheckFailed -> String

showList :: [CheckFailed] -> ShowS

Exception CheckFailed

Defined in Dhall.Util

Methods

toException :: CheckFailed -> SomeException

fromException :: SomeException -> Maybe CheckFailed

displayException :: CheckFailed -> String