-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Embedded DSL to create Dockerfiles using Haskell. Please see the
--   README on GitHub at
--   <a>https://github.com/hadolint/dockerfile-creator#readme</a>
@package dockerfile-creator
@version 0.1.1.0

module Language.Docker.EDSL

-- | The type of <tt>Identity</tt> based EDSL blocks
type EDockerfileM = Free EInstruction

-- | The type of free monad EDSL blocks
type EDockerfileTM = FreeT EInstruction
type EInstructionM = Free EInstruction
type EInstructionTM = FreeT EInstruction
embed :: forall m_aaLI. MonadFree EInstruction m_aaLI => [InstructionPos Text] -> m_aaLI ()
onBuildRaw :: forall m_aaLF. MonadFree EInstruction m_aaLF => Instruction Text -> m_aaLF ()
healthcheck :: forall m_aaLC. MonadFree EInstruction m_aaLC => Check Text -> m_aaLC ()
comment :: forall m_aaLz. MonadFree EInstruction m_aaLz => Text -> m_aaLz ()
arg :: forall m_aaLv. MonadFree EInstruction m_aaLv => Text -> Maybe Text -> m_aaLv ()
env :: forall m_aaLs. MonadFree EInstruction m_aaLs => Pairs -> m_aaLs ()
maintainer :: forall m_aaLp. MonadFree EInstruction m_aaLp => Text -> m_aaLp ()
entrypointArgs :: forall m_aaLm. MonadFree EInstruction m_aaLm => Arguments Text -> m_aaLm ()
volume :: forall m_aaLj. MonadFree EInstruction m_aaLj => Text -> m_aaLj ()
expose :: forall m_aaLg. MonadFree EInstruction m_aaLg => Ports -> m_aaLg ()
workdir :: forall m_aaLd. MonadFree EInstruction m_aaLd => Directory -> m_aaLd ()
shell :: forall m_aaLa. MonadFree EInstruction m_aaLa => Arguments Text -> m_aaLa ()
cmdArgs :: forall m_aaL7. MonadFree EInstruction m_aaL7 => Arguments Text -> m_aaL7 ()
runArgs :: forall m_aaL3. MonadFree EInstruction m_aaL3 => Arguments Text -> RunFlags -> m_aaL3 ()
copyArgs :: forall m_aaKW. MonadFree EInstruction m_aaKW => NonEmpty SourcePath -> TargetPath -> Chown -> Chmod -> CopySource -> m_aaKW ()
stopSignal :: forall m_aaKT. MonadFree EInstruction m_aaKT => Text -> m_aaKT ()
label :: forall m_aaKQ. MonadFree EInstruction m_aaKQ => Pairs -> m_aaKQ ()
user :: forall m_aaKN. MonadFree EInstruction m_aaKN => Text -> m_aaKN ()
addArgs :: forall m_aaKH. MonadFree EInstruction m_aaKH => NonEmpty SourcePath -> TargetPath -> Chown -> Chmod -> m_aaKH ()
from :: forall m_aaKy. MonadFree EInstruction m_aaKy => EBaseImage -> m_aaKy ()
runDockerWriter :: MonadWriter [Instruction Text] m => EDockerfileM a -> m a
runDockerWriterIO :: (Monad m, MonadTrans t, MonadWriter [Instruction Text] (t m)) => EDockerfileTM m a -> t m a
runDef :: MonadWriter [t] m => (t1 -> t) -> t1 -> m b -> m b
runDef2 :: MonadWriter [t] m => (t1 -> t2 -> t) -> t1 -> t2 -> m b -> m b
runD :: MonadWriter [Instruction Text] m => EInstruction (m b) -> m b
instructionPos :: Instruction args -> InstructionPos args

-- | Runs the Dockerfile EDSL and returns a <tt>Dockerfile</tt> you can
--   pretty print or manipulate
toDockerfile :: EDockerfileM a -> Dockerfile

