Merge pull request #6703 from commercialhaskell/cabal-3.14

Depend on `Cabal-3.14.*`

Author: mpilgrem

.gitattributes

@@ -0,0 +1 @@
+/stack.cabal linguist-generated=true

CONTRIBUTING.md

@@ -349,7 +349,8 @@ Stack aims to depend on well-known packages. The specific versions on which it
 depends at any time are specified by `package.yaml` and `stack.yaml`. It does
 not aim to be compatible with more than one version of the `Cabal` package at
 any time. At the time of writing (August 2025) the package versions are
-primarily ones in Stackage snapshot LTS Haskell 24.4 (for GHC 9.10.2) and
+primarily ones in Stackage snapshot LTS Haskell 24.4 (for GHC 9.10.2), the
+latest version of `Cabal` released on Hackage (`Cabal-3.14.2.0`) and
 `pantry-0.11.0`.
 
 A Stack executable makes use of Cabal (the library) through a small 'Setup'

Setup.hs

@@ -25,6 +25,7 @@ import           Distribution.Simple.Utils
 import           Distribution.Types.PackageName ( unPackageName )
 import           Distribution.Types.UnqualComponentName
                    ( unUnqualComponentName )
+import           Distribution.Utils.Path ( interpretSymbolicPathCWD )
 import           Distribution.Verbosity ( Verbosity, normal )
 import           System.FilePath ( (</>) )
 
@@ -47,7 +48,7 @@ generateBuildModule ::
   -> LocalBuildInfo
   -> IO ()
 generateBuildModule verbosity pkg lbi = do
-  let dir = autogenPackageModulesDir lbi
+  let dir = interpretSymbolicPathCWD (autogenPackageModulesDir lbi)
   createDirectoryIfMissingVerbose verbosity True dir
   withLibLBI pkg lbi $ \_ libcfg -> do
     withExeLBI pkg lbi $ \exe clbi -> do

package.yaml

@@ -33,7 +33,7 @@ homepage: http://haskellstack.org
 custom-setup:
   dependencies:
   - base >= 4.14.3.0 && < 5
-  - Cabal < 3.14
+  - Cabal >= 3.14 && < 3.16
   - filepath
 extra-source-files:
 # note: leaving out 'package.yaml' because it causes confusion with hackage metadata revisions
@@ -65,7 +65,7 @@ ghc-options:
 - -optP-Wno-nonportable-include-path
 dependencies:
 - base >= 4.16.0.0 && < 5
-- Cabal >= 3.8.1.0 && < 3.14
+- Cabal >= 3.14 && < 3.16
 - aeson >= 2.0.3.0
 - aeson-warning-parser >= 0.1.1
 - ansi-terminal >= 1.0.2

src/Stack/Component.hs

@@ -35,6 +35,7 @@ import           Distribution.PackageDescription
 import           Distribution.Types.BuildInfo ( BuildInfo )
 import           Distribution.Package ( mkPackageName )
 import qualified Distribution.PackageDescription as Cabal
+import           Distribution.Utils.Path (interpretSymbolicPathCWD)
 import           GHC.Records ( HasField )
 import           Stack.Prelude
 import           Stack.Types.Component
@@ -73,7 +74,7 @@ stackExecutableFromCabal :: Executable -> StackExecutable
 stackExecutableFromCabal cabalExecutable = StackExecutable
   { name = fromCabalName cabalExecutable.exeName
   , buildInfo = stackBuildInfoFromCabal cabalExecutable.buildInfo
-  , modulePath = cabalExecutable.modulePath
+  , modulePath = interpretSymbolicPathCWD cabalExecutable.modulePath
   }
 
 stackForeignLibraryFromCabal :: ForeignLib -> StackForeignLibrary
