Strip trailing whitespace (#1422)

sjakobi · Gabriella439 · web-flow · commit dedd5e0ea6fd · 2019-11-14T14:43:35.000+01:00
This raises the lower bound on prettyprinter to 1.5.1 since `removeTrailingWhitespace` is buggy in earlier versions. This jailbreaks hnix, which isn't compatible with prettyprinter-1.5.1 yet. Fixes #183, #1400, #1525. Co-authored-by: Gabriel Gonzalez <Gabriel439@gmail.com>
diff --git a/cabal.project b/cabal.project
@@ -1 +1,5 @@
 packages: ./dhall ./dhall-bash ./dhall-json ./dhall-yaml ./dhall-lsp-server ./dhall-nix
+
+-- While hnix doesn't allow prettyprinter > 1.3
+-- https://github.com/haskell-nix/hnix/issues/524
+allow-newer: hnix:prettyprinter
diff --git a/dhall-json/dhall-json.cabal b/dhall-json/dhall-json.cabal
@@ -44,7 +44,7 @@ Library
         exceptions                >= 0.8.3    && < 0.11,
         filepath                                 < 1.5 ,
         optparse-applicative      >= 0.14.0.0 && < 0.16,
-        prettyprinter             >= 1.2.0.1  && < 1.4 ,
+        prettyprinter             >= 1.5.1    && < 1.6 ,
         scientific                >= 0.3.0.0  && < 0.4 ,
         text                      >= 0.11.1.0 && < 1.3 ,
         unordered-containers                     < 0.3 ,
diff --git a/dhall-lsp-server/dhall-lsp-server.cabal b/dhall-lsp-server/dhall-lsp-server.cabal
@@ -61,7 +61,7 @@ library
     , megaparsec           >= 7.0.2    && < 7.1
     , mtl                  >= 2.2.2    && < 2.3
     , network-uri          >= 2.6.1.0  && < 2.7
-    , prettyprinter        >= 1.2.1    && < 1.4
+    , prettyprinter        >= 1.5.1    && < 1.6
     , text                 >= 1.2.3.0  && < 1.3
     , transformers         >= 0.5.5.0  && < 0.6
     , unordered-containers >= 0.2.9.0  && < 0.3
diff --git a/dhall-lsp-server/src/Dhall/LSP/Backend/Formatting.hs b/dhall-lsp-server/src/Dhall/LSP/Backend/Formatting.hs
@@ -1,8 +1,8 @@
 module Dhall.LSP.Backend.Formatting (formatExpr, formatExprWithHeader) where
 
 import Dhall.Core (Expr)
+import Dhall.Pretty (CharacterSet(..))
 import Dhall.Parser (Header(..))
-import Dhall.Pretty (CharacterSet, prettyCharacterSet)
 import qualified Dhall.Pretty
 import Dhall.Src (Src)
 
@@ -13,8 +13,10 @@ import qualified Data.Text.Prettyprint.Doc.Render.Text     as Pretty
 
 -- | Pretty-print the given Dhall expression.
 formatExpr :: Pretty.Pretty b => CharacterSet -> Expr Src b -> Text
-formatExpr charSet expr = Pretty.renderStrict . Dhall.Pretty.layout
-                          . Pretty.unAnnotate $ prettyCharacterSet charSet expr
+formatExpr charSet expr =
+      Pretty.renderStrict
+    . Dhall.Pretty.layout
+    $ Dhall.Pretty.prettyCharacterSet charSet expr
 
 -- | Pretty-print the given Dhall expression, prepending the given a "header"
 --   (usually consisting of comments and whitespace).
@@ -24,6 +26,6 @@ formatExprWithHeader charSet expr (Header header) = Pretty.renderStrict
   where
     doc =
       Pretty.pretty header
-        <> Pretty.unAnnotate (prettyCharacterSet charSet expr)
+        <> Dhall.Pretty.prettyCharacterSet charSet expr
         <> "\n"
 
diff --git a/dhall-try/dhall-try.cabal b/dhall-try/dhall-try.cabal
@@ -18,7 +18,7 @@ executable dhall-try
                      , aeson-pretty   >= 0.8.7    && < 0.9
                      , dhall          >= 1.19.0   && < 1.28
                      , dhall-json     >= 1.2.5    && < 1.6
-                     , prettyprinter  >= 1.2.1    && < 1.3
+                     , prettyprinter  >= 1.5.1    && < 1.6
                      , text           >= 1.2.3.0  && < 1.3
                      , ghcjs-base     >= 0.2.0.0  && < 0.3
   hs-source-dirs:      src
diff --git a/dhall/dhall.cabal b/dhall/dhall.cabal
@@ -428,7 +428,7 @@ Library
         network-uri                 >= 2.6      && < 2.7 ,
         optparse-applicative        >= 0.14.0.0 && < 0.16,
         parsers                     >= 0.12.4   && < 0.13,
-        prettyprinter               >= 1.2.0.1  && < 1.4 ,
+        prettyprinter               >= 1.5.1    && < 1.6 ,
         prettyprinter-ansi-terminal >= 1.1.1    && < 1.2 ,
         profunctors                 >= 3.1.2    && < 5.6 ,
         repline                     >= 0.2.1.0  && < 0.3 ,
diff --git a/dhall/src/Dhall/Format.hs b/dhall/src/Dhall/Format.hs
@@ -14,7 +14,7 @@ module Dhall.Format
 import Control.Exception (Exception)
 import Data.Monoid ((<>))
 import Dhall.Pretty (CharacterSet(..), annToAnsiStyle)
-import Dhall.Util (Censor, Input(..))
+import Dhall.Util (Censor, Input(..), Header(..))
 
 import qualified Data.Text.Prettyprint.Doc                 as Pretty
 import qualified Data.Text.Prettyprint.Doc.Render.Terminal as Pretty.Terminal
@@ -50,54 +50,48 @@ data FormatMode
 format
     :: Format
     -> IO ()
-format (Format {..}) =
+format (Format {..}) = do
+    let layoutHeaderAndExpr (Header header, expr) =
+            Dhall.Pretty.layout
+                (   Pretty.pretty header
+                <>  Dhall.Pretty.prettyCharacterSet characterSet expr 
+                <>  "\n")
+
+    let layoutInput input = do
+            headerAndExpr <- Dhall.Util.getExpressionAndHeader censor input
+
+            return (layoutHeaderAndExpr headerAndExpr)
+
     case formatMode of
-        Modify {..} ->
+        Modify {..} -> do
+            docStream <- layoutInput inplace
+
             case inplace of
                 InputFile file -> do
-                    (Dhall.Util.Header header, expr) <-
-                        Dhall.Util.getExpressionAndHeader censor (InputFile file)
-
-                    let doc =   Pretty.pretty header
-                            <>  Pretty.unAnnotate (Dhall.Pretty.prettyCharacterSet characterSet expr)
-                            <>  "\n"
-
                     System.IO.withFile file System.IO.WriteMode (\handle -> do
-                        Pretty.Terminal.renderIO handle (Dhall.Pretty.layout doc))
-                StandardInput -> do
-                    (Dhall.Util.Header header, expr) <-
-                        Dhall.Util.getExpressionAndHeader censor StandardInput
-
-                    let doc =   Pretty.pretty header
-                            <>  Dhall.Pretty.prettyCharacterSet characterSet expr
-                            <>  "\n"
+                        Pretty.Terminal.renderIO handle (Pretty.unAnnotateS docStream))
 
