haskell / haskell/cabal

Could we use a formatter for `.cabal` files in this project?

Open
#9,674 6 comments 1 reaction 0 assignees View on GitHub
re: code formatting type: user-question
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

Could we use a formatter for `.cabal` files such as `cabal-fmt`? Nothing fancy, just a CI check to see that the `.cabal` files have been formated (by formatting again and checking for diffs).

I notice leading commas in `cabal-install-solver.cabal` and trailing commas in `cabal-install.cabal`.

https://github.com/haskell/cabal/blob/03d7b42a3f08bc1e6aa85118ca365277d8d83334/cabal-install-solver/cabal-install-solver.cabal#L101-L113

https://github.com/haskell/cabal/blob/03d7b42a3f08bc1e6aa85118ca365277d8d83334/cabal-install/cabal-install.cabal#L214-L245

Contributor guide

Open the contributing guide

Research direction

Start with cabal-install-solver/cabal-install-solver.cabal and cabal-install/cabal-install.cabal, especially the referenced dependency sections, and review how this repository defines CI checks. Evaluate using cabal-fmt, then make CI format the .cabal files and fail when formatting produces diffs; done means the check covers the project files and catches the cited comma inconsistencies.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
build-system, ci-cd
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.