Fix #5305 Extend stack script --extra-dep to any immutable extra-dep

Author: mpilgrem

Diff for: ChangeLog.md

@@ -13,6 +13,10 @@ Behavior changes:
 Other enhancements:
 
 * Bump to Hpack 0.38.1.
+* The `--extra-dep` option of Stack's `script` command now accepts a YAML value
+  specifying any immutable extra-dep. Previously only an extra-dep in the
+  package index that could be specified by a YAML string (for example,
+  `acme-missiles-0.3@rev:0`) was accepted.
 
 Bug fixes:
 

Diff for: doc/commands/script_command.md

@@ -6,7 +6,7 @@
 stack script [--package PACKAGE] FILE
              [-- ARGUMENT(S) (e.g. stack script X.hs -- argument(s) to program).]
              [--compile | --optimize] [--[no-]use-root] [--ghc-options OPTIONS]
-             [--extra-dep PACKAGE-VERSION] [--no-run]
+             [--extra-dep EXTRA-DEP] [--no-run]
 ~~~
 
 The `stack script` command either runs a specified Haskell source file (using
@@ -52,9 +52,20 @@ For example:
 stack script --snapshot lts-23.14 MyScript.hs
 ~~~
 
-A package version can be added to the snapshot on the command line with the
+An immutable extra-dep can be added to the snapshot on the command line with the
 `--extra-dep` option (which can be specified multiple times).
 
+An extra-dep is specified using a valid YAML value. For further information, see
+the [package location](../topics/package_location.md) documentation. Examples
+are:
+
+* `--extra-dep acme-missiles-0.3@rev:0`
+* `--extra-dep '{git: [email protected]:yesodweb/wai, commit: '2f8a8e1b771829f4a8a77c0111352ce45a14c30f', subdirs: [auto-update, wai]}`
+* `--extra-dep acme-missiles-0.3.tar.gz`
+
+Relative paths to local archive files are assumed to be relative to the
+directory in which the script file is located.
+
 GHC boot packages that have been 'replaced' (see further below) can be specified
 as an `--extra-dep`.
 

Diff for: doc/topics/scripts.md

@@ -139,6 +139,8 @@ stack script --snapshot lts-23.14 -- MyScript.hs arg1 arg2 +RTS -s -RTS
 where `+RTS -s -RTS` are some of GHC's
 [runtime system (RTS) options](https://downloads.haskell.org/~ghc/latest/docs/users_guide/runtime_control.html).
 
+Arguments that include spaces can be quoted using double quotation marks.
+
 ## Just-in-time compilation
 
 As with using [`stack script`](../commands/script_command.md) at the command
@@ -169,6 +171,24 @@ options, or by providing a comma or space separated list. For example:
 -}
 ~~~
 
+## Using extra-deps
+
+As with using [`stack script`](../commands/script_command.md) at the command
+line, you can also specify one or more extra-deps using a valid YAML value for
+each. For example:
+
+~~~haskell
+#!/usr/bin/env stack
+{- stack script
+   --snapshot lts-23.14
+   --extra-dep acme-missiles-0.3@rev:0
+   --extra-dep "{git: [email protected]:yesodweb/wai, commit: '2f8a8e1b771829f4a8a77c0111352ce45a14c30f', subdirs: [auto-update, wai]}"
+-}
+~~~
+
+Relative paths to local archive files are assumed to be relative to the
+directory in which the script file is located.
+
 ## Stack configuration for scripts
 
 When using the [`stack script`](../commands/script_command.md) command, as when

Diff for: package.yaml

@@ -99,7 +99,7 @@ dependencies:
 - neat-interpolation
 - open-browser
 - optparse-applicative >= 0.18.1.0
-- pantry >= 0.10.0
+- pantry >= 0.10.1
 - path >= 0.9.5
 - path-io
 # In order for Cabal (the tool) to build Stack, it needs to be told of the

Diff for: src/Stack/Config.hs

@@ -874,7 +874,7 @@ withBuildConfig inner = do
  where
   getEmptyProject ::
        Maybe RawSnapshotLocation
-    -> [PackageIdentifierRevision]
+    -> [RawPackageLocationImmutable]
     -> RIO Config Project
   getEmptyProject mSnapshot extraDeps = do
     snapshot <- case mSnapshot of
@@ -895,7 +895,7 @@ withBuildConfig inner = do
     pure Project
       { userMsg = Nothing
       , packages = []
-      , extraDeps = map (RPLImmutable . flip RPLIHackage Nothing) extraDeps
+      , extraDeps = map RPLImmutable extraDeps
       , flagsByPkg = mempty
       , snapshot
       , compiler = Nothing

Diff for: src/Stack/Options/ScriptParser.hs

@@ -58,8 +58,9 @@ scriptOptsParser = ScriptOpts
         ))
   <*> many (option extraDepRead
         (  long "extra-dep"
-        <> metavar "PACKAGE-VERSION"
-        <> help "Extra dependencies to be added to the snapshot."
+        <> metavar "EXTRA-DEP"
+        <> help "An immutable extra dependency to be added to the snapshot \
+                \(can be specified multiple times)."
         ))
   <*> (   flag' NoRun
             (  long "no-run"
@@ -69,4 +70,4 @@ scriptOptsParser = ScriptOpts
       )
  where
   extraDepRead = eitherReader $
-                   mapLeft show . parsePackageIdentifierRevision . fromString
+                   mapLeft show . parseRawPackageLocationImmutables . fromString

Diff for: src/Stack/Script.hs

@@ -16,6 +16,7 @@ module Stack.Script
 import           Data.ByteString.Builder ( toLazyByteString )
 import qualified Data.ByteString.Char8 as S8
 import qualified Data.Conduit.List as CL
+import qualified Data.List.NonEmpty as NE
 import           Data.List.Split ( splitWhen )
 import qualified Data.Map.Strict as Map
 import qualified Data.Set as Set
@@ -127,10 +128,9 @@ data ScriptOpts = ScriptOpts
   , compile :: !ScriptExecute
   , useRoot :: !Bool
   , ghcOptions :: ![String]
-  , scriptExtraDeps :: ![PackageIdentifierRevision]
+  , scriptExtraDeps :: ![Unresolved (NonEmpty RawPackageLocationImmutable)]
   , shouldRun :: !ShouldRun
   }