-- | runs the Dockerfile EDSL and returns a <a>Lazy</a> using
--   <a>PrettyPrint</a>
--   
--   <pre>
--   import Language.Docker
--   
--   main :: IO ()
--   main = print $ toDockerfileText $ do
--       from (tagged "fpco/stack-build" "lts-6.9")
--       add ["."] "<i>app</i>language-docker"
--       workdir "<i>app</i>language-docker"
--       run "stack build --test --only-dependencies"
--       cmd "stack test"
--   </pre>
toDockerfileText :: EDockerfileM a -> Text

-- | Writes the dockerfile to the given file path after pretty-printing it
--   
--   <pre>
--   import Language.Docker
--   
--   main :: IO ()
--   main = writeDockerFile "build.Dockerfile" $ toDockerfile $ do
--       from (tagged "fpco/stack-build" "lts-6.9")
--       add ["."] "<i>app</i>language-docker"
--       workdir "<i>app</i>language-docker"
--       run "stack build --test --only-dependencies"
--       cmd "stack test"
--   </pre>
writeDockerFile :: Text -> Dockerfile -> IO ()

-- | Prints the dockerfile to stdout. Mainly used for debugging purposes
--   
--   <pre>
--   import Language.Docker
--   
--   main :: IO ()
--   main = putDockerfileStr $ do
--       from (tagged "fpco/stack-build" "lts-6.9")
--       add ["."] "<i>app</i>language-docker"
--       workdir "<i>app</i>language-docker"
--       run "stack build --test --only-dependencies"
--       cmd "stack test"
--   </pre>
putDockerfileStr :: EDockerfileM a -> IO ()

-- | Use a docker image in a FROM instruction without a tag
--   
--   The following two examples are equivalent
--   
--   <pre>
--   from $ untagged "fpco/stack-build"
--   </pre>
--   
--   Is equivalent to, when having OverloadedStrings:
--   
--   <pre>
--   from "fpco/stack-build"
--   </pre>
untagged :: Text -> EBaseImage

-- | Use a specific tag for a docker image. This function is meant to be
--   used as an infix operator.
--   
--   <pre>
--   from $ "fpco/stack-build" <a>tagged</a> "lts-10.3"
--   </pre>
tagged :: Image -> Tag -> EBaseImage

-- | Adds a digest checksum so a FROM instruction This function is meant to
--   be used as an infix operator.
--   
--   <pre>
--   from $ "fpco/stack-build" <a>digested</a> "sha256:abcdef123"
--   </pre>
digested :: EBaseImage -> Digest -> EBaseImage

-- | Alias a FROM instruction to be used as a build stage. This function is
--   meant to be used as an infix operator.
--   
--   <pre>
--   from $ "fpco/stack-build" <a>aliased</a> "builder"
--   </pre>
aliased :: EBaseImage -> ImageAlias -> EBaseImage

-- | Create a RUN instruction with the given arguments.
--   
--   <pre>
--   run "apt-get install wget"
--   </pre>
run :: MonadFree EInstruction m => Arguments Text -> m ()

-- | Create an ENTRYPOINT instruction with the given arguments.
--   
--   <pre>
--   entrypoint "<i>usr</i>local<i>bin</i>program --some-flag"
--   </pre>
entrypoint :: MonadFree EInstruction m => Arguments Text -> m ()

-- | Create a CMD instruction with the given arguments.
--   
--   <pre>
--   cmd "my-program --some-flag"
--   </pre>
cmd :: MonadFree EInstruction m => Arguments Text -> m ()

-- | Create a COPY instruction. This function is meant to be used with the
--   compinators <a>to</a>, <a>fromStage</a> and <a>ownedBy</a>
--   
--   <pre>
--   copy $ ["foo.js", "bar.js"] <a>to</a> "."
--   copy $ ["some_file"] <a>to</a> "<i>some</i>path" <a>fromStage</a> "builder"
--   </pre>
copy :: MonadFree EInstruction m => CopyArgs -> m ()

