Safe Haskell	None
Language	GHC2024

MathiasSM.Yaml.Website

Contents

Main logic
website.yaml parsing

Description

The site configuration read from website.yaml in the content repo

Synopsis

loadWebsite :: FilePath -> IO Website
validateSecurityExpiration :: Website -> IO ()
data Website = Website {
- websiteSite :: Site
- websiteContact :: Contact
- websiteManifest :: Manifest
- websiteMathjax :: Mathjax
- websiteHighlight :: Highlight
- websiteFunding :: Funding
- websiteSecurity :: Security
- websiteRobots :: Robots
- websiteTrust :: Trust
- websiteFeed :: FeedConfig
}
data Site = Site {
- siteName :: String
- siteDescription :: String
- siteAuthor :: String
- siteCopyrightYear :: Int
- siteDomain :: String
- siteTwitterHandle :: String
}
data Contact = Contact {
- contactEmail :: String
- contactPage :: String
}
data Manifest = Manifest {
- manifestBackgroundColor :: String
- manifestThemeColor :: String
}
data Mathjax = Mathjax {
- mathjaxVersion :: String
}
data Highlight = Highlight {
- highlightStyle :: HighlightStyle
}
data HighlightStyle
- = Pygments
- | Espresso
- | Zenburn
- | Tango
- | Kate
- | Monochrome
- | BreezeDark
- | Haddock
highlightStyleName :: HighlightStyle -> String
parseHighlightStyle :: String -> Maybe HighlightStyle
toPandocStyle :: HighlightStyle -> Style
data FeedConfig = FeedConfig {
- feedSize :: Int
}
data Security = Security {
- securityPreferredLanguages :: String
- securityExpires :: String
- securityExpirationMarginDays :: Int
}
data Robots = Robots {
- robotsDisallow :: [String]
}
data Trust = Trust {
- trustTrainingAllowed :: String
}
data Funding = Funding {
- fundingEntity :: FundingEntity
- fundingProjects :: [FundingProject]
- fundingChannels :: [FundingChannel]
- fundingPlans :: [FundingPlan]
}
data FundingEntity = FundingEntity {
- fundingEntityEmail :: String
- fundingEntityDescription :: String
}
data FundingProject = FundingProject {
- fundingProjectGuid :: String
- fundingProjectName :: String
- fundingProjectDescription :: String
- fundingProjectRepositoryUrl :: String
- fundingProjectRepositoryWellKnown :: String
- fundingProjectLicenses :: [String]
- fundingProjectTags :: [String]
}
data FundingChannel = FundingChannel {
- fundingChannelGuid :: String
- fundingChannelType :: String
- fundingChannelAddress :: String
- fundingChannelDescription :: String
}
data FundingPlan = FundingPlan {
- fundingPlanGuid :: String
- fundingPlanStatus :: String
- fundingPlanName :: String
- fundingPlanDescription :: String
- fundingPlanAmount :: Int
- fundingPlanCurrency :: String
- fundingPlanFrequency :: String
- fundingPlanChannels :: [String]
}

Main logic

loadWebsite :: FilePath -> IO Website Source #

Reads and parses contentDir/website.yaml, failing with a clear message

validateSecurityExpiration :: Website -> IO () Source #

Fails if the security.txt expiration is within the configured margin (or already passed)

`website.yaml` parsing

website:

data Website Source #

Everything website.yaml describes

Constructors

Website
Fields websiteSite :: Site websiteContact :: Contact websiteManifest :: Manifest websiteMathjax :: Mathjax websiteHighlight :: Highlight websiteFunding :: Funding websiteSecurity :: Security websiteRobots :: Robots websiteTrust :: Trust websiteFeed :: FeedConfig

Instances

Instances details

FromJSON Website Source #
Instance details Defined in MathiasSM.Yaml.Website Methods parseJSON :: Value -> Parser Website # parseJSONList :: Value -> Parser [Website] # omittedField :: Maybe Website #
Show Website Source #
Instance details Defined in MathiasSM.Yaml.Website Methods showsPrec :: Int -> Website -> ShowS # show :: Website -> String # showList :: [Website] -> ShowS #
Eq Website Source #
Instance details Defined in MathiasSM.Yaml.Website Methods (==) :: Website -> Website -> Bool # (/=) :: Website -> Website -> Bool #

site:

data Site Source #

The site: section: the site's identity

Constructors

Site
Fields siteName :: String siteDescription :: String siteAuthor :: String siteCopyrightYear :: Int siteDomain :: String siteTwitterHandle :: String

Instances

Instances details

