Maintainer | cabal-devel@haskell.org |
---|---|
Portability | portable |
Safe Haskell | None |
Language | Haskell2010 |
Distribution.Client.Sandbox.PackageEnvironment
Description
Utilities for working with the package environment file. Patterned after Distribution.Client.Config.
Synopsis
- data PackageEnvironment = PackageEnvironment {}
- data PackageEnvironmentType
- classifyPackageEnvironment :: FilePath -> IO PackageEnvironmentType
- readPackageEnvironmentFile :: ConstraintSource -> PackageEnvironment -> FilePath -> IO (Maybe (ParseResult PackageEnvironment))
- showPackageEnvironment :: PackageEnvironment -> String
- showPackageEnvironmentWithComments :: Maybe PackageEnvironment -> PackageEnvironment -> String
- loadUserConfig :: Verbosity -> FilePath -> Maybe FilePath -> IO SavedConfig
- userPackageEnvironmentFile :: FilePath
Documentation
data PackageEnvironment Source #
Constructors
PackageEnvironment | |
Fields |
Instances
Monoid PackageEnvironment Source # | |||||
Defined in Distribution.Client.Sandbox.PackageEnvironment Methods mempty :: PackageEnvironment # mappend :: PackageEnvironment -> PackageEnvironment -> PackageEnvironment # mconcat :: [PackageEnvironment] -> PackageEnvironment # | |||||
Semigroup PackageEnvironment Source # | |||||
Defined in Distribution.Client.Sandbox.PackageEnvironment Methods (<>) :: PackageEnvironment -> PackageEnvironment -> PackageEnvironment # sconcat :: NonEmpty PackageEnvironment -> PackageEnvironment stimes :: Integral b => b -> PackageEnvironment -> PackageEnvironment | |||||
Generic PackageEnvironment Source # | |||||
Defined in Distribution.Client.Sandbox.PackageEnvironment Associated Types
Methods from :: PackageEnvironment -> Rep PackageEnvironment x to :: Rep PackageEnvironment x -> PackageEnvironment | |||||
type Rep PackageEnvironment Source # | |||||
Defined in Distribution.Client.Sandbox.PackageEnvironment type Rep PackageEnvironment = D1 ('MetaData "PackageEnvironment" "Distribution.Client.Sandbox.PackageEnvironment" "cabal-install-3.10.2.1-BEJczJM0CAJHWGw22qxZZb" 'False) (C1 ('MetaCons "PackageEnvironment" 'PrefixI 'True) (S1 ('MetaSel ('Just "pkgEnvSavedConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SavedConfig))) |
data PackageEnvironmentType Source #
Type of the current package environment.
Constructors
UserPackageEnvironment | './cabal.config' |
AmbientPackageEnvironment | '~.configcabal/config' |
classifyPackageEnvironment :: FilePath -> IO PackageEnvironmentType Source #
Is there a 'cabal.config' in this directory?
readPackageEnvironmentFile :: ConstraintSource -> PackageEnvironment -> FilePath -> IO (Maybe (ParseResult PackageEnvironment)) Source #
Read the package environment file.
showPackageEnvironment :: PackageEnvironment -> String Source #
Pretty-print the package environment.
showPackageEnvironmentWithComments :: Maybe PackageEnvironment -> PackageEnvironment -> String Source #
Pretty-print the package environment with default values for empty fields commented out (just like the default Cabal config file).
loadUserConfig :: Verbosity -> FilePath -> Maybe FilePath -> IO SavedConfig Source #
Same as userPackageEnvironmentFile
, but returns a SavedConfig.
userPackageEnvironmentFile :: FilePath Source #
Optional package environment file that can be used to customize the default settings. Created by the user.