Merge branch 'master' into batch-load-multi-read

Author: soulomoon

.github/actions/setup-build/action.yml

@@ -7,7 +7,7 @@ inputs:
   cabal:
     description: "Cabal version"
     required: false
-    default: "3.10.2.0"
+    default: "3.14.2.0"
   os:
     description: "Operating system: Linux, Windows or macOS"
     required: true

.github/workflows/bench.yml

@@ -123,7 +123,7 @@ jobs:
       matrix:
         ghc: ['9.8', '9.10']
         os: [ubuntu-latest]
-        cabal: ['3.10']
+        cabal: ['3.14']
         example: ['cabal', 'lsp-types']
 
     steps:

cabal.project

@@ -8,7 +8,7 @@ packages:
          ./hls-test-utils
 
 
-index-state: 2025-04-26T07:34:07Z
+index-state: 2025-05-06T13:26:29Z
 
 tests: True
 test-show-details: direct

docs/configuration.md

@@ -41,9 +41,11 @@ This option obviously would not make sense for language servers for other langua
 Here is a list of the additional settings currently supported by `haskell-language-server`, along with their setting key (you may not need to know this) and default:
 
 - Formatting provider (`haskell.formattingProvider`, default `ormolu`): what formatter to use; one of `floskell`, `ormolu`, `fourmolu`, or `stylish-haskell`.
+- Cabal formatting provider (`haskell.cabalFormattingProvider`, default `cabal-gild`): what formatter to use for cabal files; one of `cabal-gild` or `cabal-fmt`.
 - Max completions (`haskell.maxCompletions`, default 40): maximum number of completions sent to the LSP client.
 - Check project (`haskell.checkProject`, default true): whether to typecheck the entire project on initial load. As it is activated by default could drive to bad performance in large projects.
 - Check parents (`haskell.checkParents`, default `CheckOnSave`): when to typecheck reverse dependencies of a file; one of `NeverCheck`, `CheckOnSave` (means dependent/parent modules will only be checked when you save), or `AlwaysCheck` (means re-typechecking them on every change).
+- Session loading preference (`haskell.sessionLoading`, default `singleComponent`): how to load sessions; one of `singleComponent` (means always loading only a single component when a new component is discovered) or `multipleComponents` (means always preferring loading multiple components in the cradle at once). `multipleComponents` might not be always possible, if the tool doesn't support multiple components loading. The cradle can decide how to handle these situations, and whether to honour the preference at all.
 
 #### Generic plugin configuration
 

docs/features.md

