Distribution.Client.ProjectFlags

Documentation

data ProjectFlags

Constructors

ProjectFlags

Fields

• flagProjectFileName :: Flag FilePath

  The cabal project file name; defaults to cabal.project. The name itself denotes the cabal project file name, but it also is the base of auxiliary project files, such as cabal.project.local and cabal.project.freeze which are also read and written out in some cases. If the path is not found in the current working directory, we will successively probe relative to parent directories until this name is found.

• flagIgnoreProject :: Flag Bool

  Whether to ignore the local project (i.e. don't search for cabal.project) The exact interpretation might be slightly different per command.

Instances

Monoid ProjectFlags

Defined in Distribution.Client.ProjectFlags

Methods

mempty :: ProjectFlags

mappend :: ProjectFlags -> ProjectFlags -> ProjectFlags

mconcat :: [ProjectFlags] -> ProjectFlags

Semigroup ProjectFlags

Defined in Distribution.Client.ProjectFlags

Methods

(<>) :: ProjectFlags -> ProjectFlags -> ProjectFlags

sconcat :: NonEmpty ProjectFlags -> ProjectFlags

stimes :: Integral b => b -> ProjectFlags -> ProjectFlags

Generic ProjectFlags

Defined in Distribution.Client.ProjectFlags

Associated Types

type Rep ProjectFlags :: Type -> Type

Methods

from :: ProjectFlags -> Rep ProjectFlags x

to :: Rep ProjectFlags x -> ProjectFlags

Show ProjectFlags

Defined in Distribution.Client.ProjectFlags

Methods

showsPrec :: Int -> ProjectFlags -> ShowS

show :: ProjectFlags -> String

showList :: [ProjectFlags] -> ShowS

type Rep ProjectFlags

Defined in Distribution.Client.ProjectFlags

type Rep ProjectFlags = D1 ('MetaData "ProjectFlags" "Distribution.Client.ProjectFlags" "cabal-install-3.10.1.0-FbhGUvZ0l0XIx7QbOQfSVh" 'False) (C1 ('MetaCons "ProjectFlags" 'PrefixI 'True) (S1 ('MetaSel ('Just "flagProjectFileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag FilePath)) :*: S1 ('MetaSel ('Just "flagIgnoreProject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))))

defaultProjectFlags :: ProjectFlags

projectFlagsOptions :: ShowOrParseArgs -> [OptionField ProjectFlags]

removeIgnoreProjectOption :: [OptionField a] -> [OptionField a]

As almost all commands use ProjectFlags but not all can honour "ignore-project" flag, provide this utility to remove the flag parsing from the help message.