Modulecabal-install-3.18.1.0Haskell2010

Distribution.Client.Init.Types

Some types used by the 'cabal init' command.

19 types
1 class
9 values

Packagecabal-install-3.18.1.0
Exports29
LanguageHaskell2010
LicenceBSD-3-Clause
SourceTypes.hs

Data

1 declaration

datadata InitFlags

InitFlags is a subset of flags available in the .cabal file that represent options that are relevant to the init command process.

Constructors

InitFlags
- interactive :: Flag Bool
- quiet :: Flag Bool
- packageDir :: Flag FilePath
- noComments :: Flag Bool
- minimal :: Flag Bool
- simpleProject :: Flag Bool
- packageName :: Flag PackageName
- version :: Flag Version
- cabalVersion :: Flag CabalSpecVersion
- license :: Flag SpecLicense
- author :: Flag String
- email :: Flag String
- homepage :: Flag String
- synopsis :: Flag String
- category :: Flag String
- extraSrc :: Flag [String]
- extraDoc :: Flag [String]
- packageType :: Flag PackageType
- mainIs :: Flag FilePath
- language :: Flag Language
- exposedModules :: Flag [ModuleName]
- otherModules :: Flag [ModuleName]
- otherExts :: Flag [Extension]
- dependencies :: Flag [Dependency]
- applicationDirs :: Flag [String]
- sourceDirs :: Flag [String]
- buildTools :: Flag [String]
- initializeTestSuite :: Flag Bool
- testDirs :: Flag [String]
- initHcPath :: Flag FilePath
- initVerbosity :: Flag VerbosityFlags
- overwrite :: Flag Bool

Instances6Eq, Show, Generic, Semigroup, Monoid, Rep

