Add with-compiler field for cabal scripts

Cabal/Cabal.cabal

@@ -443,6 +443,7 @@ library
     Distribution.Types.UnqualComponentName
     Distribution.Types.IncludeRenaming
     Distribution.Types.Mixin
+    Distribution.Types.Script
     Distribution.Types.SetupBuildInfo
     Distribution.Types.TestSuite
     Distribution.Types.TestSuiteInterface
@@ -521,6 +522,7 @@ library
     Distribution.Types.Library.Lens
     Distribution.Types.PackageDescription.Lens
     Distribution.Types.PackageId.Lens
+    Distribution.Types.Script.Lens
     Distribution.Types.SetupBuildInfo.Lens
     Distribution.Types.SourceRepo.Lens
     Distribution.Types.TestSuite.Lens

Cabal/Distribution/PackageDescription/FieldGrammar.hs

@@ -37,6 +37,8 @@ module Distribution.PackageDescription.FieldGrammar (
     setupBInfoFieldGrammar,
     -- * Component build info
     buildInfoFieldGrammar,
+    -- * Script
+    scriptFieldGrammar
     ) where
 
 import Distribution.Compat.Lens
@@ -57,6 +59,7 @@ import Distribution.Types.ExecutableScope
 import Distribution.Types.ForeignLib
 import Distribution.Types.ForeignLibType
 import Distribution.Types.LibraryVisibility
+import Distribution.Types.Script
 import Distribution.Types.UnqualComponentName
 import Distribution.Version                   (anyVersion)
 
