"stack ghci" now does package hiding when non-local targets are specified

See #361 (comment)

Author: mgsloan

ChangeLog.md

@@ -115,6 +115,9 @@ Other enhancements:
   be optimal yet. The terminal width can be overriden with the
   new `--terminal-width` command-line option (this works even on
   non-POSIX).
+* Passing non local packages as targets to `stack ghci` will now
+  cause them to be used as `-package` args along with package
+  hiding.
 
 Bug fixes:
 

src/Stack/Ghci.hs

@@ -66,7 +66,7 @@ data GhciOpts = GhciOpts
     , ghciMainIs             :: !(Maybe Text)
     , ghciLoadLocalDeps      :: !Bool
     , ghciSkipIntermediate   :: !Bool
-    , ghciHidePackages       :: !Bool
+    , ghciHidePackages       :: !(Maybe Bool)
     , ghciNoBuild            :: !Bool
     , ghciOnlyMain           :: !Bool
     } deriving Show
@@ -138,31 +138,19 @@ ghci opts@GhciOpts{..} = do
             return (targetMap, Just (fileInfo, extraFiles))
     -- Get a list of all the local target packages.
     localTargets <- getAllLocalTargets opts inputTargets mainIsTargets sourceMap
+    -- Get a list of all the non-local target packages.
+    nonLocalTargets <- getAllNonLocalTargets inputTargets
     -- Check if additional package arguments are sensible.
     addPkgs <- checkAdditionalPackages ghciAdditionalPackages
     -- Build required dependencies and setup local packages.
     stackYaml <- view stackYamlL
     buildDepsAndInitialSteps opts (map (packageNameText . fst) localTargets)
-    when (M.null inputTargets && isNothing mfileTargets) $
-        prettyWarn $ vsep
-            [ flow "No targets specified, so ghci will not use any options from your package.yaml / *.cabal files."
-            , ""
-            , flow "Potential ways to resolve this:"
-            , bulletedList
-                [ fillSep
-                    [ flow "If you want to use the package.yaml / *.cabal package in the current directory, use"
-                    , styleShell "stack init"
-                    , flow "to create a new stack.yaml."
-                    ]
-                , flow "Add to the 'packages' field of" <+> display stackYaml
-                ]
-            , ""
-            ]
+    targetWarnings stackYaml localTargets nonLocalTargets mfileTargets
     -- Load the list of modules _after_ building, to catch changes in unlisted dependencies (#1180)
     pkgs <- getGhciPkgInfos buildOptsCLI sourceMap addPkgs (fmap fst mfileTargets) localTargets
     checkForIssues pkgs
     -- Finally, do the invocation of ghci
-    runGhci opts localTargets mainIsTargets pkgs (maybe [] snd mfileTargets)
+    runGhci opts localTargets mainIsTargets pkgs (maybe [] snd mfileTargets) (nonLocalTargets ++ addPkgs)
 
 preprocessTargets :: HasEnvConfig env => BuildOptsCLI -> [Text] -> RIO env (Either [Path Abs File] (Map PackageName Target))
 preprocessTargets buildOptsCLI rawTargets = do
@@ -286,6 +274,14 @@ getAllLocalTargets GhciOpts{..} targets0 mainIsTargets sourceMap = do
                     ]
             return (directlyWanted ++ extraLoadDeps)
 
+getAllNonLocalTargets
+    :: Map PackageName Target
+    -> RIO env [PackageName]
+getAllNonLocalTargets targets = do
+  let isNonLocal (TargetAll Dependency) = True
+      isNonLocal _ = False
+  return $ map fst $ filter (isNonLocal . snd) (M.toList targets)
+
 buildDepsAndInitialSteps :: HasEnvConfig env => GhciOpts -> [Text] -> RIO env ()
 buildDepsAndInitialSteps GhciOpts{..} targets0 = do
     let targets = targets0 ++ map T.pack ghciAdditionalPackages
@@ -317,14 +313,24 @@ runGhci
     -> Maybe (Map PackageName Target)
     -> [GhciPkgInfo]
     -> [Path Abs File]