-- | Create a COPY instruction from a given build stage. This is a
--   shorthand version of using <a>copy</a> with combinators.
--   
--   <pre>
--   copyFromStage "builder" ["foo.js", "bar.js"] "."
--   </pre>
copyFromStage :: MonadFree EInstruction m => CopySource -> NonEmpty SourcePath -> TargetPath -> m ()

-- | Create an ADD instruction. This is often used as a shorthand version
--   of copy when no extra options are needed. Currently there is no way to
--   pass extra options to ADD, so you are encouraged to use <a>copy</a>
--   instead.
--   
--   <pre>
--   add ["foo.js", "bar.js"] "."
--   </pre>
add :: MonadFree EInstruction m => NonEmpty SourcePath -> TargetPath -> m ()

-- | Converts a NonEmpty list of strings to a NonEmpty list of
--   <a>SourcePath</a>
--   
--   This is a convenience function when you need to pass a non-static list
--   of strings that you build somewhere as an argument for <a>copy</a> or
--   <a>add</a>
--   
--   <pre>
--   someFiles &lt;- glob "*.js"
--   copy $ (toSources someFiles) <a>to</a> "."
--   </pre>
toSources :: NonEmpty Text -> NonEmpty SourcePath

-- | Converts a Text into a <a>TargetPath</a>
--   
--   This is a convenience function when you need to pass a string variable
--   as an argument for <a>copy</a> or <a>add</a>
--   
--   <pre>
--   let destination = buildSomePath pwd
--   add ["foo.js"] (toTarget destination)
--   </pre>
toTarget :: Text -> TargetPath

-- | Adds the --from= option to a COPY instruction.
--   
--   This function is meant to be used as an infix operator:
--   
--   <pre>
--   copy $ ["foo.js"] <a>to</a> "." <a>fromStage</a> "builder"
--   </pre>
fromStage :: CopyArgs -> CopySource -> CopyArgs

-- | Adds the --chown= option to a COPY instruction.
--   
--   This function is meant to be used as an infix operator:
--   
--   <pre>
--   copy $ ["foo.js"] <a>to</a> "." <a>ownedBy</a> "www-data:www-data"
--   </pre>
ownedBy :: CopyArgs -> Chown -> CopyArgs

-- | Usedto join source paths with atarget path as an arguments for
--   <a>copy</a>
--   
--   This function is meant to be used as an infix operator:
--   
--   <pre>
--   copy $ ["foo.js"] <a>to</a> "." <a>ownedBy</a>
--   </pre>
to :: NonEmpty SourcePath -> TargetPath -> CopyArgs
ports :: [Port] -> Ports
tcpPort :: Int -> Port
udpPort :: Int -> Port
variablePort :: Text -> Port
portRange :: Int -> Int -> Port
udpPortRange :: Int -> Int -> Port
check :: Arguments args -> Check args
interval :: Check args -> Integer -> Check args
timeout :: Check args -> Integer -> Check args
startPeriod :: Check args -> Integer -> Check args
retries :: Check args -> Integer -> Check args
noCheck :: Check args

-- | ONBUILD Dockerfile instruction
--   
--   Each nested instruction gets emitted as a separate <tt>ONBUILD</tt>
--   block
--   
--   <pre>
--   <a>toDockerfile</a> $ do
--       from "node"
--       run "apt-get update"
--       onBuild $ do
--           run "echo more-stuff"
--           run "echo here"
--   </pre>
onBuild :: MonadFree EInstruction m => EDockerfileM a -> m ()

-- | A version of <a>toDockerfile</a> which allows IO actions
toDockerfileIO :: MonadIO m => EDockerfileTM m t -> m Dockerfile

-- | A version of <a>toDockerfileText</a> which allows IO actions
toDockerfileTextIO :: MonadIO m => EDockerfileTM m t -> m Text

-- | Just runs the EDSL's writer monad
runDockerfileIO :: MonadIO m => EDockerfileTM m t -> m (t, Dockerfile)

