Merge branch 'master' into nix_flake_fix_devShells

Author: jneira

.github/workflows/build.yml

@@ -48,6 +48,11 @@ jobs:
         echo "tests: false" >> cabal.project.local
         echo "benchmarks: false" >> cabal.project.local
 
+    - name: Disable -dynamic
+      run: |
+        echo "package haskell-language-server" >> cabal.project.local
+        echo "  flags: -dynamic" >> cabal.project.local
+
     - uses: ./.github/actions/setup-build
       with:
         ghc: ${{ matrix.ghc }}

docs/troubleshooting.md

@@ -165,34 +165,34 @@ Using an explicit `hie.yaml` to configure the cradle can resolve the problem, se
 Static binaries use the GHC linker for dynamically loading dependencies when typechecking TH code, and this can run into issues when loading shared objects linked against mismatching system libraries, or into GHC linker  bugs (mainly the Mach linker used in Mac OS, but also potentially the ELF linker).
 Dynamically linked binaries (including`ghci`) use the system linker instead of the GHC linker and avoid both issues.
 
-The easiest way to obtain a dynamically linked HLS binary is to build it locally. With `cabal` this can be done as follows:
+The easiest way to obtain a dynamically linked HLS binary is to build HLS locally. With `cabal` this can be done as follows:
 
 ```bash
-cabal update && cabal install pkg:haskell-language-server --ghc-options="-dynamic"
+cabal update && cabal install pkg:haskell-language-server"
 ```
 
 If you are compiling with a ghc version with a specific `cabal-ghc${ghcVersion}.project` in the repo you will have to use it. For example for ghc-9.0.x:
 
 ```bash
-cabal update && cabal install pkg:haskell-language-server --project-file=cabal-ghc90.project --ghc-options="-dynamic"
+cabal update && cabal install pkg:haskell-language-server --project-file=cabal-ghc90.project"
 ```
 
-With `stack` you also need add the ghc option `-dynamic`.
+Or with `stack`:
 
 ```bash
-stack install haskell-language-server --stack-yaml=stack-${ghcVersion}.yaml --ghc-options="-dynamic"
+stack install haskell-language-server --stack-yaml=stack-${ghcVersion}.yaml"
 ```
 
 You also can leverage `ghcup compile hls`:
 
 ```bash
-ghcup compile hls -g master --ghc 8.10.7 -- --ghc-options="-dynamic"
+ghcup compile hls -v 1.6.1.0 --ghc 8.10.7
 ```
 
 as it uses cabal underneath you might need to use a specific cabal.project for some ghc versions:
 
 ```bash
-ghcup compile hls -g master --ghc 9.0.2 --project-file cabal-ghc90.project -- --ghc-options="-dynamic"
+ghcup compile hls -v 1.6.1.0 --ghc 9.0.2 --cabal-project cabal-ghc90.project
 ```
 
 ### Preprocessors

ghcide/test/exe/Main.hs

@@ -1520,6 +1520,36 @@ extendImportTests = testGroup "extend import actions"
                     , "import ModuleA as A (stuffB, (.*))"
                     , "main = print (stuffB .* stuffB)"
                     ])
