Language.Docker

Documentation

type Dockerfile = [InstructionPos Text]

Type of the Dockerfile AST

Parsing Dockerfiles (Language.Docker.Syntax and Language.Docker.Parser)

parseText :: Text -> Either Error Dockerfile

parseFile :: FilePath -> IO (Either Error Dockerfile)

parseStdin :: IO (Either Error Dockerfile)

Reads the standard input until the end and parses the contents as a Dockerfile

Re-exports from megaparsec

parseErrorPretty

Arguments

:: (VisualStream s, ShowErrorComponent e)

=> ParseError s e

Parse error to render

-> String

Result of rendering

Pretty-print a ParseError. The rendered String always ends with a newline.

Since: megaparsec-5.0.0

errorBundlePretty

Arguments

:: (VisualStream s, TraversableStream s, ShowErrorComponent e)

=> ParseErrorBundle s e

Parse error bundle to display

-> String

Textual rendition of the bundle

Pretty-print a ParseErrorBundle. All ParseErrors in the bundle will be pretty-printed in order together with the corresponding offending lines by doing a single efficient pass over the input stream. The rendered String always ends with a newline.

Since: megaparsec-7.0.0

Pretty-printing Dockerfiles (Language.Docker.PrettyPrint)

prettyPrint :: Dockerfile -> Text

Pretty print a Dockerfile to a Text

prettyPrintDockerfile :: Pretty (Arguments args) => [InstructionPos args] -> Doc ann

Types (Language.Docker.Syntax)

data Instruction args

All commands available in Dockerfiles

Constructors

From !BaseImage

Add !AddArgs

User !Text

Label !Pairs

Stopsignal !Text

Copy !CopyArgs

Run !(RunArgs args)

Cmd !(Arguments args)

Shell !(Arguments args)

Workdir !Directory

Expose !Ports

Volume !Text

Entrypoint !(Arguments args)

Maintainer !Text

Env !Pairs

Arg !Text !(Maybe Text)

Healthcheck !(Check args)

Comment !Text

OnBuild !(Instruction args)

Instances

Functor Instruction

Defined in Language.Docker.Syntax

Methods

fmap :: (a -> b) -> Instruction a -> Instruction b

(<$) :: a -> Instruction b -> Instruction a

Eq args => Eq (Instruction args)

Defined in Language.Docker.Syntax

Methods

(==) :: Instruction args -> Instruction args -> Bool

(/=) :: Instruction args -> Instruction args -> Bool

Ord args => Ord (Instruction args)

Defined in Language.Docker.Syntax

Methods

compare :: Instruction args -> Instruction args -> Ordering

(<) :: Instruction args -> Instruction args -> Bool

(<=) :: Instruction args -> Instruction args -> Bool

(>) :: Instruction args -> Instruction args -> Bool

(>=) :: Instruction args -> Instruction args -> Bool

max :: Instruction args -> Instruction args -> Instruction args

min :: Instruction args -> Instruction args -> Instruction args

Show args => Show (Instruction args)

Defined in Language.Docker.Syntax

Methods

showsPrec :: Int -> Instruction args -> ShowS

show :: Instruction args -> String

showList :: [Instruction args] -> ShowS

data InstructionPos args

Instruction with additional location information required for creating good check messages

Constructors

InstructionPos

Fields

• instruction :: !(Instruction args)
• sourcename :: !Filename
• lineNumber :: !Linenumber

Instances

Functor InstructionPos

Defined in Language.Docker.Syntax

Methods

fmap :: (a -> b) -> InstructionPos a -> InstructionPos b

(<$) :: a -> InstructionPos b -> InstructionPos a

Eq args => Eq (InstructionPos args)

Defined in Language.Docker.Syntax

Methods

(==) :: InstructionPos args -> InstructionPos args -> Bool

(/=) :: InstructionPos args -> InstructionPos args -> Bool

Ord args => Ord (InstructionPos args)

Defined in Language.Docker.Syntax

Methods

compare :: InstructionPos args -> InstructionPos args -> Ordering

(<) :: InstructionPos args -> InstructionPos args -> Bool

(<=) :: InstructionPos args -> InstructionPos args -> Bool

(>) :: InstructionPos args -> InstructionPos args -> Bool

(>=) :: InstructionPos args -> InstructionPos args -> Bool

max :: InstructionPos args -> InstructionPos args -> InstructionPos args

min :: InstructionPos args -> InstructionPos args -> InstructionPos args

Show args => Show (InstructionPos args)

Defined in Language.Docker.Syntax

Methods

