Safe Haskell	Safe-Inferred
Language	GHC2021

GitHub.Workflow.Command.Syntax

Contents

Synopsis

data Command
command :: Name -> Command
class ToCommand a where
- addToCommand :: a -> Command -> Command
toCommand :: ToCommand a => a -> Command
newtype Name = Name {
- text :: Text
}
class HasName a where
- name :: Lens' a Name
newtype Message = Message {
- text :: Text
}
class HasMessage a where
- message :: Lens' a Message
class FromMessage a where
- fromMessage :: Message -> a
data Properties
newtype Key = Key {
- text :: Text
}
newtype Value = Value {
- text :: Text
}
property :: HasProperties a => Key -> Lens' a (Maybe Value)
class HasProperties a where
- properties :: Lens' a Properties
class AddToProperties a where
- addToProperties :: a -> Properties -> Properties
class ToByteString a where
- toByteStringBuilder :: a -> Builder
- toByteString :: a -> ByteString
newtype ByteStringViaCommand a = ByteStringViaCommand a
printByteStringLn :: (ToByteString a, MonadIO m) => a -> m ()

Command

data Command Source #

A GitHub workflow command

A Command consists of:

Of these, only Name is always required. Some particular types of command require a message or have restrictions on what properties they support or require.

Instances

Instances details

IsString Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods fromString :: String -> Command #
Show Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods showsPrec :: Int -> Command -> ShowS # show :: Command -> String # showList :: [Command] -> ShowS #
Eq Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods (==) :: Command -> Command -> Bool # (/=) :: Command -> Command -> Bool #
Ord Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods compare :: Command -> Command -> Ordering # (<) :: Command -> Command -> Bool # (<=) :: Command -> Command -> Bool # (>) :: Command -> Command -> Bool # (>=) :: Command -> Command -> Bool # max :: Command -> Command -> Command # min :: Command -> Command -> Command #
HasMessage Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods message :: Lens' Command Message Source #
HasName Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods name :: Lens' Command Name Source #
HasProperties Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods properties :: Lens' Command Properties Source #
ToByteString Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods toByteStringBuilder :: Command -> Builder Source # toByteString :: Command -> ByteString Source #

command :: Name -> Command Source #

Construct a minimal command with a command Name e.g. "warning" or "error"

See the property and message lenses for other information include in a command.

class ToCommand a where Source #

Methods

addToCommand :: a -> Command -> Command Source #

Instances

Instances details

ToCommand Debug Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Debug Methods addToCommand :: Debug -> Command -> Command Source #
ToCommand Error Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Error Methods addToCommand :: Error -> Command -> Command Source #
ToCommand Notice Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Notice Methods addToCommand :: Notice -> Command -> Command Source #
ToCommand Warning Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Warning Methods addToCommand :: Warning -> Command -> Command Source #
ToCommand GroupEnd Source #
Instance details Defined in GitHub.Workflow.Command.Grouping Methods addToCommand :: GroupEnd -> Command -> Command Source #
ToCommand GroupStart Source #
Instance details Defined in GitHub.Workflow.Command.Grouping Methods addToCommand :: GroupStart -> Command -> Command Source #
ToCommand AddMask Source #
Instance details Defined in GitHub.Workflow.Command.Masking Methods addToCommand :: AddMask -> Command -> Command Source #
ToCommand ResumeCommands Source #
Instance details Defined in GitHub.Workflow.Command.Stopping Methods addToCommand :: ResumeCommands -> Command -> Command Source #
ToCommand StopCommands Source #
Instance details Defined in GitHub.Workflow.Command.Stopping Methods addToCommand :: StopCommands -> Command -> Command Source #
(IsAnnotationType a, HasMessage a, GetProperties a) => ToCommand (GenericAnnotation a) Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Generic Methods addToCommand :: GenericAnnotation a -> Command -> Command Source #

toCommand :: ToCommand a => a -> Command Source #

Name

newtype Name Source #

Constructors

Name
Fields text :: Text

Instances

Instances details

