Merge pull request #355 from dyegoaurelio/lang-annotation-in-list-argument

Fix language annotations inside lists on function arguments

Author: dyegoaurelio

src/Nixfmt/Pretty.hs

@@ -109,9 +109,9 @@ instance (Pretty a) => Pretty (Item a) where
   pretty (Comments trivia) = pretty trivia
   pretty (Item x) = group x
 
--- For lists, attribute sets and let bindings
-prettyItems :: (Pretty a) => Items a -> Doc
-prettyItems (Items items) = go items
+-- Render items (for lists, attribute sets and let bindings) separated by the given separator
+renderItems :: (Pretty a) => Doc -> Items a -> Doc
+renderItems separator (Items items) = go items
   where
     go [] = mempty
     go [item] = pretty item
@@ -120,9 +120,22 @@ prettyItems (Items items) = go items
       pretty (LanguageAnnotation lang)
         <> hardspace
         <> group stringItem
-        <> if null rest then mempty else hardline <> go rest
+        <> if null rest then mempty else separator <> go rest
     go (item : rest) =
-      pretty item <> if null rest then mempty else hardline <> go rest
+      pretty item <> if null rest then mempty else separator <> go rest
+
+-- Render a list given the separator between items
+renderList :: Doc -> Ann Token -> Items Term -> Ann Token -> Doc
+renderList itemSep paropen@Ann{trailComment = post} items parclose =
+  pretty (paropen{trailComment = Nothing})
+    <> surroundWith sur (nest $ pretty post <> renderItems itemSep items)
+    <> pretty parclose
+  where
+    -- If the brackets are on different lines, keep them like that
+    sur
+      | sourceLine paropen /= sourceLine parclose = hardline
+      | null $ unItems items = hardspace
+      | otherwise = line
 
 instance Pretty Trivia where
   pretty [] = mempty
@@ -197,7 +210,7 @@ prettySet _ (krec, paropen@(LoneAnn _), Items [], parclose@Ann{preTrivia = []})
 -- Singleton sets are allowed to fit onto one line,
 -- but apart from that always expand.
 prettySet wide (krec, paropen@Ann{trailComment = post}, binders, parclose) =
-  let !surrounded = surroundWith sep (nest $ pretty post <> prettyItems binders)
+  let !surrounded = surroundWith sep (nest $ pretty post <> renderItems hardline binders)
   in pretty (fmap (,hardspace) krec)
       <> pretty (paropen{trailComment = Nothing})
       <> surrounded
@@ -243,13 +256,8 @@ 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)
-    <> pretty parclose
-  where
-    -- If the brackets are on different lines, keep them like that
-    sur = if sourceLine paropen /= sourceLine parclose then hardline else line
+prettyTerm (List paropen items parclose) =
+  renderList hardline paropen items parclose
 prettyTerm (Set krec paropen items parclose) = prettySet False (krec, paropen, items, parclose)
 -- Parentheses
 prettyTerm (Parenthesized paropen expr parclose@Ann{preTrivia = closePre}) =
@@ -428,18 +436,10 @@ prettyApp indentFunction pre hasPost f a =
       -- Render the inner arguments of a function call
       absorbInner :: Expression -> Doc
       -- If lists have only simple items, try to render them single-line instead of expanding
-      -- This is just a copy of the list rendering code, but with `sepBy line` instead of `sepBy hardline`
-      absorbInner (Term (List paropen@Ann{trailComment = post'} items parclose))
+      -- Uses renderList with `line` separator instead of `hardline`
+      absorbInner (Term (List paropen items parclose))
         | length (unItems items) <= 6 && all (isSimple . Term) items =
-            pretty (paropen{trailComment = Nothing})
-              <> surroundWith sur (nest $ pretty post' <> sepBy line (unItems items))
-              <> pretty parclose
-        where
-          -- If the brackets are on different lines, keep them like that
-          sur
-            | sourceLine paropen /= sourceLine parclose = hardline
-            | null $ unItems items = hardspace
-            | otherwise = line
+            renderList line paropen items parclose
       absorbInner expr = pretty expr
 
       -- Render the last argument of a function call
@@ -696,7 +696,7 @@ instance Pretty Expression where
       convertTrailing (Just (TrailingComment t)) = [LineComment (" " <> t)]
 
       letPart = group $ pretty let_ <> hardline <> letBody
-      letBody = nest $ prettyItems binders
+      letBody = nest $ renderItems hardline binders
       inPart =
         group $
           pretty in_

test/diff/language-annotation/in.nix

@@ -70,6 +70,18 @@
     "console.log('Script 4');"
   ];
 
+  # Language annotation in list on function argument
+  runScripts = (lib.mkSomething [
+    /* bash */ ''
+      echo "Script A"
+    ''
+  ][
+    /* python */ ''
+      print("Script B")
+    ''
+      /* ruby */ "puts 'Script C'"
+  ]);
+
   aboveString = 
     /* bash */
     "echo 'Above string'";

test/diff/language-annotation/out-pure.nix

@@ -74,6 +74,22 @@
     /* js */ "console.log('Script 4');"
   ];
 
+  # Language annotation in list on function argument
+  runScripts = (
+    lib.mkSomething
+      [
+        /* bash */ ''
+          echo "Script A"
+        ''
+      ]
+      [
+        /* python */ ''
+          print("Script B")
+        ''
+        /* ruby */ "puts 'Script C'"
+      ]
+  );
+
   aboveString = /* bash */ "echo 'Above string'";
 
   # Language annotation in attribute set

test/diff/language-annotation/out.nix

@@ -74,6 +74,22 @@
     /* js */ "console.log('Script 4');"
   ];
 
+  # Language annotation in list on function argument
+  runScripts = (
+    lib.mkSomething
+      [
+        /* bash */ ''
+          echo "Script A"
+        ''
+      ]
+      [
+        /* python */ ''
+          print("Script B")
+        ''
+        /* ruby */ "puts 'Script C'"
+      ]
+  );
+
   aboveString = /* bash */ "echo 'Above string'";
 
   # Language annotation in attribute set