Hooks into the cabal build phases.

Usage:

• In your .cabal file, declare build-type: Hooks (with a cabal-version greater than or equal to 3.14),
• In your .cabal file, include a custom-setup stanza which declares the dependencies of your SetupHooks module; this will usually contain a dependency on the Cabal-hooks package.
• Provide a SetupHooks.hs module next to your .cabal file; it must export setupHooks :: SetupHooks.

Empty hooks.

Configure-time hooks.

Order of execution:

• $sel:preConfPackageHook:ConfigureHooks,
• configure the package,
• $sel:postConfPackageHook:ConfigureHooks,
• $sel:preConfComponentHook:ConfigureHooks,
• configure the components.

Empty configure phase hooks.

Inputs to the package-wide pre-configure step.

Outputs of the package-wide pre-configure step.

Prefer using noPreConfPackageOutputs and overriding the fields you care about, to avoid depending on implementation details of this datatype.

Use this smart constructor to declare an empty set of changes by the package-wide pre-configure hook, and override the fields you care about.

Use this rather than PreConfPackageOutputs to avoid relying on internal implementation details of the latter.

Inputs to the package-wide post-configure step.

Package-wide post-configure step.

Perform side effects. Last opportunity for any package-wide logic; any subsequent hooks work per-component.

Inputs to the per-component pre-configure step.

Outputs of the per-component pre-configure step.

Prefer using noPreComponentOutputs and overriding the fields you care about, to avoid depending on implementation details of this datatype.

Use this smart constructor to declare an empty set of changes by a per-component pre-configure hook, and override the fields you care about.

Use this rather than PreConfComponentOutputs to avoid relying on internal implementation details of the latter.

Per-component pre-configure step.

For each component of the package, this hook can perform side effects, and return a diff to the passed in component, e.g. to declare additional autogenerated modules.

A diff to a Cabal Component, that gets combined monoidally into an existing Component.

Build-time hooks.

Empty build hooks.

What kind of build phase are we doing/hooking into?

Is this a normal build, or is it perhaps for running an interactive session or Haddock?

Copy/install hooks.

Empty copy/install hooks.

A per-component install hook, which can only perform side effects (e.g. copying files).

Run all pre-build rules.

This function should only be called internally within Cabal, as it is used to implement the (legacy) Setup.hs interface. The build tool (e.g. cabal-install or hls) should instead go through the separate hooks executable, which allows us to only rerun the out-of-date rules (instead of running all of these rules at once).