1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
|
-- | Tests contributed by Felix Mulder as part of
-- <https://github.com/jaspervdj/stylish-haskell/pull/293>.
module Language.Haskell.Stylish.Step.Imports.FelixTests
( tests
) where
--------------------------------------------------------------------------------
import Test.Framework (Test, testGroup)
import Test.Framework.Providers.HUnit (testCase)
import Test.HUnit (Assertion)
import GHC.Stack (HasCallStack, withFrozenCallStack)
import Prelude hiding (lines)
--------------------------------------------------------------------------------
import Language.Haskell.Stylish.Module
import Language.Haskell.Stylish.Step.Imports
import Language.Haskell.Stylish.Tests.Util (testStep', (@=??))
--------------------------------------------------------------------------------
tests :: Test
tests = testGroup "Language.Haskell.Stylish.Step.ImportsGHC"
[ testCase "Hello world" ex0
, testCase "Sorted simple" ex1
, testCase "Sorted import lists" ex2
, testCase "Sorted import lists and import decls" ex3
, testCase "Import constructor all" ex4
, testCase "Import constructor specific" ex5
, testCase "Import constructor specific sorted" ex6
, testCase "Imports step does not change rest of file" ex7
, testCase "Imports respect groups" ex8
, testCase "Imports respects whitespace between groups" ex9
, testCase "Doesn't add extra space after 'hiding'" ex10
, testCase "Should be able to format symbolic imports" ex11
, testCase "Able to merge equivalent imports" ex12
, testCase "Obeys max columns setting" ex13
, testCase "Obeys max columns setting with two in each" ex14
, testCase "Respects multiple groups" ex15
, testCase "Doesn't delete nullary imports" ex16
]
--------------------------------------------------------------------------------
ex0 :: Assertion
ex0 = input `assertFormatted` output
where
input =
[ "import B"
, "import A"
]
output =
[ "import A"
, "import B"
]
ex1 :: Assertion
ex1 = input `assertFormatted` output
where
input =
[ "import B"
, "import A"
, "import C"
, "import qualified A"
, "import qualified B as X"
]
output =
[ "import A"
, "import qualified A"
, "import B"
, "import qualified B as X"
, "import C"
]
ex2 :: Assertion
ex2 = input `assertFormatted` output
where
input =
[ "import B"
, "import A (X)"
, "import C"
, "import qualified A as Y (Y)"
]
output =
[ "import A (X)"
, "import qualified A as Y (Y)"
, "import B"
, "import C"
]
ex3 :: Assertion
ex3 = input `assertFormatted` output
where
input =
[ "import B"
, "import A (X, Z, Y)"
, "import C"
, "import qualified A as A0 (b, Y, a)"
, "import qualified D as D0 (Y, b, a)"
, "import qualified E as E0 (b, a, Y)"
]
output =
[ "import A (X, Y, Z)"
, "import qualified A as A0 (Y, a, b)"
, "import B"
, "import C"
, "import qualified D as D0 (Y, a, b)"
, "import qualified E as E0 (Y, a, b)"
]
ex4 :: Assertion
ex4 = input `assertFormatted` output
where
input =
[ "import A (X, Z(..), Y)"
]
output =
[ "import A (X, Y, Z (..))"
]
ex5 :: Assertion
ex5 = input `assertFormatted` output
where
input =
[ "import A (X, Z(Z), Y)"
]
output =
[ "import A (X, Y, Z (Z))"
]
ex6 :: Assertion
ex6 = input `assertFormatted` output
where
input =
[ "import A (X, Z(X, Z, Y), Y)"
]
output =
[ "import A (X, Y, Z (X, Y, Z))"
]
ex7 :: Assertion
ex7 = input `assertFormatted` output
where
input =
[ "module Foo (tests) where"
, "import B"
, "import A (X, Z, Y)"
, "import C"
, "import qualified A as A0 (b, Y, a)"
, "import qualified D as D0 (Y, b, a)"
, "import qualified E as E0 (b, a, Y)"
, "-- hello"
, "foo :: Int"
, "foo = 1"
]
output =
[ "module Foo (tests) where"
, "import A (X, Y, Z)"
, "import qualified A as A0 (Y, a, b)"
, "import B"
, "import C"
, "import qualified D as D0 (Y, a, b)"
, "import qualified E as E0 (Y, a, b)"
, "-- hello"
, "foo :: Int"
, "foo = 1"
]
ex8 :: Assertion
ex8 = input `assertFormatted` output
where
input =
[ "import B"
, "-- Group divisor"
, "import A (X)"
, "import C"
, "import qualified A as Y (Y)"
]
output =
[ "import B"
, "-- Group divisor"
, "import A (X)"
, "import qualified A as Y (Y)"
, "import C"
]
ex9 :: Assertion
ex9 = input `assertFormatted` output
where
input =
[ "--------"
, "import B"
, ""
, "-- Group divisor"
, "import A (X)"
, "import C"
, "import qualified A as Y (Y)"
]
output =
[ "--------"
, "import B"
, ""
, "-- Group divisor"
, "import A (X)"
, "import qualified A as Y (Y)"
, "import C"
]
ex10 :: Assertion
ex10 = input `assertFormatted` output
where
input =
[ "import B hiding (X)"
, "import A hiding (X)"
]
output =
[ "import A hiding (X)"
, "import B hiding (X)"
]
ex11 :: Assertion
ex11 = input `assertFormatted` output
where
input =
[ "import Data.Aeson ((.=))"
, "import A hiding (X)"
]
output =
[ "import A hiding (X)"
, "import Data.Aeson ((.=))"
]
ex12 :: Assertion
ex12 = input `assertFormatted` output
where
input =
[ "import Data.Aeson ((.=))"
, "import Data.Aeson ((.=))"
, "import A hiding (X)"
]
output =
[ "import A hiding (X)"
, "import Data.Aeson ((.=))"
]
ex13 :: Assertion
ex13 = input `assertFormattedCols` output
where
assertFormattedCols =
assertFormatted' (Just 10)
input =
[ "import Foo (A, B, C, D)"
, "import A hiding (X)"
]
output =
[ "import A hiding (X)"
, "import Foo (A)"
, "import Foo (B)"
, "import Foo (C)"
, "import Foo (D)"
]
ex14 :: Assertion
ex14 = input `assertFormattedCols` output
where
assertFormattedCols =
assertFormatted' (Just 27)
input =
[ "import Foo (A, B, C, D)"
, "import A hiding (X)"
]
output =
[ "import A hiding (X)"
, "import Foo (A, B)"
, "import Foo (C, D)"
]
ex15 :: Assertion
ex15 = input `assertFormattedCols` output
where
assertFormattedCols =
assertFormatted' (Just 100)
input =
[ "module Custom.Prelude"
, " ( LazyByteString"
, " , UUID"
, " , decodeUtf8Lenient"
, " , error"
, " , headMay"
, " , module X"
, " , nextRandomUUID"
, " , onChars"
, " , proxyOf"
, " , show"
, " , showStr"
, " , toLazyByteString"
, " , toStrictByteString"
, " , type (~>)"
, " , uuidToText"
, " ) where"
, ""
, "--------------------------------------------------------------------------------"
, "import Prelude as X hiding ((!!), appendFile, error, foldl, head, putStrLn, readFile, show, tail, take, unlines, unwords, words, writeFile)"
, "import qualified Prelude"
, ""
, "--------------------------------------------------------------------------------"
, "import Control.Lens as X ((%~), (&), (.~), (?~), (^.), (^?), _Left, _Right, iat, over, preview, sans, set, to, view)"
, "import Control.Lens.Extras as X (is)"
, ""
, "--------------------------------------------------------------------------------"
, "import Control.Applicative as X ((<|>))"
, "import Control.Monad as X ((<=<), (>=>), guard, unless, when)"
, "import Control.Monad.Except as X (ExceptT (..), MonadError (..), liftEither, runExceptT, withExceptT)"
, "import Control.Monad.IO.Unlift as X"
, "import Control.Monad.Reader as X (MonadReader (..), ReaderT (..), asks)"
, "import Control.Monad.Trans.Class as X (MonadTrans (lift))"
, "--------------------------------------------------------------------------------"
]
output =
[ "module Custom.Prelude"
, " ( LazyByteString"
, " , UUID"
, " , decodeUtf8Lenient"
, " , error"
, " , headMay"
, " , module X"
, " , nextRandomUUID"
, " , onChars"
, " , proxyOf"
, " , show"
, " , showStr"
, " , toLazyByteString"
, " , toStrictByteString"
, " , type (~>)"
, " , uuidToText"
, " ) where"
, ""
, "--------------------------------------------------------------------------------"
, "import Prelude as X hiding (appendFile, error, foldl, head, putStrLn, readFile, show, tail, take, unlines, unwords, words, writeFile, (!!))"
, "import qualified Prelude"
, ""
, "--------------------------------------------------------------------------------"
, "import Control.Lens as X (_Left, _Right, iat, over, preview, sans, set, to)"
, "import Control.Lens as X (view, (%~), (&), (.~), (?~), (^.), (^?))"
, "import Control.Lens.Extras as X (is)"
, ""
, "--------------------------------------------------------------------------------"
, "import Control.Applicative as X ((<|>))"
, "import Control.Monad as X (guard, unless, when, (<=<), (>=>))"
, "import Control.Monad.Except as X (ExceptT (..), MonadError (..), liftEither)"
, "import Control.Monad.Except as X (runExceptT, withExceptT)"
, "import Control.Monad.IO.Unlift as X"
, "import Control.Monad.Reader as X (MonadReader (..), ReaderT (..), asks)"
, "import Control.Monad.Trans.Class as X (MonadTrans (lift))"
, "--------------------------------------------------------------------------------"
]
ex16 :: Assertion
ex16 = input `assertFormatted` output
where
input =
[ "module Foo where"
, ""
, "import B ()"
, "import A ()"
]
output =
[ "module Foo where"
, ""
, "import A ()"
, "import B ()"
]
assertFormatted :: HasCallStack => Lines -> Lines -> Assertion
assertFormatted = withFrozenCallStack $ assertFormatted' Nothing
assertFormatted' :: HasCallStack => Maybe Int -> Lines -> Lines -> Assertion
assertFormatted' maxColumns input expected =
withFrozenCallStack $ expected @=?? testStep' (step maxColumns felixOptions) input
where
felixOptions = defaultOptions
{ listAlign = Repeat
}
|
