Format .cabal files with cabal-gild #4229

fendor · 2024-05-13T09:40:03Z

Compare with #4230

haskell-language-server.cabal

jhrcek · 2024-05-13T10:11:04Z

hls-test-utils/hls-test-utils.cabal

+    directory,
+    extra,
+    filepath,
+    ghcide ==2.8.0.0,


One more reason I prefer cabal-gild, is that it doesn't try to preserve version constraint indentation.
This leads to more diff friendly format (adding/removing dependency with longer than longest name, doesn't lead to indentation changes for other version constraints)
e.g.

short >=1.0 longer >= 2.0 < Adding longer dependency re-indents version constraint for shorter, which makes for longer diffs

soulomoon · 2024-05-14T02:41:34Z

can cabal-gild have , prefixing line breaking for items?

tfausak

👋 I'm the author/maintainer of Gild. Let me know if I can do anything to help here!

ghcide/ghcide.cabal

tfausak · 2024-05-14T02:46:38Z

ghcide/ghcide.cabal

-    , unordered-containers         >=0.2.10.0
-    , vector
+    Diff ^>=0.4.0,
+    Glob,


I chose to make Gild sort things case sensitively, but I'm not set on it. See tfausak/cabal-gild#46.

ghcide/ghcide.cabal

hie-compat/hie-compat.cabal

haskell-language-server.cabal

fendor · 2024-05-15T07:35:22Z

Reformatted the .cabal files with cabal-gild-1.3.1.0 for accurate comparison.

fendor · 2025-06-08T17:23:18Z

@VeryMilkyJoe Thanks for rebasing this, I think we should merge this PR now and see how annoying it is for future contributors.

Formatted with cabal-gild-1.5.0.1

michaelpj · 2025-06-09T09:48:44Z

Shipit!

tfausak

FYI https://github.com/marketplace/actions/setup-gild

tfausak · 2025-06-09T13:42:45Z

ghcide/ghcide.cabal

-bug-reports:        https://github.com/haskell/haskell-language-server/issues
-tested-with:        GHC == {9.12.2, 9.10.1, 9.8.4, 9.6.7}
+bug-reports: https://github.com/haskell/haskell-language-server/issues
+tested-with: ghc ==9.12.2 || ==9.10.1 || ==9.8.4 || ==9.6.7


Starting with version 1.5.0.3, Gild will correctly leave this in set notation. See tfausak/cabal-gild#118.

tfausak · 2025-06-09T13:46:06Z

shake-bench/shake-bench.cabal

+    Chart,
+    Chart-diagrams,
+    aeson,
+    base >=4 && <5,


Same note here: Starting with version 1.5.0.3, Gild will correctly retain the wildcard version constraint. tfausak/cabal-gild#118

tfausak · 2025-06-09T13:51:39Z

haskell-language-server.cabal

+    hls-plugin-api ==2.11.0.0,
+    hls-test-utils ==2.11.0.0,
+
+  if flag(isolatecabalfmttests)


Cabal converts flag names to lowercase. Gild does the same in order to make this conversion obvious. However it could retain the case from the input if desired. See #4230 (comment).

tfausak · 2025-06-09T13:52:24Z

haskell-language-server.cabal

+    haskell-language-server:hls-cabal-fmt-plugin,
+    haskell-language-server:hls-cabal-plugin,


Just so you know, these can use set notation:

Suggested change

haskell-language-server:hls-cabal-fmt-plugin,

haskell-language-server:hls-cabal-plugin,

haskell-language-server:{hls-cabal-fmt-plugin, hls-cabal-plugin},

tfausak · 2025-06-09T13:55:10Z

haskell-language-server.cabal

-  if os(darwin)
-    ghc-options: -optl-Wl,-ld_classic
+  if os(osx)
+    ghc-options: "-optl-Wl,-ld_classic"


Hmm, I wonder why this got quoted. Maybe because there's a comma in it?

Also note that darwin and osx are aliases. Gild canonicalizes operating systems (and architectures).

tfausak · 2025-06-09T13:56:45Z

haskell-language-server.cabal

-    , time
+
+  hs-source-dirs: plugins/hls-refactor-plugin/src
+  build-depends:
    -- FIXME: Only needed to workaround for qualified imports in GHC 9.4


This comment got floated up to the top of the build-depends, so it doesn't really make sense anymore. I would suggest something like this:

build-depends: bytestring, ... -- FIXME: Only needed to workaround for qualified imports in GHC 9.4 build-depends: parser-combinators, regex-applicative

tfausak · 2025-06-09T13:57:08Z

haskell-language-server.cabal

-                  , semanticTokens
-                  , notes
+  import:
+    -- plugins


Same note here about comment placement.

tfausak · 2025-06-09T13:58:45Z

haskell-language-server.cabal

+    directory,
+    extra,
+    filepath,
+    ghcide,


In this case I don't think it changes the semantics, but starting with version 1.5.0.3, Gild would keep this as ghcide:{ghcide}. See tfausak/cabal-gild#115.

fendor requested review from wz1000, michaelpj and pepeiborra as code owners May 13, 2024 09:40

This was referenced May 13, 2024

Draft: Format .cabal files with cabal-fmt #4230

Closed

Format all .cabal files in the repo with a cabal formatter #4228

Open

michaelpj reviewed May 13, 2024

View reviewed changes

haskell-language-server.cabal Show resolved Hide resolved

fendor force-pushed the enhance/format-with-cabal-gild branch from b3b4bd4 to dff31ba Compare May 13, 2024 09:52

jhrcek reviewed May 13, 2024

View reviewed changes

tfausak reviewed May 14, 2024

View reviewed changes

tfausak mentioned this pull request May 14, 2024

Bad conditional formatting tfausak/cabal-gild#72

Closed

michaelpj reviewed May 14, 2024

View reviewed changes

haskell-language-server.cabal Outdated Show resolved Hide resolved

fendor force-pushed the enhance/format-with-cabal-gild branch 2 times, most recently from ac4506d to 7bda10f Compare May 15, 2024 07:35

fendor marked this pull request as draft June 13, 2024 21:51

VeryMilkyJoe force-pushed the enhance/format-with-cabal-gild branch from 5eb7a78 to cefc2d9 Compare June 8, 2025 17:21

fendor marked this pull request as ready for review June 8, 2025 17:22

fendor changed the title ~~Draft: Format .cabal files with cabal-gild~~ Format .cabal files with cabal-gild Jun 8, 2025

tfausak reviewed Jun 9, 2025

View reviewed changes

Format cabal files using cabal gild 1.5.0.1

2c69e4c

VeryMilkyJoe force-pushed the enhance/format-with-cabal-gild branch from cefc2d9 to 2c69e4c Compare June 9, 2025 14:00

		haskell-language-server:hls-cabal-fmt-plugin,
		haskell-language-server:hls-cabal-plugin,

	haskell-language-server:hls-cabal-fmt-plugin,
	haskell-language-server:hls-cabal-plugin,
	haskell-language-server:{hls-cabal-fmt-plugin, hls-cabal-plugin},

Uh oh!

Format .cabal files with cabal-gild #4229

Are you sure you want to change the base?

Format .cabal files with cabal-gild #4229

Uh oh!

Conversation

fendor commented May 13, 2024 • edited by VeryMilkyJoe Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

jhrcek May 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

soulomoon commented May 14, 2024

Uh oh!

tfausak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tfausak May 14, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fendor commented May 15, 2024

Uh oh!

fendor commented Jun 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

michaelpj commented Jun 9, 2025

Uh oh!

tfausak left a comment

Choose a reason for hiding this comment

Uh oh!

tfausak Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tfausak Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

tfausak Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

tfausak Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

tfausak Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tfausak Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

tfausak Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

tfausak Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

fendor commented May 13, 2024 •

edited by VeryMilkyJoe

Loading

jhrcek May 13, 2024 •

edited

Loading

fendor commented Jun 8, 2025 •

edited

Loading

tfausak Jun 9, 2025 •

edited

Loading

tfausak Jun 9, 2025 •

edited

Loading