Keep trailing comment in { and [

piegamesde · piegamesde · commit 5d871d779a74 · 2025-08-05T20:28:27.000+02:00
This is a partial revert of 5bb0639 The change introduced there is now redundant because we catch that specific corner case more precisely in the parser nowadays, so it's reasonable to revert
diff --git a/src/Nixfmt/Pretty.hs b/src/Nixfmt/Pretty.hs
@@ -177,10 +177,10 @@ prettySet _ (krec, paropen@(LoneAnn _), Items [], parclose@Ann{preTrivia = []})
     sep = if sourceLine paropen /= sourceLine parclose then hardline else hardspace
 -- Singleton sets are allowed to fit onto one line,
 -- but apart from that always expand.
-prettySet wide (krec, paropen@Ann{trailComment = post}, binders, parclose) =
+prettySet wide (krec, paropen, binders, parclose) =
   pretty (fmap (,hardspace) krec)
-    <> pretty (paropen{trailComment = Nothing})
-    <> surroundWith sep (nest $ pretty post <> prettyItems binders)
+    <> pretty paropen
+    <> surroundWith sep (nest $ prettyItems binders)
     <> pretty parclose
   where
     sep =
@@ -223,9 +223,9 @@ prettyTerm (List paropen@Ann{trailComment = Nothing} (Items []) parclose@Ann{pre
     sep = if sourceLine paropen /= sourceLine parclose then hardline else hardspace
 -- General list
 -- Always expand if len > 1
-prettyTerm (List paropen@Ann{trailComment = post} items parclose) =
-  pretty (paropen{trailComment = Nothing})
-    <> surroundWith sur (nest $ pretty post <> prettyItems items)
+prettyTerm (List paropen items parclose) =
+  pretty paropen
+    <> surroundWith sur (nest $ prettyItems items)
     <> pretty parclose
   where
     -- If the brackets are on different lines, keep them like that
diff --git a/test/diff/attr_set/out-pure.nix b/test/diff/attr_set/out-pure.nix
@@ -1,7 +1,6 @@
 [
   { }
-  {
-    # a
+  { # a
   }
   { a = 1; }
   { a = 1; }
@@ -21,25 +20,21 @@
   {
     b = 1; # c
   }
-  {
-    # a
+  {  # a
     b = 1;
   }
-  {
-    # a
+  {  # a
     b = 1; # c
   }
 
   rec { c = 1; }
   rec {
     c = 1; # d
   }
-  rec {
-    # b
+  rec { # b
     c = 1;
   }
-  rec {
-    # b
+  rec { # b
     c = 1; # d
   }
   rec # a
@@ -51,13 +46,11 @@
     c = 1; # d
   }
   rec # a
-  {
-    # b
+  {  # b
     c = 1;
   }
   rec # a
-  {
-    # b
+  {  # b
     c = 1; # d
   }
 
diff --git a/test/diff/attr_set/out.nix b/test/diff/attr_set/out.nix
@@ -1,7 +1,6 @@
 [
   { }
-  {
-    # a
+  { # a
   }
   { a = 1; }
   {
@@ -24,25 +23,21 @@
   {
     b = 1; # c
   }
-  {
-    # a
+  {  # a
     b = 1;
   }
-  {
-    # a
+  {  # a
     b = 1; # c
   }
 
   rec { c = 1; }
   rec {
     c = 1; # d
   }
-  rec {
-    # b
+  rec { # b
     c = 1;
   }
-  rec {
-    # b
+  rec { # b
     c = 1; # d
   }
   rec # a
@@ -54,13 +49,11 @@
     c = 1; # d
   }
   rec # a
-  {
-    # b
+  {  # b
     c = 1;
   }
   rec # a
-  {
-    # b
+  {  # b
     c = 1; # d
   }
 
diff --git a/test/diff/comment/out-pure.nix b/test/diff/comment/out-pure.nix
@@ -103,8 +103,7 @@
     ```
   */
 
-  [
-    # 1
+  [  # 1
     #2
     a # 3
     b
@@ -121,8 +120,7 @@
     a = 123; # comment
   }
 
-  {
-    # 1
+  {  # 1
     #2
     a = 1; # 3
     b = 1;
diff --git a/test/diff/comment/out.nix b/test/diff/comment/out.nix
@@ -103,8 +103,7 @@
     ```
   */
 
-  [
-    # 1
+  [  # 1
     #2
     a # 3
     b
@@ -121,8 +120,7 @@
     a = 123; # comment
   }
 
-  {
-    # 1
+  {  # 1
     #2
     a = 1; # 3
     b = 1;
diff --git a/test/diff/idioms_lib_4/out-pure.nix b/test/diff/idioms_lib_4/out-pure.nix
@@ -588,8 +588,7 @@ rec {
         families = { };
       };
     }
-    // {
-      # aliases
+    // { # aliases
       # 'darwin' is the kernel for all of them. We choose macOS by default.
       darwin = kernels.macos;
       watchos = kernels.ios;
diff --git a/test/diff/idioms_lib_4/out.nix b/test/diff/idioms_lib_4/out.nix
@@ -588,8 +588,7 @@ rec {
         families = { };
       };
     }
-    // {
-      # aliases
+    // { # aliases
       # 'darwin' is the kernel for all of them. We choose macOS by default.
       darwin = kernels.macos;
       watchos = kernels.ios;
diff --git a/test/diff/idioms_pkgs_4/out-pure.nix b/test/diff/idioms_pkgs_4/out-pure.nix
@@ -163,8 +163,7 @@ in
       cc =
         let
           nativePrefix =
-            {
-              # switch
+            {  # switch
               i686-solaris = "/usr/gnu";
               x86_64-solaris = "/opt/local/gcc47";
             }
diff --git a/test/diff/idioms_pkgs_4/out.nix b/test/diff/idioms_pkgs_4/out.nix
@@ -167,8 +167,7 @@ in
       cc =
         let
           nativePrefix =
-            {
-              # switch
+            {  # switch
               i686-solaris = "/usr/gnu";
               x86_64-solaris = "/opt/local/gcc47";
             }
diff --git a/test/diff/lists/out-pure.nix b/test/diff/lists/out-pure.nix
@@ -23,8 +23,7 @@
       foo2 = "barbar";
     }
   ]
-  {
-    # List in attrset with comment
+  {  # List in attrset with comment
 
     imports0 = [ ];
 
@@ -66,23 +65,19 @@
     b # c
     d # e
   ]
-  [
-    # a
+  [  # a
     b
     d
   ]
-  [
-    # a
+  [  # a
     b
     d # e
   ]
-  [
-    # a
+  [  # a
     b # c
     d
   ]
-  [
-    # a
+  [  # a
     b # c
     d # e
   ]
diff --git a/test/diff/lists/out.nix b/test/diff/lists/out.nix
@@ -24,8 +24,7 @@
       foo2 = "barbar";
     }
   ]
-  {
-    # List in attrset with comment
+  {  # List in attrset with comment
 
     imports0 = [ ];
 
@@ -69,23 +68,19 @@
     b # c
     d # e
   ]
-  [
-    # a
+  [  # a
     b
     d
   ]
-  [
-    # a
+  [  # a
     b
     d # e
   ]
-  [
-    # a
+  [  # a
     b # c
     d
   ]
-  [
-    # a
+  [  # a
     b # c
     d # e
   ]
diff --git a/test/diff/monsters_4/out-pure.nix b/test/diff/monsters_4/out-pure.nix
@@ -34,8 +34,7 @@
 }: # Foo
 stdenv.mkDerivation # Foo
   rec # Foo
-  {
-    # Foo
+  {  # Foo
     pname # Foo
       =  # Foo
         "contrast"; # Foo
@@ -45,8 +44,7 @@ stdenv.mkDerivation # Foo
     src # Foo
       =  # Foo
         # Foo
-        fetchFromGitLab {
-          # Foo
+        fetchFromGitLab { # Foo
           domain # Foo
             =  # Foo
               "gitlab.gnome.org"; # Foo
@@ -69,8 +67,7 @@ stdenv.mkDerivation # Foo
     cargoDeps # Foo
       =  # Foo
         rustPlatform.fetchCargoTarball # Foo
-          {
-            # Foo
+          {  # Foo
             inherit # Foo
               src
               ; # Foo
@@ -83,8 +80,7 @@ stdenv.mkDerivation # Foo
           }; # Foo
     nativeBuildInputs # Foo
       =  # Foo
-        [
-          # Foo
+        [  # Foo
           desktop-file-utils # Foo
           gettext # Foo
           meson # Foo
@@ -100,8 +96,7 @@ stdenv.mkDerivation # Foo
         ]; # Foo
     buildInputs # Foo
       =  # Foo
-        [
-          # Foo
+        [  # Foo
           cairo # Foo
           glib # Foo
           gtk4 # Foo
@@ -120,8 +115,7 @@ stdenv.mkDerivation # Foo
       =  # Foo
         with # Foo
           lib; # Foo
-        {
-          # Foo
+        {  # Foo
           description # Foo
             =  # Foo
               "Checks whether the contrast between two colors meet the WCAG requirements"; # Foo
@@ -135,8 +129,7 @@ stdenv.mkDerivation # Foo
             =  # Foo
               with # Foo
                 maintainers; # Foo
-              [
-                # Foo
+              [  # Foo
                 jtojnar # Foo
               ]; # Foo
           platforms # Foo
diff --git a/test/diff/monsters_4/out.nix b/test/diff/monsters_4/out.nix

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`	`1`	`[`
`2`	`2`	`{ }`
`3`		`- {`
`4`		`- # a`
	`3`	`+ { # a`
`5`	`4`	`}`
`6`	`5`	`{ a = 1; }`
`7`	`6`	`{ a = 1; }`
`@@ -21,25 +20,21 @@`
`21`	`20`	`{`
`22`	`21`	`b = 1; # c`
`23`	`22`	`}`
`24`		`- {`
`25`		`- # a`
	`23`	`+ { # a`
`26`	`24`	`b = 1;`
`27`	`25`	`}`
`28`		`- {`
`29`		`- # a`
	`26`	`+ { # a`
`30`	`27`	`b = 1; # c`
`31`	`28`	`}`
`32`	`29`
`33`	`30`	`rec { c = 1; }`
`34`	`31`	`rec {`
`35`	`32`	`c = 1; # d`
`36`	`33`	`}`
`37`		`- rec {`
`38`		`- # b`
	`34`	`+ rec { # b`
`39`	`35`	`c = 1;`
`40`	`36`	`}`
`41`		`- rec {`
`42`		`- # b`
	`37`	`+ rec { # b`
`43`	`38`	`c = 1; # d`
`44`	`39`	`}`
`45`	`40`	`rec # a`
`@@ -51,13 +46,11 @@`
`51`	`46`	`c = 1; # d`
`52`	`47`	`}`
`53`	`48`	`rec # a`
`54`		`- {`
`55`		`- # b`
	`49`	`+ { # b`
`56`	`50`	`c = 1;`
`57`	`51`	`}`
`58`	`52`	`rec # a`
`59`		`- {`
`60`		`- # b`
	`53`	`+ { # b`
`61`	`54`	`c = 1; # d`
`62`	`55`	`}`
`63`	`56`
Original file line number	Diff line number	Diff line change
`@@ -23,8 +23,7 @@`
`23`	`23`	`foo2 = "barbar";`
`24`	`24`	`}`
`25`	`25`	`]`
`26`		`- {`
`27`		`- # List in attrset with comment`
	`26`	`+ { # List in attrset with comment`
`28`	`27`
`29`	`28`	`imports0 = [ ];`
`30`	`29`
`@@ -66,23 +65,19 @@`
`66`	`65`	`b # c`
`67`	`66`	`d # e`
`68`	`67`	`]`
`69`		`- [`
`70`		`- # a`
	`68`	`+ [ # a`
`71`	`69`	`b`
`72`	`70`	`d`
`73`	`71`	`]`
`74`		`- [`
`75`		`- # a`
	`72`	`+ [ # a`
`76`	`73`	`b`
`77`	`74`	`d # e`
`78`	`75`	`]`
`79`		`- [`
`80`		`- # a`
	`76`	`+ [ # a`
`81`	`77`	`b # c`
`82`	`78`	`d`
`83`	`79`	`]`
`84`		`- [`
`85`		`- # a`
	`80`	`+ [ # a`
`86`	`81`	`b # c`
`87`	`82`	`d # e`
`88`	`83`	`]`