Add space after '--' in single-line comments

fourmolu · Nov 13, 2022 · a9c377b · a9c377b
1 parent c550536
commit a9c377b
Show file tree

Hide file tree

Showing 24 changed files with 104 additions and 86 deletions.
diff --git a/changelog.d/single-line-space.md b/changelog.d/single-line-space.md
@@ -0,0 +1 @@
+Don't consider the first space after `--` part of the comment ([#255](https://github.com/fourmolu/fourmolu/pull/255))
diff --git a/data/examples/module-header/leading-empty-line-four-out.hs b/data/examples/module-header/leading-empty-line-four-out.hs
@@ -1,12 +1,12 @@
-{- |
- Module      :  Text.Megaparsec
- Copyright   :  © 2015–2019 Megaparsec contributors
-                © 2007 Paolo Martini
-                © 1999–2001 Daan Leijen
- License     :  FreeBSD
+{- | 
+Module      :  Text.Megaparsec
+Copyright   :  © 2015–2019 Megaparsec contributors
+               © 2007 Paolo Martini
+               © 1999–2001 Daan Leijen
+License     :  FreeBSD
 
- Maintainer  :  Mark Karpov <markkarpov92@gmail.com>
- Stability   :  experimental
- Portability :  portable
+Maintainer  :  Mark Karpov <markkarpov92@gmail.com>
+Stability   :  experimental
+Portability :  portable
 -}
 module Main where
diff --git a/data/examples/module-header/named-section-four-out.hs b/data/examples/module-header/named-section-four-out.hs
@@ -8,7 +8,7 @@ module Magic (
 )
 where
 
-{- $explanation
+{- $explanation 
 
- Here it goes.
+Here it goes.
 -}
diff --git a/data/examples/other/comment-spacing-four-out.hs b/data/examples/other/comment-spacing-four-out.hs
@@ -1,7 +1,7 @@
--- |Something.
+-- | Something.
 foo ::
-    -- |Foo.
+    -- | Foo.
     Int ->
-    -- |Bar.
+    -- | Bar.
     IO ()
 foo _ = pure () -- comment
diff --git a/data/examples/other/comment-spacing-out.hs b/data/examples/other/comment-spacing-out.hs
@@ -1,7 +1,7 @@
--- |Something.
+-- | Something.
 foo ::
-  -- |Foo.
+  -- | Foo.
   Int ->
-  -- |Bar.
+  -- | Bar.
   IO ()
 foo _ = pure () -- comment
diff --git a/data/examples/other/comment-style-transform-four-out.hs b/data/examples/other/comment-style-transform-four-out.hs
@@ -1,4 +1,4 @@
-{- |
+{- | 
 Module:      Data.Aeson.TH
 Copyright:   (c) 2011-2016 Bryan O'Sullivan
              (c) 2011 MailRank, Inc.
@@ -8,7 +8,7 @@ Portability: portable
 -}
 module Main where
 
-{- |
+{- | 
 
 Here is a snippet:
 

diff --git a/data/examples/other/comment-style-transform-out.hs b/data/examples/other/comment-style-transform-out.hs
@@ -1,17 +1,17 @@
 -- |
---Module:      Data.Aeson.TH
---Copyright:   (c) 2011-2016 Bryan O'Sullivan
---             (c) 2011 MailRank, Inc.
---License:     BSD3
---Stability:   experimental
---Portability: portable
+-- Module:      Data.Aeson.TH
+-- Copyright:   (c) 2011-2016 Bryan O'Sullivan
+--              (c) 2011 MailRank, Inc.
+-- License:     BSD3
+-- Stability:   experimental
+-- Portability: portable
 module Main where
 
 -- |
 --
---Here is a snippet:
+-- Here is a snippet:
 --
---@
---x = y + 2
---@
+-- @
+-- x = y + 2
+-- @
 x = y + 2
diff --git a/data/examples/other/following-comment-last-3-four-out.hs b/data/examples/other/following-comment-last-3-four-out.hs
@@ -3,5 +3,5 @@ module Main where
 -- | Another datatype...
 data D'
 {- ^ ...with two docstrings.
- even on second line
+even on second line
 -}
diff --git a/data/examples/other/haddock-sections-four-out.hs b/data/examples/other/haddock-sections-four-out.hs
@@ -1,9 +1,9 @@
 {- $weird #anchor#
 
- Section 1
+Section 1
 -}
 
-{- $normal
+{- $normal 
 
- Section 2
+Section 2
 -}
diff --git a/data/fourmolu/haddock-style/output-HaddockMultiLine-module=HaddockMultiLine.hs b/data/fourmolu/haddock-style/output-HaddockMultiLine-module=HaddockMultiLine.hs
@@ -1,5 +1,5 @@
 {- | This is a test multiline
- module haddock
+module haddock
 -}
 module Foo where
 
@@ -10,22 +10,22 @@ single1 :: Int
 single2 :: Int
 
 {- | This is a multiline
- function haddock
+function haddock
 -}
 multi1 :: Int
 
-{- |
+{- | 
 This is a multiline
 function haddock
 -}
 multi2 :: Int
 
 {- | This is a haddock
 
- with two consecutive newlines
+with two consecutive newlines
 
 
- https://github.com/fourmolu/fourmolu/issues/172
+https://github.com/fourmolu/fourmolu/issues/172
 -}
 foo :: Int
 foo = 42
diff --git a/data/fourmolu/haddock-style/output-HaddockMultiLine-module=HaddockMultiLineCompact.hs b/data/fourmolu/haddock-style/output-HaddockMultiLine-module=HaddockMultiLineCompact.hs
@@ -1,5 +1,5 @@
 {-| This is a test multiline
- module haddock
+module haddock
 -}
 module Foo where
 
@@ -10,22 +10,22 @@ single1 :: Int
 single2 :: Int
 
 {- | This is a multiline
- function haddock
+function haddock
 -}
 multi1 :: Int
 
-{- |
+{- | 
 This is a multiline
 function haddock
 -}
 multi2 :: Int
 
 {- | This is a haddock
 
- with two consecutive newlines
+with two consecutive newlines
 
 
- https://github.com/fourmolu/fourmolu/issues/172
+https://github.com/fourmolu/fourmolu/issues/172
 -}
 foo :: Int
 foo = 42
diff --git a/data/fourmolu/haddock-style/output-HaddockMultiLine-module=HaddockSingleLine.hs b/data/fourmolu/haddock-style/output-HaddockMultiLine-module=HaddockSingleLine.hs
@@ -9,22 +9,22 @@ single1 :: Int
 single2 :: Int
 
 {- | This is a multiline
- function haddock
+function haddock
 -}
 multi1 :: Int
 
-{- |
+{- | 
 This is a multiline
 function haddock
 -}
 multi2 :: Int
 
 {- | This is a haddock
 
- with two consecutive newlines
+with two consecutive newlines
 
 
- https://github.com/fourmolu/fourmolu/issues/172
+https://github.com/fourmolu/fourmolu/issues/172
 -}
 foo :: Int
 foo = 42
diff --git a/data/fourmolu/haddock-style/output-HaddockMultiLine.hs b/data/fourmolu/haddock-style/output-HaddockMultiLine.hs
@@ -1,5 +1,5 @@
 {- | This is a test multiline
- module haddock
+module haddock
 -}
 module Foo where
 
@@ -10,22 +10,22 @@ single1 :: Int
 single2 :: Int
 
 {- | This is a multiline
- function haddock
+function haddock
 -}
 multi1 :: Int
 
-{- |
+{- | 
 This is a multiline
 function haddock
 -}
 multi2 :: Int
 
 {- | This is a haddock
 
- with two consecutive newlines
+with two consecutive newlines
 
 
- https://github.com/fourmolu/fourmolu/issues/172
+https://github.com/fourmolu/fourmolu/issues/172
 -}
 foo :: Int
 foo = 42
diff --git a/data/fourmolu/haddock-style/output-HaddockMultiLineCompact-module=HaddockMultiLine.hs b/data/fourmolu/haddock-style/output-HaddockMultiLineCompact-module=HaddockMultiLine.hs
@@ -1,5 +1,5 @@
 {- | This is a test multiline
- module haddock
+module haddock
 -}
 module Foo where
 
@@ -10,22 +10,22 @@ single1 :: Int
 single2 :: Int
 
 {-| This is a multiline
- function haddock
+function haddock
 -}
 multi1 :: Int
 
-{-|
+{-| 
 This is a multiline
 function haddock
 -}
 multi2 :: Int
 
 {-| This is a haddock
 
- with two consecutive newlines
+with two consecutive newlines
 
 
- https://github.com/fourmolu/fourmolu/issues/172
+https://github.com/fourmolu/fourmolu/issues/172
 -}
 foo :: Int
 foo = 42
diff --git a/data/fourmolu/haddock-style/output-HaddockMultiLineCompact-module=HaddockMultiLineCompact.hs b/data/fourmolu/haddock-style/output-HaddockMultiLineCompact-module=HaddockMultiLineCompact.hs
@@ -1,5 +1,5 @@
 {-| This is a test multiline
- module haddock
+module haddock
 -}
 module Foo where
 
@@ -10,22 +10,22 @@ single1 :: Int
 single2 :: Int
 
 {-| This is a multiline
- function haddock
+function haddock
 -}
 multi1 :: Int
 
-{-|
+{-| 
 This is a multiline
 function haddock
 -}
 multi2 :: Int
 
 {-| This is a haddock
 
- with two consecutive newlines
+with two consecutive newlines
 
 
- https://github.com/fourmolu/fourmolu/issues/172
+https://github.com/fourmolu/fourmolu/issues/172
 -}
 foo :: Int
 foo = 42
diff --git a/data/fourmolu/haddock-style/output-HaddockMultiLineCompact-module=HaddockSingleLine.hs b/data/fourmolu/haddock-style/output-HaddockMultiLineCompact-module=HaddockSingleLine.hs
@@ -9,22 +9,22 @@ single1 :: Int
 single2 :: Int
 
 {-| This is a multiline
- function haddock
+function haddock
 -}
 multi1 :: Int
 
-{-|
+{-| 
 This is a multiline
 function haddock
 -}
 multi2 :: Int
 
 {-| This is a haddock
 
- with two consecutive newlines
+with two consecutive newlines
 
 
- https://github.com/fourmolu/fourmolu/issues/172
+https://github.com/fourmolu/fourmolu/issues/172
 -}
 foo :: Int
 foo = 42
diff --git a/data/fourmolu/haddock-style/output-HaddockMultiLineCompact.hs b/data/fourmolu/haddock-style/output-HaddockMultiLineCompact.hs
@@ -1,5 +1,5 @@
 {-| This is a test multiline
- module haddock
+module haddock
 -}
 module Foo where
 
@@ -10,22 +10,22 @@ single1 :: Int
 single2 :: Int
 
 {-| This is a multiline
- function haddock
+function haddock
 -}
 multi1 :: Int
 
-{-|
+{-| 
 This is a multiline
 function haddock
 -}
 multi2 :: Int
 
 {-| This is a haddock
 
- with two consecutive newlines
+with two consecutive newlines
 
 
- https://github.com/fourmolu/fourmolu/issues/172
+https://github.com/fourmolu/fourmolu/issues/172
 -}
 foo :: Int
 foo = 42
diff --git a/data/fourmolu/haddock-style/output-HaddockSingleLine-module=HaddockMultiLine.hs b/data/fourmolu/haddock-style/output-HaddockSingleLine-module=HaddockMultiLine.hs
@@ -1,5 +1,5 @@
 {- | This is a test multiline
- module haddock
+module haddock
 -}
 module Foo where
 
@@ -14,8 +14,8 @@ single2 :: Int
 multi1 :: Int
 
 -- |
---This is a multiline
---function haddock
+-- This is a multiline
+-- function haddock
 multi2 :: Int
 
 -- | This is a haddock