Headroom.Types

Data types and type class instances shared between modules.

Documentation

data AppConfigError

Error occured during validation of application configuration.

Constructors

EmptySourcePaths

no paths to source code files provided

EmptyTemplatePaths

no paths to license header templates provided

Instances

Show AppConfigError

Defined in Headroom.Types

Methods

showsPrec :: Int -> AppConfigError -> ShowS

show :: AppConfigError -> String

showList :: [AppConfigError] -> ShowS

data HeadroomError

Represents fatal application error, that should be displayed to user in some human readable form.

Constructors

InvalidAppConfig [AppConfigError]

invalid application configuration

InvalidLicense Text

unknown license is selected in Generator

InvalidVariable Text

invalid variable format (key=value)

NoGenModeSelected

no mode for Generator command is selected

MissingVariables Text [Text]

not all variables were filled in template

ParseError Text

error parsing template file

Instances

Show HeadroomError

Defined in Headroom.Types

Methods

showsPrec :: Int -> HeadroomError -> ShowS

show :: HeadroomError -> String

showList :: [HeadroomError] -> ShowS

Exception HeadroomError

Defined in Headroom.Types

Methods

toException :: HeadroomError -> SomeException

fromException :: SomeException -> Maybe HeadroomError

displayException :: HeadroomError -> String

data NewLine

Represents newline separator.

Constructors

CR

line ends with r

CRLF

line ends with rn

LF

line ends with n

Instances

Eq NewLine

Defined in Headroom.Types

Methods

(==) :: NewLine -> NewLine -> Bool

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

Show NewLine

Defined in Headroom.Types

Methods

showsPrec :: Int -> NewLine -> ShowS

show :: NewLine -> String

showList :: [NewLine] -> ShowS

data Progress

Progress indication. First argument is current progress, second the maximum value.

Constructors

Progress Int Int

Instances

Eq Progress

Defined in Headroom.Types

Methods

(==) :: Progress -> Progress -> Bool

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

Show Progress

Defined in Headroom.Types

Methods

showsPrec :: Int -> Progress -> ShowS

show :: Progress -> String

showList :: [Progress] -> ShowS

data RunMode

Mode of the Run command, states how to license headers in source code files.

Constructors

Add

add license header if missing in source code file

Drop

drop any license header if present in source code file

Replace

replace existing or add license header

Instances

Eq RunMode

Defined in Headroom.Types

Methods

(==) :: RunMode -> RunMode -> Bool

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

Show RunMode

Defined in Headroom.Types

Methods

showsPrec :: Int -> RunMode -> ShowS

show :: RunMode -> String

showList :: [RunMode] -> ShowS

FromJSON RunMode

Defined in Headroom.Types

Methods

parseJSON :: Value -> Parser RunMode

parseJSONList :: Value -> Parser [RunMode]