showsPrec :: Int -> InstructionPos args -> ShowS

show :: InstructionPos args -> String

showList :: [InstructionPos args] -> ShowS

data BaseImage

Constructors

BaseImage

Fields

• image :: !Image
• tag :: !(Maybe Tag)
• digest :: !(Maybe Digest)
• alias :: !(Maybe ImageAlias)
• platform :: !(Maybe Platform)

Instances

Eq BaseImage

Defined in Language.Docker.Syntax

Methods

(==) :: BaseImage -> BaseImage -> Bool

(/=) :: BaseImage -> BaseImage -> Bool

Ord BaseImage

Defined in Language.Docker.Syntax

Methods

compare :: BaseImage -> BaseImage -> Ordering

(<) :: BaseImage -> BaseImage -> Bool

(<=) :: BaseImage -> BaseImage -> Bool

(>) :: BaseImage -> BaseImage -> Bool

(>=) :: BaseImage -> BaseImage -> Bool

max :: BaseImage -> BaseImage -> BaseImage

min :: BaseImage -> BaseImage -> BaseImage

Show BaseImage

Defined in Language.Docker.Syntax

Methods

showsPrec :: Int -> BaseImage -> ShowS

show :: BaseImage -> String

showList :: [BaseImage] -> ShowS

newtype SourcePath

Constructors

SourcePath

Fields

• unSourcePath :: Text

Instances

Eq SourcePath

Defined in Language.Docker.Syntax

Methods

(==) :: SourcePath -> SourcePath -> Bool

(/=) :: SourcePath -> SourcePath -> Bool

Ord SourcePath

Defined in Language.Docker.Syntax

Methods

compare :: SourcePath -> SourcePath -> Ordering

(<) :: SourcePath -> SourcePath -> Bool

(<=) :: SourcePath -> SourcePath -> Bool

(>) :: SourcePath -> SourcePath -> Bool

(>=) :: SourcePath -> SourcePath -> Bool

max :: SourcePath -> SourcePath -> SourcePath

min :: SourcePath -> SourcePath -> SourcePath

Show SourcePath

Defined in Language.Docker.Syntax

Methods

showsPrec :: Int -> SourcePath -> ShowS

show :: SourcePath -> String

showList :: [SourcePath] -> ShowS

IsString SourcePath

Defined in Language.Docker.Syntax

Methods

fromString :: String -> SourcePath

newtype TargetPath

Constructors

TargetPath

Fields

• unTargetPath :: Text

Instances

Eq TargetPath

Defined in Language.Docker.Syntax

Methods

(==) :: TargetPath -> TargetPath -> Bool

(/=) :: TargetPath -> TargetPath -> Bool

Ord TargetPath

Defined in Language.Docker.Syntax

Methods

compare :: TargetPath -> TargetPath -> Ordering

(<) :: TargetPath -> TargetPath -> Bool

(<=) :: TargetPath -> TargetPath -> Bool

(>) :: TargetPath -> TargetPath -> Bool

(>=) :: TargetPath -> TargetPath -> Bool

max :: TargetPath -> TargetPath -> TargetPath

min :: TargetPath -> TargetPath -> TargetPath

Show TargetPath

Defined in Language.Docker.Syntax

Methods

showsPrec :: Int -> TargetPath -> ShowS

show :: TargetPath -> String

showList :: [TargetPath] -> ShowS

IsString TargetPath

Defined in Language.Docker.Syntax

Methods

fromString :: String -> TargetPath

data Chown

Constructors

Chown !Text

NoChown

Instances

Eq Chown

Defined in Language.Docker.Syntax

Methods

(==) :: Chown -> Chown -> Bool

(/=) :: Chown -> Chown -> Bool

Ord Chown

Defined in Language.Docker.Syntax

Methods

compare :: Chown -> Chown -> Ordering

(<) :: Chown -> Chown -> Bool

(<=) :: Chown -> Chown -> Bool

(>) :: Chown -> Chown -> Bool

(>=) :: Chown -> Chown -> Bool

max :: Chown -> Chown -> Chown

min :: Chown -> Chown -> Chown

Show Chown

Defined in Language.Docker.Syntax

Methods

showsPrec :: Int -> Chown -> ShowS

show :: Chown -> String

showList :: [Chown] -> ShowS

IsString Chown

Defined in Language.Docker.Syntax

Methods

fromString :: String -> Chown

data CopySource

Constructors

CopySource !Text

NoSource

Instances

Eq CopySource

Defined in Language.Docker.Syntax

Methods

(==) :: CopySource -> CopySource -> Bool