+    -> [PackageName]
     -> RIO env ()
-runGhci GhciOpts{..} targets mainIsTargets pkgs extraFiles = do
+runGhci GhciOpts{..} targets mainIsTargets pkgs extraFiles exposePackages = do
     config <- view configL
     wc <- view $ actualCompilerVersionL.whichCompilerL
-    let pkgopts = hidePkgOpt ++ genOpts ++ ghcOpts
-        hidePkgOpt = if null pkgs || not ghciHidePackages then [] else ["-hide-all-packages"]
+    let pkgopts = hidePkgOpts ++ genOpts ++ ghcOpts
+        shouldHidePackages =
+          case ghciHidePackages of
+            -- Default to not hiding anything if there's nothing to
+            -- expose.
+            Nothing -> not (null pkgs && null exposePackages)
+            Just x -> x
+        hidePkgOpts =
+          if shouldHidePackages
+            then "-hide-all-packages" : concatMap (\n -> ["-package", packageNameString n]) exposePackages
+            else []
         oneWordOpts bio
-            | ghciHidePackages = bioOneWordOpts bio ++ bioPackageFlags bio
+            | shouldHidePackages = bioOneWordOpts bio ++ bioPackageFlags bio
             | otherwise = bioOneWordOpts bio
         genOpts = nubOrd (concatMap (concatMap (oneWordOpts . snd) . ghciPkgOpts) pkgs)
         (omittedOpts, ghcOpts) = partition badForGhci $
@@ -700,6 +706,40 @@ checkForDuplicateModules pkgs = do
         M.toList $ M.fromListWith (++) $
         concatMap (\pkg -> map ((, [ghciPkgName pkg]) . C.display) (S.toList (ghciPkgModules pkg))) pkgs
 
+targetWarnings
+  :: HasRunner env
+  => Path Abs File
+  -> [(PackageName, (Path Abs File, Target))]
+  -> [PackageName]
+  -> Maybe (Map PackageName (Set (Path Abs File)), [Path Abs File])
+  -> RIO env ()
+targetWarnings stackYaml localTargets nonLocalTargets mfileTargets = do
+  unless (null nonLocalTargets) $
+    prettyWarnL
+      [ flow "Some targets"
+      , parens $ fillSep $ punctuate "," $ map (styleGood . display) nonLocalTargets
+      , flow "are not local packages, and so cannot be directly loaded."
+      , flow "In future versions of stack, this might be supported - see"
+      , styleUrl "https://github.com/commercialhaskell/stack/issues/1441"
+      , "."
+      , flow "It can still be useful to specify these, as they will be passed to ghci via -package flags."
+      ]
+  when (null localTargets && isNothing mfileTargets) $
+      prettyWarn $ vsep
+          [ flow "No local targets specified, so ghci will not use any options from your package.yaml / *.cabal files."
+          , ""
+          , flow "Potential ways to resolve this:"
+          , bulletedList
+              [ fillSep
+                  [ flow "If you want to use the package.yaml / *.cabal package in the current directory, use"
+                  , styleShell "stack init"
+                  , flow "to create a new stack.yaml."
+                  ]
+              , flow "Add to the 'packages' field of" <+> display stackYaml
+              ]
+          , ""
+          ]
+
 -- Adds in intermediate dependencies between ghci targets. Note that it
 -- will return a Lib component for these intermediate dependencies even
 -- if they don't have a library (but that's fine for the usage within

src/Stack/Options/GhciParser.hs

@@ -52,6 +52,6 @@ ghciOptsParser = GhciOpts
              <*> switch (long "load-local-deps" <> help "Load all local dependencies of your targets")
              -- TODO: deprecate this? probably useless.
              <*> switch (long "skip-intermediate-deps" <> help "Skip loading intermediate target dependencies" <> internal)
-             <*> boolFlags True "package-hiding" "package hiding" idm
+             <*> optional (boolFlags True "package-hiding" "package hiding" idm)
              <*> switch (long "no-build" <> help "Don't build before launching GHCi" <> internal)
              <*> switch (long "only-main" <> help "Only load and import the main module.  If no main module, no modules will be loaded.")