Merge remote-tracking branch 'upstream/master' into 1875-tests-randomly-fail-with-exception-fd111-hputbuf-resource-vanished-broken-pipe---test-option-j1-workaround

soulomoon · soulomoon · commit 08350aa6f03c · 2025-09-06T01:00:50.000+08:00
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -443,22 +443,20 @@ This will install `eglot` and enable it by default in `haskell-mode`.
 To configure `haskell-language-server` we use the `eglot-workspace-configuration` variable.
 With `M-x eglot-show-workspace-configuration` you can see the JSON that `eglot` will send to `haskell-language-server`.
 See <https://joaotavora.github.io/eglot/#Customizing-Eglot> for more information.
-As an example, the setting below will disable the `stan` plugin.
+As an example, the setting below will disable the `stan` plugin and use `fourmolu` for formatting:
 
 ```emacs-lisp
 (use-package eglot
   :ensure t
   :config
-  (add-hook 'haskell-mode-hook 'eglot-ensure)
+  (add-hook 'haskell-mode-hook 'eglot-ensure) ; start eglot automatically in haskell projects
   :config
   (setq-default eglot-workspace-configuration
-                '((haskell
-                   (plugin
-                    (stan
-                     (globalOn . :json-false))))))  ;; disable stan
+                '(:haskell (:plugin (:stan (:globalOn :json-false)) ; disable stan
+                            :formattingProvider "fourmolu")))       ; use fourmolu instead of ormolu
   :custom
-  (eglot-autoshutdown t)  ;; shutdown language server after closing last file
-  (eglot-confirm-server-initiated-edits nil)  ;; allow edits without confirmation
+  (eglot-autoshutdown t)  ; shutdown language server after closing last file
+  (eglot-confirm-server-initiated-edits nil)  ; allow edits without confirmation
   )
 ```
 
diff --git a/ghcide-test/exe/DiagnosticTests.hs b/ghcide-test/exe/DiagnosticTests.hs
@@ -244,9 +244,7 @@ tests = testGroup "diagnostics"
       _ <- createDoc "ModuleB.hs" "haskell" contentB
       _ <- createDoc "ModuleB.hs-boot" "haskell" contentBboot
       expectDiagnostics [("ModuleB.hs", [(DiagnosticSeverity_Warning, (3,0), "Top-level binding", Just "GHC-38417")])]
