Summoner.Tui.Kit

This module contains data types to work with application form. SummonKit is the data type containing the values manipulated by the fields in the form.

Data types

data SummonKit

Global TUI state.

Constructors

SummonKit

Fields

• summonKitUser :: !User
• summonKitProject :: !Project
• summonKitCabal :: !Bool
• summonKitStack :: !Bool
• summonKitProjectMeta :: !ProjectMeta
• summonKitGitHub :: !GitHub
• summonKitExtensions :: ![Text]

  Can be recieved from the config file.

• summonKitGhcOptions :: ![Text]

  Can be recieved from the config file.

• summonKitGitignore :: ![Text]

  Received from the config file.

• summonKitConnectMode :: !ConnectMode
• summonKitShouldSummon :: !Decision

  Check if project needs to be created.

• summonKitConfigFile :: !(Maybe FilePath)

  Just if configuration file was used.

• summonKitExtraFiles :: ![TreeFs]

  Extra files

Instances

Show SummonKit

Defined in Summoner.Tui.Kit

Methods

showsPrec :: Int -> SummonKit -> ShowS

show :: SummonKit -> String

showList :: [SummonKit] -> ShowS

data User

User information.

Constructors

User

Fields

• userOwner :: !Text

  GitHub user or organization name.

• userFullName :: !Text
• userEmail :: !Text

Instances

Show User

Defined in Summoner.Tui.Kit

Methods

showsPrec :: Int -> User -> ShowS

show :: User -> String

showList :: [User] -> ShowS

data Project

Project related information

Constructors

Project

Fields

• projectRepo :: !Text

  Project name.

• projectDesc :: !Text

  Short project description.

• projectCategory :: !Text

  Comma-separated. See Hackage for existing category list.

• projectLicense :: !LicenseName

Instances

Show Project

Defined in Summoner.Tui.Kit

Methods

showsPrec :: Int -> Project -> ShowS

show :: Project -> String

showList :: [Project] -> ShowS

data ProjectMeta

Project meta information.

Constructors

ProjectMeta

Fields

• projectMetaLib :: !Bool
• projectMetaExe :: !Bool
• projectMetaTest :: !Bool
• projectMetaBench :: !Bool
• projectMetaGhcs :: ![GhcVer]

  Default GHC version is always added.

• projectMetaPreludeName :: !Text
• projectMetaPreludeModule :: !Text

Instances

Show ProjectMeta

Defined in Summoner.Tui.Kit

Methods

showsPrec :: Int -> ProjectMeta -> ShowS

show :: ProjectMeta -> String

showList :: [ProjectMeta] -> ShowS

data GitHub

Github specific information.

Constructors

GitHub

Fields

• gitHubEnabled :: !Bool
• gitHubNoUpload :: !Bool

  Do not upload to GitHub, only local initialization.

• gitHubPrivate :: !Bool
• gitHubActions :: !Bool
• gitHubTravis :: !Bool
• gitHubAppVeyor :: !Bool

Instances

Show GitHub

Defined in Summoner.Tui.Kit

Methods

showsPrec :: Int -> GitHub -> ShowS

show :: GitHub -> String

showList :: [GitHub] -> ShowS

renderWidgetTree :: SummonKit -> Text

Shows the Widget with the generated project structure tree.

configToSummonKit

Arguments

:: Text

Given project name

-> ConnectMode

offline mode option

-> Maybe FilePath

Configuration file used

-> [TreeFs]

Extra files

-> Config

Given configurations.

-> SummonKit

Gets the initial SummonKit from the given Config.

finalSettings :: SummonKit -> IO Settings

Gets Settings on successful application complition.

Lenses

SummonKit

user :: HasUser s a => Lens' s a

project :: HasProject s a => Lens' s a

cabal :: HasCabal s a => Lens' s a

stack :: HasStack s a => Lens' s a

projectMeta :: HasProjectMeta s a => Lens' s a

gitHub :: HasGitHub s a => Lens' s a

extensions :: HasExtensions s a => Lens' s a

ghcOptions :: HasGhcOptions s a => Lens' s a

connectMode :: HasConnectMode s a => Lens' s a

shouldSummon :: HasShouldSummon s a => Lens' s a

configFile :: HasConfigFile s a => Lens' s a

User

owner :: HasOwner s a => Lens' s a

fullName :: HasFullName s a => Lens' s a

email :: HasEmail s a => Lens' s a

Project

repo :: HasRepo s a => Lens' s a

desc :: HasDesc s a => Lens' s a

category :: HasCategory s a => Lens' s a

license :: HasLicense s a => Lens' s a

maybeLicense :: Lens' SummonKit (Maybe LicenseName)

Lens for Maybe LicenseName in SummonKit.

ProjectMeta

lib :: HasLib s a => Lens' s a

exe :: HasExe s a => Lens' s a

test :: HasTest s a => Lens' s a

bench :: HasBench s a => Lens' s a

ghcs :: HasGhcs s a => Lens' s a

preludeName :: HasPreludeName s a => Lens' s a

preludeModule :: HasPreludeModule s a => Lens' s a

GitHub

enabled :: HasEnabled s a => Lens' s a

noUpload :: HasNoUpload s a => Lens' s a

private :: HasPrivate s a => Lens' s a

actions :: HasActions s a => Lens' s a

travis :: HasTravis s a => Lens' s a

appVeyor :: HasAppVeyor s a => Lens' s a