master..033bb16 · ormolu

.buildkite/pipeline.yml+2−2

since splitsnapshots

unifiedsplit

@@ -3,9 +3,9 @@ steps:

3 command: |

4 nix-build --keep-going --no-out-link --argstr ormoluCompiler ghc865

5 timeout: 100

6− - label: Build and test with GHC 8.8.4

6+ - label: Build and test with GHC 8.8.3

7 command: |

8− nix-build --keep-going --no-out-link --argstr ormoluCompiler ghc884

8+ nix-build --keep-going --no-out-link --argstr ormoluCompiler ghc883

9 timeout: 100

10 - label: Build and test with GHC 8.10.1

11 command: |

.github/workflows/binaries.ymldeleted−39

@@ -1,39 +0,0 @@

1−name: Build binaries

2−on:

3− release:

4− types: [published]

5−jobs:

6− build:

7− strategy:

8− fail-fast: false

9− matrix:

10− os: [ubuntu-latest, macOS-latest, windows-latest]

11− runs-on: ${{ matrix.os }}

12− steps:

13− - uses: actions/checkout@v2

14− - uses: actions/setup-haskell@v1

15− if: runner.os != 'Linux'

16− with:

17− ghc-version: '8.10.1'

18− cabal-version: '3.2'

19− - name: Build Linux binary

20− if: runner.os == 'Linux'

21− run: |

22− docker run \

23− -v $(pwd):/mnt -w /mnt \

24− utdemir/ghc-musl:v14-ghc8101 \

25− bash .github/workflows/build.sh

26− - name: Build ${{ runner.os }} binary

27− if: runner.os != 'Linux'

28− shell: bash

29− run: |

30− cabal build exe:ormolu

31− cp $(find dist-newstyle $ -name ormolu -o -name ormolu.exe $ -type f) ormolu

32− - uses: actions/upload-release-asset@v1

33− env:

34− GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

35− with:

36− upload_url: ${{ github.event.release.upload_url }}

37− asset_path: ormolu

38− asset_name: ormolu-${{ runner.os }}

39− asset_content_type: application/octet-stream

.github/workflows/build.shdeleted−7

@@ -1,7 +0,0 @@

1−set -e

2−

3−cabal update

4−cabal build exe:ormolu --enable-executable-static --ghc-options="-split-sections"

5−

6−cp $(find dist-newstyle -name ormolu -type f) .

7−strip -s ormolu

CHANGELOG.md+1−34

@@ -1,26 +1,6 @@

1## Unreleased

2