@@ -539,3 +542,17 @@ setupBInfoFieldGrammar def = flip SetupBuildInfo def
     <$> monoidalFieldAla "setup-depends" (alaList CommaVCat) L.setupDepends
 {-# SPECIALIZE setupBInfoFieldGrammar :: Bool -> ParsecFieldGrammar' SetupBuildInfo #-}
 {-# SPECIALIZE setupBInfoFieldGrammar :: Bool ->PrettyFieldGrammar' SetupBuildInfo #-}
+
+-------------------------------------------------------------------------------
+-- Script
+-------------------------------------------------------------------------------
+
+scriptFieldGrammar
+    :: (FieldGrammar g, Applicative (g Script), Applicative (g Executable), Applicative (g BuildInfo))
+    => g Script Script
+scriptFieldGrammar = Script
+    <$> blurFieldGrammar L.executable (executableFieldGrammar "script")
+    <*> optionalFieldAla "with-compiler" FilePathNT L.hcPath
+{-# SPECIALIZE scriptFieldGrammar :: ParsecFieldGrammar' Script #-}
+{-# SPECIALIZE scriptFieldGrammar :: PrettyFieldGrammar' Script #-}
+

Cabal/Distribution/Types/Lens.hs

@@ -7,6 +7,7 @@ module Distribution.Types.Lens (
     module Distribution.Types.Library.Lens,
     module Distribution.Types.PackageDescription.Lens,
     module Distribution.Types.PackageId.Lens,
+    module Distribution.Types.Script.Lens,
     module Distribution.Types.SetupBuildInfo.Lens,
     module Distribution.Types.SourceRepo.Lens,
     module Distribution.Types.TestSuite.Lens,
@@ -20,6 +21,7 @@ import Distribution.Types.GenericPackageDescription.Lens
 import Distribution.Types.Library.Lens
 import Distribution.Types.PackageDescription.Lens
 import Distribution.Types.PackageId.Lens
+import Distribution.Types.Script.Lens
 import Distribution.Types.SetupBuildInfo.Lens
 import Distribution.Types.SourceRepo.Lens
 import Distribution.Types.TestSuite.Lens

Cabal/Distribution/Types/Script.hs

@@ -0,0 +1,17 @@
+{-# LANGUAGE DeriveDataTypeable #-}
+{-# LANGUAGE DeriveGeneric #-}
+module Distribution.Types.Script (
+    Script(..)
+) where
+
+import Prelude ()
+import Distribution.Compat.Prelude
+
+import Distribution.Types.Executable
+
+data Script = Script {
+    executable :: Executable,
+    hcPath :: Maybe FilePath
+    }
+    deriving (Generic, Show, Read, Eq, Typeable)
+

Cabal/Distribution/Types/Script/Lens.hs

@@ -0,0 +1,21 @@
+module Distribution.Types.Script.Lens (
+    Script,
+    module Distribution.Types.Script.Lens,
+    ) where
+
+import Distribution.Compat.Lens
+import Distribution.Compat.Prelude
+import Prelude ()
+
+import Distribution.Types.Executable          (Executable)
+import Distribution.Types.Script              (Script)
+
+import qualified Distribution.Types.Script as T
+
+executable :: Lens' Script Executable
+executable f s = fmap (\x -> s { T.executable = x }) (f (T.executable s))
+{-# INLINE executable #-}
+
+hcPath :: Lens' Script (Maybe FilePath)
+hcPath f s = fmap (\x -> s { T.hcPath = x }) (f (T.hcPath s))
+{-# INLINE hcPath #-}

Cabal/doc/nix-local-build.rst

@@ -476,6 +476,12 @@ interpreter, or through this command:
     $ cabal v2-run script.hs
     $ cabal v2-run script.hs -- --arg1 # args are passed like this
 
+Supported fields include:
+
+- ``build-depends``
+
+- ``with-compiler``
+
 cabal v2-freeze
 ----------------
 

cabal-install/Distribution/Client/CmdRun.hs

@@ -29,7 +29,7 @@ import Distribution.Client.GlobalFlags
          ( defaultGlobalFlags )
 import qualified Distribution.Client.Setup as Client
 import Distribution.Simple.Setup
-         ( HaddockFlags, TestFlags, BenchmarkFlags, fromFlagOrDefault )
+         ( HaddockFlags, TestFlags, BenchmarkFlags, fromFlagOrDefault, maybeToFlag )
 import Distribution.Simple.Command
          ( CommandUI(..), usageAlternatives )
 import Distribution.Types.ComponentName
@@ -70,7 +70,7 @@ import Distribution.Client.Types
 import Distribution.FieldGrammar
          ( takeFields, parseFieldGrammar )
 import Distribution.PackageDescription.FieldGrammar
-         ( executableFieldGrammar )
+         ( scriptFieldGrammar )
 import Distribution.PackageDescription.PrettyPrint
          ( writeGenericPackageDescription )
 import Distribution.Parsec
@@ -90,6 +90,8 @@ import Distribution.Types.GenericPackageDescription as GPD
          ( GenericPackageDescription(..), emptyGenericPackageDescription )
 import Distribution.Types.PackageDescription
          ( PackageDescription(..), emptyPackageDescription )
+import Distribution.Types.Script
+         ( Script(..) )
 import Distribution.Types.Version
          ( mkVersion )
 import Distribution.Types.PackageName.Magic
@@ -332,20 +334,20 @@ handleShebang :: FilePath -> [String] -> IO ()
 handleShebang script args =
   runAction (commandDefaultFlags runCommand) (script:args) defaultGlobalFlags
 
-parseScriptBlock :: BS.ByteString -> ParseResult Executable
+parseScriptBlock :: BS.ByteString -> ParseResult Script
 parseScriptBlock str =
     case readFields str of
         Right fs -> do
             let (fields, _) = takeFields fs
-            parseFieldGrammar cabalSpecLatest fields (executableFieldGrammar "script")
+            parseFieldGrammar cabalSpecLatest fields scriptFieldGrammar
         Left perr -> parseFatalFailure pos (show perr) where
             ppos = P.errorPos perr
             pos  = Position (P.sourceLine ppos) (P.sourceColumn ppos)
 
-readScriptBlock :: Verbosity -> BS.ByteString -> IO Executable
+readScriptBlock :: Verbosity -> BS.ByteString -> IO Script
 readScriptBlock verbosity = parseString parseScriptBlock verbosity "script block"
 
-readScriptBlockFromScript :: Verbosity -> PlainOrLiterate -> BS.ByteString -> IO (Executable, BS.ByteString)
+readScriptBlockFromScript :: Verbosity -> PlainOrLiterate -> BS.ByteString -> IO (Script, BS.ByteString)
 readScriptBlockFromScript verbosity pol str = do
     str' <- case extractScriptBlock pol str of
               Left e -> die' verbosity $ "Failed extracting script block: " ++ e
@@ -401,7 +403,8 @@ handleScriptCase
   -> BS.ByteString
   -> IO (ProjectBaseContext, [TargetSelector])
 handleScriptCase verbosity pol baseCtx tempDir scriptContents = do
-  (executable, contents') <- readScriptBlockFromScript verbosity pol scriptContents
+  (script, contents') <- readScriptBlockFromScript verbosity pol scriptContents
+  let Script executable hcPath = script
 
   -- We need to create a dummy package that lives in our dummy project.
   let
@@ -440,8 +443,15 @@ handleScriptCase verbosity pol baseCtx tempDir scriptContents = do
   BS.writeFile (tempDir </> mainName) contents'
 
   let
+    projectConfigShared' :: ProjectConfigShared
+    projectConfigShared' = (projectConfigShared (projectConfig baseCtx))
+      { projectConfigHcPath = (maybeToFlag hcPath) <>
+                              projectConfigHcPath (projectConfigShared (projectConfig baseCtx))
+      }
     baseCtx' = baseCtx
-      { localPackages = localPackages baseCtx ++ [SpecificSourcePackage sourcePackage] }
+      { localPackages = localPackages baseCtx ++ [SpecificSourcePackage sourcePackage]
+      , projectConfig = (projectConfig baseCtx) { projectConfigShared = projectConfigShared' }
+      }
     targetSelectors = [TargetPackage TargetExplicitNamed [pkgId] Nothing]
 
   return (baseCtx', targetSelectors)

cabal-install/changelog

@@ -4,6 +4,7 @@
 	* `v2-build` (and other `v2-`prefixed commands) now accept the
 	  `--benchmark-option(s)` flags, which pass options to benchmark executables
 	  (analogous to how `--test-option(s)` works). (#6209)
+	* `v2-run` can now read a `with-compiler` flag in the script metadata field
 
 3.0.0.0 Mikhail Glushenkov <mikhail.glushenkov@gmail.com> August 2019
 	* Parse comma-separated lists for extra-prog-path, extra-lib-dirs, extra-framework-dirs,