e5bbfdd...master · ormolu

git.iko.soy/ormolu

28 files changed+159−53

since splitsnapshots

unifiedsplit

.buildkite/pipeline.yml+2−2 .github/workflows/binaries.yml+39 .github/workflows/build.sh+7 CHANGELOG.md+8 README.md+18−9 app/Main.hs+10−6 data/examples/declaration/signature/type/infix-promoted-type-constructor-out.hs−1 data/examples/declaration/signature/type/unrelated-out.hs+4 data/examples/declaration/signature/type/unrelated.hs+4 data/examples/declaration/value/function/implicit-params-out.hs+1 data/examples/declaration/value/function/implicit-params.hs+2 data/examples/other/argument-comment-out.hs−1 data/examples/other/cpp/separation-2b-out.hs−1 default.nix+7−10 expected-failures/Agda.txt+1−1 expected-failures/esqueleto.txt+1−1 expected-failures/hlint.txt+11 expected-failures/intero.txt+1−1 expected-failures/pandoc.txt+1−1 expected-failures/postgrest.txt+5 expected-failures/purescript.txt+2−2 expected-failures/tensorflow.txt+7 nix/nixpkgs/default.nix+7−3 ormolu.cabal+4−4 shell.nix+3−1 src/Ormolu/Printer/Meat/Declaration.hs+14−4 src/Ormolu/Printer/Meat/Declaration.hs-boot−1 src/Ormolu/Printer/Meat/Declaration/Value.hs-boot−4

.buildkite/pipeline.yml+2−2

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

33 command: |

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

55 timeout: 100

6− - label: Build and test with GHC 8.8.3

6+ - label: Build and test with GHC 8.8.4

77 command: |

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

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

99 timeout: 100

1010 - label: Build and test with GHC 8.10.1

1111 command: |

.github/workflows/binaries.ymlnew file+39

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

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.shnew file+7

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

1+set -e

3+cabal update

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

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

7+strip -s ormolu

CHANGELOG.md+8

@@ -1,3 +1,8 @@

1+## Unreleased

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

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

16## Ormolu 0.1.2.0

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

@@ -6,6 +11,9 @@

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

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

813

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

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

16+

917## Ormolu 0.1.1.0

1018

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

README.md+18−9

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

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

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

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

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

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

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

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

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

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

130130 criterion than just being valid Haskell modules.

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

132132

133−## Editor integration

134−

135−We know of the following editor integrations:

136−

137−* [Emacs][emacs-package]

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

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

140−

141133## Running on Hackage

142134

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

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

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

153145into Ormolu).

154146

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+

155163## Contributing

156164

157165See [CONTRIBUTING.md][contributing].

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

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

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

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

app/Main.hs+10−6

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

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

6262 exitWith (ExitFailure 101)

6363 Just inputFile -> do

64− r <- ormoluFile config inputFile

64+ originalInput <- TIO.readFile inputFile

65+ formattedInput <- ormoluFile config inputFile

6566 case mode of

6667 Stdout ->

67− TIO.putStr r

68− InPlace ->

69− TIO.writeFile inputFile r

68+ TIO.putStr formattedInput

69+ InPlace -> do

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

7075 Check -> do

71− r' <- TIO.readFile inputFile

