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

Author: soulomoon

.github/mergify.yml

@@ -2,26 +2,19 @@ queue_rules:
   - name: default
     # Mergify always respects the branch protection settings
     # so we can left empty mergify own ones
-    conditions: []
-
-pull_request_rules:
-  - name: Automatically merge pull requests
-    conditions:
+    queue_conditions:
       - label=merge me
       - '#approved-reviews-by>=1'
-    actions:
-      queue:
-        method: squash
-        name: default
-  # The queue action automatically updates PRs that
-  # have entered the queue, but in order to do that
-  # they must have passed CI. Since our CI is a bit
-  # flaky, PRs can fail to get in, which then means
-  # they don't get updated, which is extra annoying.
-  # This just adds the updating as an independent 
-  # step.
+    merge_conditions: []
+    merge_method: squash
+
+pull_request_rules:
   - name: Automatically update pull requests
     conditions:
       - label=merge me
     actions:
       update:
+  - name: refactored queue action rule
+    conditions: []
+    actions:
+      queue:

cabal.project

@@ -8,7 +8,7 @@ packages:
          ./hls-test-utils
 
 
-index-state:  2024-11-02T00:00:00Z
+index-state:  2024-12-02T00:00:00Z
 
 tests: True
 test-show-details: direct
@@ -47,7 +47,17 @@ if impl(ghc >= 9.9)
   -- https://github.com/haskell/haskell-language-server/issues/4324
   benchmarks: False
 