IsString Name Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Name Methods fromString :: String -> Name #
Show Name Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Name Methods showsPrec :: Int -> Name -> ShowS # show :: Name -> String # showList :: [Name] -> ShowS #
Eq Name Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Name Methods (==) :: Name -> Name -> Bool # (/=) :: Name -> Name -> Bool #
Ord Name Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Name Methods compare :: Name -> Name -> Ordering # (<) :: Name -> Name -> Bool # (<=) :: Name -> Name -> Bool # (>) :: Name -> Name -> Bool # (>=) :: Name -> Name -> Bool # max :: Name -> Name -> Name # min :: Name -> Name -> Name #
HasName Name Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Name Methods name :: Lens' Name Name Source #
ToByteString Name Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Name Methods toByteStringBuilder :: Name -> Builder Source # toByteString :: Name -> ByteString Source #

class HasName a where Source #

Methods

name :: Lens' a Name Source #

Instances

Instances details

HasName Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods name :: Lens' Command Name Source #
HasName Name Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Name Methods name :: Lens' Name Name Source #

Message

newtype Message Source #

Constructors

Message
Fields text :: Text

Instances

Instances details

IsString Message Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Message Methods fromString :: String -> Message #
Show Message Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Message Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
Eq Message Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Message Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #
Ord Message Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Message Methods compare :: Message -> Message -> Ordering # (<) :: Message -> Message -> Bool # (<=) :: Message -> Message -> Bool # (>) :: Message -> Message -> Bool # (>=) :: Message -> Message -> Bool # max :: Message -> Message -> Message # min :: Message -> Message -> Message #
FromMessage Message Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Message Methods fromMessage :: Message -> Message Source #
HasMessage Message Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Message Methods message :: Lens' Message Message Source #
ToByteString Message Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Message Methods toByteStringBuilder :: Message -> Builder Source # toByteString :: Message -> ByteString Source #

class HasMessage a where Source #

Methods

message :: Lens' a Message Source #

Instances

Instances details

HasMessage Debug Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Debug Methods message :: Lens' Debug Message Source #
HasMessage Error Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Error Methods message :: Lens' Error Message Source #
HasMessage Notice Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Notice Methods message :: Lens' Notice Message Source #
HasMessage Warning Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Warning Methods message :: Lens' Warning Message Source #
HasMessage Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods message :: Lens' Command Message Source #
HasMessage Message Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Message Methods message :: Lens' Message Message Source #

class FromMessage a where Source #

Methods

fromMessage :: Message -> a Source #

Instances

Instances details

FromMessage Debug Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Debug Methods fromMessage :: Message -> Debug Source #
FromMessage Error Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Error Methods fromMessage :: Message -> Error Source #
FromMessage Notice Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Notice Methods fromMessage :: Message -> Notice Source #
FromMessage Warning Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Warning Methods fromMessage :: Message -> Warning Source #
FromMessage Message Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Message Methods fromMessage :: Message -> Message Source #

Properties

data Properties Source #

Instances

Instances details

Show Properties Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Properties Methods showsPrec :: Int -> Properties -> ShowS # show :: Properties -> String # showList :: [Properties] -> ShowS #
Eq Properties Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Properties Methods (==) :: Properties -> Properties -> Bool # (/=) :: Properties -> Properties -> Bool #
Ord Properties Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Properties Methods compare :: Properties -> Properties -> Ordering # (<) :: Properties -> Properties -> Bool # (<=) :: Properties -> Properties -> Bool # (>) :: Properties -> Properties -> Bool # (>=) :: Properties -> Properties -> Bool # max :: Properties -> Properties -> Properties # min :: Properties -> Properties -> Properties #
HasProperties Properties Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Properties Methods properties :: Lens' Properties Properties Source #
ToByteString Properties Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Properties Methods toByteStringBuilder :: Properties -> Builder Source # toByteString :: Properties -> ByteString Source #

newtype Key Source #

Constructors

Key
Fields text :: Text

Instances

Instances details

IsString Key Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Key Methods fromString :: String -> Key #
Show Key Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Key Methods showsPrec :: Int -> Key -> ShowS # show :: Key -> String # showList :: [Key] -> ShowS #
Eq Key Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Key Methods (==) :: Key -> Key -> Bool # (/=) :: Key -> Key -> Bool #
Ord Key Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Key Methods compare :: Key -> Key -> Ordering # (<) :: Key -> Key -> Bool # (<=) :: Key -> Key -> Bool # (>) :: Key -> Key -> Bool # (>=) :: Key -> Key -> Bool # max :: Key -> Key -> Key # min :: Key -> Key -> Key #
ToByteString Key Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Key Methods toByteStringBuilder :: Key -> Builder Source # toByteString :: Key -> ByteString Source #

newtype Value Source #

Constructors

