adding whole-project loading

Author: Saizan

cabal.project

@@ -6,7 +6,7 @@ packages:
          ./hls-plugin-api
          ./hls-test-utils
 
-index-state: 2026-04-16T00:00:00Z
+index-state: 2026-07-03T13:55:55Z
 
 tests: True
 test-show-details: direct

ghcide/ghcide.cabal

@@ -74,7 +74,7 @@ library
     , Glob
     , haddock-library              >=1.8      && <1.12
     , hashable
-    , hie-bios                     ^>= 0.19.0
+    , hie-bios                     ^>= 0.20.0
     , hiedb                        ^>= 0.8.0.0
     , hls-graph                    == 2.14.0.0
     , hls-plugin-api               == 2.14.0.0

ghcide/session-loader/Development/IDE/Session.hs

@@ -1040,7 +1040,7 @@ cradleToOptsAndLibDir recorder loadConfig cradle file old_fps = do
     --     noneCradleFoundMessage f = T.pack $ "none cradle found for " <> f <> ", ignoring the file"
     -- Start off by getting the session options
     logWith recorder Debug $ LogCradle cradle
-    cradleRes <- HieBios.getCompilerOptions file loadStyle cradle
+    cradleRes <- HieBios.getCompilerOptions (TargetWithContext file old_fps) loadStyle cradle
     case cradleRes of
         CradleSuccess r -> do
             -- Now get the GHC lib dir
@@ -1061,8 +1061,9 @@ cradleToOptsAndLibDir recorder loadConfig cradle file old_fps = do
 
     where
         loadStyle = case loadConfig of
-            PreferSingleComponentLoading -> LoadFile
-            PreferMultiComponentLoading  -> LoadWithContext old_fps
+            PreferSingleComponentLoading   -> LoadFile
+            PreferMultiComponentLoading    -> LoadFileWithContext
+            PreferMultiWholeProjectLoading -> LoadUnitsFromCradle
 
 -- ----------------------------------------------------------------------------
 -- Utilities

ghcide/session-loader/Development/IDE/Session/Implicit.hs

@@ -78,12 +78,12 @@ stackCradle fp = do
   pkgsWithComps <- liftIO $ catMaybes <$> mapM (nestedPkg fp) pkgs
   let yaml = fp </> "stack.yaml"
   pure $ (,fp) $ case pkgsWithComps of
-    [] -> Stack (StackType Nothing (Just yaml))
+    [] -> Stack (StackType Nothing (Just yaml) Nothing)
     ps -> StackMulti mempty $ do
       Package n cs <- ps
       c <- cs
       let (prefix, comp) = Implicit.stackComponent n c
-      pure (prefix, StackType (Just comp) (Just yaml))
+      pure (prefix, StackType (Just comp) (Just yaml) Nothing)
 
 -- | By default, we generate a simple cabal cradle which is equivalent to the
 -- following hie.yaml:
@@ -95,7 +95,7 @@ stackCradle fp = do
 --
 -- Note, this only works reliable for reasonably modern cabal versions >= 3.2.
 simpleCabalCradle :: FilePath -> (CradleTree a, FilePath)
-simpleCabalCradle fp = (Cabal $ CabalType Nothing Nothing, fp)
+simpleCabalCradle fp = (Cabal $ CabalType Nothing Nothing Nothing, fp)
 
 cabalExecutable :: MaybeT IO FilePath
 cabalExecutable = MaybeT $ findExecutable "cabal"

hls-plugin-api/src/Ide/Plugin/Config.hs

@@ -10,16 +10,17 @@ module Ide.Plugin.Config
     , CheckParents(..)
     ) where
 
-import           Control.Lens     (preview)
-import           Data.Aeson       hiding (Error)
-import qualified Data.Aeson       as A
-import           Data.Aeson.Lens  (_String)
-import qualified Data.Aeson.Types as A
+import           Control.Applicative
+import           Control.Lens        (preview)
+import           Data.Aeson          hiding (Error)
+import qualified Data.Aeson          as A
+import           Data.Aeson.Lens     (_String)
+import qualified Data.Aeson.Types    as A
 import           Data.Default
-import qualified Data.Map.Strict  as Map
-import           Data.Maybe       (fromMaybe)
-import qualified Data.Text        as T
-import           GHC.Exts         (toList)
+import qualified Data.Map.Strict     as Map
+import           Data.Maybe          (fromMaybe)
+import qualified Data.Text           as T
+import           GHC.Exts            (toList)
 import           Ide.Types
 
 -- ---------------------------------------------------------------------
@@ -42,11 +43,15 @@ parseConfig idePlugins defValue = A.withObject "settings" $ \o ->
     <*> o .:? "formattingProvider"                      .!= formattingProvider defValue
     <*> o .:? "cabalFormattingProvider"                 .!= cabalFormattingProvider defValue
     <*> o .:? "maxCompletions"                          .!= maxCompletions defValue
-    <*> o .:? "sessionLoading"                          .!= sessionLoading defValue
+    <*> loadingPref o
     <*> o .:? "linkSourceTo"                            .!= linkSourceTo defValue
     <*> o .:? "linkDocTo"                               .!=
         linkDocTo defValue
     <*> A.explicitParseFieldMaybe (parsePlugins idePlugins) o "plugin" .!= plugins defValue
+    where
+      loadingPref o =
+        (o .:? "componentsLoading"
+        <|> o .:? "sessionLoading") .!= sessionLoading defValue
 
 -- | Parse the 'PluginConfig'.
 --   Since we need to fall back to default values if we do not find one in the input,