-  , testWithDummyPlugin "bidirectional module dependency with hs-boot"
-        (mkIdeTestFs [directCradle ["ModuleA", "ModuleB"]])
-        $ do
+  , testWithDummyPluginEmpty "bidirectional module dependency with hs-boot" $ do
       let contentA = T.unlines
             [ "module ModuleA where"
             , "import {-# SOURCE #-} ModuleB"
diff --git a/ghcide/src/Development/IDE/GHC/Compat/Error.hs b/ghcide/src/Development/IDE/GHC/Compat/Error.hs
@@ -18,6 +18,9 @@ module Development.IDE.GHC.Compat.Error (
   DriverMessage (..),
   -- * General Diagnostics
   Diagnostic(..),
+  -- * GHC Hints
+  GhcHint (SuggestExtension),
+  LanguageExtensionHint (..),
   -- * Prisms and lenses for error selection
   _TcRnMessage,
   _TcRnMessageWithCtx,
diff --git a/hls-test-utils/hls-test-utils.cabal b/hls-test-utils/hls-test-utils.cabal
@@ -49,8 +49,8 @@ library
     , lsp
     , lsp-test                ^>=0.17
     , lsp-types               ^>=2.3
-    , neat-interpolation
     , safe-exceptions
+    , string-interpolate
     , tasty
     , tasty-expected-failure
     , tasty-golden
diff --git a/hls-test-utils/src/Test/Hls.hs b/hls-test-utils/src/Test/Hls.hs
@@ -369,7 +369,7 @@ goldenWithDocInTmpDir languageKind config plugin title tree path desc ext act =
 -- For example:
 --
 -- @
---  parameterisedCursorTest "Cursor Test" [trimming|
+--  parameterisedCursorTest "Cursor Test" [__i|
 --       foo = 2
 --        ^
 --       bar = 3
@@ -392,7 +392,7 @@ goldenWithDocInTmpDir languageKind config plugin title tree path desc ext act =
 -- TODO: Many Haskell and Cabal source may contain '^' characters for good reasons.
 -- We likely need a way to change the character for certain test cases in the future.
 --
--- The quasi quoter 'trimming' is very helpful to define such tests, as it additionally
+-- The quasi quoter '__i' is very helpful to define such tests, as it additionally
 -- allows to interpolate haskell values and functions. We reexport this quasi quoter
 -- for easier usage.
 parameterisedCursorTest :: (Show a, Eq a) => String -> T.Text -> [a] -> (T.Text -> PosPrefixInfo -> IO a) -> TestTree
diff --git a/hls-test-utils/src/Test/Hls/Util.hs b/hls-test-utils/src/Test/Hls/Util.hs
@@ -47,7 +47,7 @@ module Test.Hls.Util
     -- * Extract positions from input file.
     , extractCursorPositions
     , mkParameterisedLabel
-    , trimming
+    , __i
   )
 where
 
@@ -81,11 +81,11 @@ import           Test.Tasty.ExpectedFailure               (expectFailBecause,
 import           Test.Tasty.HUnit                         (assertFailure)
 
 import qualified Data.List                                as List
+import           Data.String.Interpolate                  (__i)
 import qualified Data.Text.Internal.Search                as T
 import qualified Data.Text.Utf16.Rope.Mixed               as Rope
 import           Development.IDE.Plugin.Completions.Logic (getCompletionPrefixFromRope)
 import           Development.IDE.Plugin.Completions.Types (PosPrefixInfo (..))
-import           NeatInterpolation                        (trimming)
 
 noLiteralCaps :: ClientCapabilities
 noLiteralCaps = def & L.textDocument ?~ textDocumentCaps
diff --git a/plugins/hls-cabal-plugin/test/Completer.hs b/plugins/hls-cabal-plugin/test/Completer.hs
@@ -392,39 +392,39 @@ extract item = case item ^. L.textEdit of
   _            -> error ""
 
 importTestData :: T.Text
-importTestData = [trimming|
-cabal-version:      3.0
-name:               hls-cabal-plugin
-version:            0.1.0.0
-synopsis:
-homepage:
-license:            MIT
-license-file:       LICENSE
-author:             Fendor
-maintainer:         fendor@posteo.de
-category:           Development
-extra-source-files: CHANGELOG.md
+importTestData = [__i|
+  cabal-version:      3.0
+  name:               hls-cabal-plugin
+  version:            0.1.0.0
+  synopsis:
+  homepage:
+  license:            MIT
+  license-file:       LICENSE
+  author:             Fendor
+  maintainer:         fendor@posteo.de
+  category:           Development
+  extra-source-files: CHANGELOG.md
 
-common defaults
-  default-language: GHC2021
-  -- Should have been in GHC2021, an oversight
-  default-extensions: ExplicitNamespaces
+  common defaults
+    default-language: GHC2021
+    -- Should have been in GHC2021, an oversight
+    default-extensions: ExplicitNamespaces
 
-common test-defaults
-  ghc-options: -threaded -rtsopts -with-rtsopts=-N
+  common test-defaults
+    ghc-options: -threaded -rtsopts -with-rtsopts=-N
 
-library
-    import:
-            ^
-    exposed-modules:  IDE.Plugin.Cabal
-    build-depends:    base ^>=4.14.3.0
-    hs-source-dirs:   src
-    default-language: Haskell2010
+  library
+      import:
+              ^
+      exposed-modules:  IDE.Plugin.Cabal
+      build-depends:    base ^>=4.14.3.0
+      hs-source-dirs:   src
+      default-language: Haskell2010
 
-common notForLib
-  default-language: GHC2021
+  common notForLib
+    default-language: GHC2021
 
-test-suite tests
-  import:
-          ^
+  test-suite tests
+    import:
+            ^
 |]
diff --git a/plugins/hls-cabal-plugin/test/Context.hs b/plugins/hls-cabal-plugin/test/Context.hs
@@ -217,93 +217,93 @@ getContextTests =
 -- ------------------------------------------------------------------------
 
 libraryStanzaData :: T.Text
-libraryStanzaData = [trimming|
-cabal-version:      3.0
-name:               simple-cabal
-library
-    default-language: Haskell98
-    build-depends:
+libraryStanzaData = [__i|
+    cabal-version:      3.0
+    name:               simple-cabal
+    library
+        default-language: Haskell98
+        build-depends:
 
-ma
+    ma
 |]
 
 executableStanzaData :: T.Text
-executableStanzaData = [trimming|
-cabal-version:      3.0
-name:               simple-cabal
-executable exeName
-    default-language: Haskell2010
-    hs-source-dirs: test/preprocessor
+executableStanzaData = [__i|
+    cabal-version:      3.0
+    name:               simple-cabal
+    executable exeName
+        default-language: Haskell2010
+        hs-source-dirs: test/preprocessor
 |]
 
 topLevelData :: T.Text
-topLevelData = [trimming|
-cabal-version:      3.0
-name:
+topLevelData = [__i|
+    cabal-version:      3.0
+    name:
 
 
 
-          eee
+              eee
 |]
 
 conditionalData :: T.Text
-conditionalData = [trimming|
-cabal-version:      3.0
-name:               simple-cabal
-library
-    if os(windows)
-       buildable:
-    elif os(linux)
-       buildable:
-    else
-       buildable:
+conditionalData = [__i|
+    cabal-version:      3.0
+    name:               simple-cabal
+    library
+        if os(windows)
+           buildable:
+        elif os(linux)
+           buildable:
+        else
+           buildable:
 |]
 multiLineOptsData :: T.Text
-multiLineOptsData = [trimming|
-cabal-version:      3.0
-name:
+multiLineOptsData = [__i|
+    cabal-version:      3.0
+    name:
 
 
-library
-    build-depends:
-        base,
+    library
+        build-depends:
+            base,
 
-        text ,
+            text ,
 |]
 
 multiPositionTestData :: T.Text
-multiPositionTestData = [trimming|
-cabal-version:      3.4
-       ^             ^
-category:           Development
-^
-name:               haskell-language-server
-description:
-  Please see the README on GitHub at <https://github.com/haskell/haskell-language-server#readme>
+multiPositionTestData = [__i|
+    cabal-version:      3.4
+           ^             ^
+    category:           Development
     ^
-extra-source-files:
-  README.md
-  ChangeLog.md
-  test/testdata/**/*.project
-  test/testdata/**/*.cabal
-  test/testdata/**/*.yaml
-  test/testdata/**/*.hs
-  test/testdata/**/*.json
-    ^
-  -- These globs should only match test/testdata
-  plugins/**/*.project
+    name:               haskell-language-server
+    description:
+      Please see the README on GitHub at <https://github.com/haskell/haskell-language-server\#readme>
+        ^
+    extra-source-files:
+      README.md
+      ChangeLog.md
+      test/testdata/**/*.project
+      test/testdata/**/*.cabal
+      test/testdata/**/*.yaml
+      test/testdata/**/*.hs
+      test/testdata/**/*.json
+        ^
+      -- These globs should only match test/testdata
+      plugins/**/*.project
 
-source-repository head
-     ^              ^   ^
-  type:     git
-    ^    ^    ^  ^
-  location: https://github.com/haskell/haskell-language-server
+    source-repository head
+         ^              ^   ^
+      type:     git
+        ^    ^    ^  ^
+      location: https://github.com/haskell/haskell-language-server
 
-  ^
-common cabalfmt
+      ^
+    common cabalfmt
 
-  ^
-  build-depends: haskell-language-server:hls-cabal-fmt-plugin
-    ^            ^
-  cpp-options: -Dhls_cabalfmt
+      ^
+      build-depends: haskell-language-server:hls-cabal-fmt-plugin
+        ^            ^
+      cpp-options: -Dhls_cabalfmt
 |]
diff --git a/plugins/hls-cabal-plugin/test/Main.hs b/plugins/hls-cabal-plugin/test/Main.hs
@@ -292,7 +292,7 @@ reloadOnCabalChangeTests = testGroup "Reload on .cabal changes"
         cabalDoc <- openDoc "simple-reload.cabal" "cabal"
         skipManyTill anyMessage cabalKickDone
         saveDoc cabalDoc
-            [trimming|
+            [__i|
             cabal-version:      3.4
             name:               simple-reload
             version:            0.1.0.0
diff --git a/plugins/hls-pragmas-plugin/src/Ide/Plugin/Pragmas.hs b/plugins/hls-pragmas-plugin/src/Ide/Plugin/Pragmas.hs