(/=) :: CopySource -> CopySource -> Bool

Ord CopySource

Defined in Language.Docker.Syntax

Methods

compare :: CopySource -> CopySource -> Ordering

(<) :: CopySource -> CopySource -> Bool

(<=) :: CopySource -> CopySource -> Bool

(>) :: CopySource -> CopySource -> Bool

(>=) :: CopySource -> CopySource -> Bool

max :: CopySource -> CopySource -> CopySource

min :: CopySource -> CopySource -> CopySource

Show CopySource

Defined in Language.Docker.Syntax

Methods

showsPrec :: Int -> CopySource -> ShowS

show :: CopySource -> String

showList :: [CopySource] -> ShowS

IsString CopySource

Defined in Language.Docker.Syntax

Methods

fromString :: String -> CopySource

data CopyArgs

Constructors

CopyArgs

Fields

• sourcePaths :: NonEmpty SourcePath
• targetPath :: !TargetPath
• chownFlag :: !Chown
• sourceFlag :: !CopySource

Instances

Eq CopyArgs

Defined in Language.Docker.Syntax

Methods

(==) :: CopyArgs -> CopyArgs -> Bool

(/=) :: CopyArgs -> CopyArgs -> Bool

Ord CopyArgs

Defined in Language.Docker.Syntax

Methods

compare :: CopyArgs -> CopyArgs -> Ordering

(<) :: CopyArgs -> CopyArgs -> Bool

(<=) :: CopyArgs -> CopyArgs -> Bool

(>) :: CopyArgs -> CopyArgs -> Bool

(>=) :: CopyArgs -> CopyArgs -> Bool

max :: CopyArgs -> CopyArgs -> CopyArgs

min :: CopyArgs -> CopyArgs -> CopyArgs

Show CopyArgs

Defined in Language.Docker.Syntax

Methods

showsPrec :: Int -> CopyArgs -> ShowS

show :: CopyArgs -> String

showList :: [CopyArgs] -> ShowS

data AddArgs

Constructors

AddArgs

Fields

• sourcePaths :: NonEmpty SourcePath
• targetPath :: !TargetPath
• chownFlag :: !Chown

Instances

Eq AddArgs

Defined in Language.Docker.Syntax

Methods

(==) :: AddArgs -> AddArgs -> Bool

(/=) :: AddArgs -> AddArgs -> Bool

Ord AddArgs

Defined in Language.Docker.Syntax

Methods

compare :: AddArgs -> AddArgs -> Ordering

(<) :: AddArgs -> AddArgs -> Bool

(<=) :: AddArgs -> AddArgs -> Bool

(>) :: AddArgs -> AddArgs -> Bool

(>=) :: AddArgs -> AddArgs -> Bool

max :: AddArgs -> AddArgs -> AddArgs

min :: AddArgs -> AddArgs -> AddArgs

Show AddArgs

Defined in Language.Docker.Syntax

Methods

showsPrec :: Int -> AddArgs -> ShowS

show :: AddArgs -> String

showList :: [AddArgs] -> ShowS

data Check args

Constructors

Check !(CheckArgs args)

NoCheck

Instances

Functor Check

Defined in Language.Docker.Syntax

Methods

fmap :: (a -> b) -> Check a -> Check b

(<$) :: a -> Check b -> Check a

Eq args => Eq (Check args)

Defined in Language.Docker.Syntax

Methods

(==) :: Check args -> Check args -> Bool

(/=) :: Check args -> Check args -> Bool

Ord args => Ord (Check args)

Defined in Language.Docker.Syntax

Methods

compare :: Check args -> Check args -> Ordering

(<) :: Check args -> Check args -> Bool

(<=) :: Check args -> Check args -> Bool

(>) :: Check args -> Check args -> Bool

(>=) :: Check args -> Check args -> Bool

max :: Check args -> Check args -> Check args

min :: Check args -> Check args -> Check args

Show args => Show (Check args)

Defined in Language.Docker.Syntax

Methods

showsPrec :: Int -> Check args -> ShowS

show :: Check args -> String

showList :: [Check args] -> ShowS

data CheckArgs args

Constructors

CheckArgs

Fields

• checkCommand :: !(Arguments args)
• interval :: !(Maybe Duration)
• timeout :: !(Maybe Duration)
• startPeriod :: !(Maybe Duration)
• retries :: !(Maybe Retries)

Instances

Functor CheckArgs

Defined in Language.Docker.Syntax

Methods

fmap :: (a -> b) -> CheckArgs a -> CheckArgs b

