cabal-install-3.12.1.0: The command-line interface for Cabal and Hackage.
Safe HaskellSafe-Inferred
LanguageHaskell2010

Distribution.Client.ProjectFlags

Synopsis

Documentation

data ProjectFlags Source #

Constructors

ProjectFlags 

Fields

  • flagProjectDir :: Flag FilePath

    The project directory.

  • flagProjectFile :: Flag FilePath

    The cabal project file path; defaults to cabal.project. This path, when relative, is relative to the project directory. The filename portion of the path 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 a project directory was not specified, and 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

Instances details
Monoid ProjectFlags Source # 
Instance details

Defined in Distribution.Client.ProjectFlags

Semigroup ProjectFlags Source # 
Instance details

Defined in Distribution.Client.ProjectFlags

Generic ProjectFlags Source # 
Instance details

Defined in Distribution.Client.ProjectFlags

Associated Types

type Rep ProjectFlags :: Type -> Type #

Show ProjectFlags Source # 
Instance details

Defined in Distribution.Client.ProjectFlags

type Rep ProjectFlags Source # 
Instance details

Defined in Distribution.Client.ProjectFlags

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

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

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.