hls-plugin-api/src/Ide/Types.hs

@@ -78,6 +78,7 @@ import           Data.Hashable                 (Hashable)
 import           Data.HashMap.Strict           (HashMap)
 import qualified Data.HashMap.Strict           as HashMap
 import           Data.Kind                     (Type)
+import qualified Data.List                     as List
 import           Data.List.Extra               (find, sortOn)
 import           Data.List.NonEmpty            (NonEmpty (..), toList)
 import qualified Data.Map                      as Map
@@ -192,7 +193,7 @@ instance ToJSON Config where
            , "formattingProvider"          .= formattingProvider
            , "cabalFormattingProvider"     .= cabalFormattingProvider
            , "maxCompletions"              .= maxCompletions
-           , "sessionLoading"              .= sessionLoading
+           , "componentsLoading"           .= sessionLoading
            , "linkSourceTo"                .= linkSourceTo
            , "linkDocTo"                   .= linkDocTo
            , "plugin"                      .= Map.mapKeysMonotonic (\(PluginId p) -> p) plugins
@@ -240,24 +241,40 @@ data SessionLoadingPreferenceConfig
     --
     -- The cradle can decide how to handle these situations, and whether
     -- to honour the preference at all.
+    | PreferMultiWholeProjectLoading
+    -- ^ Prefer loading all the components specified in the cradle, if possible.
   deriving stock (Eq, Ord, Show, Generic)
 
 instance Pretty SessionLoadingPreferenceConfig where
-    pretty PreferSingleComponentLoading = "Prefer Single Component Loading"
-    pretty PreferMultiComponentLoading  = "Prefer Multiple Components Loading"
+    pretty PreferSingleComponentLoading   = "Prefer Single Component Loading"
+    pretty PreferMultiComponentLoading    = "Prefer Multiple Components Loading"
+    pretty PreferMultiWholeProjectLoading = "Prefer Whole Project Loading"
 
 instance ToJSON SessionLoadingPreferenceConfig where
     toJSON PreferSingleComponentLoading =
-        String "singleComponent"
+        String "single"
     toJSON PreferMultiComponentLoading =
-        String "multipleComponents"
+        String "multi: needed-only"
+    toJSON PreferMultiWholeProjectLoading =
+        String "multi: whole-project"
 
 instance FromJSON SessionLoadingPreferenceConfig where
     parseJSON (String val) = case val of
         "singleComponent"    -> pure PreferSingleComponentLoading
+        "single"             -> pure PreferSingleComponentLoading
         "multipleComponents" -> pure PreferMultiComponentLoading
+        "multi: needed-only" -> pure PreferMultiComponentLoading
+        "multi: whole-project" -> pure PreferMultiWholeProjectLoading
         _ -> A.prependFailure "parsing SessionLoadingPreferenceConfig failed, "
-            (A.parseFail $ "Expected one of \"singleComponent\" or \"multipleComponents\" but got " <> T.unpack val )
+            (A.parseFail $ unwords ["Expected one of", expected,  "but got", T.unpack val] )
+          where
+            expected = concat ["[", List.intercalate ", " fields, "]"]
+            fields = map (show @String)
+              ["single", "multi: only-needed", "multi: whole-project"]
+              ++
+              [ show @String old_value ++ " (deprecated)"
+              | old_value <- ["singleComponent","multiComponent"]
+              ]
     parseJSON o = A.prependFailure "parsing SessionLoadingPreferenceConfig failed, "
             (A.typeMismatch "String" o)
 

stack-lts24.yaml

@@ -21,7 +21,7 @@ extra-deps:
   - hiedb-0.8.0.0
   - hie-compat-0.3.1.2
   - implicit-hie-0.1.4.0
-  - hie-bios-0.19.0
+  - hie-bios-0.20.0
   - hw-fingertree-0.1.2.1
   - monad-dijkstra-0.1.1.5
   - unordered-containers-0.2.21

stack.yaml

@@ -22,7 +22,7 @@ extra-deps:
   - hiedb-0.8.0.0
   - hie-compat-0.3.1.2
   - implicit-hie-0.1.4.0
-  - hie-bios-0.19.0
+  - hie-bios-0.20.0
   - hw-fingertree-0.1.2.1
   - monad-dijkstra-0.1.1.5
   - unordered-containers-0.2.21

test/testdata/schema/ghc910/default-config.golden.json

@@ -2,6 +2,7 @@
     "cabalFormattingProvider": "cabal-gild",
     "checkParents": "CheckOnSave",
     "checkProject": true,
+    "componentsLoading": "multi: needed-only",
     "formattingProvider": "ormolu",
     "linkDocTo": "LinkToHackage",
     "linkSourceTo": "LinkToHackage",
@@ -159,6 +160,5 @@
         "stan": {
             "globalOn": false
         }
-    },
-    "sessionLoading": "multipleComponents"
+    }
 }

test/testdata/schema/ghc912/default-config.golden.json

@@ -2,6 +2,7 @@
     "cabalFormattingProvider": "cabal-gild",
     "checkParents": "CheckOnSave",
     "checkProject": true,
+    "componentsLoading": "multi: needed-only",
     "formattingProvider": "ormolu",
     "linkDocTo": "LinkToHackage",
     "linkSourceTo": "LinkToHackage",
@@ -163,6 +164,5 @@
         "splice": {
             "globalOn": true
         }
-    },
-    "sessionLoading": "multipleComponents"
+    }
 }