+                StandardInput -> do
                     supportsANSI <- System.Console.ANSI.hSupportsANSI System.IO.stdout
 
-                    if supportsANSI
-                      then
-                        Pretty.Terminal.renderIO
-                          System.IO.stdout
-                          (fmap annToAnsiStyle (Dhall.Pretty.layout doc))
-                      else
-                        Pretty.Terminal.renderIO
-                          System.IO.stdout
-                          (Dhall.Pretty.layout (Pretty.unAnnotate doc))
+                    Pretty.Terminal.renderIO
+                        System.IO.stdout
+                        (if supportsANSI
+                            then (fmap annToAnsiStyle docStream)
+                            else (Pretty.unAnnotateS docStream))
+
         Check {..} -> do
             originalText <- case path of
                 InputFile file -> Data.Text.IO.readFile file
                 StandardInput  -> Data.Text.IO.getContents
 
-            (Dhall.Util.Header header, expr) <- case path of
-                InputFile _ -> Dhall.Util.getExpressionAndHeader censor path
-                StandardInput  -> Dhall.Util.getExpressionAndHeaderFromStdinText censor originalText
-
-            let doc =   Pretty.pretty header
-                    <>  Pretty.unAnnotate (Dhall.Pretty.prettyCharacterSet characterSet expr)
-                    <>  "\n"
+            docStream <- case path of
+                InputFile _    -> layoutInput path
+                StandardInput  -> do
+                    headerAndExpr <- Dhall.Util.getExpressionAndHeaderFromStdinText censor originalText
+                    return (layoutHeaderAndExpr headerAndExpr)
 