-- | Runs the EDSL's writer monad and pretty-prints the result
runDockerfileTextIO :: MonadIO m => EDockerfileTM m t -> m (t, Text)

module Language.Docker.EDSL.Quasi

-- | Quasiquoter for embedding dockerfiles on the EDSL
--   
--   <pre>
--   putStr $ <a>toDockerfile</a> $ do
--       from "node"
--       run "apt-get update"
--       [edockerfile|
--       RUN apt-get update
--       CMD node something.js
--       |]
--   </pre>
edockerfile :: QuasiQuoter
edockerfileE :: String -> ExpQ
dockerfile :: QuasiQuoter
dockerfileE :: String -> ExpQ

module Language.Docker.Creator

-- | runs the Dockerfile EDSL and returns a <a>Lazy</a> using
--   <a>PrettyPrint</a>
--   
--   <pre>
--   import Language.Docker
--   
--   main :: IO ()
--   main = print $ toDockerfileText $ do
--       from (tagged "fpco/stack-build" "lts-6.9")
--       add ["."] "<i>app</i>language-docker"
--       workdir "<i>app</i>language-docker"
--       run "stack build --test --only-dependencies"
--       cmd "stack test"
--   </pre>
toDockerfileText :: EDockerfileM a -> Text

-- | Runs the Dockerfile EDSL and returns a <tt>Dockerfile</tt> you can
--   pretty print or manipulate
toDockerfile :: EDockerfileM a -> Dockerfile

-- | Prints the dockerfile to stdout. Mainly used for debugging purposes
--   
--   <pre>
--   import Language.Docker
--   
--   main :: IO ()
--   main = putDockerfileStr $ do
--       from (tagged "fpco/stack-build" "lts-6.9")
--       add ["."] "<i>app</i>language-docker"
--       workdir "<i>app</i>language-docker"
--       run "stack build --test --only-dependencies"
--       cmd "stack test"
--   </pre>
putDockerfileStr :: EDockerfileM a -> IO ()

-- | Writes the dockerfile to the given file path after pretty-printing it
--   
--   <pre>
--   import Language.Docker
--   
--   main :: IO ()
--   main = writeDockerFile "build.Dockerfile" $ toDockerfile $ do
--       from (tagged "fpco/stack-build" "lts-6.9")
--       add ["."] "<i>app</i>language-docker"
--       workdir "<i>app</i>language-docker"
--       run "stack build --test --only-dependencies"
--       cmd "stack test"
--   </pre>
writeDockerFile :: Text -> Dockerfile -> IO ()

-- | A version of <a>toDockerfileText</a> which allows IO actions
toDockerfileTextIO :: MonadIO m => EDockerfileTM m t -> m Text

-- | A version of <a>toDockerfile</a> which allows IO actions
toDockerfileIO :: MonadIO m => EDockerfileTM m t -> m Dockerfile

-- | Just runs the EDSL's writer monad
runDockerfileIO :: MonadIO m => EDockerfileTM m t -> m (t, Dockerfile)

-- | Runs the EDSL's writer monad and pretty-prints the result
runDockerfileTextIO :: MonadIO m => EDockerfileTM m t -> m (t, Text)

-- | Lift a computation from the <a>IO</a> monad.
liftIO :: MonadIO m => IO a -> m a
from :: forall m_aaKy. MonadFree EInstruction m_aaKy => EBaseImage -> m_aaKy ()

-- | Use a specific tag for a docker image. This function is meant to be
--   used as an infix operator.
--   
--   <pre>
--   from $ "fpco/stack-build" <a>tagged</a> "lts-10.3"
--   </pre>
tagged :: Image -> Tag -> EBaseImage

-- | Use a docker image in a FROM instruction without a tag
--   
--   The following two examples are equivalent
--   
--   <pre>
--   from $ untagged "fpco/stack-build"
--   </pre>
--   
--   Is equivalent to, when having OverloadedStrings:
--   
--   <pre>
--   from "fpco/stack-build"
--   </pre>
untagged :: Text -> EBaseImage