-  deriving Show
 
 -- | Run a Stack Script
 scriptCmd :: ScriptOpts -> RIO Runner ()
@@ -149,16 +149,20 @@ scriptCmd opts = do
 
   file <- resolveFile' opts.file
   let scriptFile = filename file
+      scriptRoot = parent file
 
   isNoRunCompile <- fromFirstFalse . (.noRunCompile) <$>
                            view (globalOptsL . to (.configMonoid))
 
+  resolvedExtraDeps <-
+    mapM (resolvePaths (Just scriptRoot)) opts.scriptExtraDeps
   let scriptDir = parent file
+      extraDeps = concatMap NE.toList resolvedExtraDeps
       modifyGO go = go
         { configMonoid = go.configMonoid
             { ConfigMonoid.installGHC = FirstTrue $ Just True
             }
-        , stackYaml = SYLNoProject opts.scriptExtraDeps
+        , stackYaml = SYLNoProject extraDeps
         }
       (shouldRun, shouldCompile) = if isNoRunCompile
         then (NoRun, SECompile)

Diff for: src/Stack/Types/ProjectConfig.hs

@@ -16,7 +16,7 @@ data ProjectConfig a
   | PCGlobalProject
     -- ^ No project was found when using 'SYLDefault'. Instead, use
     -- the implicit global.
-  | PCNoProject ![PackageIdentifierRevision]
+  | PCNoProject ![RawPackageLocationImmutable]
     -- ^ Use a no project run. This comes from 'SYLNoProject'.
 
 -- | Yields 'True' only if the project configuration information is for the

Diff for: src/Stack/Types/StackYamlLoc.hs

@@ -13,7 +13,7 @@ data StackYamlLoc
     -- ^ Use the standard parent-directory-checking logic
   | SYLOverride !(Path Abs File)
     -- ^ Use a specific stack.yaml file provided
-  | SYLNoProject ![PackageIdentifierRevision]
+  | SYLNoProject ![RawPackageLocationImmutable]
     -- ^ Do not load up a project, just user configuration. Include
     -- the given extra dependencies with the snapshot.
   | SYLGlobalProject

Diff for: stack.cabal

@@ -1,6 +1,6 @@
 cabal-version: 2.2
 
--- This file has been generated from package.yaml by hpack version 0.38.0.
+-- This file has been generated from package.yaml by hpack version 0.38.1.
 --
 -- see: https://github.com/sol/hpack
 
@@ -439,7 +439,7 @@ library
     , neat-interpolation
     , open-browser
     , optparse-applicative >=0.18.1.0
-    , pantry >=0.10.0
+    , pantry >=0.10.1
     , path >=0.9.5
     , path-io
     , persistent >=2.14.0.0 && <2.15
@@ -562,7 +562,7 @@ executable stack
     , neat-interpolation
     , open-browser
     , optparse-applicative >=0.18.1.0
-    , pantry >=0.10.0
+    , pantry >=0.10.1
     , path >=0.9.5
     , path-io
     , persistent >=2.14.0.0 && <2.15
@@ -666,7 +666,7 @@ executable stack-integration-test
     , open-browser
     , optparse-applicative >=0.18.1.0
     , optparse-generic
-    , pantry >=0.10.0
+    , pantry >=0.10.1
     , path >=0.9.5
     , path-io
     , persistent >=2.14.0.0 && <2.15
@@ -783,7 +783,7 @@ test-suite stack-unit-test
     , neat-interpolation
     , open-browser
     , optparse-applicative >=0.18.1.0
-    , pantry >=0.10.0
+    , pantry >=0.10.1
     , path >=0.9.5
     , path-io
     , persistent >=2.14.0.0 && <2.15

Diff for: stack.yaml

@@ -3,6 +3,11 @@ snapshot: lts-23.14 # GHC 9.8.4
 extra-deps:
 # lts-23.14 provides hpack-0.37.0
 - hpack-0.38.1
+# lts-23.14 provides pantry-0.10.0. See:
+# https://github.com/commercialhaskell/pantry/pull/142
+# This is temporary until pantry-0.10.1 is released.
+- git: https://github.com/commercialhaskell/pantry.git
+  commit: d0d05e2b950189d2db023313e3edd1610a873dd5
 
 docker:
   enable: false

Diff for: stack.yaml.lock

@@ -11,6 +11,17 @@ packages:
       size: 3798
   original:
     hackage: hpack-0.38.1
+- completed:
+    commit: d0d05e2b950189d2db023313e3edd1610a873dd5
+    git: https://github.com/commercialhaskell/pantry.git
+    name: pantry
+    pantry-tree:
+      sha256: 71c0a8d8999fc4dff290dc0dc2f2afc23b5a72a9996dc4988413920e3fc2f34d
+      size: 3698
+    version: 0.10.1
+  original:
+    commit: d0d05e2b950189d2db023313e3edd1610a873dd5
+    git: https://github.com/commercialhaskell/pantry.git
 snapshots:
 - completed:
     sha256: 1964d439d2a152be4238053f3f997a09fb348391984daab86d724975ef9a423f