OrgStat.Config

Configuration file types, together with json instances.

Documentation

data ConfigException

Exception type for everything bad that happens with config, starting from parsing to logic errors.

Constructors

ConfigParseException Text

ConfigLogicException Text

Instances

Show ConfigException

Methods

showsPrec :: Int -> ConfigException -> ShowS

show :: ConfigException -> String

showList :: [ConfigException] -> ShowS

Exception ConfigException

Methods

toException :: ConfigException -> SomeException

fromException :: SomeException -> Maybe ConfigException

displayException :: ConfigException -> String

data ConfDate

Constructors

ConfNow

ConfLocal !LocalTime

Instances

Show ConfDate

Methods

showsPrec :: Int -> ConfDate -> ShowS

show :: ConfDate -> String

showList :: [ConfDate] -> ShowS

FromJSON ConfDate

Methods

parseJSON :: Value -> Parser ConfDate

parseJSONList :: Value -> Parser [ConfDate]

data ConfRange

Constructors

ConfFromTo !ConfDate !ConfDate

ConfBlockWeek !Integer

ConfBlockDay !Integer

ConfBlockMonth !Integer

Instances

Show ConfRange

Methods

showsPrec :: Int -> ConfRange -> ShowS

show :: ConfRange -> String

showList :: [ConfRange] -> ShowS

FromJSON ConfRange

Methods

parseJSON :: Value -> Parser ConfRange

parseJSONList :: Value -> Parser [ConfRange]

data ConfOutputType

Constructors

TimelineOutput

Fields

• toParams :: !TimelineParams
• toReport :: !Text

SummaryOutput !SummaryParams

BlockOutput

Fields

• boParams :: !BlockParams
• boReport :: !Text

Instances

Show ConfOutputType

Methods

showsPrec :: Int -> ConfOutputType -> ShowS

show :: ConfOutputType -> String

showList :: [ConfOutputType] -> ShowS

FromJSON ConfOutputType

Methods

parseJSON :: Value -> Parser ConfOutputType

parseJSONList :: Value -> Parser [ConfOutputType]

data ConfOutput

Constructors

ConfOutput

Fields

• coType :: !ConfOutputType
• coName :: !Text

Instances

Show ConfOutput

Methods

showsPrec :: Int -> ConfOutput -> ShowS

show :: ConfOutput -> String

showList :: [ConfOutput] -> ShowS

FromJSON ConfOutput

Methods

parseJSON :: Value -> Parser ConfOutput

parseJSONList :: Value -> Parser [ConfOutput]

data ConfScope

Constructors

ConfScope

Fields

• csName :: !Text
• csPaths :: !(NonEmpty FilePath)

Instances

Show ConfScope

Methods

showsPrec :: Int -> ConfScope -> ShowS

show :: ConfScope -> String

showList :: [ConfScope] -> ShowS

FromJSON ConfScope

Methods

parseJSON :: Value -> Parser ConfScope

parseJSONList :: Value -> Parser [ConfScope]

data ConfReport

Constructors

ConfReport

Fields

• crName :: !Text
• crScope :: !Text
• crRange :: !ConfRange
• crModifiers :: ![ScopeModifier]

Instances

Show ConfReport

Methods

showsPrec :: Int -> ConfReport -> ShowS

show :: ConfReport -> String

showList :: [ConfReport] -> ShowS

FromJSON ConfReport

Methods

parseJSON :: Value -> Parser ConfReport

parseJSONList :: Value -> Parser [ConfReport]

data OrgStatConfig

Constructors

OrgStatConfig

Fields

• confScopes :: ![ConfScope]
• confReports :: ![ConfReport]
• confOutputs :: ![ConfOutput]
• confBaseTimelineParams :: !TimelineParams
• confTodoKeywords :: ![Text]
• confOutputDir :: !FilePath
• confColorSalt :: !Int

Instances

Show OrgStatConfig

Methods

showsPrec :: Int -> OrgStatConfig -> ShowS

show :: OrgStatConfig -> String

showList :: [OrgStatConfig] -> ShowS

FromJSON OrgStatConfig

Methods

parseJSON :: Value -> Parser OrgStatConfig

parseJSONList :: Value -> Parser [OrgStatConfig]

Orphan instances

FromJSON TimelineParams

Methods

parseJSON :: Value -> Parser TimelineParams

parseJSONList :: Value -> Parser [TimelineParams]

FromJSON ScopeModifier

Methods

parseJSON :: Value -> Parser ScopeModifier

parseJSONList :: Value -> Parser [ScopeModifier]

FromJSON AstPath

Methods

parseJSON :: Value -> Parser AstPath

parseJSONList :: Value -> Parser [AstPath]