@@ -107,20 +108,20 @@ stackBuildInfoFromCabal buildInfoV = gatherComponentToolsAndDepsFromCabal
   StackBuildInfo
     { buildable = buildInfoV.buildable
     , otherModules = buildInfoV.otherModules
-    , jsSources = buildInfoV.jsSources
+    , jsSources = map interpretSymbolicPathCWD buildInfoV.jsSources
     , hsSourceDirs = buildInfoV.hsSourceDirs
-    , cSources = buildInfoV.cSources
+    , cSources = map interpretSymbolicPathCWD buildInfoV.cSources
     , dependency = mempty
     , unknownTools = mempty
     , cppOptions = buildInfoV.cppOptions
     , targetBuildDepends = buildInfoV.targetBuildDepends
     , options = buildInfoV.options
     , allLanguages = Cabal.allLanguages buildInfoV
     , usedExtensions = Cabal.usedExtensions buildInfoV
-    , includeDirs = buildInfoV.includeDirs
+    , includeDirs = map interpretSymbolicPathCWD buildInfoV.includeDirs
     , extraLibs = buildInfoV.extraLibs
-    , extraLibDirs = buildInfoV.extraLibDirs
-    , frameworks = buildInfoV.frameworks
+    , extraLibDirs = map interpretSymbolicPathCWD buildInfoV.extraLibDirs
+    , frameworks = map interpretSymbolicPathCWD buildInfoV.frameworks
     }
 
 -- | Iterate on all three dependency list given, and transform and sort them

src/Stack/ComponentFile.hs

@@ -36,7 +36,8 @@ import           Distribution.PackageDescription
                    ( BenchmarkInterface (..), TestSuiteInterface (..) )
 import           Distribution.Text ( display )
 import           Distribution.Utils.Path
-                   ( PackageDir, SourceDir, SymbolicPath, getSymbolicPath )
+                   ( Pkg, Source, SymbolicPath, getSymbolicPath )
+import qualified Distribution.Utils.Path as Cabal
 import           GHC.Records ( HasField )
 import qualified HiFileParser as Iface
 import           Path
@@ -91,7 +92,7 @@ stackBenchmarkFiles bench =
   exposed :: [DotCabalDescriptor]
   exposed =
     case bench.interface of
-      BenchmarkExeV10 _ fp -> [DotCabalMain fp]
+      BenchmarkExeV10 _ fp -> [DotCabalMain $ getSymbolicPath fp]
       BenchmarkUnsupported _ -> []
 
   bnames :: [DotCabalDescriptor]
@@ -113,7 +114,7 @@ stackTestSuiteFiles test =
   exposed :: [DotCabalDescriptor]
   exposed =
     case test.interface of
-      TestSuiteExeV10 _ fp -> [DotCabalMain fp]
+      TestSuiteExeV10 _ fp -> [DotCabalMain $ getSymbolicPath fp]
       TestSuiteLibV09 _ mn -> [DotCabalModule mn]
       TestSuiteUnsupported _ -> []
 
@@ -168,7 +169,7 @@ stackLibraryFiles lib =
 -- | Get all files referenced by the component.
 resolveComponentFiles ::
      ( CAndJsSources rec
-     , HasField "hsSourceDirs" rec [SymbolicPath PackageDir SourceDir]
+     , HasField "hsSourceDirs" rec [SymbolicPath Pkg (Cabal.Dir Source)]
      )
   => NamedComponent
   -> rec

src/Stack/Package.hs

@@ -61,7 +61,7 @@ import           Distribution.Simple.PackageDescription ( readHookedBuildInfo )
 import           Distribution.System ( OS (..), Arch, Platform (..) )
 import           Distribution.Text ( display )
 import qualified Distribution.Types.CondTree as Cabal
-import           Distribution.Utils.Path ( getSymbolicPath )
+import           Distribution.Utils.Path ( makeSymbolicPath, getSymbolicPath )
 import           Distribution.Verbosity ( silent )
 import           Distribution.Version
                    ( anyVersion, mkVersion, orLaterVersion )
@@ -131,8 +131,8 @@ import           RIO.Seq ((|>))
 --
 -- NOTE: not to be confused with BuildInfo, an Stack-internal datatype.
 readDotBuildinfo :: MonadIO m => Path Abs File -> m HookedBuildInfo
-readDotBuildinfo buildinfofp =
-  liftIO $ readHookedBuildInfo silent (toFilePath buildinfofp)
+readDotBuildinfo =
+  liftIO . readHookedBuildInfo silent Nothing . makeSymbolicPath . toFilePath
 
 -- | Resolve a parsed Cabal file into a t'Package', which contains all of the
 -- info needed for Stack to build the t'Package' given the current

src/Stack/PackageFile.hs

