Stack.Types.PackageFile

The facility for retrieving all files from the main Stack Package type. This was moved into its own module to allow component-level file-gathering without circular dependency at the Package level.

Documentation

data GetPackageFileContext

Constructors

GetPackageFileContext

Fields

• ctxFile :: !(Path Abs File)
• ctxDistDir :: !(Path Abs Dir)
• ctxBuildConfig :: !BuildConfig
• ctxCabalVer :: !Version

Instances

HasPantryConfig GetPackageFileContext

Defined in Stack.Types.PackageFile

Methods

pantryConfigL :: Lens' GetPackageFileContext PantryConfig

HasLogFunc GetPackageFileContext

Defined in Stack.Types.PackageFile

Methods

logFuncL :: Lens' GetPackageFileContext LogFunc

HasProcessContext GetPackageFileContext

Defined in Stack.Types.PackageFile

Methods

processContextL :: Lens' GetPackageFileContext ProcessContext

HasTerm GetPackageFileContext

Defined in Stack.Types.PackageFile

Methods

useColorL :: Lens' GetPackageFileContext Bool

termWidthL :: Lens' GetPackageFileContext Int

HasStylesUpdate GetPackageFileContext

Defined in Stack.Types.PackageFile

Methods

stylesUpdateL :: Lens' GetPackageFileContext StylesUpdate

HasBuildConfig GetPackageFileContext

Defined in Stack.Types.PackageFile

Methods

buildConfigL :: Lens' GetPackageFileContext BuildConfig

HasConfig GetPackageFileContext

Defined in Stack.Types.PackageFile

Methods

configL :: Lens' GetPackageFileContext Config

HasGHCVariant GetPackageFileContext

Defined in Stack.Types.PackageFile

Methods

ghcVariantL :: SimpleGetter GetPackageFileContext GHCVariant

HasPlatform GetPackageFileContext

Defined in Stack.Types.PackageFile

Methods

platformL :: Lens' GetPackageFileContext Platform

platformVariantL :: Lens' GetPackageFileContext PlatformVariant

HasRunner GetPackageFileContext

Defined in Stack.Types.PackageFile

Methods

runnerL :: Lens' GetPackageFileContext Runner

data DotCabalPath

A path resolved from the Cabal file, which is either main-is or an exposedinternalreferenced module.

Constructors

DotCabalModulePath !(Path Abs File)

DotCabalMainPath !(Path Abs File)

DotCabalFilePath !(Path Abs File)

DotCabalCFilePath !(Path Abs File)

Instances

Show DotCabalPath

Defined in Stack.Types.PackageFile

Methods

showsPrec :: Int -> DotCabalPath -> ShowS

show :: DotCabalPath -> String

showList :: [DotCabalPath] -> ShowS

Eq DotCabalPath

Defined in Stack.Types.PackageFile

Methods

(==) :: DotCabalPath -> DotCabalPath -> Bool

(/=) :: DotCabalPath -> DotCabalPath -> Bool

Ord DotCabalPath

Defined in Stack.Types.PackageFile

Methods

compare :: DotCabalPath -> DotCabalPath -> Ordering

(<) :: DotCabalPath -> DotCabalPath -> Bool

(<=) :: DotCabalPath -> DotCabalPath -> Bool

(>) :: DotCabalPath -> DotCabalPath -> Bool

(>=) :: DotCabalPath -> DotCabalPath -> Bool

max :: DotCabalPath -> DotCabalPath -> DotCabalPath

min :: DotCabalPath -> DotCabalPath -> DotCabalPath

data DotCabalDescriptor

A descriptor from a Cabal file indicating one of the following:

exposed-modules: Foo other-modules: Foo or main-is: Foo.hs

Constructors

DotCabalModule !ModuleName

DotCabalMain !FilePath

DotCabalFile !FilePath

DotCabalCFile !FilePath

Instances

Show DotCabalDescriptor

Defined in Stack.Types.PackageFile

Methods

showsPrec :: Int -> DotCabalDescriptor -> ShowS

show :: DotCabalDescriptor -> String

showList :: [DotCabalDescriptor] -> ShowS

Eq DotCabalDescriptor

Defined in Stack.Types.PackageFile

Methods

(==) :: DotCabalDescriptor -> DotCabalDescriptor -> Bool

(/=) :: DotCabalDescriptor -> DotCabalDescriptor -> Bool

Ord DotCabalDescriptor

Defined in Stack.Types.PackageFile

Methods

compare :: DotCabalDescriptor -> DotCabalDescriptor -> Ordering

(<) :: DotCabalDescriptor -> DotCabalDescriptor -> Bool

(<=) :: DotCabalDescriptor -> DotCabalDescriptor -> Bool

(>) :: DotCabalDescriptor -> DotCabalDescriptor -> Bool

(>=) :: DotCabalDescriptor -> DotCabalDescriptor -> Bool

max :: DotCabalDescriptor -> DotCabalDescriptor -> DotCabalDescriptor

min :: DotCabalDescriptor -> DotCabalDescriptor -> DotCabalDescriptor

newtype GetPackageFiles

Files that the package depends on, relative to package directory. Argument is the location of the Cabal file

Constructors

GetPackageFiles

Fields

• getPackageFiles :: forall env. HasEnvConfig env => Path Abs File -> RIO env (Map NamedComponent (Map ModuleName (Path Abs File)), Map NamedComponent [DotCabalPath], Set (Path Abs File), [PackageWarning])

Instances

Show GetPackageFiles

Defined in Stack.Types.PackageFile

Methods

showsPrec :: Int -> GetPackageFiles -> ShowS

show :: GetPackageFiles -> String

showList :: [GetPackageFiles] -> ShowS

data PackageWarning

Warning generated when reading a package

Constructors

UnlistedModulesWarning NamedComponent [ModuleName]

Modules found that are not listed in Cabal file TODO: bring this back - see https://github.com/commercialhaskell/stack/issues/2649