(<$) :: a -> CheckArgs b -> CheckArgs a

Eq args => Eq (CheckArgs args)

Defined in Language.Docker.Syntax

Methods

(==) :: CheckArgs args -> CheckArgs args -> Bool

(/=) :: CheckArgs args -> CheckArgs args -> Bool

Ord args => Ord (CheckArgs args)

Defined in Language.Docker.Syntax

Methods

compare :: CheckArgs args -> CheckArgs args -> Ordering

(<) :: CheckArgs args -> CheckArgs args -> Bool

(<=) :: CheckArgs args -> CheckArgs args -> Bool

(>) :: CheckArgs args -> CheckArgs args -> Bool

(>=) :: CheckArgs args -> CheckArgs args -> Bool

max :: CheckArgs args -> CheckArgs args -> CheckArgs args

min :: CheckArgs args -> CheckArgs args -> CheckArgs args

Show args => Show (CheckArgs args)

Defined in Language.Docker.Syntax

Methods

showsPrec :: Int -> CheckArgs args -> ShowS

show :: CheckArgs args -> String

showList :: [CheckArgs args] -> ShowS

data Image

Constructors

Image

Fields

• registryName :: !(Maybe Registry)
• imageName :: !Text

Instances

Eq Image

Defined in Language.Docker.Syntax

Methods

(==) :: Image -> Image -> Bool

(/=) :: Image -> Image -> Bool

Ord Image

Defined in Language.Docker.Syntax

Methods

compare :: Image -> Image -> Ordering

(<) :: Image -> Image -> Bool

(<=) :: Image -> Image -> Bool

(>) :: Image -> Image -> Bool

(>=) :: Image -> Image -> Bool

max :: Image -> Image -> Image

min :: Image -> Image -> Image

Show Image

Defined in Language.Docker.Syntax

Methods

showsPrec :: Int -> Image -> ShowS

show :: Image -> String

showList :: [Image] -> ShowS

IsString Image

Defined in Language.Docker.Syntax

Methods

fromString :: String -> Image

newtype Registry

Constructors

Registry

Fields

• unRegistry :: Text

Instances

Eq Registry

Defined in Language.Docker.Syntax

Methods

(==) :: Registry -> Registry -> Bool

(/=) :: Registry -> Registry -> Bool

Ord Registry

Defined in Language.Docker.Syntax

Methods

compare :: Registry -> Registry -> Ordering

(<) :: Registry -> Registry -> Bool

(<=) :: Registry -> Registry -> Bool

(>) :: Registry -> Registry -> Bool

(>=) :: Registry -> Registry -> Bool

max :: Registry -> Registry -> Registry

min :: Registry -> Registry -> Registry

Show Registry

Defined in Language.Docker.Syntax

Methods

showsPrec :: Int -> Registry -> ShowS

show :: Registry -> String

showList :: [Registry] -> ShowS

IsString Registry

Defined in Language.Docker.Syntax

Methods

fromString :: String -> Registry

newtype ImageAlias

Constructors

ImageAlias

Fields

• unImageAlias :: Text

Instances

Eq ImageAlias

Defined in Language.Docker.Syntax

Methods

(==) :: ImageAlias -> ImageAlias -> Bool

(/=) :: ImageAlias -> ImageAlias -> Bool

Ord ImageAlias

Defined in Language.Docker.Syntax

Methods

compare :: ImageAlias -> ImageAlias -> Ordering

(<) :: ImageAlias -> ImageAlias -> Bool

(<=) :: ImageAlias -> ImageAlias -> Bool

(>) :: ImageAlias -> ImageAlias -> Bool

(>=) :: ImageAlias -> ImageAlias -> Bool

max :: ImageAlias -> ImageAlias -> ImageAlias

min :: ImageAlias -> ImageAlias -> ImageAlias

Show ImageAlias

Defined in Language.Docker.Syntax

Methods

showsPrec :: Int -> ImageAlias -> ShowS

show :: ImageAlias -> String

showList :: [ImageAlias] -> ShowS

IsString ImageAlias

Defined in Language.Docker.Syntax

Methods

fromString :: String -> ImageAlias

newtype Tag

Constructors

Tag

Fields

• unTag :: Text

Instances

Eq Tag

Defined in Language.Docker.Syntax

Methods

(==) :: Tag -> Tag -> Bool

(/=) :: Tag -> Tag -> Bool

Ord Tag

Defined in Language.Docker.Syntax

Methods

compare :: Tag -> Tag -> Ordering

(<) :: Tag -> Tag -> Bool

(<=) :: Tag -> Tag -> Bool

