summoner-2.0.1.1: Tool for scaffolding fully configured batteries-included production-level Haskell projects.

Copyright	(c) 2017-2019 Kowainik
License	MPL-2.0
Maintainer	Kowainik <xrom.xkov@gmail.com>
Safe Haskell	None
Language	Haskell2010

Summoner.Settings

Description

Complete settings required for the project creation.

Synopsis

data Settings = Settings {
- settingsRepo :: !Text
- settingsOwner :: !Text
- settingsDescription :: !Text
- settingsFullName :: !Text
- settingsEmail :: !Text
- settingsYear :: !Text
- settingsCategories :: !Text
- settingsLicenseName :: !LicenseName
- settingsLicenseText :: !License
- settingsGitHub :: !Bool
- settingsPrivate :: !Bool
- settingsGhActions :: !Bool
- settingsTravis :: !Bool
- settingsAppVeyor :: !Bool
- settingsIsLib :: !Bool
- settingsIsExe :: !Bool
- settingsTest :: !Bool
- settingsBench :: !Bool
- settingsTestedVersions :: ![GhcVer]
- settingsPrelude :: !(Maybe CustomPrelude)
- settingsExtensions :: ![Text]
- settingsGhcOptions :: ![Text]
- settingsGitignore :: ![Text]
- settingsCabal :: !Bool
- settingsStack :: !Bool
- settingsNoUpload :: !Bool
- settingsFiles :: ![TreeFs]
}
data Tool
- = Cabal
- | Stack
showTool :: Tool -> Text
parseTool :: Text -> Maybe Tool

Documentation

data Settings Source #

Data needed for project creation.

Constructors

Fields

settingsRepo :: !Text
repository name
settingsOwner :: !Text
github username
settingsDescription :: !Text
project description
settingsFullName :: !Text
full name
settingsEmail :: !Text
e-mail
settingsYear :: !Text
year
settingsCategories :: !Text
project category
settingsLicenseName :: !LicenseName
type of license
settingsLicenseText :: !License
license text
settingsGitHub :: !Bool
GitHub repository
settingsPrivate :: !Bool
private repository
settingsGhActions :: !Bool
GitHub Actions CI integration
settingsTravis :: !Bool
Travis CI integration
settingsAppVeyor :: !Bool
AppVeyor CI integration
settingsIsLib :: !Bool
is library
settingsIsExe :: !Bool
is executable
settingsTest :: !Bool
add tests
settingsBench :: !Bool
add benchmarks
settingsTestedVersions :: ![GhcVer]
GHC versions
settingsPrelude :: !(Maybe CustomPrelude)
custom prelude to be used
settingsExtensions :: ![Text]
default extensions
settingsGhcOptions :: ![Text]
default GHC options
settingsGitignore :: ![Text]
.gitignore file
settingsCabal :: !Bool
settingsStack :: !Bool
settingsNoUpload :: !Bool
do not upload to GitHub
settingsFiles :: ![TreeFs]
Tree nodes of extra files

Instances

Instances details

Show Settings Source #
Instance details Defined in Summoner.Settings Methods showsPrec :: Int -> Settings -> ShowS # show :: Settings -> String # showList :: [Settings] -> ShowS #

data Tool Source #

Enum for supported build tools.

Constructors

Cabal
Stack

Instances

Instances details

Bounded Tool Source #
Instance details Defined in Summoner.Settings Methods minBound :: Tool # maxBound :: Tool #
Enum Tool Source #
Instance details Defined in Summoner.Settings Methods succ :: Tool -> Tool # pred :: Tool -> Tool # toEnum :: Int -> Tool # fromEnum :: Tool -> Int # enumFrom :: Tool -> [Tool] # enumFromThen :: Tool -> Tool -> [Tool] # enumFromTo :: Tool -> Tool -> [Tool] # enumFromThenTo :: Tool -> Tool -> Tool -> [Tool] #
Eq Tool Source #
Instance details Defined in Summoner.Settings Methods (==) :: Tool -> Tool -> Bool # (/=) :: Tool -> Tool -> Bool #
Show Tool Source #
Instance details Defined in Summoner.Settings Methods showsPrec :: Int -> Tool -> ShowS # show :: Tool -> String # showList :: [Tool] -> ShowS #

showTool :: Tool -> Text Source #

Show Tool in lowercase.

parseTool :: Text -> Maybe Tool Source #

Parse Tool from string. Inverse of showTool.