-            let formattedText =
-                    Pretty.Text.renderStrict (Dhall.Pretty.layout doc)
+            let formattedText = Pretty.Text.renderStrict docStream
 
             if originalText == formattedText
                 then return ()
diff --git a/dhall/src/Dhall/Freeze.hs b/dhall/src/Dhall/Freeze.hs
@@ -17,7 +17,7 @@ module Dhall.Freeze
 import Data.Monoid ((<>))
 import Data.Text
 import Dhall.Parser (Src)
-import Dhall.Pretty (CharacterSet, annToAnsiStyle, prettyCharacterSet)
+import Dhall.Pretty (CharacterSet)
 import Dhall.Syntax (Expr(..), Import(..), ImportHashed(..), ImportType(..))
 import Dhall.Util (Censor, Input(..))
 import System.Console.ANSI (hSupportsANSI)
@@ -26,7 +26,6 @@ import qualified Control.Exception
 import qualified Control.Monad.Trans.State.Strict          as State
 import qualified Data.Text.Prettyprint.Doc                 as Pretty
 import qualified Data.Text.Prettyprint.Doc.Render.Terminal as Pretty
-import qualified Data.Text.IO
 import qualified Dhall.Core
 import qualified Dhall.Import
 import qualified Dhall.Optics
@@ -88,20 +87,22 @@ writeExpr :: Input -> (Text, Expr Src Import) -> CharacterSet -> IO ()
 writeExpr inplace (header, expr) characterSet = do
     let doc =  Pretty.pretty header
             <> Dhall.Pretty.prettyCharacterSet characterSet expr
+            <> "\n"
 
-    let unAnnotated = Dhall.Pretty.layout (Pretty.unAnnotate doc)
+    let stream = Dhall.Pretty.layout doc
+
+    let unAnnotated = Pretty.unAnnotateS stream
 
     case inplace of
         InputFile f ->
             System.IO.withFile f System.IO.WriteMode (\handle -> do
-                Pretty.renderIO handle unAnnotated
-                Data.Text.IO.hPutStrLn handle "" )
+                Pretty.renderIO handle unAnnotated)
 
         StandardInput -> do
             supportsANSI <- System.Console.ANSI.hSupportsANSI System.IO.stdout
             if supportsANSI
                then
-                 Pretty.renderIO System.IO.stdout (annToAnsiStyle <$> Dhall.Pretty.layout doc)
+                 Pretty.renderIO System.IO.stdout (Dhall.Pretty.annToAnsiStyle <$> stream)
                else
                  Pretty.renderIO System.IO.stdout unAnnotated
 
diff --git a/dhall/src/Dhall/Pretty/Internal.hs b/dhall/src/Dhall/Pretty/Internal.hs
@@ -1082,7 +1082,7 @@ prettyCharacterSet characterSet expression =
       where
         long =
             Pretty.align
