Reimplement cabal check

Cabal-syntax/src/Distribution/Types/Benchmark.hs

@@ -48,24 +48,12 @@ instance Monoid Benchmark where
 instance Semigroup Benchmark where
   a <> b =
     Benchmark
-      { benchmarkName = combine' benchmarkName
+      { benchmarkName = combineNames a b benchmarkName "benchmark"
       , benchmarkInterface = combine benchmarkInterface
       , benchmarkBuildInfo = combine benchmarkBuildInfo
       }
     where
       combine field = field a `mappend` field b
-      combine' field = case ( unUnqualComponentName $ field a
-                            , unUnqualComponentName $ field b
-                            ) of
-        ("", _) -> field b
-        (_, "") -> field a
-        (x, y) ->
-          error $
-            "Ambiguous values for test field: '"
-              ++ x
-              ++ "' and '"
-              ++ y
-              ++ "'"
 
 emptyBenchmark :: Benchmark
 emptyBenchmark = mempty

Cabal-syntax/src/Distribution/Types/Executable.hs

@@ -40,25 +40,13 @@ instance Monoid Executable where
 instance Semigroup Executable where
   a <> b =
     Executable
-      { exeName = combine' exeName
+      { exeName = combineNames a b exeName "executable"
       , modulePath = combine modulePath
       , exeScope = combine exeScope
       , buildInfo = combine buildInfo
       }
     where
       combine field = field a `mappend` field b
-      combine' field = case ( unUnqualComponentName $ field a
-                            , unUnqualComponentName $ field b
-                            ) of
-        ("", _) -> field b
-        (_, "") -> field a
-        (x, y) ->
-          error $
-            "Ambiguous values for executable field: '"
-              ++ x
-              ++ "' and '"
-              ++ y
-              ++ "'"
 
 emptyExecutable :: Executable
 emptyExecutable = mempty

Cabal-syntax/src/Distribution/Types/ForeignLib.hs

@@ -140,7 +140,7 @@ instance NFData ForeignLib where rnf = genericRnf
 instance Semigroup ForeignLib where
   a <> b =
     ForeignLib
-      { foreignLibName = combine' foreignLibName
+      { foreignLibName = combineNames a b foreignLibName "foreign library"
       , foreignLibType = combine foreignLibType
       , foreignLibOptions = combine foreignLibOptions
       , foreignLibBuildInfo = combine foreignLibBuildInfo
@@ -150,18 +150,6 @@ instance Semigroup ForeignLib where
       }
     where
       combine field = field a `mappend` field b
-      combine' field = case ( unUnqualComponentName $ field a
-                            , unUnqualComponentName $ field b
-                            ) of
-        ("", _) -> field b
-        (_, "") -> field a
-        (x, y) ->
-          error $
-            "Ambiguous values for executable field: '"
-              ++ x
-              ++ "' and '"
-              ++ y
-              ++ "'"
       combine'' field = field b
 
 instance Monoid ForeignLib where

Cabal-syntax/src/Distribution/Types/TestSuite.hs

@@ -51,25 +51,13 @@ instance Monoid TestSuite where
 instance Semigroup TestSuite where
   a <> b =
     TestSuite
-      { testName = combine' testName
+      { testName = combineNames a b testName "test"
       , testInterface = combine testInterface
       , testBuildInfo = combine testBuildInfo
       , testCodeGenerators = combine testCodeGenerators
       }
     where
       combine field = field a `mappend` field b
-      combine' field = case ( unUnqualComponentName $ field a
-                            , unUnqualComponentName $ field b
-                            ) of
-        ("", _) -> field b
-        (_, "") -> field a
-        (x, y) ->
-          error $
-            "Ambiguous values for test field: '"
-              ++ x
-              ++ "' and '"
-              ++ y
-              ++ "'"
 
 emptyTestSuite :: TestSuite
 emptyTestSuite = mempty

Cabal-syntax/src/Distribution/Types/UnqualComponentName.hs