FromJSON Site Source #
Instance details Defined in MathiasSM.Yaml.Website Methods parseJSON :: Value -> Parser Site # parseJSONList :: Value -> Parser [Site] # omittedField :: Maybe Site #
Show Site Source #
Instance details Defined in MathiasSM.Yaml.Website Methods showsPrec :: Int -> Site -> ShowS # show :: Site -> String # showList :: [Site] -> ShowS #
Eq Site Source #
Instance details Defined in MathiasSM.Yaml.Website Methods (==) :: Site -> Site -> Bool # (/=) :: Site -> Site -> Bool #

contact:

data Contact Source #

The contact: section: how to reach the site owner

Constructors

Contact
Fields contactEmail :: String contactPage :: String

Instances

Instances details

FromJSON Contact Source #
Instance details Defined in MathiasSM.Yaml.Website Methods parseJSON :: Value -> Parser Contact # parseJSONList :: Value -> Parser [Contact] # omittedField :: Maybe Contact #
Show Contact Source #
Instance details Defined in MathiasSM.Yaml.Website Methods showsPrec :: Int -> Contact -> ShowS # show :: Contact -> String # showList :: [Contact] -> ShowS #
Eq Contact Source #
Instance details Defined in MathiasSM.Yaml.Website Methods (==) :: Contact -> Contact -> Bool # (/=) :: Contact -> Contact -> Bool #

manifest:

data Manifest Source #

The manifest: section: web app manifest colours

Constructors

Manifest
Fields manifestBackgroundColor :: String manifestThemeColor :: String

Instances

Instances details

FromJSON Manifest Source #
Instance details Defined in MathiasSM.Yaml.Website Methods parseJSON :: Value -> Parser Manifest # parseJSONList :: Value -> Parser [Manifest] # omittedField :: Maybe Manifest #
Show Manifest Source #
Instance details Defined in MathiasSM.Yaml.Website Methods showsPrec :: Int -> Manifest -> ShowS # show :: Manifest -> String # showList :: [Manifest] -> ShowS #
Eq Manifest Source #
Instance details Defined in MathiasSM.Yaml.Website Methods (==) :: Manifest -> Manifest -> Bool # (/=) :: Manifest -> Manifest -> Bool #

mathjax:

data Mathjax Source #

The mathjax: section: which MathJax CDN version renders the site's math

Constructors

Mathjax
Fields mathjaxVersion :: String

Instances

Instances details

FromJSON Mathjax Source #
Instance details Defined in MathiasSM.Yaml.Website Methods parseJSON :: Value -> Parser Mathjax # parseJSONList :: Value -> Parser [Mathjax] # omittedField :: Maybe Mathjax #
Show Mathjax Source #
Instance details Defined in MathiasSM.Yaml.Website Methods showsPrec :: Int -> Mathjax -> ShowS # show :: Mathjax -> String # showList :: [Mathjax] -> ShowS #
Eq Mathjax Source #
Instance details Defined in MathiasSM.Yaml.Website Methods (==) :: Mathjax -> Mathjax -> Bool # (/=) :: Mathjax -> Mathjax -> Bool #

highlight:

data Highlight Source #

The highlight: section: which pandoc style renders code blocks

Constructors

Highlight
Fields highlightStyle :: HighlightStyle

Instances

Instances details

FromJSON Highlight Source #
Instance details Defined in MathiasSM.Yaml.Website Methods parseJSON :: Value -> Parser Highlight # parseJSONList :: Value -> Parser [Highlight] # omittedField :: Maybe Highlight #
Show Highlight Source #
Instance details Defined in MathiasSM.Yaml.Website Methods showsPrec :: Int -> Highlight -> ShowS # show :: Highlight -> String # showList :: [Highlight] -> ShowS #
Eq Highlight Source #
Instance details Defined in MathiasSM.Yaml.Website Methods (==) :: Highlight -> Highlight -> Bool # (/=) :: Highlight -> Highlight -> Bool #

data HighlightStyle Source #

A pandoc syntax-highlighting style, as spelled in highlight.style

Constructors

Pygments
Espresso
Zenburn
Tango
Kate
Monochrome
BreezeDark
Haddock

Instances

Instances details

FromJSON HighlightStyle Source #
Instance details Defined in MathiasSM.Yaml.Website Methods parseJSON :: Value -> Parser HighlightStyle # parseJSONList :: Value -> Parser [HighlightStyle] # omittedField :: Maybe HighlightStyle #
Bounded HighlightStyle Source #
Instance details Defined in MathiasSM.Yaml.Website Methods minBound :: HighlightStyle # maxBound :: HighlightStyle #
Enum HighlightStyle Source #
Instance details Defined in MathiasSM.Yaml.Website Methods succ :: HighlightStyle -> HighlightStyle # pred :: HighlightStyle -> HighlightStyle # toEnum :: Int -> HighlightStyle # fromEnum :: HighlightStyle -> Int # enumFrom :: HighlightStyle -> [HighlightStyle] # enumFromThen :: HighlightStyle -> HighlightStyle -> [HighlightStyle] # enumFromTo :: HighlightStyle -> HighlightStyle -> [HighlightStyle] # enumFromThenTo :: HighlightStyle -> HighlightStyle -> HighlightStyle -> [HighlightStyle] #
Show HighlightStyle Source #
Instance details Defined in MathiasSM.Yaml.Website Methods showsPrec :: Int -> HighlightStyle -> ShowS # show :: HighlightStyle -> String # showList :: [HighlightStyle] -> ShowS #
Eq HighlightStyle Source #
Instance details Defined in MathiasSM.Yaml.Website Methods (==) :: HighlightStyle -> HighlightStyle -> Bool # (/=) :: HighlightStyle -> HighlightStyle -> Bool #

