Distribution.Client.Sandbox.PackageEnvironment

Utilities for working with the package environment file. Patterned after Distribution.Client.Config.

Documentation

data PackageEnvironment

Constructors

PackageEnvironment

Fields

• pkgEnvSavedConfig :: SavedConfig

Instances

Generic PackageEnvironment

Defined in Distribution.Client.Sandbox.PackageEnvironment

Associated Types

type Rep PackageEnvironment :: Type -> Type

Methods

from :: PackageEnvironment -> Rep PackageEnvironment x

to :: Rep PackageEnvironment x -> PackageEnvironment

Semigroup PackageEnvironment

Defined in Distribution.Client.Sandbox.PackageEnvironment

Methods

(<>) :: PackageEnvironment -> PackageEnvironment -> PackageEnvironment

sconcat :: NonEmpty PackageEnvironment -> PackageEnvironment

stimes :: Integral b => b -> PackageEnvironment -> PackageEnvironment

Monoid PackageEnvironment

Defined in Distribution.Client.Sandbox.PackageEnvironment

Methods

mempty :: PackageEnvironment

mappend :: PackageEnvironment -> PackageEnvironment -> PackageEnvironment

mconcat :: [PackageEnvironment] -> PackageEnvironment

type Rep PackageEnvironment

Defined in Distribution.Client.Sandbox.PackageEnvironment

type Rep PackageEnvironment = D1 ('MetaData "PackageEnvironment" "Distribution.Client.Sandbox.PackageEnvironment" "cabal-install-3.8.1.0-7iNu5HGLMqL9QLfLAUJqbd" 'False) (C1 ('MetaCons "PackageEnvironment" 'PrefixI 'True) (S1 ('MetaSel ('Just "pkgEnvSavedConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SavedConfig)))

data PackageEnvironmentType

Type of the current package environment.

Constructors

UserPackageEnvironment

'./cabal.config'

AmbientPackageEnvironment

'~.cabalconfig'

classifyPackageEnvironment :: FilePath -> IO PackageEnvironmentType

Is there a 'cabal.config' in this directory?

readPackageEnvironmentFile :: ConstraintSource -> PackageEnvironment -> FilePath -> IO (Maybe (ParseResult PackageEnvironment))

Read the package environment file.

showPackageEnvironment :: PackageEnvironment -> String

Pretty-print the package environment.

showPackageEnvironmentWithComments :: Maybe PackageEnvironment -> PackageEnvironment -> String

Pretty-print the package environment with default values for empty fields commented out (just like the default ~.cabalconfig).

loadUserConfig :: Verbosity -> FilePath -> Maybe FilePath -> IO SavedConfig

Same as userPackageEnvironmentFile, but returns a SavedConfig.

userPackageEnvironmentFile :: FilePath

Optional package environment file that can be used to customize the default settings. Created by the user.