@@ -9,11 +9,12 @@ module Distribution.Types.UnqualComponentName
   , mkUnqualComponentName
   , packageNameToUnqualComponentName
   , unqualComponentNameToPackageName
+  , combineNames
   ) where
 
 import Distribution.Compat.Prelude
 import Distribution.Utils.ShortText
-import Prelude ()
+import Prelude as P (null)
 
 import Distribution.Parsec
 import Distribution.Pretty
@@ -105,3 +106,33 @@ packageNameToUnqualComponentName = UnqualComponentName . unPackageNameST
 -- @since 2.0.0.2
 unqualComponentNameToPackageName :: UnqualComponentName -> PackageName
 unqualComponentNameToPackageName = mkPackageNameST . unUnqualComponentNameST
+
+-- | Combine names in targets if one name is empty or both names are equal
+-- (partial function).
+-- Useful in 'Semigroup' and similar instances.
+combineNames
+  :: a
+  -> a
+  -> (a -> UnqualComponentName)
+  -> String
+  -> UnqualComponentName
+combineNames a b tacc tt
+  -- One empty or the same.
+  | P.null unb
+      || una == unb =
+      na
+  | P.null una = nb
+  -- Both non-empty, different.
+  | otherwise =
+      error $
+        "Ambiguous values for "
+          ++ tt
+          ++ " field: '"
+          ++ una
+          ++ "' and '"
+          ++ unb
+          ++ "'"
+  where
+    (na, nb) = (tacc a, tacc b)
+    una = unUnqualComponentName na
+    unb = unUnqualComponentName nb

Cabal-tests/tests/CheckTests.hs

@@ -71,7 +71,7 @@ checkTest fp = cabalGoldenTest fp correct $ do
             -- Note: parser warnings are reported by `cabal check`, but not by
             -- D.PD.Check functionality.
             unlines (map (showPWarning fp) ws) ++
-            unlines (map show (checkPackage gpd Nothing))
+            unlines (map show (checkPackage gpd))
         Left (_, errs) -> unlines $ map (("ERROR: " ++) . showPError fp) $ NE.toList errs
   where
     input = "tests" </> "ParserTests" </> "regressions" </> fp

Cabal-tests/tests/HackageTests.hs

@@ -196,7 +196,7 @@ parseCheckTest fpath bs = do
                              Parsec.parseGenericPackageDescription bs
     case parsec of
         Right gpd -> do
-            let checks = checkPackage gpd Nothing
+            let checks = checkPackage gpd
             let w [] = 0
                 w _  = 1
 

Cabal-tests/tests/ParserTests/regressions/all-upper-bound.check

@@ -1,6 +1,6 @@
-These packages miss upper bounds:
+On library, these packages miss upper bounds:
+  - somelib
   - alphalib
   - betalib
   - deltalib
-  - somelib
-Please add them, using `cabal gen-bounds` for suggestions. For more information see:  https://pvp.haskell.org/
+Please add them. There is more information at https://pvp.haskell.org/

Cabal-tests/tests/ParserTests/regressions/bad-glob-syntax.check

@@ -1,2 +1,2 @@
-In the 'extra-source-files' field: invalid file glob 'foo/blah-*.hs'. Wildcards '*' may only totally replace the file's base name, not only parts of it.
 In the 'extra-source-files' field: invalid file glob 'foo/*/bar'. A wildcard '**' is only allowed as the final parent directory. Stars must not otherwise appear in the parent directories.
+In the 'extra-source-files' field: invalid file glob 'foo/blah-*.hs'. Wildcards '*' may only totally replace the file's base name, not only parts of it.

Cabal-tests/tests/ParserTests/regressions/decreasing-indentation.cabal

@@ -24,7 +24,7 @@ Flag UseBinary
   Description: Use the binary package for serializing keys.
 
 Library
- build-depends: base >= 3
+ build-depends: base < 3
  if flag(UseBinary)
    build-depends: binary <10
    CPP-Options: -DUSE_BINARY