Value
Fields text :: Text

Instances

Instances details

IsString Value Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Value Methods fromString :: String -> Value #
Show Value Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Value Methods showsPrec :: Int -> Value -> ShowS # show :: Value -> String # showList :: [Value] -> ShowS #
Eq Value Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Value Methods (==) :: Value -> Value -> Bool # (/=) :: Value -> Value -> Bool #
Ord Value Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Value Methods compare :: Value -> Value -> Ordering # (<) :: Value -> Value -> Bool # (<=) :: Value -> Value -> Bool # (>) :: Value -> Value -> Bool # (>=) :: Value -> Value -> Bool # max :: Value -> Value -> Value # min :: Value -> Value -> Value #
ToByteString Value Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Value Methods toByteStringBuilder :: Value -> Builder Source # toByteString :: Value -> ByteString Source #

property :: HasProperties a => Key -> Lens' a (Maybe Value) Source #

class HasProperties a where Source #

Methods

properties :: Lens' a Properties Source #

Instances

Instances details

HasProperties Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods properties :: Lens' Command Properties Source #
HasProperties Properties Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Properties Methods properties :: Lens' Properties Properties Source #

class AddToProperties a where Source #

Methods

addToProperties :: a -> Properties -> Properties Source #

Instances

Instances details

AddToProperties Location Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Location Methods addToProperties :: Location -> Properties -> Properties Source #
AddToProperties Position Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Position Methods addToProperties :: Position -> Properties -> Properties Source #
AddToProperties Columns Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Position.Columns Methods addToProperties :: Columns -> Properties -> Properties Source #
AddToProperties Extent Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Position.Extent Methods addToProperties :: Extent -> Properties -> Properties Source #
AddToProperties Properties Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Properties Methods addToProperties :: Properties -> Properties0 -> Properties0 Source #

Output

class ToByteString a where Source #

Minimal complete definition

toByteStringBuilder

Methods

toByteStringBuilder :: a -> Builder Source #

toByteString :: a -> ByteString Source #

Instances

Instances details

ToByteString Debug Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Debug Methods toByteStringBuilder :: Debug -> Builder Source # toByteString :: Debug -> ByteString Source #
ToByteString Error Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Error Methods toByteStringBuilder :: Error -> Builder Source # toByteString :: Error -> ByteString Source #
ToByteString Notice Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Notice Methods toByteStringBuilder :: Notice -> Builder Source # toByteString :: Notice -> ByteString Source #
ToByteString Warning Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Warning Methods toByteStringBuilder :: Warning -> Builder Source # toByteString :: Warning -> ByteString Source #
ToByteString Command Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods toByteStringBuilder :: Command -> Builder Source # toByteString :: Command -> ByteString Source #
ToByteString Key Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Key Methods toByteStringBuilder :: Key -> Builder Source # toByteString :: Key -> ByteString Source #
ToByteString Message Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Message Methods toByteStringBuilder :: Message -> Builder Source # toByteString :: Message -> ByteString Source #
ToByteString Name Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Name Methods toByteStringBuilder :: Name -> Builder Source # toByteString :: Name -> ByteString Source #
ToByteString Properties Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Properties Methods toByteStringBuilder :: Properties -> Builder Source # toByteString :: Properties -> ByteString Source #
ToByteString Value Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Value Methods toByteStringBuilder :: Value -> Builder Source # toByteString :: Value -> ByteString Source #
ToCommand a => ToByteString (GenericAnnotation a) Source #
Instance details Defined in GitHub.Workflow.Command.Annotation.Commands.Generic Methods toByteStringBuilder :: GenericAnnotation a -> Builder Source # toByteString :: GenericAnnotation a -> ByteString Source #
ToCommand a => ToByteString (ByteStringViaCommand a) Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods toByteStringBuilder :: ByteStringViaCommand a -> Builder Source # toByteString :: ByteStringViaCommand a -> ByteString Source #

newtype ByteStringViaCommand a Source #

Constructors

ByteStringViaCommand a

Instances

Instances details

ToCommand a => ToByteString (ByteStringViaCommand a) Source #
Instance details Defined in GitHub.Workflow.Command.Syntax.Command Methods toByteStringBuilder :: ByteStringViaCommand a -> Builder Source # toByteString :: ByteStringViaCommand a -> ByteString Source #

printByteStringLn :: (ToByteString a, MonadIO m) => a -> m () Source #