stack-2.14.0: The Haskell Tool Stack

Safe Haskell	Safe-Inferred
Language	GHC2021

Stack.ComponentFile

Description

A module which exports all component-level file-gathering logic. It also includes utility functions for handling paths and directories.

Synopsis

resolveOrWarn :: Text -> (Path Abs Dir -> String -> RIO GetPackageFileContext (Maybe a)) -> FilePath -> RIO GetPackageFileContext (Maybe a)
libraryFiles :: NamedComponent -> Library -> RIO GetPackageFileContext (Map ModuleName (Path Abs File), [DotCabalPath], [PackageWarning])
executableFiles :: NamedComponent -> Executable -> RIO GetPackageFileContext (Map ModuleName (Path Abs File), [DotCabalPath], [PackageWarning])
testFiles :: NamedComponent -> TestSuite -> RIO GetPackageFileContext (Map ModuleName (Path Abs File), [DotCabalPath], [PackageWarning])
benchmarkFiles :: NamedComponent -> Benchmark -> RIO GetPackageFileContext (Map ModuleName (Path Abs File), [DotCabalPath], [PackageWarning])
componentOutputDir :: NamedComponent -> Path Abs Dir -> Path Abs Dir
componentBuildDir :: Version -> NamedComponent -> Path Abs Dir -> Path Abs Dir
packageAutogenDir :: Version -> Path Abs Dir -> Maybe (Path Abs Dir)
buildDir :: Path Abs Dir -> Path Abs Dir
componentAutogenDir :: Version -> NamedComponent -> Path Abs Dir -> Path Abs Dir

Documentation

resolveOrWarn :: Text -> (Path Abs Dir -> String -> RIO GetPackageFileContext (Maybe a)) -> FilePath -> RIO GetPackageFileContext (Maybe a) Source #

libraryFiles :: NamedComponent -> Library -> RIO GetPackageFileContext (Map ModuleName (Path Abs File), [DotCabalPath], [PackageWarning]) Source #

Get all files referenced by the library.

executableFiles :: NamedComponent -> Executable -> RIO GetPackageFileContext (Map ModuleName (Path Abs File), [DotCabalPath], [PackageWarning]) Source #

Get all files referenced by the executable.

testFiles :: NamedComponent -> TestSuite -> RIO GetPackageFileContext (Map ModuleName (Path Abs File), [DotCabalPath], [PackageWarning]) Source #

Get all files referenced by the test.

benchmarkFiles :: NamedComponent -> Benchmark -> RIO GetPackageFileContext (Map ModuleName (Path Abs File), [DotCabalPath], [PackageWarning]) Source #

Get all files referenced by the benchmark.

componentOutputDir :: NamedComponent -> Path Abs Dir -> Path Abs Dir Source #

The directory where generated files are put like .o or .hs (from .x files).

componentBuildDir :: Version -> NamedComponent -> Path Abs Dir -> Path Abs Dir Source #

See componentBuildDir

packageAutogenDir :: Version -> Path Abs Dir -> Maybe (Path Abs Dir) Source #

Make the global autogen dir if Cabal version is new enough.

buildDir :: Path Abs Dir -> Path Abs Dir Source #

Make the build dir. Note that Cabal >= 2.0 uses the componentBuildDir above for some things.

componentAutogenDir :: Version -> NamedComponent -> Path Abs Dir -> Path Abs Dir Source #

Make the autogen dir.