@@ -34,7 +34,7 @@ Library
  exposed-modules: Codec.Crypto.RSA
 
 Executable test_rsa
-    build-depends: base >= 3
+    build-depends: base < 3
   CPP-Options: -DRSA_TEST
   Main-Is: Test.hs
   Other-Modules: Codec.Crypto.RSA
@@ -52,7 +52,7 @@ Executable warnings
 
 -- Increasing indentation is also possible if we use braces to delimit field contents.
 Executable warnings2
-  build-depends: { base <5 }
+  build-depends: { base < 5 }
     main-is: { warnings2.hs }
       Other-Modules: FooBar
 
@@ -62,9 +62,9 @@ flag splitBase
 
 Executable warnings3
     if flag(splitBase)
-        build-depends: base >= 3
+        build-depends: base < 3
     else
-        build-depends: base <  3
+        build-depends: base < 5
 
  Main-Is: warnings3.hs
  Other-Modules:

Cabal-tests/tests/ParserTests/regressions/denormalised-paths.check

@@ -1,11 +1,14 @@
-The 'subdir' field of a source-repository is not a good relative path: "trailing same directory segment: ."
-The paths 'files/<>/*.txt', 'c/**/*.c', 'C:foo/bar', '||s' are invalid on Windows, which would cause portability problems for this package. Windows file names cannot contain any of the characters ":*?<>|" and there a few reserved names including "aux", "nul", "con", "prn", "com1-9", "lpt1-9" and "clock$".
 'hs-source-dirs: ../../assoc/src' is a relative path outside of the source tree. This will not work when generating a tarball with 'sdist'.
+The 'subdir' field of a source-repository is not a good relative path: "trailing same directory segment: ."
 'extra-source-files: files/**/*.txt/' is not a good relative path: "trailing slash"
 'extra-source-files: files/../foo.txt' is not a good relative path: "parent directory segment: .."
-'license-file: LICENSE2/' is not a good relative path: "trailing slash"
-'license-file: .' is not a good relative path: "trailing dot segment"
+'hs-source-dirs: ../../assoc/src' is not a good relative path: "parent directory segment: .."
 'hs-source-dirs: src/.' is not a good relative path: "trailing same directory segment: ."
-'hs-source-dirs: src/../src' is not a good relative path: "parent directory segment: .."
 'hs-source-dirs: src/../../assoc/src' is not a good relative path: "parent directory segment: .."
-'hs-source-dirs: ../../assoc/src' is not a good relative path: "parent directory segment: .."
+'hs-source-dirs: src/../src' is not a good relative path: "parent directory segment: .."
+'license-file: .' is not a good relative path: "trailing dot segment"
+'license-file: LICENSE2/' is not a good relative path: "trailing slash"
+The path 'C:foo/bar' is invalid on Windows, which would cause portability problems for this package. Windows file names cannot contain any of the characters ":*?<>|" and there a few reserved names including "aux", "nul", "con", "prn", "com1-9", "lpt1-9" and "clock$".
+The path 'c/**/*.c' is invalid on Windows, which would cause portability problems for this package. Windows file names cannot contain any of the characters ":*?<>|" and there a few reserved names including "aux", "nul", "con", "prn", "com1-9", "lpt1-9" and "clock$".
+The path 'files/<>/*.txt' is invalid on Windows, which would cause portability problems for this package. Windows file names cannot contain any of the characters ":*?<>|" and there a few reserved names including "aux", "nul", "con", "prn", "com1-9", "lpt1-9" and "clock$".
+The path '||s' is invalid on Windows, which would cause portability problems for this package. Windows file names cannot contain any of the characters ":*?<>|" and there a few reserved names including "aux", "nul", "con", "prn", "com1-9", "lpt1-9" and "clock$".

Cabal-tests/tests/ParserTests/regressions/ghc-option-j.check