Eq InitFlagsDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Show InitFlagsDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Generic InitFlagsDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Semigroup InitFlagsDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Monoid InitFlagsDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
type Rep InitFlags = D1 ('MetaData "InitFlags" "Distribution.Client.Init.Types" "cabal-install-3.18.1.0-7ZOq76AEqY2DvdiklqxZ41" 'False) (C1 ('MetaCons "InitFlags" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "interactive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :*: S1 ('MetaSel ('Just "quiet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))) :*: (S1 ('MetaSel ('Just "packageDir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag FilePath)) :*: S1 ('MetaSel ('Just "noComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)))) :*: ((S1 ('MetaSel ('Just "minimal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)) :*: S1 ('MetaSel ('Just "simpleProject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))) :*: (S1 ('MetaSel ('Just "packageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag PackageName)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Version))))) :*: (((S1 ('MetaSel ('Just "cabalVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag CabalSpecVersion)) :*: S1 ('MetaSel ('Just "license") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag SpecLicense))) :*: (S1 ('MetaSel ('Just "author") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag String)) :*: S1 ('MetaSel ('Just "email") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag String)))) :*: ((S1 ('MetaSel ('Just "homepage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag String)) :*: S1 ('MetaSel ('Just "synopsis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag String))) :*: (S1 ('MetaSel ('Just "category") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag String)) :*: S1 ('MetaSel ('Just "extraSrc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag [String])))))) :*: ((((S1 ('MetaSel ('Just "extraDoc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag [String])) :*: S1 ('MetaSel ('Just "packageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag PackageType))) :*: (S1 ('MetaSel ('Just "mainIs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag FilePath)) :*: S1 ('MetaSel ('Just "language") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Language)))) :*: ((S1 ('MetaSel ('Just "exposedModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag [ModuleName])) :*: S1 ('MetaSel ('Just "otherModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag [ModuleName]))) :*: (S1 ('MetaSel ('Just "otherExts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag [Extension])) :*: S1 ('MetaSel ('Just "dependencies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag [Dependency]))))) :*: (((S1 ('MetaSel ('Just "applicationDirs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag [String])) :*: S1 ('MetaSel ('Just "sourceDirs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag [String]))) :*: (S1 ('MetaSel ('Just "buildTools") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag [String])) :*: S1 ('MetaSel ('Just "initializeTestSuite") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool)))) :*: ((S1 ('MetaSel ('Just "testDirs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag [String])) :*: S1 ('MetaSel ('Just "initHcPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag FilePath))) :*: (S1 ('MetaSel ('Just "initVerbosity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag VerbosityFlags)) :*: S1 ('MetaSel ('Just "overwrite") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))))))))Defined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types

Targets and descriptions

datadata PkgDescription

PkgDescription represents the relevant options set by the user when building a package description during the init command process.

Constructors

PkgDescription
- _pkgCabalVersion :: CabalSpecVersion
- _pkgName :: PackageName
- _pkgVersion :: Version
- _pkgLicense :: SpecLicense
- _pkgAuthor :: String
- _pkgEmail :: String
- _pkgHomePage :: String
- _pkgSynopsis :: String
- _pkgCategory :: String
- _pkgExtraSrcFiles :: Set String
- _pkgExtraDocFiles :: Maybe (Set String)

Instances2Eq, Show

Eq PkgDescriptionDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Show PkgDescriptionDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types

datadata LibTarget

LibTarget represents the relevant options set by the user when building a library package during the init command process.

Constructors

LibTarget
- _libSourceDirs :: [String]
- _libLanguage :: Language
- _libExposedModules :: NonEmpty ModuleName
- _libOtherModules :: [ModuleName]
- _libOtherExts :: [Extension]
- _libDependencies :: [Dependency]
- _libBuildTools :: [Dependency]

Instances2Eq, Show

Eq LibTargetDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Show LibTargetDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types

datadata ExeTarget

ExeTarget represents the relevant options set by the user when building an executable package.

Constructors

ExeTarget
- _exeMainIs :: HsFilePath
- _exeApplicationDirs :: [String]
- _exeLanguage :: Language
- _exeOtherModules :: [ModuleName]
- _exeOtherExts :: [Extension]
- _exeDependencies :: [Dependency]
- _exeBuildTools :: [Dependency]

Instances2Eq, Show

Eq ExeTargetDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Show ExeTargetDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types

datadata TestTarget

TestTarget represents the relevant options set by the user when building a library package.

Constructors

TestTarget
- _testMainIs :: HsFilePath
- _testDirs :: [String]
- _testLanguage :: Language
- _testOtherModules :: [ModuleName]
- _testOtherExts :: [Extension]
- _testDependencies :: [Dependency]
- _testBuildTools :: [Dependency]

Instances2Eq, Show

Eq TestTargetDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Show TestTargetDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types

package types

datadata PackageType

Enum to denote whether the user wants to build a library target, executable target, library and executable targets, or a standalone test suite.

Library Executable LibraryAndExecutable TestSuite

Instances4Eq, Show, Generic, Rep

Eq PackageTypeDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Show PackageTypeDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Generic PackageTypeDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
type Rep PackageType = D1 ('MetaData "PackageType" "Distribution.Client.Init.Types" "cabal-install-3.18.1.0-7ZOq76AEqY2DvdiklqxZ41" 'False) ((C1 ('MetaCons "Library" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Executable" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "LibraryAndExecutable" 'PrefixI 'False) U1 :+: C1 ('MetaCons "TestSuite" 'PrefixI 'False) U1))Defined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types

Main file

datadata HsFilePath

Constructors

HsFilePath
- _hsFilePath :: FilePath
- _hsFileType :: HsFileType

Instances2Eq, Show

Eq HsFilePathDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Show HsFilePathDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types

datadata HsFileType

Literate Standard InvalidHsPath

Instances2Eq, Show

Eq HsFileTypeDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Show HsFileTypeDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types

valuefromHsFilePath :: HsFilePath -> Maybe FilePath

valuetoHsFilePath :: FilePath -> HsFilePath

valuetoLiterateHs :: HsFilePath -> HsFilePath

valuetoStandardHs :: HsFilePath -> HsFilePath

valuemkLiterate :: HsFilePath -> [String] -> [String]

valueisHsFilePath :: FilePath -> Bool

Typeclasses

9 declarations

classclass Monad m => Interactive (m :: Type -> Type) where

Methods

getLine :: m String
readFile :: FilePath -> m String
getCurrentDirectory :: m FilePath
getHomeDirectory :: m FilePath
listDirectory :: FilePath -> m [FilePath]
doesDirectoryExist :: FilePath -> m Bool
doesFileExist :: FilePath -> m Bool
canonicalizePathNoThrow :: FilePath -> m FilePath
readProcessWithExitCode :: FilePath -> [String] -> String -> m (ExitCode, String, String)
maybeReadProcessWithExitCode :: FilePath -> [String] -> String -> m (Maybe (ExitCode, String, String))
getEnvironment :: m [(String, String)]
getCurrentYear :: m Integer
listFilesInside :: (FilePath -> m Bool) -> FilePath -> m [FilePath]
listFilesRecursive :: FilePath -> m [FilePath]
putStr :: String -> m ()
putStrLn :: String -> m ()
createDirectory :: FilePath -> m ()
removeDirectory :: FilePath -> m ()
writeFile :: FilePath -> String -> m ()
removeExistingFile :: FilePath -> m ()
copyFile :: FilePath -> FilePath -> m ()
renameDirectory :: FilePath -> FilePath -> m ()
hFlush :: Handle -> m ()
message :: Verbosity -> Severity -> String -> m ()
break :: m Bool
throwPrompt :: BreakException -> m a
getLastChosenLanguage :: m (Maybe String)
setLastChosenLanguage :: Maybe String -> m ()

Instances2Interactive

Interactive PromptIODefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Interactive PurePromptDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types

newtypenewtype BreakException

A pure exception thrown exclusively by the pure prompter to cancel infinite loops in the prompting process.

For example, in order to break on parse errors, or user-driven continuations that do not make sense to test.

Constructors

BreakException String

Instances3Eq, Show, Exception

Eq BreakExceptionDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Show BreakExceptionDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Exception BreakExceptionDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types

newtypenewtype PromptIO a

Instances5Monad, Functor, Applicative, MonadIO, Interactive

Monad PromptIODefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Functor PromptIODefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Applicative PromptIODefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
MonadIO PromptIODefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Interactive PromptIODefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types

valuerunPromptIO :: PromptIO a -> IO a

typetype Inputs = NonEmpty String

newtypenewtype PurePrompt a

Instances4Monad, Functor, Applicative, Interactive

Monad PurePromptDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Functor PurePromptDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Applicative PurePromptDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Interactive PurePromptDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types

valuerunPrompt :: PurePrompt a -> Inputs -> Either BreakException (a, Inputs)

valueevalPrompt :: PurePrompt a -> Inputs -> a

datadata Severity

Used to inform the intent of prompted messages.

Info Warning Error

Instances1Eq

Eq SeverityDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types

Aliases

2 declarations

typetype IsLiterate = Bool

Convenience alias for the literate haskell flag

typetype IsSimple = Bool

Convenience alias for generating simple projects

File creator opts

2 declarations

datadata WriteOpts

Constructors

WriteOpts
- _optOverwrite :: Bool
- _optMinimal :: Bool
- _optNoComments :: Bool
- _optVerbosity :: VerbosityFlags
- _optPkgDir :: FilePath
- _optPkgType :: PackageType
- _optPkgName :: PackageName
- _optCabalSpec :: CabalSpecVersion

Instances2Eq, Show

Eq WriteOptsDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Show WriteOptsDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types

datadata ProjectSettings

Constructors

ProjectSettings
- _pkgOpts :: WriteOpts
- _pkgDesc :: PkgDescription
- _pkgLibTarget :: Maybe LibTarget
- _pkgExeTarget :: Maybe ExeTarget
- _pkgTestTarget :: Maybe TestTarget

Instances2Eq, Show

Eq ProjectSettingsDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Show ProjectSettingsDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types

Formatters

1 declaration

datadata FieldAnnotation

Annotations for cabal file PrettyField.

Constructors

FieldAnnotation
- annCommentedOut :: Bool
  True iif the field and its contents should be commented out.
- annCommentLines :: CommentPosition
  Comment lines to place before the field or section.

Other conveniences

1 declaration

datadata DefaultPrompt t

Defines whether or not a prompt will have a default value, is optional, or is mandatory.

Instances2Functor, Eq

Functor DefaultPromptDefined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types
Eq t => Eq (DefaultPrompt t)Defined in cabal-install-3.18.1.0 · Distribution.Client.Init.Types