@@ -411,6 +411,17 @@ Known limitations:
 
 - Cross-module renaming requires all components to be indexed, which sometimes causes [partial renames in multi-component projects](https://github.com/haskell/haskell-language-server/issues/2193).
 
+To eagerly load all components, you need to
+
+- set `haskell.sessionLoading` to `multipleComponents`,
+- set `hie.yaml` to load all components (currently only cabal supports this),
+  ```yaml
+  cradle:
+    cabal:
+      component: all
+  ```
+- and enable tests and benchmarks in `cabal.project` with `tests: True` and `benchmarks: True`.
+
 ## Semantic tokens
 
 Provided by: `hls-semantic-tokens-plugin`

ghcide-test/data/watched-files/reload/reload.cabal

@@ -0,0 +1,12 @@
+cabal-version:      2.4
+name:               reload
+version:            0.1.0.0
+author:             Lin Jian
+maintainer:         [email protected]
+build-type:         Simple
+
+library
+  exposed-modules:  MyLib
+  build-depends:    base
+  hs-source-dirs:   src
+  default-language: Haskell2010

ghcide-test/data/watched-files/reload/src/MyLib.hs

@@ -0,0 +1,6 @@
+module MyLib (someFunc) where
+
+import Data.List.Split
+
+someFunc :: IO ()
+someFunc = putStrLn "someFunc"

ghcide-test/exe/WatchedFileTests.hs

@@ -3,11 +3,14 @@
 
 module WatchedFileTests (tests) where
 
-import           Config                          (testWithDummyPluginEmpty')
+import           Config                          (mkIdeTestFs,
+                                                  testWithDummyPlugin',
+                                                  testWithDummyPluginEmpty')
 import           Control.Applicative.Combinators
 import           Control.Monad.IO.Class          (liftIO)
 import qualified Data.Aeson                      as A
 import qualified Data.Text                       as T
+import qualified Data.Text.IO                    as T
 import           Development.IDE.Test            (expectDiagnostics)
 import           Language.LSP.Protocol.Message
 import           Language.LSP.Protocol.Types     hiding
@@ -18,6 +21,7 @@ import           Language.LSP.Protocol.Types     hiding
 import           Language.LSP.Test
 import           System.Directory
 import           System.FilePath
+import           Test.Hls.FileSystem
 import           Test.Tasty
 import           Test.Tasty.HUnit
 
@@ -69,6 +73,17 @@ tests = testGroup "watched files"
         sendNotification SMethod_WorkspaceDidChangeWatchedFiles $ DidChangeWatchedFilesParams
                [FileEvent (filePathToUri $ sessionDir </> "B.hs") FileChangeType_Changed ]
         expectDiagnostics [("A.hs", [(DiagnosticSeverity_Error, (3, 4), "Couldn't match expected type '()' with actual type 'Int'", Just "GHC-83865")])]
+      , testWithDummyPlugin' "reload HLS after .cabal file changes" (mkIdeTestFs [copyDir ("watched-files" </> "reload")]) $ \sessionDir -> do
+          let hsFile = "src" </> "MyLib.hs"
+          _ <- openDoc hsFile "haskell"
+          expectDiagnostics [(hsFile, [(DiagnosticSeverity_Error, (2, 7), "Could not load module \8216Data.List.Split\8217", Nothing)])]
+          let cabalFile = "reload.cabal"
+          cabalContent <- liftIO $ T.readFile cabalFile
+          let fix = T.replace "build-depends:    base" "build-depends:    base, split"
+          liftIO $ T.writeFile cabalFile (fix cabalContent)
+          sendNotification SMethod_WorkspaceDidChangeWatchedFiles $ DidChangeWatchedFilesParams
+            [ FileEvent (filePathToUri $ sessionDir </> cabalFile) FileChangeType_Changed ]
+          expectDiagnostics [(hsFile, [])]
     ]
   ]
 

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

@@ -893,13 +893,18 @@ loadSessionWithOptions recorder SessionLoadingOptions{..} rootDir que = do
         checkInCache ncfp = runMaybeT $ do
                cachedHieYamlLocation <- MaybeT $ STM.lookup ncfp (filesMap sessionState)
                m <- MaybeT $ STM.lookup cachedHieYamlLocation (fileToFlags sessionState)
-               MaybeT $ pure $ HM.lookup ncfp m
+               -- Each one of deps will be registered as a FileSystemWatcher in the GhcSession action
+               -- so that we can get a workspace/didChangeWatchedFiles notification when a dep changes.
+               -- The GlobPattern of a FileSystemWatcher can be absolute or relative.
+               -- We use the absolute one because it is supported by more LSP clients.
+               -- Here we make sure deps are absolute and later we use those absolute deps as GlobPattern.
+               let absolutePathsCradleDeps (eq, deps) = (eq, fmap toAbsolutePath deps)
+               MaybeT $ pure $ absolutePathsCradleDeps <$> HM.lookup ncfp m
 
     -- The main function which gets options for a file. We only want one of these running
     -- at a time. Therefore the IORef contains the currently running cradle, if we try
     -- to get some more options then we wait for the currently running action to finish
     -- before attempting to do so.
-
     let getOptionsLoop :: IO ()
         getOptionsLoop = do
             -- Get the next file to load

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

@@ -28,15 +28,17 @@ data CradleErrorDetails =
   Depicts the cradle error in a user-friendly way.
 -}
 renderCradleError :: CradleError -> Cradle a -> NormalizedFilePath -> FileDiagnostic
-renderCradleError (CradleError deps _ec ms _attemptToLoadFiles) cradle nfp =
+renderCradleError cradleError cradle nfp =
   let noDetails =
         ideErrorWithSource (Just "cradle") (Just DiagnosticSeverity_Error) nfp (T.unlines $ map T.pack userFriendlyMessage) Nothing
   in
   if HieBios.isCabalCradle cradle
      then noDetails & fdLspDiagnosticL %~ \diag -> diag{_data_ = Just $ Aeson.toJSON CradleErrorDetails{cabalProjectFiles=absDeps}}
      else noDetails
   where
-    absDeps = fmap (cradleRootDir cradle </>) deps
+    ms = cradleErrorStderr cradleError
+
+    absDeps = fmap (cradleRootDir cradle </>) (cradleErrorDependencies cradleError)
     userFriendlyMessage :: [String]
     userFriendlyMessage
       | HieBios.isCabalCradle cradle = fromMaybe ms $ fileMissingMessage <|> mkUnknownModuleMessage