Safe Haskell	Safe-Inferred
Language	GHC2021

Stack.Types.PackageFile

Description

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.

Synopsis

data GetPackageFileContext = GetPackageFileContext {
- ctxFile :: !(Path Abs File)
- ctxDistDir :: !(Path Abs Dir)
- ctxBuildConfig :: !BuildConfig
- ctxCabalVer :: !Version
}
data DotCabalPath
- = DotCabalModulePath !(Path Abs File)
- | DotCabalMainPath !(Path Abs File)
- | DotCabalFilePath !(Path Abs File)
- | DotCabalCFilePath !(Path Abs File)
data DotCabalDescriptor
- = DotCabalModule !ModuleName
- | DotCabalMain !FilePath
- | DotCabalFile !FilePath
- | DotCabalCFile !FilePath
newtype GetPackageFiles = GetPackageFiles {
- 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])
}
data PackageWarning = UnlistedModulesWarning NamedComponent [ModuleName]

Documentation

data GetPackageFileContext Source #

Constructors

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

Instances

Instances details

HasPantryConfig GetPackageFileContext Source #
Instance details Defined in Stack.Types.PackageFile Methods pantryConfigL :: Lens' GetPackageFileContext PantryConfig #
HasLogFunc GetPackageFileContext Source #
Instance details Defined in Stack.Types.PackageFile Methods logFuncL :: Lens' GetPackageFileContext LogFunc #
HasProcessContext GetPackageFileContext Source #
Instance details Defined in Stack.Types.PackageFile Methods processContextL :: Lens' GetPackageFileContext ProcessContext #
HasTerm GetPackageFileContext Source #
Instance details Defined in Stack.Types.PackageFile Methods useColorL :: Lens' GetPackageFileContext Bool # termWidthL :: Lens' GetPackageFileContext Int #
HasStylesUpdate GetPackageFileContext Source #
Instance details Defined in Stack.Types.PackageFile Methods stylesUpdateL :: Lens' GetPackageFileContext StylesUpdate #
HasBuildConfig GetPackageFileContext Source #
Instance details Defined in Stack.Types.PackageFile Methods buildConfigL :: Lens' GetPackageFileContext BuildConfig Source #
HasConfig GetPackageFileContext Source #
Instance details Defined in Stack.Types.PackageFile Methods configL :: Lens' GetPackageFileContext Config Source #
HasGHCVariant GetPackageFileContext Source #
Instance details Defined in Stack.Types.PackageFile Methods ghcVariantL :: SimpleGetter GetPackageFileContext GHCVariant Source #
HasPlatform GetPackageFileContext Source #
Instance details Defined in Stack.Types.PackageFile Methods platformL :: Lens' GetPackageFileContext Platform Source # platformVariantL :: Lens' GetPackageFileContext PlatformVariant Source #
HasRunner GetPackageFileContext Source #
Instance details Defined in Stack.Types.PackageFile Methods runnerL :: Lens' GetPackageFileContext Runner Source #

data DotCabalPath Source #

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

Instances details

Show DotCabalPath Source #
Instance details Defined in Stack.Types.PackageFile Methods showsPrec :: Int -> DotCabalPath -> ShowS # show :: DotCabalPath -> String # showList :: [DotCabalPath] -> ShowS #
Eq DotCabalPath Source #
Instance details Defined in Stack.Types.PackageFile Methods (==) :: DotCabalPath -> DotCabalPath -> Bool # (/=) :: DotCabalPath -> DotCabalPath -> Bool #
Ord DotCabalPath Source #
Instance details 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 Source #

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

Instances details

Show DotCabalDescriptor Source #
Instance details Defined in Stack.Types.PackageFile Methods showsPrec :: Int -> DotCabalDescriptor -> ShowS # show :: DotCabalDescriptor -> String # showList :: [DotCabalDescriptor] -> ShowS #
Eq DotCabalDescriptor Source #
Instance details Defined in Stack.Types.PackageFile Methods (==) :: DotCabalDescriptor -> DotCabalDescriptor -> Bool # (/=) :: DotCabalDescriptor -> DotCabalDescriptor -> Bool #
Ord DotCabalDescriptor Source #
Instance details 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 Source #

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

Instances details

Show GetPackageFiles Source #
Instance details Defined in Stack.Types.PackageFile Methods showsPrec :: Int -> GetPackageFiles -> ShowS # show :: GetPackageFiles -> String # showList :: [GetPackageFiles] -> ShowS #

data PackageWarning Source #

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