Support hoogle for prebuilt and local packages
Nobody has claimed this yet.
- Dominant language
- Starlark
- Stars
- 279
- Forks
- 93
- Avg merge
- 13d 11h
- Merged PRs (30d)
- 3
Description
Atm, there is no explicit support for hoogle in rules_haskell, and no obvious way to generate a hoogle database for a given set of packages:
-
Since
haskell_docrunshaddockwith the--hoogleflag, we can generate a hoogle db for local packages using something likehoogle generate $(ls bazel-bin/docs/ | sed 's/^/--local=bazel-bin\/docs\//')(assuming we have ahaskell_docrule nameddocs). -
We can also generate a db for the prebuilt dependencies using
hoogle generate --localwith the right ghc in scope.
The problem is that there is (afaik) no way to merge these databases nor an easy way to combine these two calls, so no way to create an haddock database containing all the available packages.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the haskell_doc rule and the example docs target described in the issue, then inspect how rules_haskell handles prebuilt dependencies and Hoogle generation. Define a workflow that combines Hoogle data from local and prebuilt packages; done means one generated database contains both sets of available packages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100