Sort the warnings

Author: mpickering

Cabal-syntax/src/Distribution/Parsec/Error.hs

@@ -16,9 +16,10 @@ import System.FilePath (normalise)
 import Prelude ()
 
 -- | Parser error.
-data PError = PError Position String
+data PError = PError { perrorPosition :: Position, perrorMessage :: String }
   deriving (Show, Generic)
 
+
 data PErrorWithSource src = PErrorWithSource {perrorSource :: !(PSource src), perror :: !PError}
   deriving (Show, Generic, Functor)
 

Cabal-syntax/src/Distribution/Parsec/Warning.hs

@@ -73,7 +73,7 @@ instance Binary PWarnType
 instance NFData PWarnType where rnf = genericRnf
 
 -- | Parser warning.
-data PWarning = PWarning !PWarnType !Position String
+data PWarning = PWarning { pwarningType :: !PWarnType, pwarningPosition :: !Position, pwarningMessage :: !String }
   deriving (Eq, Ord, Show, Generic)
 
 data PWarningWithSource src = PWarningWithSource {pwarningSource :: !(PSource src), pwarning :: !PWarning}

cabal-install/src/Distribution/Client/Errors/Parser.hs

@@ -241,8 +241,8 @@ renderParseErrorGeneral header err_header provenance extra_info errors warnings
 
     header' = if null header then "" else (" " <> header)
 
-    renderedErrors = concatMap renderError errors
-    renderedWarnings = concatMap renderWarning warnings
+    renderedErrors = concatMap renderError (sortBy (comparing perrorPosition) errors)
+    renderedWarnings = concatMap renderWarning (sortBy (comparing pwarningPosition) warnings)
 
     renderError :: PError -> [String]
     renderError (PError pos msg)

cabal-install/src/Distribution/Client/ProjectConfig.hs

@@ -963,7 +963,9 @@ reportParseResultParsec verbosity fpath contents pr = do
   let (warnings, result) = runParseResult pr
   case result of
     Right x -> do
-      reportProjectParseWarnings verbosity fpath (map (showPWarningWithSource . fmap renderProjectFileSource) warnings)
+      let sortKey p = (pwarningSource p, pwarningPosition (pwarning p))
+          sortedWarnings = sortBy (comparing sortKey) warnings
+      reportProjectParseWarnings verbosity fpath (map (showPWarningWithSource . fmap renderProjectFileSource) sortedWarnings)
       return x
     Left (_, errors) -> do
       dieWithException verbosity $ ProjectConfigParseFailure $ ProjectConfigParseError errors warnings

cabal-testsuite/PackageTests/ProjectImport/ParseWarningProvenance/cabal.out

@@ -1,10 +1,10 @@
 # cabal v2-build
 Warnings found while parsing the project file, cabal.project:
- - y.config:123:1: Invalid subsection "-"
- - x.config:3:1: Invalid subsection "-"
- - x.config:2:1: Invalid subsection "-"
- - x.config:1:1: Invalid subsection "-"
- - dir-y/a.config:123:1: Invalid subsection "-"
- - dir-x/a.config:3:1: Invalid subsection "-"
- - dir-x/a.config:2:1: Invalid subsection "-"
  - dir-x/a.config:1:1: Invalid subsection "-"
+ - dir-x/a.config:2:1: Invalid subsection "-"
+ - dir-x/a.config:3:1: Invalid subsection "-"
+ - dir-y/a.config:123:1: Invalid subsection "-"
+ - x.config:1:1: Invalid subsection "-"
+ - x.config:2:1: Invalid subsection "-"
+ - x.config:3:1: Invalid subsection "-"
+ - y.config:123:1: Invalid subsection "-"