Summoner.Config

Summoner configurations.

Documentation

data ConfigP (p :: Phase)

Potentially incomplete configuration.

Constructors

ConfigP

Fields

• cOwner :: !(p :- Text)
• cFullName :: !(p :- Text)
• cEmail :: !(p :- Text)
• cLicense :: !(p :- LicenseName)
• cGhcVer :: !(p :- [GhcVer])
• cCabal :: !Decision
• cStack :: !Decision
• cGitHub :: !Decision
• cGhActions :: !Decision
• cTravis :: !Decision
• cAppVey :: !Decision
• cPrivate :: !Decision
• cLib :: !Decision
• cExe :: !Decision
• cTest :: !Decision
• cBench :: !Decision
• cPrelude :: !(Last CustomPrelude)
• cExtensions :: ![Text]
• cGhcOptions :: ![Text]

  GHC options to add to each stanza

• cGitignore :: ![Text]
• cNoUpload :: !Any

  Do not upload to the GitHub (even if enabled)

• cFiles :: !(Map FilePath Source)

  Custom files

Instances

Semigroup PartialConfig

Defined in Summoner.Config

Methods

(<>) :: PartialConfig -> PartialConfig -> PartialConfig

sconcat :: NonEmpty PartialConfig -> PartialConfig

stimes :: Integral b => b -> PartialConfig -> PartialConfig

Monoid PartialConfig

Defined in Summoner.Config

Methods

mempty :: PartialConfig

mappend :: PartialConfig -> PartialConfig -> PartialConfig

mconcat :: [PartialConfig] -> PartialConfig

(Eq (p :- Text), Eq (p :- LicenseName), Eq (p :- [GhcVer])) => Eq (ConfigP p)

Defined in Summoner.Config

Methods

(==) :: ConfigP p -> ConfigP p -> Bool

(/=) :: ConfigP p -> ConfigP p -> Bool

(Show (p :- Text), Show (p :- LicenseName), Show (p :- [GhcVer])) => Show (ConfigP p)

Defined in Summoner.Config

Methods

showsPrec :: Int -> ConfigP p -> ShowS

show :: ConfigP p -> String

showList :: [ConfigP p] -> ShowS

Generic (ConfigP p)

Defined in Summoner.Config

Associated Types

type Rep (ConfigP p) :: Type -> Type

Methods

from :: ConfigP p -> Rep (ConfigP p) x

to :: Rep (ConfigP p) x -> ConfigP p

type Rep (ConfigP p)

Defined in Summoner.Config

type Rep (ConfigP p)

type PartialConfig = ConfigP 'Partial

Incomplete configurations.

type Config = ConfigP 'Final

Complete configurations.

configCodec :: TomlCodec PartialConfig

Identifies how to read Config data from the .toml file.

defaultConfig :: PartialConfig

Default Config configurations.

guessConfigFromGit :: IO PartialConfig

Try to retrieve user information from Git config. Return the PartialConfig with the corresponding filled fields if the information is applicable.

finalise :: PartialConfig -> Validation [Text] Config

Make sure that all the required configurations options were specified.

loadFileConfig :: MonadIO m => FilePath -> m PartialConfig

Read configuration from the given file and return it in data type.