(>) :: Tag -> Tag -> Bool

(>=) :: Tag -> Tag -> Bool

max :: Tag -> Tag -> Tag

min :: Tag -> Tag -> Tag

Show Tag

Defined in Language.Docker.Syntax

Methods

showsPrec :: Int -> Tag -> ShowS

show :: Tag -> String

showList :: [Tag] -> ShowS

IsString Tag

Defined in Language.Docker.Syntax

Methods

fromString :: String -> Tag

newtype Digest

Constructors

Digest

Fields

• unDigest :: Text

Instances

Eq Digest

Defined in Language.Docker.Syntax

Methods

(==) :: Digest -> Digest -> Bool

(/=) :: Digest -> Digest -> Bool

Ord Digest

Defined in Language.Docker.Syntax

Methods

compare :: Digest -> Digest -> Ordering

(<) :: Digest -> Digest -> Bool

(<=) :: Digest -> Digest -> Bool

(>) :: Digest -> Digest -> Bool

(>=) :: Digest -> Digest -> Bool

max :: Digest -> Digest -> Digest

min :: Digest -> Digest -> Digest

Show Digest

Defined in Language.Docker.Syntax

Methods

showsPrec :: Int -> Digest -> ShowS

show :: Digest -> String

showList :: [Digest] -> ShowS

IsString Digest

Defined in Language.Docker.Syntax

Methods

fromString :: String -> Digest

data Ports

Instances

IsList Ports

Defined in Language.Docker.Syntax

Associated Types

type Item Ports :: Type

Methods

fromList :: [Item Ports] -> Ports

fromListN :: Int -> [Item Ports] -> Ports

toList :: Ports -> [Item Ports]

Eq Ports

Defined in Language.Docker.Syntax

Methods

(==) :: Ports -> Ports -> Bool

(/=) :: Ports -> Ports -> Bool

Ord Ports

Defined in Language.Docker.Syntax

Methods

compare :: Ports -> Ports -> Ordering

(<) :: Ports -> Ports -> Bool

(<=) :: Ports -> Ports -> Bool

(>) :: Ports -> Ports -> Bool

(>=) :: Ports -> Ports -> Bool

max :: Ports -> Ports -> Ports

min :: Ports -> Ports -> Ports

Show Ports

Defined in Language.Docker.Syntax

Methods

showsPrec :: Int -> Ports -> ShowS

show :: Ports -> String

showList :: [Ports] -> ShowS

type Item Ports

Defined in Language.Docker.Syntax

type Item Ports = Port

type Directory = Text

data Arguments args

Instances

Functor Arguments

Defined in Language.Docker.Syntax

Methods

fmap :: (a -> b) -> Arguments a -> Arguments b

(<$) :: a -> Arguments b -> Arguments a

IsList (Arguments Text)

Defined in Language.Docker.Syntax

Associated Types

type Item (Arguments Text) :: Type

Methods

fromList :: [Item (Arguments Text)] -> Arguments Text

fromListN :: Int -> [Item (Arguments Text)] -> Arguments Text

toList :: Arguments Text -> [Item (Arguments Text)]

Eq args => Eq (Arguments args)

Defined in Language.Docker.Syntax

Methods

(==) :: Arguments args -> Arguments args -> Bool

(/=) :: Arguments args -> Arguments args -> Bool

Ord args => Ord (Arguments args)

Defined in Language.Docker.Syntax

Methods

compare :: Arguments args -> Arguments args -> Ordering

(<) :: Arguments args -> Arguments args -> Bool

(<=) :: Arguments args -> Arguments args -> Bool

(>) :: Arguments args -> Arguments args -> Bool

(>=) :: Arguments args -> Arguments args -> Bool

max :: Arguments args -> Arguments args -> Arguments args

min :: Arguments args -> Arguments args -> Arguments args

Show args => Show (Arguments args)

Defined in Language.Docker.Syntax

Methods

showsPrec :: Int -> Arguments args -> ShowS

show :: Arguments args -> String

showList :: [Arguments args] -> ShowS

IsString (Arguments Text)

Defined in Language.Docker.Syntax

Methods

fromString :: String -> Arguments Text

Pretty (Arguments Text)

Defined in Language.Docker.PrettyPrint

Methods

pretty :: Arguments Text -> Doc ann

prettyList :: [Arguments Text] -> Doc ann

type Item (Arguments Text)

Defined in Language.Docker.Syntax

type Item (Arguments Text) = Text

type Pairs = [(Text, Text)]

type Filename = Text

type Platform = Text

type Linenumber = Int