3−* Ormolu no longer overwrites already formatted files. [PR

3+* Duplicate imports in a single import list are now eliminated.

4− 649](https://github.com/tweag/ormolu/pull/649).

5−

6−## Ormolu 0.1.2.0

7−

8−* Fixed the bug when comments in different styles got glued together after

9− formatting. [Issue 589](https://github.com/tweag/ormolu/issues/589).

10−

11−* Added `-i` as a shortcut for `--mode inplace`. [Issue

12− 467](https://github.com/tweag/ormolu/issues/467).

13−

14−* Improved grouping of top-level declarations. [Issue

15− 466](https://github.com/tweag/ormolu/issues/466).

16−

17−## Ormolu 0.1.1.0

18−

19−* Imports in a import lists are now normalized: duplicate imports are

20− combined/eliminated intelligently.

21−

22−* Import declarations that can be merged are now automatically merged.

23− [Issue 414](https://github.com/tweag/ormolu/issues/414).

24

4

25* The magic comments for disabling and enabling Ormolu now can encompass any

5* The magic comments for disabling and enabling Ormolu now can encompass any

26 fragment of code provided that the remaining code after exclusion of the

6 fragment of code provided that the remaining code after exclusion of the

@@ -39,19 +19,6 @@

39* Fixed rendering of function arguments in multiline layout. [Issue

19* Fixed rendering of function arguments in multiline layout. [Issue

40 609](https://github.com/tweag/ormolu/issues/609).

20 609](https://github.com/tweag/ormolu/issues/609).

41

21

42−* Blank lines between definitions in `let` and `while` bindings are now

43− preserved. [Issue 554](https://github.com/tweag/ormolu/issues/554).

44−

45−* Fixed the bug when type applications stuck to the `$` of TH splices that

46− followed them. [Issue 613](https://github.com/tweag/ormolu/issues/613).

47−

48−* Improved region formatting so that indented fragments—such as definitions

49− inside of `where` clauses—can be formatted. [Issue

50− 572](https://github.com/tweag/ormolu/issues/572).

51−

52−* Fixed the bug related to the de-association of pragma comments. [Issue

53− 619](https://github.com/tweag/ormolu/issues/619).

54−

55## Ormolu 0.1.0.0

22## Ormolu 0.1.0.0

56

23

57* Fixed rendering of type signatures concerning several identifiers. [Issue

24* Fixed rendering of type signatures concerning several identifiers. [Issue

README.md+11−21

@@ -22,7 +22,7 @@ the following goals in mind:

22* That formatting style aims to result in minimal diffs while still

23 remaining very close to “conventional” Haskell formatting people use.

24* Choose a style compatible with modern dialects of Haskell. As new Haskell

25− extensions enter broad use, we may change the style to accommodate them.

25+ extensions enter broad use, we may change the style to accomodate them.

26* Idempotence: formatting already formatted code doesn't change it.

27* Be well-tested and robust to the point that it can be used in large

28 projects without exposing unfortunate, disappointing bugs here and there.

@@ -45,12 +45,11 @@ Alternatively, `stack` could be used with a `stack.yaml` file as follows.

45

46```console

47$ cat stack.yaml

48−resolver: lts-16.0

48+resolver: lts-14.3

49packages:

50- '.'

51

52−$ stack build # to build

52+$ stack build

53−$ stack install # to install

54```

53```

55

54

56To use Ormolu directly from GitHub with Nix, this snippet may come in handy:

55To use Ormolu directly from GitHub with Nix, this snippet may come in handy:

@@ -130,6 +129,14 @@ independent top-level definitions.

130 criterion than just being valid Haskell modules.

129 criterion than just being valid Haskell modules.

131* Various minor idempotence issues, most of them are related to comments.

130* Various minor idempotence issues, most of them are related to comments.

132

131

132+## Editor integration

133+

134+We know of the following editor integrations:

135+

136+* [Emacs][emacs-package]

137+* [VS Code][vs-code-plugin]

138+* vim: [neoformat][neoformat], [vim-ormolu][vim-ormolu]

139+

133## Running on Hackage

140## Running on Hackage

134

141

135It's possible to try Ormolu on arbitrary packages from Hackage. For that

142It's possible to try Ormolu on arbitrary packages from Hackage. For that

@@ -144,22 +151,6 @@ also contain formatted `.hs` files for inspection and original inputs with

144`.hs-original` extension (those are with CPP dropped, exactly what is fed

151`.hs-original` extension (those are with CPP dropped, exactly what is fed

145into Ormolu).

152into Ormolu).

146

153

147−## Editor integration

148−

149−We know of the following editor integrations:

150−

151−* [Emacs][emacs-package]

152−* [VS Code][vs-code-plugin]

153−* vim: [neoformat][neoformat], [vim-ormolu][vim-ormolu]

154−

155−## Arch Linux

156−

157−To install Ormolu on Arch Linux, one can use [the package on AUR][aur]:

158−

159−```console

160−yay -S ormolu

161−```

162−

163## Contributing

154## Contributing

164

155

165See [CONTRIBUTING.md][contributing].

156See [CONTRIBUTING.md][contributing].

178[vs-code-plugin]: https://marketplace.visualstudio.com/items?itemName=sjurmillidahl.ormolu-vscode

169[vs-code-plugin]: https://marketplace.visualstudio.com/items?itemName=sjurmillidahl.ormolu-vscode

179[vim-ormolu]: https://github.com/sdiehl/vim-ormolu

170[vim-ormolu]: https://github.com/sdiehl/vim-ormolu

180[neoformat]: https://github.com/sbdchd/neoformat

171[neoformat]: https://github.com/sbdchd/neoformat

181−[aur]: https://aur.archlinux.org/packages/ormolu

app/Main.hs+13−23

@@ -8,7 +8,6 @@ module Main (main) where

8

9import Control.Exception (SomeException, displayException, try)

10import Control.Monad

11−import Data.Bool (bool)

12import Data.Either (lefts)

11import Data.Either (lefts)

13import Data.List (intercalate, sort)

12import Data.List (intercalate, sort)

14import qualified Data.Text.IO as TIO

13import qualified Data.Text.IO as TIO

@@ -61,19 +60,15 @@ formatOne mode config = \case

61 -- 101 is different from all the other exit codes we already use.

60 -- 101 is different from all the other exit codes we already use.

62 exitWith (ExitFailure 101)

61 exitWith (ExitFailure 101)

63 Just inputFile -> do

62 Just inputFile -> do

64− originalInput <- TIO.readFile inputFile

65− formattedInput <- ormoluFile config inputFile

63+ r <- ormoluFile config inputFile

66 case mode of

64 case mode of

67 Stdout ->

65 Stdout ->

68− TIO.putStr formattedInput

66+ TIO.putStr r

69− InPlace -> do

67+ InPlace ->

70− -- Only write when the contents have changed, in order to avoid

71− -- updating the modified timestamp if the file was already correctly

72− -- formatted.

73− when (formattedInput /= originalInput) $

74− TIO.writeFile inputFile formattedInput

68+ TIO.writeFile inputFile r

75 Check -> do

69 Check -> do

76− when (formattedInput /= originalInput) $

70+ r' <- TIO.readFile inputFile

71+ when (r /= r') $

77 -- 100 is different to all the other exit code that are emitted

72 -- 100 is different to all the other exit code that are emitted

78 -- either from an 'OrmoluException' or from 'error' and

73 -- either from an 'OrmoluException' or from 'error' and

79 -- 'notImplemented'.

74 -- 'notImplemented'.

@@ -139,18 +134,13 @@ optsParserInfo =

139optsParser :: Parser Opts

134optsParser :: Parser Opts

140optsParser =

135optsParser =

141 Opts

136 Opts

142− <$> ( (fmap (bool Stdout InPlace) . switch . mconcat)

143− [ short 'i',

144− help "A shortcut for --mode inplace"

145− ]

146− <|> (option parseMode . mconcat)

137+ <$> (option parseMode . mconcat)

147− [ long "mode",

138+ [ long "mode",

148− short 'm',

139+ short 'm',

149− metavar "MODE",

140+ metavar "MODE",

150− value Stdout,

141+ value Stdout,

151− help "Mode of operation: 'stdout' (default), 'inplace', or 'check'"

142+ help "Mode of operation: 'stdout' (default), 'inplace', or 'check'"

152− ]

143+ ]

153− )

154 <*> configParser

144 <*> configParser

155 <*> (many . strArgument . mconcat)

145 <*> (many . strArgument . mconcat)

156 [ metavar "FILE",

146 [ metavar "FILE",

data/examples/declaration/signature/type/infix-promoted-type-constructor-out.hs+1

@@ -1,2 +1,3 @@

1fun1 :: Def ('[Ref s (Stored Uint32), IBool] 'T.:-> IBool)

2+

2fun2 :: Def ('[Ref s (Stored Uint32), IBool] ':-> IBool)

3fun2 :: Def ('[Ref s (Stored Uint32), IBool] ':-> IBool)

data/examples/declaration/signature/type/unrelated-out.hsdeleted−4

@@ -1,4 +0,0 @@

1−clientFunc1 :: SomeType1

2−clientFunc2 :: SomeType2

3−clientFunc3 :: SomeType3

4−clientFunc1 :<|> clientFunc2 :<|> clientFunc3 = hoistClient foo bar baz

data/examples/declaration/signature/type/unrelated.hsdeleted−4

@@ -1,4 +0,0 @@

1−clientFunc1 :: SomeType1

2−clientFunc2 :: SomeType2

3−clientFunc3 :: SomeType3

4−clientFunc1 :<|> clientFunc2 :<|> clientFunc3 = hoistClient foo bar baz

data/examples/declaration/value/function/blank-lines-let-out.hsdeleted−6

@@ -1,6 +0,0 @@

1−foo =

2− let x = 10

3−

4− y = 11

5− z = 12

6− in x + y + z

data/examples/declaration/value/function/blank-lines-let.hsdeleted−9

@@ -1,9 +0,0 @@

1−foo =

2− let

3−

4− x = 10

5−

6− y = 11

7− z = 12

8−

9− in x + y + z

data/examples/declaration/value/function/blank-lines-where-out.hsdeleted−6

@@ -1,6 +0,0 @@

1−foo = x + y + z

2− where

3− x = 10

4−

5− y = 11

6− z = 12

data/examples/declaration/value/function/blank-lines-where.hsdeleted−7

@@ -1,7 +0,0 @@

1−foo = x + y + z

2− where

3−

4− x = 10

5−

6− y = 11

7− z = 12

data/examples/declaration/value/function/implicit-params-out.hs−1

@@ -1,7 +1,6 @@

1{-# LANGUAGE ImplicitParams #-}

2

3sortBy :: (a -> a -> Bool) -> [a] -> [a]

4−sortBy = undefined

5

4

6sort :: (?cmp :: a -> a -> Bool) => [a] -> [a]

5sort :: (?cmp :: a -> a -> Bool) => [a] -> [a]

7sort = sortBy ?cmp

6sort = sortBy ?cmp

data/examples/declaration/value/function/implicit-params.hs−2

@@ -1,8 +1,6 @@

1{-# LANGUAGE ImplicitParams #-}

2sortBy :: (a -> a -> Bool) -> [a] -> [a]

3

4−sortBy = undefined

5−

6sort :: (?cmp :: a -> a -> Bool) => [a] -> [a]

4sort :: (?cmp :: a -> a -> Bool) => [a] -> [a]

7sort = sortBy ?cmp

5sort = sortBy ?cmp

8

6

data/examples/declaration/value/function/type-applications-and-splice-out.hsdeleted−4

@@ -1,4 +0,0 @@

1−{-# LANGUAGE TemplateHaskell #-}

2−{-# LANGUAGE TypeApplications #-}

3−

4−staticKey name = [|sing @ $(symFQN name)|]

data/examples/declaration/value/function/type-applications-and-splice.hsdeleted−4

@@ -1,4 +0,0 @@

1−{-# LANGUAGE TemplateHaskell #-}

2−{-# LANGUAGE TypeApplications #-}

3−

4−staticKey name = [| sing @ $(symFQN name) |]

data/examples/import/deduplication-bug-out.hsdeleted−6

@@ -1,6 +0,0 @@

1−import Foo1 (Bar1 (..), Baz1)

2−import Foo2 (Bar2 (..), Baz2)

3−import Foo3 (Bar3 (x1, x2, x3))

4−import Foo4 (Bar4 (x1, x2))

5−import Foo5 (Bar5 (x1))

6−import Foo6 (Bar6 (..))

data/examples/import/deduplication-bug.hsdeleted−6

@@ -1,6 +0,0 @@

1−import Foo1 (Bar1, Baz1, Bar1(..))

2−import Foo2 (Bar2(..), Baz2, Bar2)

3−import Foo3 (Bar3(x1,x3), Bar3(x1, x2))

4−import Foo4 (Bar4(x1), Bar4(x2))

5−import Foo5 (Bar5, Bar5(x1))

6−import Foo6 (Bar6(x1), Bar6(..))

data/examples/import/merging-0-out.hsdeleted−3

@@ -1,3 +0,0 @@

1−import Foo

2−import Foo (bar, foo)

3−import Foo as F

data/examples/import/merging-0.hsdeleted−4

@@ -1,4 +0,0 @@

1−import Foo

2−import Foo (foo)

3−import Foo (bar)

4−import Foo as F

data/examples/import/merging-1-out.hsdeleted−2

@@ -1,2 +0,0 @@

1−import "bar" Foo (bar)

2−import "foo" Foo (baz, foo)

data/examples/import/merging-1.hsdeleted−3

@@ -1,3 +0,0 @@

1−import "foo" Foo (foo)

2−import "bar" Foo (bar)

3−import "foo" Foo (baz)

data/examples/import/merging-2-out.hsdeleted−2

@@ -1,2 +0,0 @@

1−import Foo hiding (bar4, foo2)

2−import qualified Foo (bar3, foo1)

data/examples/import/merging-2.hsdeleted−4

@@ -1,4 +0,0 @@

1−import qualified Foo (foo1)

2−import Foo hiding (foo2)

3−import qualified Foo (bar3)

4−import Foo hiding (bar4)

data/examples/import/qualified-post-out.hs+1−1

@@ -1,5 +1,5 @@

1{-# LANGUAGE ImportQualifiedPost #-}

2

3+import Data.Text qualified as T

3import Data.Text qualified (a, b, c)

4import Data.Text qualified (a, b, c)

4import Data.Text qualified hiding (a, b, c)

5import Data.Text qualified hiding (a, b, c)

5−import Data.Text qualified as T

data/examples/import/qualified-prelude-out.hs+1−1

@@ -1,4 +1,4 @@

1module P where

2

3−import Prelude hiding (id, (.))

4import qualified Prelude

3import qualified Prelude

4+import Prelude hiding (id, (.))

data/examples/import/simple-out.hs+5−2

@@ -1,5 +1,8 @@

1import Data.Text

2+import Data.Text

3+import qualified Data.Text as T

4+import qualified Data.Text (a, b, c)

5+import Data.Text (a, b, c)

6+import Data.Text hiding (a, b, c)

2import Data.Text (a, b, c)

7import Data.Text (a, b, c)

3import Data.Text hiding (a, b, c)

8import Data.Text hiding (a, b, c)

4−import qualified Data.Text (a, b, c)

5−import qualified Data.Text as T

data/examples/other/argument-comment-out.hs+1

@@ -9,6 +9,7 @@ foo ::

9 -- | Foo

10 Int ->

11 Int

12+

12foo ::

13foo ::

13 Foo a =>

14 Foo a =>

14 -- | Foo

15 -- | Foo

data/examples/other/comment-glued-together-out.hsdeleted−7

@@ -1,7 +0,0 @@

1−module Main (main) where

2−

3−-- | Foo.

4−

5−-- Bar

6−main :: IO ()

7−main = return ()

data/examples/other/comment-glued-together.hsdeleted−6

@@ -1,6 +0,0 @@

1−module Main (main) where

2−

3−{- | Foo. -}

4−-- Bar

5−main :: IO ()

6−main = return ()

data/examples/other/cpp/separation-2b-out.hs+1

@@ -1,4 +1,5 @@

1ffff, ffffffff :: Natural

2+

2#ifdef HASKELL_ZIP_DEV_MODE

3#ifdef HASKELL_ZIP_DEV_MODE

3ffff = 200

4ffff = 200

4ffffffff = 5000

5ffffffff = 5000

data/examples/other/pragma-comments-after-out.hsdeleted−4

@@ -1,4 +0,0 @@

1−{-# LANGUAGE AllowAmbiguousTypes #-}

2−{-# LANGUAGE ConstraintKinds #-}

3−-- TODO: Fix and delete this pragma

4−{-# OPTIONS_GHC -Wno-incomplete-uni-patterns #-}

data/examples/other/pragma-comments-after.hsdeleted−3

@@ -1,3 +0,0 @@

1−{-# OPTIONS_GHC -Wno-incomplete-uni-patterns #-} -- TODO: Fix and delete this pragma

2−{-# LANGUAGE AllowAmbiguousTypes #-}

3−{-# LANGUAGE ConstraintKinds #-}

default.nix+16−17

@@ -1,6 +1,5 @@

1−{ pkgs ? (import ./nix/nixpkgs { inherit system; })

1+{ pkgs ? (import ./nix/nixpkgs)

2−, system ? builtins.currentSystem

3−, ormoluCompiler ? "ghc884" # the shell doesn't work with ghc8101 yet

2+, ormoluCompiler ? "ghc883" # the shell doesn't work with ghc8101 yet

4}:

3}:

5

4

6let

5let

@@ -17,6 +16,12 @@ let

17 };

16 };

18 ormoluOverlay = self: super: {

17 ormoluOverlay = self: super: {

19 "ormolu" = super.callCabal2nixWithOptions "ormolu" source "-fdev" { };

18 "ormolu" = super.callCabal2nixWithOptions "ormolu" source "-fdev" { };

19+ "ghc-lib-parser" = pkgs.haskell.lib.dontHaddock

20+ (super.callHackageDirect {

21+ pkg = "ghc-lib-parser";

22+ ver = "8.10.1.20200412";

23+ sha256 = "sha256-EjMzp8xRT3xVFKDI1fAfopkylGB0hv35Av2+uZeETRU=";

24+ } {});

20 };

25 };

21 ormolize = import ./nix/ormolize {

26 ormolize = import ./nix/ormolize {

22 inherit pkgs;

27 inherit pkgs;

@@ -28,16 +33,14 @@ let

28 "distributed-process"

33 "distributed-process"

29 "esqueleto"

34 "esqueleto"

30 "fay"

35 "fay"

31− "hlint"

32 "idris"

36 "idris"

33 "intero"

37 "intero"

34 "leksah"

38 "leksah"

39+ "lens"

35 "pandoc"

40 "pandoc"

36 "pipes"

41 "pipes"

37− "postgrest"

38 "purescript"

42 "purescript"

39− "tensorflow"

43+ ];

40− ] ++ (if ormoluCompiler == "ghc8101" then [] else ["lens"]);

41 ormolizedPackages = doCheck:

44 ormolizedPackages = doCheck:

42 pkgs.lib.mapAttrs (name: p: ormolize {

45 pkgs.lib.mapAttrs (name: p: ormolize {

43 package = p;

46 package = p;

@@ -129,19 +132,17 @@ in {

129 cp src.hs result-all-implicit.hs

132 cp src.hs result-all-implicit.hs

130 ormolu --check-idempotence --mode inplace result-all-implicit.hs

133 ormolu --check-idempotence --mode inplace result-all-implicit.hs

131 cp src.hs result-all-explicit.hs

134 cp src.hs result-all-explicit.hs

132− ormolu --check-idempotence --mode inplace --start-line 1 --end-line 18 result-all-explicit.hs

135+ ormolu --check-idempotence --mode inplace --start-line 1 --end-line 13 result-all-explicit.hs

133 cp src.hs result-only-start.hs

136 cp src.hs result-only-start.hs

134 ormolu --check-idempotence --mode inplace --start-line 1 result-only-start.hs

137 ormolu --check-idempotence --mode inplace --start-line 1 result-only-start.hs

135 cp src.hs result-only-end.hs

138 cp src.hs result-only-end.hs

136− ormolu --check-idempotence --mode inplace --end-line 18 result-only-end.hs

139+ ormolu --check-idempotence --mode inplace --end-line 13 result-only-end.hs

137 cp src.hs result-6-7.hs

140 cp src.hs result-6-7.hs

138 ormolu --check-idempotence --mode inplace --start-line 6 --end-line 7 result-6-7.hs

141 ormolu --check-idempotence --mode inplace --start-line 6 --end-line 7 result-6-7.hs

139 cp src.hs result-6-8.hs

142 cp src.hs result-6-8.hs

140 ormolu --check-idempotence --mode inplace --start-line 6 --end-line 8 result-6-8.hs

143 ormolu --check-idempotence --mode inplace --start-line 6 --end-line 8 result-6-8.hs

141− cp src.hs result-9-12.hs

144+ cp src.hs result-9-13.hs

142− ormolu --check-idempotence --mode inplace --start-line 9 --end-line 12 result-9-12.hs

145+ ormolu --check-idempotence --mode inplace --start-line 9 --end-line 13 result-9-13.hs

143− cp src.hs result-17-18.hs

144− ormolu --check-idempotence --mode inplace --start-line 17 --end-line 18 result-17-18.hs

145 '';

146 '';

146 checkPhase = ''

147 checkPhase = ''

147 echo result-all-implicit.hs

148 echo result-all-implicit.hs

@@ -156,10 +157,8 @@ in {

156 diff --color=always expected-result-6-7.hs result-6-7.hs

157 diff --color=always expected-result-6-7.hs result-6-7.hs

157 echo result-6-8.hs

158 echo result-6-8.hs

158 diff --color=always expected-result-6-8.hs result-6-8.hs

159 diff --color=always expected-result-6-8.hs result-6-8.hs

159− echo result-9-12.hs

160+ echo result-9-13.hs

160− diff --color=always expected-result-9-12.hs result-9-12.hs

161+ diff --color=always expected-result-9-13.hs result-9-13.hs

161− echo result-17-18.hs

162− diff --color=always expected-result-17-18.hs result-17-18.hs

163 '';

162 '';

164 installPhase = ''

163 installPhase = ''

165 mkdir "$out"

164 mkdir "$out"

expected-failures/Agda.txt+2−2

@@ -1,11 +1,11 @@

1Formatting is not idempotent:

2− dist/build/Agda/Syntax/Parser/Lexer.hs<rendered>:1602:17

2+ dist/build/Agda/Syntax/Parser/Lexer.hs<rendered>:1597:17

3 before: " = (check_ac"

4 after: " =\n "

5Please, consider reporting the bug.

6

7Formatting is not idempotent:

8− src/full/Agda/Syntax/Translation/InternalToAbstract.hs<rendered>:769:4

8+ src/full/Agda/Syntax/Translation/InternalToAbstract.hs<rendered>:750:4

9 before: " nes\n\n "

10 after: " nes\n\n -- Andreas"

11Please, consider reporting the bug.

expected-failures/esqueleto.txt+1−1

@@ -3,5 +3,5 @@ The GHC parser (in Haddock mode) failed:

3 lexical error in string/character literal at character 's'

4

5The GHC parser (in Haddock mode) failed:

6− test/PostgreSQL/Test.hs:562:9-41

6+ test/PostgreSQL/Test.hs:510:9-41

7 parse error on input `-- | Check the result is not null'

expected-failures/hlint.txtdeleted−11

@@ -1,11 +0,0 @@

1−Formatting is not idempotent:

2− src/Extension.hs<rendered>:19:22

3− before: "DoRec , -} Recursive"

4− after: "DoRec , -}\n "

5−Please, consider reporting the bug.

6−

7−Formatting is not idempotent:

8− src/Hint/Bracket.hs<rendered>:249:50

9− before: "\" x y [r]) {ideaSpan"

10− after: "\" x y [r])\n "

11−Please, consider reporting the bug.

expected-failures/idris.txt+4

@@ -2,6 +2,10 @@ The GHC parser (in Haddock mode) failed:

2 src/Idris/Parser.hs:1052:1

3 parse error on input `@'

4

5+AST of input and AST of formatted code differ.

6+ at src/Idris/Parser/Data.hs:281:1-29

7+Please, consider reporting the bug.

8+

5The GHC parser (in Haddock mode) failed:

9The GHC parser (in Haddock mode) failed:

6 src/Idris/Parser/Expr.hs:75:1

10 src/Idris/Parser/Expr.hs:75:1

7 parse error on input `@'

11 parse error on input `@'

expected-failures/intero.txt+1−1

@@ -1,5 +1,5 @@

1Formatting is not idempotent:

2− src/InteractiveUI.hs<rendered>:3748:33

2+ src/InteractiveUI.hs<rendered>:3710:33

3 before: "text \"Try\" <+> doWha"

4 after: "text \"Try\"\n "

5Please, consider reporting the bug.

expected-failures/leksah.txt+1−1

@@ -1,5 +1,5 @@

1Formatting is not idempotent:

2− src/IDE/Pane/Modules.hs<rendered>:1184:7

2+ src/IDE/Pane/Modules.hs<rendered>:1187:7

3 before: "cr\n -- show"

4 after: "cr\n in -- show"

5Please, consider reporting the bug.

expected-failures/pandoc.txt+1−1

@@ -3,7 +3,7 @@ The GHC parser (in Haddock mode) failed:

3 parse error on input `import'

4

5Formatting is not idempotent:

6− src/Text/Pandoc/Readers/Vimwiki.hs<rendered>:613:19

6+ src/Text/Pandoc/Readers/Vimwiki.hs<rendered>:615:19

7 before: ".softbreak <$ endlin"

8 after: ".softbreak\n <$ en"

9Please, consider reporting the bug.

expected-failures/postgrest.txtdeleted−5

@@ -1,5 +0,0 @@

1−Formatting is not idempotent:

2− src/PostgREST/DbRequestBuilder.hs<rendered>:149:24

3− before: " || -- clients"

4− after: " || ( origin ="

5−Please, consider reporting the bug.

expected-failures/purescript.txt+2−2

@@ -1,10 +1,10 @@

1The GHC parser (in Haddock mode) failed:

2− src/Language/PureScript/AST/Declarations.hs:479:1-17

2+ src/Language/PureScript/AST/Declarations.hs:478:1-17

3 Invalid type signature: pattern ValueDecl :: ...

4Perhaps you meant to use PatternSynonyms?

5

6The GHC parser (in Haddock mode) failed:

7− src/Language/PureScript/AST/SourcePos.hs:99:1-22

7+ src/Language/PureScript/AST/SourcePos.hs:101:1-22

8 Invalid type signature: pattern NullSourceSpan :: ...

9Perhaps you meant to use PatternSynonyms?

10

expected-failures/tensorflow.txtdeleted−7

@@ -1,7 +0,0 @@

1−The GHC parser (in Haddock mode) failed:

2− tensorflow-mnist/app/Main.hs:50:13-14

3− parse error on input `->'

4−

5−The GHC parser (in Haddock mode) failed:

6− tensorflow-ops/tests/RegressionTest.hs:3:1-6

7− parse error on input `import'

nix/nixpkgs/default.nix+3−7

@@ -1,13 +1,9 @@

1−{ system ? builtins.currentSystem }:

2let

1let

3− rev = "32b46dd897ab2143a609988a04d87452f0bbef59";

2+ rev = "807ca93fadd5197c2260490de0c76e500562dc05";

4− sha256 = "1gzfrpjnr1bz9zljsyg3a4zrhk8r927sz761mrgcg56dwinkhpjk";

3+ sha256 = "10yq8bnls77fh3pk5chkkb1sv5lbdgyk1rr2v9xn71rr1k2x563p";

5 nixpkgs = builtins.fetchTarball {

4 nixpkgs = builtins.fetchTarball {

6 url = "https://github.com/NixOS/nixpkgs/archive/${rev}.tar.gz";

5 url = "https://github.com/NixOS/nixpkgs/archive/${rev}.tar.gz";

7 inherit sha256;

6 inherit sha256;

8 };

7 };

9− pkgs = import nixpkgs {

10− inherit system;

11− config.allowUnfree = true;

8+ pkgs = import nixpkgs { config.allowUnfree = true; };

12− };

13in pkgs

9in pkgs

ormolu.cabal+4−5

@@ -1,10 +1,10 @@

1cabal-version: 1.18

2name: ormolu

3−version: 0.1.2.0

3+version: 0.1.0.0

4license: BSD3

5license-file: LICENSE.md

6maintainer: Mark Karpov <mark.karpov@tweag.io>

7−tested-with: ghc ==8.6.5 ghc ==8.8.4 ghc ==8.10.1

7+tested-with: ghc ==8.6.5 ghc ==8.8.3 ghc ==8.10.1

8homepage: https://github.com/tweag/ormolu

9bug-reports: https://github.com/tweag/ormolu/issues

10synopsis: A formatter for Haskell source code

@@ -119,7 +119,7 @@ library

119 base >=4.12 && <5.0,

120 bytestring >=0.2 && <0.11,

121 containers >=0.5 && <0.7,

122− dlist >=0.8 && <2.0,

122+ dlist >=0.8 && <0.9,

123 exceptions >=0.6 && <0.11,

124 ghc-lib-parser >=8.10 && <8.11,

125 mtl >=2.0 && <3.0,

@@ -144,7 +144,7 @@ executable ormolu

144 base >=4.12 && <5.0,

145 ghc-lib-parser >=8.10 && <8.11,

146 gitrev >=1.3 && <1.4,

147− optparse-applicative >=0.14 && <0.17,

147+ optparse-applicative >=0.14 && <0.16,

148 ormolu -any,

149 text >=0.2 && <1.3

150

@@ -152,7 +152,6 @@ executable ormolu

152 ghc-options:

153 -Wall -Werror -Wcompat -Wincomplete-record-updates

154 -Wincomplete-uni-patterns -Wnoncanonical-monad-instances

155− -optP-Wno-nonportable-include-path

156

155

157 else

156 else

158 ghc-options: -O2 -Wall -rtsopts

157 ghc-options: -O2 -Wall -rtsopts

region-tests/expected-result-17-18.hsdeleted−17

@@ -1,17 +0,0 @@

1−{-# LANGUAGE LambdaCase #-}

2−

3−module Foo (

4− foo, bar, baz) where

5−

6−foo :: Int

7−foo = 5

8−

9−bar :: Int -> Int

10−bar = \case

11− 0 -> foo

12− x -> x - foo

13−

14−baz :: Int -> Int

15−baz = gege

16− where

17− gege = 1 + 2

region-tests/expected-result-6-7.hs+1−6

@@ -1,7 +1,7 @@

1{-# LANGUAGE LambdaCase #-}

2

3module Foo (

4− foo, bar, baz) where

4+ foo, bar) where

5

6foo :: Int

7foo = 5

@@ -10,8 +10,3 @@ bar :: Int -> Int

10bar = \case

11 0 -> foo

12 x -> x - foo

13−

14−baz :: Int -> Int

15−baz = gege

16− where

17− gege = 1 + 2

region-tests/expected-result-6-8.hs+1−6

@@ -1,7 +1,7 @@

1{-# LANGUAGE LambdaCase #-}

2

3module Foo (

4− foo, bar, baz) where

4+ foo, bar) where

5

6foo :: Int

7foo = 5

@@ -9,8 +9,3 @@ bar :: Int -> Int

9bar = \case

10 0 -> foo

11 x -> x - foo

12−

13−baz :: Int -> Int

14−baz = gege

15− where

16− gege = 1 + 2

region-tests/expected-result-9-12.hs → region-tests/expected-result-9-13.hsrenamed+1−6

@@ -1,7 +1,7 @@

1{-# LANGUAGE LambdaCase #-}

2

3module Foo (

4− foo, bar, baz) where

4+ foo, bar) where

5

6foo :: Int

7foo = 5

@@ -10,8 +10,3 @@ bar :: Int -> Int

10bar = \case

11 0 -> foo

12 x -> x - foo

13−

14−baz :: Int -> Int

15−baz = gege

16− where

17− gege = 1 + 2

region-tests/expected-result-all.hs−6

@@ -3,7 +3,6 @@

3module Foo

4 ( foo,

5 bar,

6− baz,

7 )

6 )

8where

7where

9

8

@@ -14,8 +13,3 @@ bar :: Int -> Int

14bar = \case

13bar = \case

15 0 -> foo

14 0 -> foo

16 x -> x - foo

15 x -> x - foo

17−

18−baz :: Int -> Int

19−baz = gege

20− where

21− gege = 1 + 2

region-tests/src.hs+1−6

@@ -1,7 +1,7 @@

1{-# LANGUAGE LambdaCase #-}

2

3module Foo (

4− foo, bar, baz) where

4+ foo, bar) where

5

6foo :: Int

7foo = 5

@@ -10,8 +10,3 @@ bar :: Int -> Int

10bar = \case

11 0 -> foo

12 x -> x - foo

13−

14−baz :: Int -> Int

15−baz = gege

16− where

17− gege = 1 + 2

shell.nix+1−3

@@ -1,5 +1,3 @@

1−{ pkgs ? (import ./nix/nixpkgs { inherit system; })

1+{ pkgs ? (import ./nix/nixpkgs) }:

2−, system ? builtins.currentSystem

3−}:

4

2

5(import ./default.nix { inherit pkgs; }).dev.ormoluShell

3(import ./default.nix { inherit pkgs; }).dev.ormoluShell

src/Ormolu/Diff.hs+3−3

@@ -14,7 +14,7 @@ import Data.Text (Text)

14import qualified Data.Text as T

15import qualified FastString as GHC

16import GHC

17−import Ormolu.Imports (normalizeImports)

17+import Ormolu.Imports (sortImports)

18import Ormolu.Parser.CommentStream

19import Ormolu.Parser.Result

20import Ormolu.Utils

@@ -47,8 +47,8 @@ diffParseResult

47 } =

48 matchIgnoringSrcSpans cstream0 cstream1

49 <> matchIgnoringSrcSpans

50− hs0 {hsmodImports = normalizeImports (hsmodImports hs0)}

50+ hs0 {hsmodImports = sortImports (hsmodImports hs0)}

51− hs1 {hsmodImports = normalizeImports (hsmodImports hs1)}

51+ hs1 {hsmodImports = sortImports (hsmodImports hs1)}

52

53-- | Compare two values for equality disregarding differences in 'SrcSpan's

54-- and the ordering of import lists.

src/Ormolu/Imports.hs+43−141

@@ -4,176 +4,78 @@

4

5-- | Manipulations on import lists.

6module Ormolu.Imports

7− ( normalizeImports,

7+ ( sortImports,

8 )

9where

10

11import Data.Bifunctor

12import Data.Char (isAlphaNum)

13import Data.Function (on)

14+import Data.Generics (gcompare)

14−import Data.List (foldl', nubBy, sortBy, sortOn)

15+import Data.List (nubBy, sortBy)

15−import Data.Map.Strict (Map)

16−import qualified Data.Map.Strict as M

17−import FastString (FastString)

18import GHC hiding (GhcPs, IE)

16import GHC hiding (GhcPs, IE)

19import GHC.Hs.Extension

17import GHC.Hs.Extension

20import GHC.Hs.ImpExp (IE (..))

18import GHC.Hs.ImpExp (IE (..))

21import Ormolu.Utils (notImplemented, showOutputable)

19import Ormolu.Utils (notImplemented, showOutputable)

22

20

23−-- | Sort and normalize imports.

21+-- | Sort imports by module name. This also sorts explicit import lists for

22+-- each declaration.

24−normalizeImports :: [LImportDecl GhcPs] -> [LImportDecl GhcPs]

23+sortImports :: [LImportDecl GhcPs] -> [LImportDecl GhcPs]

25−normalizeImports =

24+sortImports = sortBy compareIdecl . fmap (fmap sortImportLists)

26− fmap snd

27− . M.toAscList

28− . M.fromListWith combineImports

29− . fmap (\x -> (importId x, g x))

30 where

25 where

31− g (L l ImportDecl {..}) =

26+ sortImportLists :: ImportDecl GhcPs -> ImportDecl GhcPs

32− L

27+ sortImportLists = \case

33− l

28+ ImportDecl {..} ->

34 ImportDecl

29 ImportDecl

35− { ideclHiding = second (fmap normalizeLies) <$> ideclHiding,

30+ { ideclHiding = second (fmap sortLies) <$> ideclHiding,

36 ..

31 ..

37 }

32 }

38− g _ = notImplemented "XImportDecl"

33+ XImportDecl x -> noExtCon x

39

34

40−-- | Combine two import declarations. It should be assumed that 'ImportId's

41−-- are equal.

42−combineImports ::

43− LImportDecl GhcPs ->

44− LImportDecl GhcPs ->

35+-- | Compare two @'LImportDecl' 'GhcPs'@ things.

45− LImportDecl GhcPs

36+compareIdecl :: LImportDecl GhcPs -> LImportDecl GhcPs -> Ordering

46−combineImports (L lx ImportDecl {..}) (L _ y) =

37+compareIdecl (L _ m0) (L _ m1) =

47− L

38+ case (isPrelude n0, isPrelude n1) of

48− lx

39+ (False, False) -> n0 `compare` n1

49− ImportDecl

40+ (True, False) -> GT

50− { ideclHiding = case (ideclHiding, GHC.ideclHiding y) of

41+ (False, True) -> LT

51− (Just (hiding, L l' xs), Just (_, L _ ys)) ->

42+ (True, True) -> m0 `gcompare` m1

52− Just (hiding, (L l' (normalizeLies (xs ++ ys))))

53− _ -> Nothing,

54− ..

55− }

56−combineImports _ _ = notImplemented "XImportDecl"

57−

58−-- | Import id, a collection of all things that justify having a separate

59−-- import entry. This is used for merging of imports. If two imports have

60−-- the same 'ImportId' they can be merged.

61−data ImportId = ImportId

62− { importIsPrelude :: Bool,

63− importIdName :: ModuleName,

64− importPkgQual :: Maybe FastString,

65− importSource :: Bool,

66− importSafe :: Bool,

67− importQualified :: Bool,

68− importImplicit :: Bool,

69− importAs :: Maybe ModuleName,

70− importHiding :: Maybe Bool

71− }

72− deriving (Eq, Ord)

73−

74−-- | Obtain an 'ImportId' for a given import.

75−importId :: LImportDecl GhcPs -> ImportId

76−importId (L _ ImportDecl {..}) =

77− ImportId

78− { importIsPrelude = isPrelude,

79− importIdName = moduleName,

80− importPkgQual = sl_fs <$> ideclPkgQual,

81− importSource = ideclSource,

82− importSafe = ideclSafe,

83− importQualified = case ideclQualified of

84− QualifiedPre -> True

85− QualifiedPost -> True

86− NotQualified -> False,

87− importImplicit = ideclImplicit,

88− importAs = unLoc <$> ideclAs,

89− importHiding = fst <$> ideclHiding

90− }

91 where

43 where

44+ n0 = unLoc (ideclName m0)

45+ n1 = unLoc (ideclName m1)

92− isPrelude = moduleNameString moduleName == "Prelude"

46+ isPrelude = (== "Prelude") . moduleNameString

93− moduleName = unLoc ideclName

94−importId _ = notImplemented "XImportDecl"

95

47

96−-- | Normalize a collection of import\/export items.

48+-- | Sort located import or export, dropping duplicates.

97−normalizeLies :: [LIE GhcPs] -> [LIE GhcPs]

49+sortLies :: [LIE GhcPs] -> [LIE GhcPs]

98−normalizeLies = sortOn (getIewn . unLoc) . M.elems . foldl' combine M.empty

50+sortLies =

99− where

51+ nubBy (\x y -> compareLIE x y == EQ)

100− combine ::

52+ . sortBy compareLIE

101− Map IEWrappedNameOrd (LIE GhcPs) ->

53+ . fmap (fmap sortThings)

102− LIE GhcPs ->

103− Map IEWrappedNameOrd (LIE GhcPs)

104− combine m (L new_l new) =

105− let wname = getIewn new

106− normalizeWNames =

107− nubBy (\x y -> compareLIewn x y == EQ) . sortBy compareLIewn

108− alter = \case

109− Nothing -> Just . L new_l $

110− case new of

111− IEThingWith NoExtField n wildcard g flbl ->

112− IEThingWith NoExtField n wildcard (normalizeWNames g) flbl

113− other -> other

114− Just old ->

115− let f = \case

116− IEVar NoExtField n -> IEVar NoExtField n

117− IEThingAbs NoExtField _ -> new

118− IEThingAll NoExtField n -> IEThingAll NoExtField n

119− IEThingWith NoExtField n wildcard g flbl ->

120− case new of

121− IEVar NoExtField _ ->

122− error "Ormolu.Imports broken presupposition"

123− IEThingAbs NoExtField _ ->

124− IEThingWith NoExtField n wildcard g flbl

125− IEThingAll NoExtField n' ->

126− IEThingAll NoExtField n'

127− IEThingWith NoExtField n' wildcard' g' flbl' ->

128− let combinedWildcard =

129− case (wildcard, wildcard') of

130− (IEWildcard _, _) -> IEWildcard 0

131− (_, IEWildcard _) -> IEWildcard 0

132− _ -> NoIEWildcard

133− in IEThingWith

134− NoExtField

135− n'

136− combinedWildcard

137− (normalizeWNames (g <> g'))

138− flbl'

139− IEModuleContents NoExtField _ -> notImplemented "IEModuleContents"

140− IEGroup NoExtField _ _ -> notImplemented "IEGroup"

141− IEDoc NoExtField _ -> notImplemented "IEDoc"

142− IEDocNamed NoExtField _ -> notImplemented "IEDocNamed"

143− XIE x -> noExtCon x

144− IEModuleContents NoExtField _ -> notImplemented "IEModuleContents"

145− IEGroup NoExtField _ _ -> notImplemented "IEGroup"

146− IEDoc NoExtField _ -> notImplemented "IEDoc"

147− IEDocNamed NoExtField _ -> notImplemented "IEDocNamed"

148− XIE x -> noExtCon x

149− in Just (f <$> old)

150− in M.alter alter wname m

151

54

152−-- | A wrapper for @'IEWrappedName' 'RdrName'@ that allows us to define an

55+-- | Sort imports\/exports inside of 'IEThingWith'.

153−-- 'Ord' instance for it.

56+sortThings :: IE GhcPs -> IE GhcPs

154−newtype IEWrappedNameOrd = IEWrappedNameOrd (IEWrappedName RdrName)

57+sortThings = \case

155− deriving (Eq)

58+ IEThingWith NoExtField x w xs fl ->

59+ IEThingWith NoExtField x w (sortBy (compareIewn `on` unLoc) xs) fl

60+ other -> other

156

61

157−instance Ord IEWrappedNameOrd where

62+-- | Compare a pair of located imports or exports.

158− compare (IEWrappedNameOrd x) (IEWrappedNameOrd y) = compareIewn x y

63+compareLIE :: LIE GhcPs -> LIE GhcPs -> Ordering

64+compareLIE = compareIewn `on` getIewn . unLoc

159

65

160-- | Project @'IEWrappedName' 'RdrName'@ from @'IE' 'GhcPs'@.

66-- | Project @'IEWrappedName' 'RdrName'@ from @'IE' 'GhcPs'@.

161−getIewn :: IE GhcPs -> IEWrappedNameOrd

67+getIewn :: IE GhcPs -> IEWrappedName RdrName

162getIewn = \case

68getIewn = \case

163− IEVar NoExtField x -> IEWrappedNameOrd (unLoc x)

69+ IEVar NoExtField x -> unLoc x

164− IEThingAbs NoExtField x -> IEWrappedNameOrd (unLoc x)

70+ IEThingAbs NoExtField x -> unLoc x

165− IEThingAll NoExtField x -> IEWrappedNameOrd (unLoc x)

71+ IEThingAll NoExtField x -> unLoc x

166− IEThingWith NoExtField x _ _ _ -> IEWrappedNameOrd (unLoc x)

72+ IEThingWith NoExtField x _ _ _ -> unLoc x

167 IEModuleContents NoExtField _ -> notImplemented "IEModuleContents"

73 IEModuleContents NoExtField _ -> notImplemented "IEModuleContents"

168 IEGroup NoExtField _ _ -> notImplemented "IEGroup"

74 IEGroup NoExtField _ _ -> notImplemented "IEGroup"

169 IEDoc NoExtField _ -> notImplemented "IEDoc"

75 IEDoc NoExtField _ -> notImplemented "IEDoc"

170 IEDocNamed NoExtField _ -> notImplemented "IEDocNamed"

76 IEDocNamed NoExtField _ -> notImplemented "IEDocNamed"

171 XIE x -> noExtCon x

77 XIE x -> noExtCon x

172

78

173−-- | Like 'compareIewn' for located wrapped names.

174−compareLIewn :: LIEWrappedName RdrName -> LIEWrappedName RdrName -> Ordering

175−compareLIewn = compareIewn `on` unLoc

176−

177-- | Compare two @'IEWrapppedName' 'RdrName'@ things.

79-- | Compare two @'IEWrapppedName' 'RdrName'@ things.

178compareIewn :: IEWrappedName RdrName -> IEWrappedName RdrName -> Ordering

80compareIewn :: IEWrappedName RdrName -> IEWrappedName RdrName -> Ordering

179compareIewn (IEName x) (IEName y) = unLoc x `compareRdrName` unLoc y

81compareIewn (IEName x) (IEName y) = unLoc x `compareRdrName` unLoc y

src/Ormolu/Parser.hs+3−5

@@ -32,7 +32,7 @@ import Ormolu.Parser.Anns

32import Ormolu.Parser.CommentStream

33import Ormolu.Parser.Result

34import Ormolu.Processing.Preprocess (preprocess)

35−import Ormolu.Utils (incSpanLine, removeIndentation)

35+import Ormolu.Utils (incSpanLine)

36import qualified Panic as GHC

37import qualified Parser as GHC

38import qualified StringBuffer as GHC

@@ -51,9 +51,8 @@ parseModule ::

51 Either (SrcSpan, String) ParseResult

52 )

53parseModule Config {..} path rawInput = liftIO $ do

54− let (literalPrefix, indentedInput, literalSuffix, extraComments) =

54+ let (literalPrefix, input, literalSuffix, extraComments) =

55 preprocess path rawInput cfgRegion

56− (input, indent) = removeIndentation indentedInput

57 -- It's important that 'setDefaultExts' is done before

56 -- It's important that 'setDefaultExts' is done before

58 -- 'parsePragmasIntoDynFlags', because otherwise we might enable an

57 -- 'parsePragmasIntoDynFlags', because otherwise we might enable an

59 -- extension that was explicitly disabled in the file.

58 -- extension that was explicitly disabled in the file.

@@ -111,8 +110,7 @@ parseModule Config {..} path rawInput = liftIO $ do

111 prImportQualifiedPost =

110 prImportQualifiedPost =

112 GHC.xopt ImportQualifiedPost dynFlags,

111 GHC.xopt ImportQualifiedPost dynFlags,

113 prLiteralPrefix = T.pack literalPrefix,

112 prLiteralPrefix = T.pack literalPrefix,

114− prLiteralSuffix = T.pack literalSuffix,

113+ prLiteralSuffix = T.pack literalSuffix

115− prIndent = indent

116 }

114 }

117 return (warnings, r)

115 return (warnings, r)

118

116

src/Ormolu/Parser/CommentStream.hs+3−15

@@ -28,7 +28,7 @@ import qualified Lexer as GHC

28import Ormolu.Parser.Pragma

29import Ormolu.Parser.Shebang

30import Ormolu.Processing.Common

31−import Ormolu.Utils (onTheSameLine, showOutputable)

31+import Ormolu.Utils (showOutputable)

32import SrcLoc

33

34----------------------------------------------------------------------------

@@ -150,7 +150,6 @@ isMultilineComment (Comment _ (x :| _)) = "{-" `L.isPrefixOf` x

150

151-- | Detect and extract stack header if it is present.

152extractStackHeader ::

153− -- | Comment stream to analyze

154 [RealLocated String] ->

153 [RealLocated String] ->

155 ([RealLocated String], Maybe (RealLocated Comment))

154 ([RealLocated String], Maybe (RealLocated Comment))

156extractStackHeader = \case

155extractStackHeader = \case

@@ -166,9 +165,7 @@ extractStackHeader = \case

166

165

167-- | Extract pragmas and their associated comments.

166-- | Extract pragmas and their associated comments.

168extractPragmas ::

167extractPragmas ::

169− -- | Input

170 String ->

168 String ->

171− -- | Comment stream to analyze

172 [RealLocated String] ->

169 [RealLocated String] ->

173 ([RealLocated Comment], [([RealLocated Comment], Pragma)])

170 ([RealLocated Comment], [([RealLocated Comment], Pragma)])

174extractPragmas input = go initialLs id id

171extractPragmas input = go initialLs id id

@@ -182,17 +179,8 @@ extractPragmas input = go initialLs id id

182 let (ls', x') = mkComment ls x

179 let (ls', x') = mkComment ls x

183 in go ls' (csSoFar . (x' :)) pragmasSoFar xs

180 in go ls' (csSoFar . (x' :)) pragmasSoFar xs

184 Just pragma ->

181 Just pragma ->

185− let combined ys = (csSoFar ys, pragma)

182+ let combined = (csSoFar [], pragma)

186− go' ls' ys rest = go ls' id (pragmasSoFar . (combined ys :)) rest

183+ in go ls id (pragmasSoFar . (combined :)) xs

187− in case xs of

188− [] -> go' ls [] xs

189− (y : ys) ->

190− let (ls', y') = mkComment ls y

191− in if onTheSameLine

192− (RealSrcSpan (getRealSrcSpan x))

193− (RealSrcSpan (getRealSrcSpan y))

194− then go' ls' [y'] ys

195− else go' ls [] xs

196

184

197-- | Get a 'String' from 'GHC.AnnotationComment'.

185-- | Get a 'String' from 'GHC.AnnotationComment'.

198unAnnotationComment :: GHC.AnnotationComment -> Maybe String

186unAnnotationComment :: GHC.AnnotationComment -> Maybe String

src/Ormolu/Parser/Result.hs+1−3

@@ -35,9 +35,7 @@ data ParseResult = ParseResult

35 -- | Literal prefix

36 prLiteralPrefix :: Text,

37 -- | Literal suffix

38− prLiteralSuffix :: Text,

38+ prLiteralSuffix :: Text

39− -- | Indentation level, can be non-zero in case of region formatting

40− prIndent :: Int

41 }

39 }

42

40

43-- | Pretty-print a 'ParseResult'.

41-- | Pretty-print a 'ParseResult'.

src/Ormolu/Printer.hs+1−1

@@ -23,7 +23,7 @@ printModule ParseResult {..} =

23 prLiteralPrefix <> region <> prLiteralSuffix

24 where

25 region =

26− postprocess prIndent $

26+ postprocess $

27 runR

28 ( p_hsModule

29 prStackHeader

src/Ormolu/Printer/Comments.hs+2−2

@@ -154,7 +154,6 @@ needsNewlineBefore ::

154 -- | Last printed comment span

155 Maybe SpanMark ->

156 Bool

157−needsNewlineBefore _ (Just (HaddockSpan _ _)) = True

158needsNewlineBefore l mlastMark =

157needsNewlineBefore l mlastMark =

159 case spanMarkSpan <$> mlastMark of

158 case spanMarkSpan <$> mlastMark of

160 Nothing -> False

159 Nothing -> False

@@ -239,7 +238,8 @@ commentFollowsElt ref mnSpn meSpn mlastMark (L l comment) =

239 -- lexemes in front of it and goes right after the previous comment.

238 -- lexemes in front of it and goes right after the previous comment.

240 not (hasAtomsBefore comment)

239 not (hasAtomsBefore comment)

241 && ( case mlastMark of

240 && ( case mlastMark of

242− Just (HaddockSpan _ _) -> False

241+ Just (HaddockSpan _ spn) ->

242+ srcSpanEndLine spn + 1 == srcSpanStartLine l

243 Just (CommentSpan spn) ->

244 srcSpanEndLine spn + 1 == srcSpanStartLine l

245 _ -> False

src/Ormolu/Printer/Meat/Declaration.hs+4−14

@@ -85,6 +85,9 @@ isDocumented = any (isHaddock . unLoc)

85 isHaddock _ = False

86

87-- | Group relevant declarations together.

88+--

89+-- Add a declaration to a group iff it is relevant to either the first or

90+-- the preceding declaration in the group.

88groupDecls :: [LHsDecl GhcPs] -> [NonEmpty (LHsDecl GhcPs)]

91groupDecls :: [LHsDecl GhcPs] -> [NonEmpty (LHsDecl GhcPs)]

89groupDecls [] = []

92groupDecls [] = []

90groupDecls (l@(L _ DocNext) : xs) =

93groupDecls (l@(L _ DocNext) : xs) =

@@ -97,8 +100,7 @@ groupDecls (header : xs) =

97 let (grp, rest) = flip span (zip (header : xs) xs) $ \(previous, current) ->

100 let (grp, rest) = flip span (zip (header : xs) xs) $ \(previous, current) ->

98 let relevantToHdr = groupedDecls header current

101 let relevantToHdr = groupedDecls header current

99 relevantToPrev = groupedDecls previous current

102 relevantToPrev = groupedDecls previous current

100− isDeclSeries = declSeries previous current

101− in isDeclSeries || relevantToHdr || relevantToPrev

103+ in relevantToHdr || relevantToPrev

102 in (header :| map snd grp) : groupDecls (map snd rest)

104 in (header :| map snd grp) : groupDecls (map snd rest)

103

105

104p_hsDecl :: FamilyStyle -> HsDecl GhcPs -> R ()

106p_hsDecl :: FamilyStyle -> HsDecl GhcPs -> R ()

@@ -195,18 +197,6 @@ groupedDecls (L l_x x') (L l_y y') =

195 (_, DocPrev) -> True

197 (_, DocPrev) -> True

196 _ -> False

198 _ -> False

197

199

198−-- | Detect declaration series that should not have blanks between them.

199−declSeries ::

200− LHsDecl GhcPs ->

201− LHsDecl GhcPs ->

202− Bool

203−declSeries (L _ x) (L _ y) =

204− case (x, y) of

205− ( SigD NoExtField (TypeSig NoExtField _ _),

206− SigD NoExtField (TypeSig NoExtField _ _)

207− ) -> True

208− _ -> False

209−

210intersects :: Ord a => [a] -> [a] -> Bool

200intersects :: Ord a => [a] -> [a] -> Bool

211intersects a b = go (sort a) (sort b)

201intersects a b = go (sort a) (sort b)

212 where

202 where

src/Ormolu/Printer/Meat/Declaration.hs-boot+1

@@ -9,4 +9,5 @@ import Ormolu.Printer.Combinators

9import Ormolu.Printer.Meat.Common

10

11p_hsDecls :: FamilyStyle -> [LHsDecl GhcPs] -> R ()

12+

12p_hsDeclsRespectGrouping :: FamilyStyle -> [LHsDecl GhcPs] -> R ()

13p_hsDeclsRespectGrouping :: FamilyStyle -> [LHsDecl GhcPs] -> R ()

src/Ormolu/Printer/Meat/Declaration/Value.hs+21−27

@@ -353,14 +353,7 @@ p_hsCmdTop = \case

353 HsCmdTop NoExtField cmd -> located cmd p_hsCmd

354 XCmdTop x -> noExtCon x

355

356−-- | Render an expression preserving blank lines between such consecutive

357−-- expressions found in the original source code.

358−withSpacing ::

356+withSpacing :: Data a => (a -> R ()) -> Located a -> R ()

359− -- | Rendering function

360− (a -> R ()) ->

361− -- | Entity to render

362− Located a ->

363− R ()

364withSpacing f l = located l $ \x -> do

357withSpacing f l = located l $ \x -> do

365 case getLoc l of

358 case getLoc l of

366 UnhelpfulSpan _ -> f x

359 UnhelpfulSpan _ -> f x

@@ -471,24 +464,30 @@ gatherStmtBlock (XParStmtBlock x) = noExtCon x

471p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()

464p_hsLocalBinds :: HsLocalBindsLR GhcPs GhcPs -> R ()

472p_hsLocalBinds = \case

465p_hsLocalBinds = \case

473 HsValBinds NoExtField (ValBinds NoExtField bag lsigs) -> do

466 HsValBinds NoExtField (ValBinds NoExtField bag lsigs) -> do

467+ let ssStart =

468+ either

469+ (srcSpanStart . getLoc)

470+ (srcSpanStart . getLoc)

471+ items =

472+ (Left <$> bagToList bag) ++ (Right <$> lsigs)

473+ p_item (Left x) = located x p_valDecl

474+ p_item (Right x) = located x p_sigDecl

474 -- When in a single-line layout, there is a chance that the inner

475 -- When in a single-line layout, there is a chance that the inner

475 -- elements will also contain semicolons and they will confuse the

476 -- elements will also contain semicolons and they will confuse the

476 -- parser. so we request braces around every element except the last.

477 -- parser. so we request braces around every element except the last.

477 br <- layoutToBraces <$> getLayout

478 br <- layoutToBraces <$> getLayout

478− let items =

479+ sitcc $

479− let injectLeft (L l x) = L l (Left x)

480+ sepSemi

480− injectRight (L l x) = L l (Right x)

481+ ( \(p, i) ->

481− in (injectLeft <$> bagToList bag) ++ (injectRight <$> lsigs)

482+ ( case p of

482− positionToBracing = \case

483− SinglePos -> id

483+ SinglePos -> id

484− FirstPos -> br

484+ FirstPos -> br

485− MiddlePos -> br

485+ MiddlePos -> br

486− LastPos -> id

486+ LastPos -> id

487− p_item' (p, item) =

487+ )

488− positionToBracing p $

488+ (p_item i)

489− withSpacing (either p_valDecl p_sigDecl) item

489+ )

490− binds = sortOn (srcSpanStart . getLoc) items

490+ (attachRelativePos $ sortOn ssStart items)

491− sitcc $ sepSemi p_item' (attachRelativePos binds)

492 HsValBinds NoExtField _ -> notImplemented "HsValBinds"

491 HsValBinds NoExtField _ -> notImplemented "HsValBinds"

493 HsIPBinds NoExtField (IPBinds NoExtField xs) ->

492 HsIPBinds NoExtField (IPBinds NoExtField xs) ->

494 -- Second argument of IPBind is always Left before type-checking.

493 -- Second argument of IPBind is always Left before type-checking.

@@ -613,11 +612,6 @@ p_hsExpr' s = \case

613 breakpoint

612 breakpoint

614 inci $ do

613 inci $ do

615 txt "@"

614 txt "@"

616− -- Insert a space when the type is represented as a TH splice to avoid

617− -- gluing @ and $ together.

618− case unLoc (hswc_body a) of

619− HsSpliceTy {} -> space

620− _ -> return ()

621 located (hswc_body a) p_hsType

615 located (hswc_body a) p_hsType

622 OpApp NoExtField x op y -> do

616 OpApp NoExtField x op y -> do

623 let opTree = OpBranch (exprOpTree x) op (exprOpTree y)

617 let opTree = OpBranch (exprOpTree x) op (exprOpTree y)

src/Ormolu/Printer/Meat/Declaration/Value.hs-boot+4

@@ -11,7 +11,11 @@ import GHC

11import Ormolu.Printer.Combinators

12

13p_valDecl :: HsBindLR GhcPs GhcPs -> R ()

14+

14p_pat :: Pat GhcPs -> R ()

15p_pat :: Pat GhcPs -> R ()

16+

15p_hsExpr :: HsExpr GhcPs -> R ()

17p_hsExpr :: HsExpr GhcPs -> R ()

18+

16p_hsSplice :: HsSplice GhcPs -> R ()

19p_hsSplice :: HsSplice GhcPs -> R ()

20+

17p_stringLit :: String -> R ()

21p_stringLit :: String -> R ()

src/Ormolu/Printer/Meat/Module.hs+2−2

@@ -11,7 +11,7 @@ where

11import Control.Monad

12import qualified Data.Text as T

13import GHC

14−import Ormolu.Imports (normalizeImports)

14+import Ormolu.Imports

15import Ormolu.Parser.CommentStream

16import Ormolu.Parser.Pragma

17import Ormolu.Parser.Shebang

@@ -69,7 +69,7 @@ p_hsModule mstackHeader shebangs pragmas qualifiedPost HsModule {..} = do

69 txt "where"

70 newline

71 newline

72− forM_ (normalizeImports hsmodImports) (located' (p_hsmodImport qualifiedPost))

72+ forM_ (sortImports hsmodImports) (located' (p_hsmodImport qualifiedPost))

73 newline

74 switchLayout (getLoc <$> hsmodDecls) $ do

75 p_hsDecls Free hsmodDecls

src/Ormolu/Processing/Postprocess.hs+2−10

@@ -1,4 +1,3 @@

1−{-# LANGUAGE OverloadedStrings #-}

2{-# LANGUAGE ViewPatterns #-}

1{-# LANGUAGE ViewPatterns #-}

3

2

4-- | Postprocessing for the results of printing.

3-- | Postprocessing for the results of printing.

@@ -13,19 +12,12 @@ import Ormolu.Processing.Common

13import qualified Ormolu.Processing.Cpp as Cpp

12import qualified Ormolu.Processing.Cpp as Cpp

14

13

15-- | Postprocess output of the formatter.

14-- | Postprocess output of the formatter.

16−postprocess ::

15+postprocess :: Text -> Text

17− -- | Desired indentation level

18− Int ->

19− -- | Input to process

20− Text ->

21− Text

22−postprocess indent =

16+postprocess =

23 T.unlines

17 T.unlines

24− . fmap indentLine

25 . fmap Cpp.unmaskLine

18 . fmap Cpp.unmaskLine

26 . filter (not . magicComment)

19 . filter (not . magicComment)

27 . T.lines

20 . T.lines

28 where

21 where

29 magicComment (T.stripStart -> x) =

22 magicComment (T.stripStart -> x) =

30 x == startDisabling || x == endDisabling

23 x == startDisabling || x == endDisabling

31− indentLine x = T.replicate indent " " <> x

src/Ormolu/Processing/Preprocess.hs+2−1

@@ -11,7 +11,8 @@ where

11import Control.Monad

12import Data.Char (isSpace)

13import qualified Data.List as L

14−import Data.Maybe (isJust, maybeToList)

14+import Data.Maybe (isJust)

15+import Data.Maybe (maybeToList)

15import FastString

16import FastString

16import Ormolu.Config (RegionDeltas (..))

17import Ormolu.Config (RegionDeltas (..))

17import Ormolu.Parser.Shebang (isShebang)

18import Ormolu.Parser.Shebang (isShebang)

src/Ormolu/Utils.hs+1−15

@@ -1,6 +1,5 @@

1{-# LANGUAGE LambdaCase #-}

2{-# LANGUAGE OverloadedStrings #-}

3−{-# LANGUAGE ViewPatterns #-}

4

3

5-- | Random utilities used by the code.

4-- | Random utilities used by the code.

6module Ormolu.Utils

5module Ormolu.Utils

@@ -16,14 +15,12 @@ module Ormolu.Utils

16 separatedByBlank,

15 separatedByBlank,

17 separatedByBlankNE,

16 separatedByBlankNE,

18 onTheSameLine,

17 onTheSameLine,

19− removeIndentation,

20 )

18 )

21where

19where

22

20

23−import Data.Char (isSpace)

24import Data.List (dropWhileEnd)

21import Data.List (dropWhileEnd)

25−import Data.List.NonEmpty (NonEmpty (..))

26import qualified Data.List.NonEmpty as NE

22import qualified Data.List.NonEmpty as NE

23+import Data.List.NonEmpty (NonEmpty (..))

27import Data.Maybe (fromMaybe)

24import Data.Maybe (fromMaybe)

28import Data.Text (Text)

25import Data.Text (Text)

29import qualified Data.Text as T

26import qualified Data.Text as T

@@ -142,14 +139,3 @@ separatedByBlankNE loc a b = separatedByBlank loc (NE.last a) (NE.head b)

142onTheSameLine :: SrcSpan -> SrcSpan -> Bool

139onTheSameLine :: SrcSpan -> SrcSpan -> Bool

143onTheSameLine a b =

140onTheSameLine a b =

144 isOneLineSpan (mkSrcSpan (srcSpanEnd a) (srcSpanStart b))

141 isOneLineSpan (mkSrcSpan (srcSpanEnd a) (srcSpanStart b))

145−

146−-- | Remove indentation from a given 'String'. Return the input with

147−-- indentation removed and the detected indentation level.

148−removeIndentation :: String -> (String, Int)

149−removeIndentation (lines -> xs) = (unlines (drop n <$> xs), n)

150− where

151− n = minimum (getIndent <$> xs)

152− getIndent y =

153− if all isSpace y

154− then 0

155− else length (takeWhile isSpace y)