Skip to content

Closing few issues #367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 26, 2021
Merged

Closing few issues #367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
67204c2
Add regression test showing that issue #282 does no longer exist
EncodePanda Apr 23, 2021
7fdb769
Add regression tests showing that issue #273 is fixed
EncodePanda Apr 23, 2021
1d78fb3
Add regression test for issue #198
EncodePanda Apr 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions stylish-haskell.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@ Test-suite stylish-haskell-tests
Language.Haskell.Stylish.Step.TrailingWhitespace.Tests
Language.Haskell.Stylish.Step.UnicodeSyntax
Language.Haskell.Stylish.Step.UnicodeSyntax.Tests
Language.Haskell.Stylish.Regressions
Language.Haskell.Stylish.Tests
Language.Haskell.Stylish.Tests.Util
Language.Haskell.Stylish.Util
Expand Down
35 changes: 35 additions & 0 deletions tests/Language/Haskell/Stylish/Regressions.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{-# LANGUAGE OverloadedLists #-}
{-# LANGUAGE OverloadedStrings #-}
module Language.Haskell.Stylish.Regressions
( tests
) where

import Language.Haskell.Stylish.Step.Imports
import Language.Haskell.Stylish.Tests.Util (testStep)
import Test.Framework (Test, testGroup)
import Test.Framework.Providers.HUnit (testCase)
import Test.HUnit (Assertion, (@=?))


tests :: Test
tests = testGroup "Language.Haskell.Stylish.Regressions"
[ testCase "case 00 (#198)" case00
]
-- | Error parsing '(,) #198
--
-- See https://github.com/haskell/stylish-haskell/issues/198
case00 :: Assertion
case00 = expected @=? testStep (step (Just 80) $ importStepConfig Global) input
where
input = unlines
[ "{-# LANGUAGE TemplateHaskell #-}"
, ""
, "import Language.Haskell.TH.Syntax"
, ""
, "main = print $ showName '(,)"
]

expected = input

importStepConfig :: ImportAlign -> Options
importStepConfig align = defaultOptions { importAlign = align }
68 changes: 68 additions & 0 deletions tests/Language/Haskell/Stylish/Step/Data/Tests.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ tests = testGroup "Language.Haskell.Stylish.Step.Data.Tests"
, testCase "case 58" case58
, testCase "case 59" case59
, testCase "case 60" case60
, testCase "case 61 (issue 282)" case61
, testCase "case 62 (issue 273)" case62
]

case00 :: Assertion
Expand Down Expand Up @@ -1309,6 +1311,72 @@ case60 = assertSnippet (step defaultConfig)
[ "data Foo = forall a . Bar a" ]
[ "data Foo = forall a. Bar a" ]

-- | Formatting duplicates haddock comments #282
--
-- Regression test for https://github.com/haskell/stylish-haskell/issues/282
case61 :: Assertion
case61 = expected @=? testStep (step sameIndentStyle) input
where
input = unlines
[ "module Herp where"
, ""
, "data Game = Game { _board :: Board -- ^ Board state"
, " , _time :: Int -- ^ Time elapsed"
, " , _paused :: Bool -- ^ Playing vs. paused"
, " , _speed :: Float -- ^ Speed in [0..1]"
, " , _interval :: TVar Int -- ^ Interval kept in TVar"
, " }"
]

expected = unlines
[ "module Herp where"
, ""
, "data Game = Game"
, " { _board :: Board"
, " -- ^ Board state"
, " , _time :: Int"
, " -- ^ Time elapsed"
, " , _paused :: Bool"
, " -- ^ Playing vs. paused"
, " , _speed :: Float"
, " -- ^ Speed in [0..1]"
, " , _interval :: TVar Int"
, " -- ^ Interval kept in TVar"
, " }"
]

-- | Comment issues with record formatting #273
--
-- Regression test for https://github.com/haskell/stylish-haskell/issues/273
case62 :: Assertion
case62 = expected @=? testStep (step sameIndentStyle) input
where
input = unlines
[ "module Herp where"
, ""
, "data Foo = Foo"
, " { -- | This is a comment above some line."
, " -- It can span multiple lines."
, " fooName :: String"
, " , fooAge :: Int"
, " -- ^ This is a comment below some line."
, " -- It can span multiple lines."
, " }"
]

expected = unlines
[ "module Herp where"
, ""
, "data Foo = Foo"
, " { -- | This is a comment above some line."
, " -- It can span multiple lines."
, " fooName :: String"
, " , fooAge :: Int"
, " -- ^ This is a comment below some line."
, " -- It can span multiple lines."
, " }"
]

sameSameStyle :: Config
sameSameStyle = Config SameLine SameLine 2 2 False True SameLine False True NoMaxColumns

Expand Down
2 changes: 2 additions & 0 deletions tests/TestSuite.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import qualified Language.Haskell.Stylish.Step.Tabs.Tests
import qualified Language.Haskell.Stylish.Step.TrailingWhitespace.Tests
import qualified Language.Haskell.Stylish.Step.UnicodeSyntax.Tests
import qualified Language.Haskell.Stylish.Tests
import qualified Language.Haskell.Stylish.Regressions


--------------------------------------------------------------------------------
Expand All @@ -40,4 +41,5 @@ main = defaultMain
, Language.Haskell.Stylish.Step.TrailingWhitespace.Tests.tests
, Language.Haskell.Stylish.Step.UnicodeSyntax.Tests.tests
, Language.Haskell.Stylish.Tests.tests
, Language.Haskell.Stylish.Regressions.tests
]