Modulecabal-install-3.16.0.0Haskell2010

Distribution.Client.ScriptUtils

Utilities to help commands with scripts

2 types
9 values

Packagecabal-install-3.16.0.0
Exports11
LanguageHaskell2010
LicenceBSD-3-Clause
SourceScriptUtils.hs

valuegetScriptHash :: FilePath -> IO String

Get the hash of a script's absolute path.

Two hashes will be the same as long as the absolute paths are the same.

valuegetScriptCacheDirectory :: FilePath -> IO FilePath

Get the directory for caching a script build.

The only identity of a script is it's absolute path, so append the hashed path to the script-builds dir to get the cache directory.

valueensureScriptCacheDirectory :: Verbosity -> FilePath -> IO FilePath

Get the directory for caching a script build and ensure it exists.

The only identity of a script is it's absolute path, so append the hashed path to the script-builds dir to get the cache directory.

valuewithContextAndSelectors

:: Verbosity
-> AcceptNoTargets
What your command should do when no targets are found.
-> Maybe ComponentKind
A target filter
-> NixStyleFlags a
Command line flags
-> [String]
Target strings or a script and args.
-> GlobalFlags
Global flags.
-> CurrentCommand
Current Command (usually for error reporting).
-> (TargetContext -> ProjectBaseContext -> [TargetSelector] -> IO b)
The body of your command action.
-> IO b

Determine whether the targets represent regular targets or a script and return the proper context and target selectors. Die with an error message if selectors are valid as neither regular targets or as a script.

In the case that the context refers to a temporary directory, delete it after the action finishes.

datadata AcceptNoTargets

What your command should do when no targets are found.

Constructors

RejectNoTargets
die on TargetSelectorNoTargetsInProject
AcceptNoTargets
return a default TargetSelector

Instances2Eq, Show

Eq AcceptNoTargetsDefined in cabal-install-3.16.0.0 · Distribution.Client.ScriptUtils
Show AcceptNoTargetsDefined in cabal-install-3.16.0.0 · Distribution.Client.ScriptUtils

datadata TargetContext

Information about the context in which we found the TargetSelectors.

Constructors

ProjectContext
The target selectors are part of a project.
GlobalContext
The target selectors are from the global context.
ScriptContext FilePath Executable
The target selectors refer to a script. Contains the path to the script and the executable metadata parsed from the script

Instances2Eq, Show

Eq TargetContextDefined in cabal-install-3.16.0.0 · Distribution.Client.ScriptUtils
Show TargetContextDefined in cabal-install-3.16.0.0 · Distribution.Client.ScriptUtils

valueupdateContextAndWriteProjectFile

Add the executable metadata to the context and write a .cabal file.

valueupdateContextAndWriteProjectFile'

:: ProjectBaseContext
-> SourcePackage (PackageLocation (Maybe FilePath))
-> IO ProjectBaseContext

Add the SourcePackage to the context and use it to write a .cabal file.

valuefakeProjectSourcePackage :: FilePath -> SourcePackage (PackageLocation loc)

The base for making a SourcePackage for a fake project. It needs a Library or Executable depending on the command.

value

lSrcpkgDescription :: Functor f => LensLike f (SourcePackage loc) (SourcePackage loc) GenericPackageDescription GenericPackageDescription

A lens for the srcpkgDescription field of SourcePackage

valuemovedExePath

Find the path of an exe that has been relocated with a "-o" option