Safe Haskell	None
Language	Haskell2010

OrgStat.Config

Contents

Orphan instances

Description

Configuration file types, together with json instances.

Synopsis

data ConfigException
- = ConfigParseException Text
- | ConfigLogicException Text
data ConfDate
- = ConfNow
- | ConfLocal !LocalTime
data ConfRange
- = ConfFromTo !ConfDate !ConfDate
- | ConfBlockWeek !Integer
- | ConfBlockDay !Integer
- | ConfBlockMonth !Integer
data ConfOutputType
- = TimelineOutput {
  - toParams :: !TimelineParams
  - toReport :: !Text
  }
- | SummaryOutput !SummaryParams
- | BlockOutput {
  - boParams :: !BlockParams
  - boReport :: !Text
  }
data ConfOutput = ConfOutput {
- coType :: !ConfOutputType
- coName :: !Text
}
data ConfScope = ConfScope {
- csName :: !Text
- csPaths :: !(NonEmpty FilePath)
}
data ConfReport = ConfReport {
- crName :: !Text
- crScope :: !Text
- crRange :: !ConfRange
- crModifiers :: ![ScopeModifier]
}
data OrgStatConfig = OrgStatConfig {
- confScopes :: ![ConfScope]
- confReports :: ![ConfReport]
- confOutputs :: ![ConfOutput]
- confBaseTimelineParams :: !TimelineParams
- confTodoKeywords :: ![Text]
- confOutputDir :: !FilePath
- confColorSalt :: !Int
}

Documentation

data ConfigException Source #

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

Constructors

ConfigParseException Text
ConfigLogicException Text

Instances

Show ConfigException Source #
Instance details Defined in OrgStat.Config Methods showsPrec :: Int -> ConfigException -> ShowS # show :: ConfigException -> String # showList :: [ConfigException] -> ShowS #
Exception ConfigException Source #
Instance details Defined in OrgStat.Config Methods toException :: ConfigException -> SomeException # fromException :: SomeException -> Maybe ConfigException # displayException :: ConfigException -> String #

data ConfDate Source #

Constructors

ConfNow
ConfLocal !LocalTime

Instances

Show ConfDate Source #
Instance details Defined in OrgStat.Config Methods showsPrec :: Int -> ConfDate -> ShowS # show :: ConfDate -> String # showList :: [ConfDate] -> ShowS #
FromJSON ConfDate Source #
Instance details Defined in OrgStat.Config Methods parseJSON :: Value -> Parser ConfDate # parseJSONList :: Value -> Parser [ConfDate] #

data ConfRange Source #

Constructors

ConfFromTo !ConfDate !ConfDate
ConfBlockWeek !Integer
ConfBlockDay !Integer
ConfBlockMonth !Integer

Instances

Show ConfRange Source #
Instance details Defined in OrgStat.Config Methods showsPrec :: Int -> ConfRange -> ShowS # show :: ConfRange -> String # showList :: [ConfRange] -> ShowS #
FromJSON ConfRange Source #
Instance details Defined in OrgStat.Config Methods parseJSON :: Value -> Parser ConfRange # parseJSONList :: Value -> Parser [ConfRange] #

data ConfOutputType Source #

Constructors

TimelineOutput
Fields toParams :: !TimelineParams toReport :: !Text
SummaryOutput !SummaryParams
BlockOutput
Fields boParams :: !BlockParams boReport :: !Text

Instances

Show ConfOutputType Source #
Instance details Defined in OrgStat.Config Methods showsPrec :: Int -> ConfOutputType -> ShowS # show :: ConfOutputType -> String # showList :: [ConfOutputType] -> ShowS #
FromJSON ConfOutputType Source #
Instance details Defined in OrgStat.Config Methods parseJSON :: Value -> Parser ConfOutputType # parseJSONList :: Value -> Parser [ConfOutputType] #

data ConfOutput Source #

Constructors

ConfOutput
Fields coType :: !ConfOutputType coName :: !Text

Instances

Show ConfOutput Source #
Instance details Defined in OrgStat.Config Methods showsPrec :: Int -> ConfOutput -> ShowS # show :: ConfOutput -> String # showList :: [ConfOutput] -> ShowS #
FromJSON ConfOutput Source #
Instance details Defined in OrgStat.Config Methods parseJSON :: Value -> Parser ConfOutput # parseJSONList :: Value -> Parser [ConfOutput] #

data ConfScope Source #

Constructors

ConfScope
Fields csName :: !Text csPaths :: !(NonEmpty FilePath)

Instances

Show ConfScope Source #
Instance details Defined in OrgStat.Config Methods showsPrec :: Int -> ConfScope -> ShowS # show :: ConfScope -> String # showList :: [ConfScope] -> ShowS #
FromJSON ConfScope Source #
Instance details Defined in OrgStat.Config Methods parseJSON :: Value -> Parser ConfScope # parseJSONList :: Value -> Parser [ConfScope] #

data ConfReport Source #

Constructors

ConfReport
Fields crName :: !Text crScope :: !Text crRange :: !ConfRange crModifiers :: ![ScopeModifier]

Instances

Show ConfReport Source #
Instance details Defined in OrgStat.Config Methods showsPrec :: Int -> ConfReport -> ShowS # show :: ConfReport -> String # showList :: [ConfReport] -> ShowS #
FromJSON ConfReport Source #
Instance details Defined in OrgStat.Config Methods parseJSON :: Value -> Parser ConfReport # parseJSONList :: Value -> Parser [ConfReport] #

data OrgStatConfig Source #

Constructors

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

Instances

Show OrgStatConfig Source #
Instance details Defined in OrgStat.Config Methods showsPrec :: Int -> OrgStatConfig -> ShowS # show :: OrgStatConfig -> String # showList :: [OrgStatConfig] -> ShowS #
FromJSON OrgStatConfig Source #
Instance details Defined in OrgStat.Config Methods parseJSON :: Value -> Parser OrgStatConfig # parseJSONList :: Value -> Parser [OrgStatConfig] #

Orphan instances

FromJSON TimelineParams Source #
Instance details Methods parseJSON :: Value -> Parser TimelineParams # parseJSONList :: Value -> Parser [TimelineParams] #
FromJSON ScopeModifier Source #
Instance details Methods parseJSON :: Value -> Parser ScopeModifier # parseJSONList :: Value -> Parser [ScopeModifier] #
FromJSON AstPath Source #
Instance details Methods parseJSON :: Value -> Parser AstPath # parseJSONList :: Value -> Parser [AstPath] #