+        , knownBrokenForGhcVersions [GHC92] "missing comma. #2662" $ testSession "extend single line import with infix constructor" $ template
+            []
+            ("ModuleB.hs", T.unlines
+                    [ "module ModuleB where"
+                    , "import Data.List.NonEmpty (fromList)"
+                    , "main = case (fromList []) of _ :| _ -> pure ()"
+                    ])
+            (Range (Position 2 5) (Position 2 6))
+            ["Add NonEmpty((:|)) to the import list of Data.List.NonEmpty"]
+            (T.unlines
+                    [ "module ModuleB where"
+                    , "import Data.List.NonEmpty (fromList, NonEmpty ((:|)))"
+                    , "main = case (fromList []) of _ :| _ -> pure ()"
+                    ])
+        , knownBrokenForGhcVersions [GHC92] "missing comma. #2662" $ testSession "extend single line import with prefix constructor" $ template
+            []
+            ("ModuleB.hs", T.unlines
+                    [ "module ModuleB where"
+                    , "import Prelude hiding (Maybe(..))"
+                    , "import Data.Maybe (catMaybes)"
+                    , "x = Just 10"
+                    ])
+            (Range (Position 3 5) (Position 2 6))
+            ["Add Maybe(Just) to the import list of Data.Maybe"]
+            (T.unlines
+                    [ "module ModuleB where"
+                    , "import Prelude hiding (Maybe(..))"
+                    , "import Data.Maybe (catMaybes, Maybe (Just))"
+                    , "x = Just 10"
+                    ])
         , testSession "extend single line import with type" $ template
             [("ModuleA.hs", T.unlines
                     [ "module ModuleA where"

haskell-language-server.cabal

@@ -208,6 +208,11 @@ flag brittany
   default:     True
   manual:      True
 
+flag dynamic
+  description: Build with the dyn rts
+  default:     True
+  manual:      True
+
 common example-plugins
   hs-source-dirs: plugins/default/src
   other-modules: Ide.Plugin.Example,
@@ -364,6 +369,15 @@ executable haskell-language-server
     -Wno-unticked-promoted-constructors
   if flag(pedantic)
     ghc-options: -Werror
+  if !os(windows) && flag(dynamic)
+  -- We want to link against the dyn rts just like official GHC binaries do;
+  --   the linked rts determines how external libs are loaded dynamically by TH.
+  -- The standard way of doing this is via the --enable-dynamic-executables Cabal option
+  -- Unfortunately it doesnt' work, see https://github.com/haskell/haskell-language-server/issues/2659
+  -- One can use --ghc-options=-dynamic but this gets applied to the dependencies as well,
+  -- which results in massive rebuilds and incompatibilities with profiling.
+  -- So instead we set the -dynamic flag diretly here.
+    ghc-options: -dynamic
 
   build-depends:
     , aeson

plugins/hls-eval-plugin/hls-eval-plugin.cabal

@@ -45,6 +45,7 @@ library
   other-modules:
     Ide.Plugin.Eval.Code
     Ide.Plugin.Eval.CodeLens
+    Ide.Plugin.Eval.Config
     Ide.Plugin.Eval.GHC
     Ide.Plugin.Eval.Parse.Comments
     Ide.Plugin.Eval.Parse.Option
@@ -105,10 +106,12 @@ test-suite tests
   build-depends:
     , aeson
     , base
+    , containers
     , directory
     , extra
     , filepath
     , hls-eval-plugin
+    , hls-plugin-api
     , hls-test-utils   ^>=1.2
     , lens
     , lsp-types

plugins/hls-eval-plugin/src/Ide/Plugin/Eval.hs

@@ -11,17 +11,23 @@ module Ide.Plugin.Eval (
 
 import           Development.IDE          (IdeState)
 import qualified Ide.Plugin.Eval.CodeLens as CL
+import           Ide.Plugin.Eval.Config
 import           Ide.Plugin.Eval.Rules    (rules)
-import           Ide.Types                (PluginDescriptor (..), PluginId,
+import           Ide.Types                (ConfigDescriptor (..),
+                                           PluginDescriptor (..), PluginId,
+                                           defaultConfigDescriptor,
                                            defaultPluginDescriptor,
-                                           mkPluginHandler)
+                                           mkCustomConfig, mkPluginHandler)
 import           Language.LSP.Types
 
 -- |Plugin descriptor
 descriptor :: PluginId -> PluginDescriptor IdeState
 descriptor plId =
     (defaultPluginDescriptor plId)
         { pluginHandlers = mkPluginHandler STextDocumentCodeLens CL.codeLens
-        , pluginCommands = [CL.evalCommand]
+        , pluginCommands = [CL.evalCommand plId]
         , pluginRules = rules
+        , pluginConfigDescriptor = defaultConfigDescriptor
+                                   { configCustomConfig = mkCustomConfig properties
+                                   }
         }