-            (   literal ("''" <> Pretty.hardline)
+            (   literal "''" <> Pretty.hardline
             <>  Pretty.align
                 (foldMap prettyMultilineChunk a <> prettyMultilineText b)
             <>  literal "''"
@@ -1100,12 +1100,18 @@ prettyCharacterSet characterSet expression =
             <>  prettyExpression d
             <>  rbrace
 
-        prettyMultilineText text = literal (mconcat docs)
+        prettyMultilineText text = mconcat docs
           where
             lines_ = Text.splitOn "\n" (escapeSingleQuotedText text)
 
+            -- Annotate only non-empty lines so trailing whitespace can be
+            -- removed on empty ones.
+            prettyLine line =
+                (if Text.null line then id else literal)
+                    (Pretty.pretty line)
+
             docs =
-                Data.List.intersperse Pretty.hardline (fmap Pretty.pretty lines_)
+                Data.List.intersperse Pretty.hardline (map prettyLine lines_)
 
         prettyChunk (c, d) =
                 prettyText c
@@ -1177,7 +1183,7 @@ prettyToStrictText = docToStrictText . Pretty.pretty
 --
 -- Tries hard to fit the document into 80 columns.
 layout :: Pretty.Doc ann -> Pretty.SimpleDocStream ann
-layout = Pretty.layoutSmart layoutOpts
+layout = Pretty.removeTrailingWhitespace . Pretty.layoutSmart layoutOpts
 
 -- | Default layout options
 layoutOpts :: Pretty.LayoutOptions
diff --git a/dhall/tests/diff/function.txt b/dhall/tests/diff/function.txt
@@ -2,5 +2,5 @@
 → …
 → …@- 1
     + 0
-  
+
 → …
diff --git a/dhall/tests/format/concatSepB.dhall b/dhall/tests/format/concatSepB.dhall
@@ -23,7 +23,7 @@ let concatSep
                       status
                 )
                 Status.Empty
-        
+
         in  merge { Empty = "", NonEmpty = λ(result : Text) → result } status
 
 let example0 = assert : concatSep ", " [ "ABC", "DEF", "GHI" ] ≡ "ABC, DEF, GHI"
diff --git a/dhall/tests/format/headerB.dhall b/dhall/tests/format/headerB.dhall
@@ -1,3 +1,3 @@
 {- bla -}
-  
+
 True
diff --git a/dhall/tests/format/innerMultilineB.dhall b/dhall/tests/format/innerMultilineB.dhall
@@ -1,11 +1,11 @@
 { inner =
     ''
-    
+
     one
-    
+
     two
-    
+
     three
-    
+
     ''
 }
diff --git a/dhall/tests/format/issue1413B.dhall b/dhall/tests/format/issue1413B.dhall
@@ -1,5 +1,5 @@
 let foo =
-    
+
     {- test -}
       "hello"
 
diff --git a/dhall/tests/format/issue183A.dhall b/dhall/tests/format/issue183A.dhall
@@ -0,0 +1,11 @@
+    let foo = 1
+
+in    λ(bar : Integer)
+    →     let exposePort =
+                  λ(portSpec : { ext : Integer, int : Integer })
+                → Integer/show portSpec.ext ++ ":" ++ Integer/show portSpec.int
+      
+      in  let exposeSamePort =
+                λ(port : Integer) → exposePort { ext = port, int = port }
+      
+      in  { blah = bar }
diff --git a/dhall/tests/format/issue183B.dhall b/dhall/tests/format/issue183B.dhall
@@ -0,0 +1,11 @@
+let foo = 1
+
+in    λ(bar : Integer)
+    → let exposePort =
+              λ(portSpec : { ext : Integer, int : Integer })
+            → Integer/show portSpec.ext ++ ":" ++ Integer/show portSpec.int
+
+      in  let exposeSamePort =
+                λ(port : Integer) → exposePort { ext = port, int = port }
+
+          in  { blah = bar }
diff --git a/dhall/tests/format/letNewlineCommentsB.dhall b/dhall/tests/format/letNewlineCommentsB.dhall
@@ -5,5 +5,5 @@ in  let {- aaaaaaaaaaaaaaaaaaa
         : {- bbbbbbbbbbbbbbbbbbbbb
           -} Natural
         = {- ddddddddddddddddd -} 2
-    
+
     in  x
diff --git a/dhall/tests/format/multilineTrailingWhitespaceA.dhall b/dhall/tests/format/multilineTrailingWhitespaceA.dhall
@@ -0,0 +1 @@
+{ x = "  \n\nfoo  \n" }
diff --git a/dhall/tests/format/multilineTrailingWhitespaceB.dhall b/dhall/tests/format/multilineTrailingWhitespaceB.dhall
@@ -0,0 +1,7 @@
+{ x =
+    ''
+      
+
+    foo  
+    ''
+}
diff --git a/nix/prettyprinter.nix b/nix/prettyprinter.nix
@@ -1,22 +1,22 @@
-{ mkDerivation, ansi-wl-pprint, base, bytestring, containers
-, criterion, deepseq, doctest, mtl, pgp-wordlist, QuickCheck
-, random, stdenv, tasty, tasty-hunit, tasty-quickcheck, text
-, transformers
+{ mkDerivation, ansi-wl-pprint, base, base-compat, bytestring
+, containers, criterion, deepseq, doctest, mtl, pgp-wordlist
+, QuickCheck, random, stdenv, tasty, tasty-hunit, tasty-quickcheck
+, text, transformers
 }:
 mkDerivation {
   pname = "prettyprinter";
-  version = "1.2.1";
-  sha256 = "e7653e0ba87cc06553a50e4780dde81c5dd156196c0199511d03d972e5517fcf";
+  version = "1.5.1";
+  sha256 = "fb66b498cdd46aa7f36abdaf0b49e88444a3e6ed9d04bec8924ed6355f393794";
   isLibrary = true;
   isExecutable = true;
   libraryHaskellDepends = [ base text ];
   testHaskellDepends = [
-    base bytestring doctest pgp-wordlist tasty tasty-hunit
+    base bytestring doctest pgp-wordlist QuickCheck tasty tasty-hunit
     tasty-quickcheck text
   ];
   benchmarkHaskellDepends = [
-    ansi-wl-pprint base containers criterion deepseq mtl QuickCheck
-    random text transformers
+    ansi-wl-pprint base base-compat containers criterion deepseq mtl
+    QuickCheck random text transformers
   ];
   homepage = "http://github.com/quchen/prettyprinter";
   description = "A modern, easy to use, well-documented, extensible pretty-printer";
diff --git a/nix/shared.nix b/nix/shared.nix
@@ -177,6 +177,11 @@ let
                 doBenchmarkExtension =
                   mass pkgsNew.haskell.lib.doBenchmark allDhallPackages;
 
+                doJailbreakExtension =
+                  mass pkgsNew.haskell.lib.doJailbreak [
+                    "hnix"
+                  ];
+
                 failOnAllWarningsExtension =
                   mass failOnAllWarnings [
                     "dhall"
@@ -266,6 +271,7 @@ let
                     extension
                     doCheckExtension
                     doBenchmarkExtension
+                    doJailbreakExtension
                     failOnAllWarningsExtension
                     failOnMissingHaddocksExtension
                   ];
diff --git a/stack-lts-6.yaml b/stack-lts-6.yaml
@@ -45,7 +45,7 @@ extra-deps:
 - optparse-generic-1.3.0
 - parsec-3.1.13.0
 - parser-combinators-1.0.0
-- prettyprinter-1.2.0.1
+- prettyprinter-1.5.1@sha256:fca87c3e2611d3499a0341a59857e9b424a23f31646e4737d535a18582284f96,5375
 - prettyprinter-ansi-terminal-1.1.1.2
 - primitive-0.6.3.0
 - process-1.6.2.0
diff --git a/stack.yaml b/stack.yaml

-Original file line number
+Diff line change
 → …
 → …@- 1
     + 0
+-
++
 → …