SetupHooks: make Location a separate data type

[sheaf]

This commit updates the Hooks API, making Location a separate data type:

data Location where
  Location
    :: SymbolicPath Pkg (Dir baseDir)
    -> RelativePath baseDir File
    -> Location

instead of being a type synonym for (FilePath, FilePath).

We noted during testing of the Hooks API that it was all too easy to give an incorrect location for rule outputs, e.g. by omitting an extension or using an absolute path.
This change allows us to improve the API documentation, as well as clarifying the types to avoid any ambiguities about what kind of file path is expected (FilePath vs SymbolicPath).

---

Template Α: This PR modifies behaviour or interface.

• Patch conforms to the coding conventions.
• Changes noted in the changelog: this change will be part of the first Hooks API, so no changelog entry is needed.
• The documentation has been updated.
• The Hooks tests have been updated in consequence.

[ffaf1]

I have a question which is not strictly related to the pr

[x] Changes noted in the changelog: this change will be part of the first Hooks API, so no changelog entry is needed.

Is there a development branch where I can see the changelog files? Are the changelog files being written somewhere public? Are they already in master?

[sheaf]

Is there a development branch where I can see the changelog files? Are the changelog files being written somewhere public? Are they already in master?

The first version of the Cabal library with support for "build-type: Hooks" will be 3.14, and the Haddocks for the Distribution.Simple.SetupHooks module constitutes the bulk of the documentation for the API. As (I expect and intend) this PR to land before the 3.14 branch is cut, there is no changelog to speak of (the change will be part of the first released version of the API).

Does that answer your question?

[ffaf1]

It does, thank you.

[ulysses4ever]

Looks like a clear win to me!

[alt-romes]

@mergify rebase

[mergify]

rebase

❌ Unable to rebase: user alt-romes is unknown.

Please make sure alt-romes has logged in Mergify dashboard.

[Mikolaj]

@mergify rebase

[mergify]

rebase

✅ Branch has been successfully rebased

[Mikolaj]

Let me restart https://github.com/haskell/cabal/actions/runs/9125479546/job/25091745764?pr=9992. It may or may not be transient.

[Mikolaj]

This does seem to be transient, but common, so let me restart until it passes.

[Mikolaj]

@mergify rebase

[mergify]

rebase

✅ Branch has been successfully rebased

[Mikolaj]

@mergify rebase

[mergify]

rebase

✅ Branch has been successfully rebased

[Mikolaj]

@mergify rebase

[mergify]

rebase

✅ Branch has been successfully rebased

[Mikolaj]

@mergify rebase

[mergify]

rebase

✅ Branch has been successfully rebased