highlightStyleName :: HighlightStyle -> String Source #

How a highlight style is spelled

parseHighlightStyle :: String -> Maybe HighlightStyle Source #

Resolves a HighlightStyle from its highlight.style spelling, if known

toPandocStyle :: HighlightStyle -> Style Source #

The pandoc Style backing a HighlightStyle

feed:

data FeedConfig Source #

The feed: section: data behind atom.xml files

Constructors

FeedConfig
Fields feedSize :: Int

Instances

Instances details

FromJSON FeedConfig Source #
Instance details Defined in MathiasSM.Yaml.Website Methods parseJSON :: Value -> Parser FeedConfig # parseJSONList :: Value -> Parser [FeedConfig] # omittedField :: Maybe FeedConfig #
Show FeedConfig Source #
Instance details Defined in MathiasSM.Yaml.Website Methods showsPrec :: Int -> FeedConfig -> ShowS # show :: FeedConfig -> String # showList :: [FeedConfig] -> ShowS #
Eq FeedConfig Source #
Instance details Defined in MathiasSM.Yaml.Website Methods (==) :: FeedConfig -> FeedConfig -> Bool # (/=) :: FeedConfig -> FeedConfig -> Bool #

security:

data Security Source #

The security: section: data behind .well-known/security.txt

Constructors

Security
Fields securityPreferredLanguages :: String securityExpires :: String securityExpirationMarginDays :: Int

Instances

Instances details

FromJSON Security Source #
Instance details Defined in MathiasSM.Yaml.Website Methods parseJSON :: Value -> Parser Security # parseJSONList :: Value -> Parser [Security] # omittedField :: Maybe Security #
Show Security Source #
Instance details Defined in MathiasSM.Yaml.Website Methods showsPrec :: Int -> Security -> ShowS # show :: Security -> String # showList :: [Security] -> ShowS #
Eq Security Source #
Instance details Defined in MathiasSM.Yaml.Website Methods (==) :: Security -> Security -> Bool # (/=) :: Security -> Security -> Bool #

robots:

data Robots Source #

The robots: section: data behind robots.txt

Constructors

Robots
Fields robotsDisallow :: [String]

Instances

Instances details

FromJSON Robots Source #
Instance details Defined in MathiasSM.Yaml.Website Methods parseJSON :: Value -> Parser Robots # parseJSONList :: Value -> Parser [Robots] # omittedField :: Maybe Robots #
Show Robots Source #
Instance details Defined in MathiasSM.Yaml.Website Methods showsPrec :: Int -> Robots -> ShowS # show :: Robots -> String # showList :: [Robots] -> ShowS #
Eq Robots Source #
Instance details Defined in MathiasSM.Yaml.Website Methods (==) :: Robots -> Robots -> Bool # (/=) :: Robots -> Robots -> Bool #

trust:

data Trust Source #

The trust: section: data behind .well-known/trust.txt

Constructors

Trust
Fields trustTrainingAllowed :: String

Instances

Instances details

FromJSON Trust Source #
Instance details Defined in MathiasSM.Yaml.Website Methods parseJSON :: Value -> Parser Trust # parseJSONList :: Value -> Parser [Trust] # omittedField :: Maybe Trust #
Show Trust Source #
Instance details Defined in MathiasSM.Yaml.Website Methods showsPrec :: Int -> Trust -> ShowS # show :: Trust -> String # showList :: [Trust] -> ShowS #
Eq Trust Source #
Instance details Defined in MathiasSM.Yaml.Website Methods (==) :: Trust -> Trust -> Bool # (/=) :: Trust -> Trust -> Bool #

funding:

data Funding Source #

The funding: section: data behind funding.json

Constructors

Funding
Fields fundingEntity :: FundingEntity fundingProjects :: [FundingProject] fundingChannels :: [FundingChannel] fundingPlans :: [FundingPlan]

Instances

Instances details

