DzenDhall.Commands.Plug

Documentation

plugCommand :: PlugCommand -> App Common ()

data PluginSourceSpec

Constructors

FromGithub

Load from Github by username and repository

Fields

• userName :: String
• repository :: String
• revision :: String

FromOrg

Load from https://github.com/dzen-dhall/plugins by name.

Fields

• name :: String
• revision :: String

FromURL URI

Load from URL

FromFile FilePath

Instances

Eq PluginSourceSpec

Defined in DzenDhall.Commands.Plug

Methods

(==) :: PluginSourceSpec -> PluginSourceSpec -> Bool

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

Show PluginSourceSpec

Defined in DzenDhall.Commands.Plug

Methods

showsPrec :: Int -> PluginSourceSpec -> ShowS

show :: PluginSourceSpec -> String

showList :: [PluginSourceSpec] -> ShowS

askConfirmation :: App Common ()

suggestReviewing :: Expr Src Import -> App Common ()

printUsage :: PluginMeta -> App Common ()

invalidSourceSpec :: ParseError -> App Common ()

invalidFile :: Text -> App Common ()

httpHandler :: HttpException -> IO a

parseSourceSpec :: String -> Either ParseError PluginSourceSpec

saneIdentifier :: Parsec String () String

getPluginSource :: PluginSourceSpec -> String

getPluginContents :: PluginSourceSpec -> IO Text

getPluginContentsFromURL :: String -> IO Text

Load plugin from URL and validate it by parsing.

parsePlugin :: Text -> Maybe (Expr Src Import)

Try parsing a file.

data MetaValidationError

Constructors

NoParse

InvalidPluginName Text

Instances

Show MetaValidationError

Defined in DzenDhall.Commands.Plug

Methods

showsPrec :: Int -> MetaValidationError -> ShowS

show :: MetaValidationError -> String

showList :: [MetaValidationError] -> ShowS

invalidMeta :: MetaValidationError -> App stage ()

readPluginMeta :: PluginSourceSpec -> Text -> App Common (Either MetaValidationError PluginMeta)

Try to load plugin meta by inserting a plugin into the current environment (using inputWithSettings).

checkIfPluginFileExists :: Text -> App Common ()

writePluginFile :: Text -> Text -> App Common ()

getPluginPaths :: Text -> App Common (String, String)

Given a plugin name, get the file of the plugin and locate the plugins directory.