72− when (r /= r') $

76+ when (formattedInput /= originalInput) $

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

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

7579 -- 'notImplemented'.

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

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

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

2−

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

data/examples/declaration/signature/type/unrelated-out.hsnew file+4

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

1+clientFunc1 :: SomeType1

2+clientFunc2 :: SomeType2

3+clientFunc3 :: SomeType3

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

data/examples/declaration/signature/type/unrelated.hsnew file+4

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

1+clientFunc1 :: SomeType1

2+clientFunc2 :: SomeType2

3+clientFunc3 :: SomeType3

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

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

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

11{-# LANGUAGE ImplicitParams #-}

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

4+sortBy = undefined

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

67sort = sortBy ?cmp

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

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

11{-# LANGUAGE ImplicitParams #-}

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

4+sortBy = undefined

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

57sort = sortBy ?cmp

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

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

99 -- | Foo

1010 Int ->

1111 Int

12−

1312foo ::

1413 Foo a =>

1514 -- | Foo

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

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

11ffff, ffffffff :: Natural

2−

32#ifdef HASKELL_ZIP_DEV_MODE

43ffff = 200

54ffffffff = 5000

default.nix+7−10

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

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

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

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

2+, system ? builtins.currentSystem

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

34}:

56let

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

1617 };

1718 ormoluOverlay = self: super: {

1819 "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− } {});

2520 };

2621 ormolize = import ./nix/ormolize {

2722 inherit pkgs;

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

3328 "distributed-process"

3429 "esqueleto"

3530 "fay"

31+ "hlint"

3632 "idris"

3733 "intero"

3834 "leksah"

39− "lens"

4035 "pandoc"

4136 "pipes"

37+ "postgrest"

4238 "purescript"

43− ];

39+ "tensorflow"

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

4441 ormolizedPackages = doCheck:

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

4643 package = p;

expected-failures/Agda.txt+1−1

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

11Formatting is not idempotent:

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

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

33 before: " = (check_ac"

44 after: " =\n "

55Please, consider reporting the bug.

expected-failures/esqueleto.txt+1−1

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

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

55The GHC parser (in Haddock mode) failed:

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

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

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

expected-failures/hlint.txtnew file+11

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

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.

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/intero.txt+1−1

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

11Formatting is not idempotent:

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

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

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

44 after: "text \"Try\"\n "

55Please, consider reporting the bug.

expected-failures/pandoc.txt+1−1

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

33 parse error on input `import'

55Formatting is not idempotent:

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

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

77 before: ".softbreak <$ endlin"

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

99Please, consider reporting the bug.

expected-failures/postgrest.txtnew file+5

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

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 @@

11The GHC parser (in Haddock mode) failed:

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

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

33 Invalid type signature: pattern ValueDecl :: ...

44Perhaps you meant to use PatternSynonyms?

66The GHC parser (in Haddock mode) failed:

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

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

88 Invalid type signature: pattern NullSourceSpan :: ...

99Perhaps you meant to use PatternSynonyms?

1010

expected-failures/tensorflow.txtnew file+7

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

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

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

3+ parse error on input `->'

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+7−3

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

1+{ system ? builtins.currentSystem }:

12let

2− rev = "807ca93fadd5197c2260490de0c76e500562dc05";

3− sha256 = "10yq8bnls77fh3pk5chkkb1sv5lbdgyk1rr2v9xn71rr1k2x563p";

3+ rev = "32b46dd897ab2143a609988a04d87452f0bbef59";

4+ sha256 = "1gzfrpjnr1bz9zljsyg3a4zrhk8r927sz761mrgcg56dwinkhpjk";

45 nixpkgs = builtins.fetchTarball {

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

67 inherit sha256;

78 };

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

9+ pkgs = import nixpkgs {

10+ inherit system;

11+ config.allowUnfree = true;

12+ };

913in pkgs

ormolu.cabal+4−4

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

11cabal-version: 1.18

22name: ormolu

3−version: 0.1.1.0

3+version: 0.1.2.0

44license: BSD3

55license-file: LICENSE.md

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

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

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

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

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

1010synopsis: A formatter for Haskell source code

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

119119 base >=4.12 && <5.0,

120120 bytestring >=0.2 && <0.11,

121121 containers >=0.5 && <0.7,

122− dlist >=0.8 && <0.9,

122+ dlist >=0.8 && <2.0,

123123 exceptions >=0.6 && <0.11,

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

125125 mtl >=2.0 && <3.0,

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

144144 base >=4.12 && <5.0,

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

146146 gitrev >=1.3 && <1.4,

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

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

148148 ormolu -any,

149149 text >=0.2 && <1.3

150150

shell.nix+3−1

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

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

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

2+, system ? builtins.currentSystem

3+}:

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

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

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

8585 isHaddock _ = False

8686

8787-- | 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.

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

9289groupDecls [] = []

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

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

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

10198 let relevantToHdr = groupedDecls header current

10299 relevantToPrev = groupedDecls previous current

103− in relevantToHdr || relevantToPrev

100+ isDeclSeries = declSeries previous current

101+ in isDeclSeries || relevantToHdr || relevantToPrev

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

105103

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

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

197195 (_, DocPrev) -> True

198196 _ -> False

199197

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+

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

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

202212 where

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

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

99import Ormolu.Printer.Meat.Common

1010

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

12−

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

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

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

1111import Ormolu.Printer.Combinators

1212

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

14−

1514p_pat :: Pat GhcPs -> R ()

16−

1715p_hsExpr :: HsExpr GhcPs -> R ()

18−

1916p_hsSplice :: HsSplice GhcPs -> R ()

20−

2117p_stringLit :: String -> R ()