FromJSON Funding Source #
Instance details Defined in MathiasSM.Yaml.Website Methods parseJSON :: Value -> Parser Funding # parseJSONList :: Value -> Parser [Funding] # omittedField :: Maybe Funding #
Show Funding Source #
Instance details Defined in MathiasSM.Yaml.Website Methods showsPrec :: Int -> Funding -> ShowS # show :: Funding -> String # showList :: [Funding] -> ShowS #
Eq Funding Source #
Instance details Defined in MathiasSM.Yaml.Website Methods (==) :: Funding -> Funding -> Bool # (/=) :: Funding -> Funding -> Bool #

data FundingEntity Source #

The entity being funded (the funding.entity section)

Constructors

FundingEntity
Fields fundingEntityEmail :: String fundingEntityDescription :: String

Instances

Instances details

FromJSON FundingEntity Source #
Instance details Defined in MathiasSM.Yaml.Website Methods parseJSON :: Value -> Parser FundingEntity # parseJSONList :: Value -> Parser [FundingEntity] # omittedField :: Maybe FundingEntity #
Show FundingEntity Source #
Instance details Defined in MathiasSM.Yaml.Website Methods showsPrec :: Int -> FundingEntity -> ShowS # show :: FundingEntity -> String # showList :: [FundingEntity] -> ShowS #
Eq FundingEntity Source #
Instance details Defined in MathiasSM.Yaml.Website Methods (==) :: FundingEntity -> FundingEntity -> Bool # (/=) :: FundingEntity -> FundingEntity -> Bool #

data FundingProject Source #

A project listed in funding.json

Constructors

FundingProject
Fields fundingProjectGuid :: String fundingProjectName :: String fundingProjectDescription :: String fundingProjectRepositoryUrl :: String fundingProjectRepositoryWellKnown :: String fundingProjectLicenses :: [String] fundingProjectTags :: [String]

Instances

Instances details

FromJSON FundingProject Source #
Instance details Defined in MathiasSM.Yaml.Website Methods parseJSON :: Value -> Parser FundingProject # parseJSONList :: Value -> Parser [FundingProject] # omittedField :: Maybe FundingProject #
Show FundingProject Source #
Instance details Defined in MathiasSM.Yaml.Website Methods showsPrec :: Int -> FundingProject -> ShowS # show :: FundingProject -> String # showList :: [FundingProject] -> ShowS #
Eq FundingProject Source #
Instance details Defined in MathiasSM.Yaml.Website Methods (==) :: FundingProject -> FundingProject -> Bool # (/=) :: FundingProject -> FundingProject -> Bool #

data FundingChannel Source #

A funding channel in funding.json

Constructors

FundingChannel
Fields fundingChannelGuid :: String fundingChannelType :: String fundingChannelAddress :: String fundingChannelDescription :: String

Instances

Instances details

FromJSON FundingChannel Source #
Instance details Defined in MathiasSM.Yaml.Website Methods parseJSON :: Value -> Parser FundingChannel # parseJSONList :: Value -> Parser [FundingChannel] # omittedField :: Maybe FundingChannel #
Show FundingChannel Source #
Instance details Defined in MathiasSM.Yaml.Website Methods showsPrec :: Int -> FundingChannel -> ShowS # show :: FundingChannel -> String # showList :: [FundingChannel] -> ShowS #
Eq FundingChannel Source #
Instance details Defined in MathiasSM.Yaml.Website Methods (==) :: FundingChannel -> FundingChannel -> Bool # (/=) :: FundingChannel -> FundingChannel -> Bool #

data FundingPlan Source #

A funding plan in funding.json

Constructors

FundingPlan
Fields fundingPlanGuid :: String fundingPlanStatus :: String fundingPlanName :: String fundingPlanDescription :: String fundingPlanAmount :: Int fundingPlanCurrency :: String fundingPlanFrequency :: String fundingPlanChannels :: [String]

Instances

Instances details

FromJSON FundingPlan Source #
Instance details Defined in MathiasSM.Yaml.Website Methods parseJSON :: Value -> Parser FundingPlan # parseJSONList :: Value -> Parser [FundingPlan] # omittedField :: Maybe FundingPlan #
Show FundingPlan Source #
Instance details Defined in MathiasSM.Yaml.Website Methods showsPrec :: Int -> FundingPlan -> ShowS # show :: FundingPlan -> String # showList :: [FundingPlan] -> ShowS #
Eq FundingPlan Source #
Instance details Defined in MathiasSM.Yaml.Website Methods (==) :: FundingPlan -> FundingPlan -> Bool # (/=) :: FundingPlan -> FundingPlan -> Bool #

Main logic

website.yaml parsing

website:

Instances

site:

Instances

contact:

Instances

manifest:

Instances

mathjax:

Instances

highlight:

Instances

Instances

feed:

Instances

security:

Instances

robots:

Instances

trust:

Instances

funding:

Instances

Instances

Instances

Instances

Instances

`website.yaml` parsing