@@ -1,2 +1,2 @@
-'ghc-options: -j[N]' can make sense for specific user's setup, but it is not appropriate for a distributed package. Alternatively, if you want to use this, make it conditional based on a Cabal configuration flag (with 'manual: True' and 'default: False') and enable that flag during development.
-'ghc-shared-options: -j[N]' can make sense for specific user's setup, but it is not appropriate for a distributed package. Alternatively, if you want to use this, make it conditional based on a Cabal configuration flag (with 'manual: True' and 'default: False') and enable that flag during development.
+'ghc-options: -j[N]' can make sense for a particular user's setup, but it is not appropriate for a distributed package. Alternatively, if you want to use this, make it conditional based on a Cabal configuration flag (with 'manual: True' and 'default: False') and enable that flag during development.
+'ghc-shared-options: -j[N]' can make sense for a particular user's setup, but it is not appropriate for a distributed package. Alternatively, if you want to use this, make it conditional based on a Cabal configuration flag (with 'manual: True' and 'default: False') and enable that flag during development.

Cabal-tests/tests/ParserTests/regressions/issue-774.check

@@ -1,6 +1,6 @@
 issue-774.cabal:13:22: Packages with 'cabal-version: 1.12' or later should specify a specific version of the Cabal spec of the form 'cabal-version: x.y'. Use 'cabal-version: 1.12'.
+'ghc-options: -rtsopts' has no effect for libraries. It should only be used for executables.
+'ghc-options: -with-rtsopts' has no effect for libraries. It should only be used for executables.
 No 'category' field.
 No 'maintainer' field.
 The 'license' field is missing or is NONE.
-'ghc-options: -rtsopts' has no effect for libraries. It should only be used for executables.
-'ghc-options: -with-rtsopts' has no effect for libraries. It should only be used for executables.

Cabal-tests/tests/ParserTests/regressions/nothing-unicode.check

@@ -2,5 +2,5 @@ No 'category' field.
 No 'maintainer' field.
 No 'description' field.
 The 'license' field is missing or is NONE.
-Suspicious flag names: 無. To avoid ambiguity in command line interfaces, flag shouldn't start with a dash. Also for better compatibility, flag names shouldn't contain non-ascii characters.
+Suspicious flag names: 無. To avoid ambiguity in command line interfaces, a flag shouldn't start with a dash. Also for better compatibility, flag names shouldn't contain non-ascii characters.
 Non ascii custom fields: x-無. For better compatibility, custom field names shouldn't contain non-ascii characters.

Cabal-tests/tests/ParserTests/regressions/pre-2.4-globstar.check

@@ -1,3 +1,3 @@
 In the 'data-files' field: invalid file glob 'foo/**/*.dat'. Using the double-star syntax requires 'cabal-version: 2.4' or greater. Alternatively, for compatibility with earlier Cabal versions, list the included directories explicitly.
-In the 'extra-source-files' field: invalid file glob 'foo/**/*.hs'. Using the double-star syntax requires 'cabal-version: 2.4' or greater. Alternatively, for compatibility with earlier Cabal versions, list the included directories explicitly.
 In the 'extra-doc-files' field: invalid file glob 'foo/**/*.html'. Using the double-star syntax requires 'cabal-version: 2.4' or greater. Alternatively, for compatibility with earlier Cabal versions, list the included directories explicitly.
+In the 'extra-source-files' field: invalid file glob 'foo/**/*.hs'. Using the double-star syntax requires 'cabal-version: 2.4' or greater. Alternatively, for compatibility with earlier Cabal versions, list the included directories explicitly.

Cabal/Cabal.cabal

@@ -322,6 +322,12 @@ library
     Distribution.Compat.SnocList
     Distribution.GetOpt
     Distribution.Lex
+    Distribution.PackageDescription.Check.Common
+    Distribution.PackageDescription.Check.Conditional
+    Distribution.PackageDescription.Check.Monad
+    Distribution.PackageDescription.Check.Paths
+    Distribution.PackageDescription.Check.Target
+    Distribution.PackageDescription.Check.Warning
     Distribution.Simple.Build.Macros.Z
     Distribution.Simple.Build.PackageInfoModule.Z
     Distribution.Simple.Build.PathsModule.Z