-- | Adds a digest checksum so a FROM instruction This function is meant to
--   be used as an infix operator.
--   
--   <pre>
--   from $ "fpco/stack-build" <a>digested</a> "sha256:abcdef123"
--   </pre>
digested :: EBaseImage -> Digest -> EBaseImage

-- | Alias a FROM instruction to be used as a build stage. This function is
--   meant to be used as an infix operator.
--   
--   <pre>
--   from $ "fpco/stack-build" <a>aliased</a> "builder"
--   </pre>
aliased :: EBaseImage -> ImageAlias -> EBaseImage

-- | Create an ADD instruction. This is often used as a shorthand version
--   of copy when no extra options are needed. Currently there is no way to
--   pass extra options to ADD, so you are encouraged to use <a>copy</a>
--   instead.
--   
--   <pre>
--   add ["foo.js", "bar.js"] "."
--   </pre>
add :: MonadFree EInstruction m => NonEmpty SourcePath -> TargetPath -> m ()
user :: forall m_aaKN. MonadFree EInstruction m_aaKN => Text -> m_aaKN ()
label :: forall m_aaKQ. MonadFree EInstruction m_aaKQ => Pairs -> m_aaKQ ()
stopSignal :: forall m_aaKT. MonadFree EInstruction m_aaKT => Text -> m_aaKT ()

-- | Create a COPY instruction. This function is meant to be used with the
--   compinators <a>to</a>, <a>fromStage</a> and <a>ownedBy</a>
--   
--   <pre>
--   copy $ ["foo.js", "bar.js"] <a>to</a> "."
--   copy $ ["some_file"] <a>to</a> "<i>some</i>path" <a>fromStage</a> "builder"
--   </pre>
copy :: MonadFree EInstruction m => CopyArgs -> m ()

-- | Create a COPY instruction from a given build stage. This is a
--   shorthand version of using <a>copy</a> with combinators.
--   
--   <pre>
--   copyFromStage "builder" ["foo.js", "bar.js"] "."
--   </pre>
copyFromStage :: MonadFree EInstruction m => CopySource -> NonEmpty SourcePath -> TargetPath -> m ()

-- | Usedto join source paths with atarget path as an arguments for
--   <a>copy</a>
--   
--   This function is meant to be used as an infix operator:
--   
--   <pre>
--   copy $ ["foo.js"] <a>to</a> "." <a>ownedBy</a>
--   </pre>
to :: NonEmpty SourcePath -> TargetPath -> CopyArgs

-- | Adds the --from= option to a COPY instruction.
--   
--   This function is meant to be used as an infix operator:
--   
--   <pre>
--   copy $ ["foo.js"] <a>to</a> "." <a>fromStage</a> "builder"
--   </pre>
fromStage :: CopyArgs -> CopySource -> CopyArgs

-- | Adds the --chown= option to a COPY instruction.
--   
--   This function is meant to be used as an infix operator:
--   
--   <pre>
--   copy $ ["foo.js"] <a>to</a> "." <a>ownedBy</a> "www-data:www-data"
--   </pre>
ownedBy :: CopyArgs -> Chown -> CopyArgs

-- | Converts a NonEmpty list of strings to a NonEmpty list of
--   <a>SourcePath</a>
--   
--   This is a convenience function when you need to pass a non-static list
--   of strings that you build somewhere as an argument for <a>copy</a> or
--   <a>add</a>
--   
--   <pre>
--   someFiles &lt;- glob "*.js"
--   copy $ (toSources someFiles) <a>to</a> "."
--   </pre>
toSources :: NonEmpty Text -> NonEmpty SourcePath

-- | Converts a Text into a <a>TargetPath</a>
--   
--   This is a convenience function when you need to pass a string variable
--   as an argument for <a>copy</a> or <a>add</a>
--   
--   <pre>
--   let destination = buildSomePath pwd
--   add ["foo.js"] (toTarget destination)
--   </pre>
toTarget :: Text -> TargetPath

