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

Source#

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

Source#

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

Source#

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

Source#

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-4MgBWnQbRpBByysMMKvgoy" '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

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

Source#

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

Source#

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

typetype IsLiterate = Bool

Source#

Convenience alias for the literate haskell flag

typetype IsSimple = Bool

Source#

Convenience alias for generating simple projects

File creator opts

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

datadata FieldAnnotation

Source#

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

datadata DefaultPrompt t

Source#

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