@@ -20,6 +20,7 @@ import qualified Data.Set as S
 import           Distribution.CabalSpecVersion ( CabalSpecVersion )
 import qualified Distribution.PackageDescription as Cabal
 import           Distribution.Simple.Glob ( matchDirFileGlob )
+import           Distribution.Utils.Path ( makeSymbolicPath, getSymbolicPath )
 import           Path ( parent, (</>) )
 import           Path.Extra ( forgivingResolveFile, rejectMissingFile )
 import           Path.IO ( doesFileExist )
@@ -121,9 +122,9 @@ resolveGlobFiles cabalFileVersion =
        FilePath
     -> FilePath
     -> RIO GetPackageFileContext [FilePath]
-  matchDirFileGlob' dir glob =
+  matchDirFileGlob' dir glob = map getSymbolicPath <$> do
     catch
-      (liftIO (matchDirFileGlob minBound cabalFileVersion dir glob))
+      (liftIO $ matchDirFileGlob minBound cabalFileVersion (Just $ makeSymbolicPath dir) (makeSymbolicPath glob))
       ( \(e :: IOException) ->
         if isUserError e
           then do
@@ -183,9 +184,9 @@ getPackageFile pkg cabalFP =
 stackPackageFileFromCabal :: Cabal.PackageDescription -> StackPackageFile
 stackPackageFileFromCabal cabalPkg =
   StackPackageFile
-    (Cabal.extraSrcFiles cabalPkg)
-    (Cabal.dataDir cabalPkg)
-    (Cabal.dataFiles cabalPkg)
+    (map getSymbolicPath $ Cabal.extraSrcFiles cabalPkg)
+    (getSymbolicPath $ Cabal.dataDir cabalPkg)
+    (map getSymbolicPath $ Cabal.dataFiles cabalPkg)
 
 insertComponentFile ::
      PackageComponentFile

src/Stack/SDist.hs

@@ -572,18 +572,7 @@ checkPackageInExtractedTarball pkgDir = do
     , flow "for common mistakes using Cabal version"
     , fromString $ versionString cabalVersion <> "."
     ]
-  let pkgChecks =
-        -- MSS 2017-12-12: Try out a few different variants of pkgDesc to try
-        -- and provoke an error or warning. I don't know why, but when using
-        -- `Just pkgDesc`, it appears that Cabal does not detect that `^>=` is
-        -- used with `cabal-version: 1.24` or earlier. It seems like pkgDesc
-        -- (the one we create) does not populate the `buildDepends` field,
-        -- whereas flattenPackageDescription from Cabal does. In any event,
-        -- using `Nothing` seems more logical for this check anyway, and the
-        -- fallback to `Just pkgDesc` is just a crazy sanity check.
-        case Check.checkPackage gpd of
-          [] -> Check.checkConfiguredPackage pkgDesc
-          x -> x
+  let pkgChecks = Check.checkPackage gpd
   fileChecks <-
     liftIO $ Check.checkPackageFiles minBound pkgDesc (toFilePath pkgDir)
   let checks = pkgChecks ++ fileChecks

src/Stack/Types/Component.hs

@@ -31,7 +31,8 @@ import           Distribution.ModuleName ( ModuleName )
 import           Distribution.PackageDescription
                    ( BenchmarkInterface, Dependency, TestSuiteInterface )
 import           Distribution.Simple ( Extension, Language )
-import           Distribution.Utils.Path ( PackageDir, SourceDir, SymbolicPath )
+import           Distribution.Utils.Path ( Pkg, Source, SymbolicPath )
+import qualified Distribution.Utils.Path as Cabal
 import           GHC.Records ( HasField (..) )
 import           Stack.Prelude
 import           Stack.Types.ComponentUtils
@@ -133,7 +134,7 @@ data StackBuildInfo = StackBuildInfo
     -- ^ Only used in file gathering. See usage in "Stack.ComponentFile" module.
   , jsSources :: [FilePath]
     -- ^ Only used in file gathering. See usage in "Stack.ComponentFile" module.
-  , hsSourceDirs :: [SymbolicPath PackageDir SourceDir]
+  , hsSourceDirs :: [SymbolicPath Pkg (Cabal.Dir Source)]
     -- ^ Only used in file & opts gathering. See usage in "Stack.ComponentFile"
     -- module for fle gathering.
   , cSources :: [FilePath]