+if impl(ghc >= 9.8.4) && impl(ghc < 9.8.5)
+  -- By depending on ghc-lib-parser and ghc, we are encountering
+  -- a constraint conflict, ghc-9.8.4 comes with `filepath-1.4.301.0`,
+  -- and `ghc-lib-parser-9.8.4.20241130` specifies `filepath >=1.5 && < 1.6.
+  -- See https://github.com/digital-asset/ghc-lib/issues/572 for details.
+  allow-older:
+    ghc-lib-parser:filepath
+  constraints:
+    ghc-lib-parser==9.8.4.20241130
+
 source-repository-package
   type: git
   location: https://github.com/soulomoon/hie-bios.git
-  tag: 93582c21372af573e5103bad198777a3317a2df2
+  tag: 93582c21372af573e5103bad198777a3317a2df2

docs/requirements.txt

@@ -1,4 +1,4 @@
-Sphinx~=5.3.0
-sphinx-rtd-theme~=1.1.0
-myst-parser~=1.0.0
-docutils<0.19
+Sphinx~=8.1.3
+sphinx-rtd-theme~=3.0.2
+myst-parser~=4.0.0
+docutils~=0.21.2

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/CabalAdd.hs

@@ -156,9 +156,8 @@ addDependencySuggestCodeAction plId verTxtDocId suggestions haskellFilePath caba
     -- | Gives the build targets that are used in the `CabalAdd`.
     -- Note the unorthodox usage of `readBuildTargets`:
     -- If the relative path to the haskell file is provided,
-    -- the `readBuildTargets` will return a main build target.
-    -- This behaviour is acceptable for now, but changing to a way of getting
-    -- all build targets in a file is advised.
+    -- the `readBuildTargets` will return build targets, where this
+    -- module is mentioned (in exposed-modules or other-modules).
     getBuildTargets :: GenericPackageDescription -> FilePath -> FilePath -> IO [BuildTarget]
     getBuildTargets gpd cabalFilePath haskellFilePath = do
       let haskellFileRelativePath = makeRelative (dropFileName cabalFilePath) haskellFilePath
@@ -167,10 +166,10 @@ addDependencySuggestCodeAction plId verTxtDocId suggestions haskellFilePath caba
     mkCodeAction :: FilePath -> Maybe String -> (T.Text, T.Text) -> CodeAction
     mkCodeAction cabalFilePath target (suggestedDep, suggestedVersion) =
       let
-        versionTitle = if T.null suggestedVersion then T.empty else "  version " <> suggestedVersion
+        versionTitle = if T.null suggestedVersion then T.empty else "-" <> suggestedVersion
         targetTitle = case target of
           Nothing -> T.empty
-          Just t  -> "  target " <> T.pack t
+          Just t  -> " at " <> T.pack t
         title = "Add dependency " <> suggestedDep <> versionTitle <> targetTitle
         version = if T.null suggestedVersion then Nothing else Just suggestedVersion
 

plugins/hls-cabal-plugin/test/CabalAdd.hs

@@ -27,16 +27,30 @@ cabalAddTests :: TestTree
 cabalAddTests =
   testGroup
     "CabalAdd Tests"
-    [ runHaskellTestCaseSession "Code Actions - Can add hidden package" ("cabal-add-testdata" </> "cabal-add-exe")
+    [ runHaskellTestCaseSession "Code Actions - Can add hidden package to an executable" ("cabal-add-testdata" </> "cabal-add-exe")
         (generateAddDependencyTestSession "cabal-add-exe.cabal" ("src" </> "Main.hs") "split" [253])
-    , runHaskellTestCaseSession "Code Actions - Guard against HPack" ("cabal-add-testdata" </> "cabal-add-packageYaml")
-        (generatePackageYAMLTestSession ("src" </> "Main.hs"))
     , runHaskellTestCaseSession "Code Actions - Can add hidden package to a library" ("cabal-add-testdata" </> "cabal-add-lib")
         (generateAddDependencyTestSession "cabal-add-lib.cabal" ("src" </> "MyLib.hs") "split" [348])
     , runHaskellTestCaseSession "Code Actions - Can add hidden package to a test" ("cabal-add-testdata" </> "cabal-add-tests")
         (generateAddDependencyTestSession "cabal-add-tests.cabal" ("test" </> "Main.hs") "split" [478])
     , runHaskellTestCaseSession "Code Actions - Can add hidden package to a benchmark" ("cabal-add-testdata" </> "cabal-add-bench")
         (generateAddDependencyTestSession "cabal-add-bench.cabal" ("bench" </> "Main.hs") "split" [403])
+
+    , runHaskellTestCaseSession "Code Actions - Can add hidden package to an executable, multiple targets" ("cabal-add-testdata" </> "cabal-add-multitarget")
+        (generateAddDependencyTestSession "cabal-add-multitarget.cabal" ("src" </> "Main.hs") "split" [269])
+    , runHaskellTestCaseSession "Code Actions - Can add hidden package to a library, multiple targets" ("cabal-add-testdata" </> "cabal-add-multitarget")
+        (generateAddDependencyTestSession "cabal-add-multitarget.cabal" ("lib" </> "MyLib.hs") "split" [413])
+    , runHaskellTestCaseSession "Code Actions - Can add hidden package to an internal library, multiple targets" ("cabal-add-testdata" </> "cabal-add-multitarget")
+        (generateAddDependencyTestSession "cabal-add-multitarget.cabal" ("lib" </> "InternalLib.hs") "split" [413])
+    , runHaskellTestCaseSession "Code Actions - Can add hidden package to a test, multiple targets" ("cabal-add-testdata" </> "cabal-add-multitarget")
+        (generateAddDependencyTestSession "cabal-add-multitarget.cabal" ("test" </> "Main.hs") "split" [655])
+    , runHaskellTestCaseSession "Code Actions - Can add hidden package to a benchmark, multiple targets" ("cabal-add-testdata" </> "cabal-add-multitarget")
+        (generateAddDependencyTestSession "cabal-add-multitarget.cabal" ("bench" </> "Main.hs") "split" [776])
+
+
+    , runHaskellTestCaseSession "Code Actions - Guard against HPack" ("cabal-add-testdata" </> "cabal-add-packageYaml")
+        (generatePackageYAMLTestSession ("src" </> "Main.hs"))
+
     , testHiddenPackageSuggestions "Check CabalAdd's parser, no version"
                                    [ "It is a member of the hidden package 'base'"
                                    , "It is a member of the hidden package 'Blammo-wai'"

plugins/hls-cabal-plugin/test/testdata/cabal-add-testdata/cabal-add-multitarget/bench/Main.hs

@@ -0,0 +1,6 @@
+module Main (main) where
+
+import Data.List.Split
+
+main :: IO ()
+main = putStrLn "Test suite not yet implemented."

plugins/hls-cabal-plugin/test/testdata/cabal-add-testdata/cabal-add-multitarget/cabal-add-multitarget.cabal

@@ -0,0 +1,33 @@
+cabal-version:       2.4
+name:                cabal-add-multitarget
+version:             0.1.0.0
+build-type:          Simple
+
+executable cabal-add-exe
+    main-is:             Main.hs
+    hs-source-dirs:      src
+    ghc-options:         -Wall
+    build-depends:       base
+    default-language:    Haskell2010
+
+library
+    exposed-modules:     MyLib
+    other-modules:       InternalLib
+    build-depends:       base >= 4 && < 5
+    hs-source-dirs:      lib
+    ghc-options:         -Wall
+
+test-suite cabal-add-tests-test
+    main-is:             Main.hs
+    hs-source-dirs:      test
+    type:                exitcode-stdio-1.0
+    build-depends:       base
+    default-language:    Haskell2010
+
+benchmark benchmark
+    main-is:             Main.hs
+    build-depends:       base
+    hs-source-dirs:      bench
+    type:                exitcode-stdio-1.0
+    ghc-options:         -threaded
+

plugins/hls-cabal-plugin/test/testdata/cabal-add-testdata/cabal-add-multitarget/lib/InternalLib.hs

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

plugins/hls-cabal-plugin/test/testdata/cabal-add-testdata/cabal-add-multitarget/lib/MyLib.hs

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

plugins/hls-cabal-plugin/test/testdata/cabal-add-testdata/cabal-add-multitarget/src/Main.hs

@@ -0,0 +1,5 @@
+module Main where
+
+import Data.List.Split
+
+main = putStrLn "Hello, Haskell!"