shake-factory-0.0.0.0: See README for more info

Safe HaskellNone
LanguageHaskell2010

ShakeFactory.Dhall

Contents

Description

Shake functions for dhall project

Synopsis

Dhall commands

dhallFormat #

Arguments

:: String

The dhall expression

-> Action String 

A shake action to run dhall format

dhallFreeze #

Arguments

:: String

The cwd

-> String

The dhall expression

-> Action String 

A shake action to run dhall freeze

dhallFormatFreeze #

Arguments

:: FilePath

The cwd

-> String

The dhall expression

-> Action String 

A shake action to format and freeze an expression

dhallYaml #

Arguments

:: String

The expression

-> FilePath

The output file

-> Action () 

dhallJson #

Arguments

:: String

The expression

-> FilePath

The output file

-> Action () 

Actions

dhallTopLevelPackageAction #

Arguments

:: FilePath

Path of the real package

-> FilePath

Name of the top level file

-> Action () 

A shake action to create the top-level package.dhall

dhallPackageAction :: FilePath -> Action () #

Create a dhall package at file at location from ["*.dhall", */package.dhall] For example, if the location directory contains a Type and default file, the package will contains: { Type = .Type.dhall, default = .default.dhall }

dhallUnionAction :: [FilePattern] -> FilePath -> Action () #

dhallReadmeAction :: FilePath -> Action () #

Ensure the readme contains the latest content and result This function replace every code-block with the file content and the command output.

dhallDefaultAction :: FilePath -> Action () #

dhallZuulAction #

Arguments

:: String

The expression

-> FilePath

The output file

-> Action () 

A shake action to render a zuul configuration

dhallContainerAction #

Arguments

:: String

The Containerfile expression

-> String

The dhall-containerfile version

-> FilePath

The output path

-> Action () 

A shake action to render a Containerfile

Helpers

dhallDocsRules #

Arguments

:: String

The name of the dhall package

-> Rules () 

dhallDocsDirRules #

Arguments

:: FilePath

The root of the dhall package

-> String

The name of the dhall package

-> Rules () 

Render the documentation of a dhall project

mkDhallPackage :: [FilePath] -> String #

Create a dhall package from a list of files:

>>> mkDhallPackage ["Type.dhall", "Project/package.dhall"]
"{ Type = ./Type.dhall , Project = ./Project/package.dhall }"

mkDhallUnion :: [FilePath] -> String #

Create a dhall union from a list of files:

>>> mkDhallUnion ["Job/package.dhall", "Project/package.dhall"]
"< Job : ./Job/package.dhall | Project : ./Project/package.dhall >"

Re-Export

needDhall :: [FilePath] -> Action () #