Usefulness of releasing `cabal-install` the library

Open
#12,326 4 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 3 days

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Refactor
Clarity
Needs clarification
Activity status
Active
Tech stack
haskell

Research direction

Start by reviewing the exported modules of the cabal-install library and the listed reverse dependencies: cabal-add, cabal-hoogle, cabal-matrix, guardian, hackage-revdeps, hix, and acme-everything. Determine which API is actually used and whether trimming it is feasible; done would require an agreed scope for removing or retaining modules, but the issue does not name specific files or tests.

Written by the indexing model from the issue text.

Description

type: discussion type: enhancement

Summary: cabal-install API is big, unused, is holding us back. Should we axe/trim it?


During the release of 3.18.2.0, a number of PRs (e.g. #12289) were not backported because they break cabal-install API.

While we should be extra careful with Cabal and Cabal-syntax, how much damage does breaking cabal-install API causes?

Reverse dependencies for cabal-install are: cabal-add, cabal-hoogle, cabal-matrix, guardian, hackage-revdeps, hix, and the memetic acme-everything.

cabal-install API is quite wide, with ≃140 exported modules. Do we need them all? Can we axe most of it?

Dominant language
Haskell
Stars
1.8k
Forks
766
Avg merge
5d 21h
Merged PRs (30d)
27

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from haskell/cabal

All issues in haskell/cabal

Similar issues

More Haskell issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.