-- | Create a RUN instruction with the given arguments.
--   
--   <pre>
--   run "apt-get install wget"
--   </pre>
run :: MonadFree EInstruction m => Arguments Text -> m ()
runArgs :: forall m_aaL3. MonadFree EInstruction m_aaL3 => Arguments Text -> RunFlags -> m_aaL3 ()

-- | Create a CMD instruction with the given arguments.
--   
--   <pre>
--   cmd "my-program --some-flag"
--   </pre>
cmd :: MonadFree EInstruction m => Arguments Text -> m ()
cmdArgs :: forall m_aaL7. MonadFree EInstruction m_aaL7 => Arguments Text -> m_aaL7 ()
healthcheck :: forall m_aaLC. MonadFree EInstruction m_aaLC => Check Text -> m_aaLC ()
check :: Arguments args -> Check args
interval :: Check args -> Integer -> Check args
timeout :: Check args -> Integer -> Check args
startPeriod :: Check args -> Integer -> Check args
retries :: Check args -> Integer -> Check args
workdir :: forall m_aaLd. MonadFree EInstruction m_aaLd => Directory -> m_aaLd ()
expose :: forall m_aaLg. MonadFree EInstruction m_aaLg => Ports -> m_aaLg ()
ports :: [Port] -> Ports
tcpPort :: Int -> Port
udpPort :: Int -> Port
variablePort :: Text -> Port
portRange :: Int -> Int -> Port
udpPortRange :: Int -> Int -> Port
volume :: forall m_aaLj. MonadFree EInstruction m_aaLj => Text -> m_aaLj ()

-- | Create an ENTRYPOINT instruction with the given arguments.
--   
--   <pre>
--   entrypoint "<i>usr</i>local<i>bin</i>program --some-flag"
--   </pre>
entrypoint :: MonadFree EInstruction m => Arguments Text -> m ()
entrypointArgs :: forall m_aaLm. MonadFree EInstruction m_aaLm => Arguments Text -> m_aaLm ()
maintainer :: forall m_aaLp. MonadFree EInstruction m_aaLp => Text -> m_aaLp ()
env :: forall m_aaLs. MonadFree EInstruction m_aaLs => Pairs -> m_aaLs ()
arg :: forall m_aaLv. MonadFree EInstruction m_aaLv => Text -> Maybe Text -> m_aaLv ()
comment :: forall m_aaLz. MonadFree EInstruction m_aaLz => Text -> m_aaLz ()

-- | ONBUILD Dockerfile instruction
--   
--   Each nested instruction gets emitted as a separate <tt>ONBUILD</tt>
--   block
--   
--   <pre>
--   <a>toDockerfile</a> $ do
--       from "node"
--       run "apt-get update"
--       onBuild $ do
--           run "echo more-stuff"
--           run "echo here"
--   </pre>
onBuild :: MonadFree EInstruction m => EDockerfileM a -> m ()
onBuildRaw :: forall m_aaLF. MonadFree EInstruction m_aaLF => Instruction Text -> m_aaLF ()
embed :: forall m_aaLI. MonadFree EInstruction m_aaLI => [InstructionPos Text] -> m_aaLI ()

-- | Quasiquoter for embedding dockerfiles on the EDSL
--   
--   <pre>
--   putStr $ <a>toDockerfile</a> $ do
--       from "node"
--       run "apt-get update"
--       [edockerfile|
--       RUN apt-get update
--       CMD node something.js
--       |]
--   </pre>
edockerfile :: QuasiQuoter

-- | The type of <tt>Identity</tt> based EDSL blocks
type EDockerfileM = Free EInstruction

-- | The type of free monad EDSL blocks
type EDockerfileTM = FreeT EInstruction
data EBaseImage
EBaseImage :: Image -> Maybe Tag -> Maybe Digest -> Maybe ImageAlias -> Maybe Platform -> EBaseImage
dockerfile :: QuasiQuoter
instructionPos :: Instruction args -> InstructionPos args