Merge branch 'master' into apply-refact-exts

Author: jneira

.github/mergify.yml

@@ -32,7 +32,7 @@ pull_request_rules:
   - status-success=test (windows-latest, 8.6.5, true)
   - status-success=test (windows-latest, 8.10.2.2)
   - status-success=test (windows-latest, 8.10.1)
-  - status-success=test (windows-latest, 8.6.4)
+  # - status-success=test (windows-latest, 8.6.4)
 
   - 'status-success=ci/circleci: ghc-8.10.3'
   - 'status-success=ci/circleci: ghc-8.10.2'

.github/workflows/test.yml

@@ -40,8 +40,9 @@ jobs:
             ghc: '8.10.2.2'
           - os: windows-latest
             ghc: '8.10.1'
-          - os: windows-latest
-            ghc: '8.6.4'
+          # This build get stuck frequently
+          # - os: windows-latest
+          #   ghc: '8.6.4'
 
     steps:
       # Cancel queued workflows from earlier commits in this branch

README.md

@@ -49,9 +49,9 @@ background](https://neilmitchell.blogspot.com/2020/01/one-haskell-ide-to-rule-th
 
 ## Features
 
- - Code evaluation codelens (inspired by [Dante](https://github.com/jyp/dante#-reploid)). You can evaluate code by writing it in a comment of the form -- >>>
+- Code evaluation codelens ([Tutorial](plugins/hls-eval-plugin/README.md)):
 
-   ![Eval](https://i.imgur.com/bh992sT.gif)
+   ![Eval Demo](plugins/hls-eval-plugin/demo.gif)
 
 - Type information and documentation on hover. Note that currently, in order for docs to be displayed for dependencies, they must have been built with GHC's `-haddock` flag:
 
@@ -295,7 +295,7 @@ Here is a list of the additional settings currently supported by `haskell-langua
 - Format on imports (`haskell.formatOnImportOn`, default true): whether to format after adding an import
 - Maximum number of problems to report (`haskell.maxNumberOfProblems`, default 100): the maximum number of problems the server will send to the client
 - Diagnostics on change (`haskell.diagnosticsOnChange`, default true): (currently unused)
-- Completion snippets (`haskell.completionSnippetsOn`, default true): whether to support completion snippets (currently unused until we have snippets to provide)
+- Completion snippets (`haskell.completionSnippetsOn`, default true): whether to support completion snippets
 - Liquid Haskell (`haskell.liquidOn`, default false): whether to enable Liquid Haskell support (currently unused until the Liquid Haskell support is functional again)
 - Hlint (`haskell.hlintOn`, default true): whether to enable Hlint support
 

cabal.project

@@ -4,7 +4,6 @@ packages:
          ./shake-bench
          ./ghcide
          ./hls-plugin-api
-         ./hls-exactprint-utils
          ./plugins/tactics
          ./plugins/hls-class-plugin
          ./plugins/hls-eval-plugin

ghcide/.hlint.yaml

@@ -79,6 +79,7 @@
     - Development.IDE.Core.Compile
     - Development.IDE.Core.Rules
     - Development.IDE.GHC.Compat
+    - Development.IDE.GHC.ExactPrint
     - Development.IDE.GHC.Orphans
     - Development.IDE.GHC.Util
     - Development.IDE.Import.FindImports

ghcide/CHANGELOG.md

@@ -1,5 +1,20 @@
+### 0.7.1 (2020-01-13)
+
+* Fix sticky diagnostics bug (#1188) - (Pepe Iborra)
+* Use completionSnippetsOn flag (#1195) - (Yuya Kono)
+* Update tested-with GHC in cabal config - (jneira)
+* Do not disable parallel GC by default (#1190) - (Pepe Iborra)
+* Fix module outline becoming stale after switching branches (#1189) - (Pepe Iborra)
+* Make adding missing constraint work in presence of 'forall' (fixes #1164) (#1177) - (Jan Hrcek)
+* Bump haskell-lsp to 0.23 (#1146) - (Potato Hatsue)
+* Fix #723 (Instance declarations in hs-boot files result in GHC errors) (#781) - (Ben Simms)
+* Also suggest importing methods without parent class (#766) - (Thomas Winant)
+* Update links to issues/PRs in ghcide tests. (#1142) - (Peter Wicks Stringfield)
+* fix suggestAddTypeAnnotation regex (#760) - (Kostas Dermentzis)
+
 ### 0.7.0 (2020-01-03)
 
+* Ghcide now loads HLS plugins internally - (Pepe Iborra)
 * Retry a failed cradle if the cradle descriptor changes (#762) - (Pepe Iborra)
 * Fix extend imports regression (#769) - (Pepe Iborra)
 * Perform memory measurement on SIGUSR1 (#761) - (Pepe Iborra)

ghcide/bench/config.yaml

@@ -58,5 +58,7 @@ versions:
 # - v0.4.0
 # - v0.5.0
 # - v0.6.0
+# - v0.7.0
+# - v0.7.1
 - upstream: origin/master
 - HEAD

ghcide/ghcide.cabal

@@ -2,7 +2,7 @@ cabal-version:      1.20
 build-type:         Simple
 category:           Development
 name:               ghcide
-version:            0.7.0.0
+version:            0.7.1.0
 license:            Apache-2.0
 license-file:       LICENSE
 author:             Digital Asset and Ghcide contributors
@@ -51,6 +51,7 @@ library
         fuzzy,
         filepath,
         fingertree,
+        ghc-exactprint,
         Glob,
         haddock-library >= 1.8,
         hashable,
@@ -66,6 +67,7 @@ library
         prettyprinter-ansi-terminal,
         prettyprinter,
         regex-tdfa >= 1.3.1.0,
+        retrie,
         rope-utf16-splay,
         safe,
         safe-exceptions,
@@ -144,6 +146,7 @@ library
         Development.IDE.Core.Tracing
         Development.IDE.GHC.Compat
         Development.IDE.GHC.Error
+        Development.IDE.GHC.ExactPrint
         Development.IDE.GHC.Orphans
         Development.IDE.GHC.Util
         Development.IDE.Import.DependencyInformation

ghcide/src/Development/IDE/Core/Rules.hs

@@ -11,8 +11,10 @@
 --   using the "Shaker" abstraction layer for in-memory use.
 --
 module Development.IDE.Core.Rules(
+    -- * Types
     IdeState, GetDependencies(..), GetParsedModule(..), TransitiveDependencies(..),
     Priority(..), GhcSessionIO(..), GetClientSettings(..),
+    -- * Functions
     priorityTypeCheck,
     priorityGenerateCore,
     priorityFilesOfInterest,
@@ -27,8 +29,33 @@ module Development.IDE.Core.Rules(
     highlightAtPoint,
     getDependencies,
     getParsedModule,
+    getParsedModuleWithComments,
     getClientConfigAction,
-    getParsedModuleWithComments
+    -- * Rules
+    CompiledLinkables(..),
+    IsHiFileStable(..),
+    getParsedModuleRule,
+    getParsedModuleWithCommentsRule,
+    getLocatedImportsRule,
+    getDependencyInformationRule,
+    reportImportCyclesRule,
+    getDependenciesRule,
+    typeCheckRule,
+    getDocMapRule,
+    loadGhcSession,
+    getModIfaceFromDiskRule,
+    getModIfaceRule,
+    getModIfaceWithoutLinkableRule,
+    getModSummaryRule,
+    isHiFileStableRule,
+    getModuleGraphRule,
+    knownFilesRule,
+    getClientSettingsRule,
+    getHieAstsRule,
+    getBindingsRule,
+    needsCompilationRule,
+    generateCoreRule,
+    getImportMapRule
     ) where
 
 import Fingerprint

ghcide/src/Development/IDE/Core/Shake.hs

@@ -815,20 +815,20 @@ defineEarlyCutoff op = addBuiltinRule noLint noIdentity $ \(Q (key, file)) (old
                     (do v <- op key file; liftIO $ evaluate $ force v) $
                     \(e :: SomeException) -> pure (Nothing, ([ideErrorText file $ T.pack $ show e | not $ isBadDependency e],Nothing))
                 modTime <- liftIO $ (currentValue . fst =<<) <$> getValues state GetModificationTime file
-                (bs, diags, diagsV, res) <- case res of
+                (bs, res) <- case res of
                     Nothing -> do
                         staleV <- liftIO $ getValues state key file
                         pure $ case staleV of
-                            Nothing -> (toShakeValue ShakeResult bs, diags, Vector.fromList diags, Failed)
+                            Nothing -> (toShakeValue ShakeResult bs, Failed)
                             Just v -> case v of
-                                (Succeeded ver v, diags) ->
-                                    (toShakeValue ShakeStale bs, Vector.toList diags, diags, Stale ver v)
-                                (Stale ver v, diags) ->
-                                    (toShakeValue ShakeStale bs, Vector.toList diags, diags, Stale ver v)
-                                (Failed, diags) ->
-                                    (toShakeValue ShakeResult bs, Vector.toList diags, diags, Failed)
-                    Just v -> pure (maybe ShakeNoCutoff ShakeResult bs, diags, Vector.fromList diags, Succeeded (vfsVersion =<< modTime) v)
-                liftIO $ setValues state key file res diagsV
+                                (Succeeded ver v, _) ->
+                                    (toShakeValue ShakeStale bs, Stale ver v)
+                                (Stale ver v, _) ->
+                                    (toShakeValue ShakeStale bs, Stale ver v)
+                                (Failed, _) ->
+                                    (toShakeValue ShakeResult bs, Failed)
+                    Just v -> pure (maybe ShakeNoCutoff ShakeResult bs, Succeeded (vfsVersion =<< modTime) v)
+                liftIO $ setValues state key file res (Vector.fromList diags)
                 updateFileDiagnostics file (Key key) extras $ map (\(_,y,z) -> (y,z)) diags
                 let eq = case (bs, fmap decodeShakeValue old) of
                         (ShakeResult a, Just (ShakeResult b)) -> a == b

hls-exactprint-utils/src/Ide/TreeTransform.hs renamed to ghcide/src/Development/IDE/GHC/ExactPrint.hs

@@ -1,14 +1,10 @@
 {-# LANGUAGE CPP #-}
 {-# LANGUAGE DerivingStrategies #-}
 {-# LANGUAGE GADTs #-}
-{-# LANGUAGE GeneralizedNewtypeDeriving #-}
-{-# LANGUAGE LambdaCase #-}
 {-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE RankNTypes #-}
-{-# LANGUAGE RecordWildCards #-}
-{-# LANGUAGE ScopedTypeVariables #-}
 
-module Ide.TreeTransform
+module Development.IDE.GHC.ExactPrint
     ( Graft(..),
       graft,
       graftDecls,
@@ -34,6 +30,7 @@ import Control.Monad.Trans.Class
 import Control.Monad.Trans.Except
 import Control.Monad.Zip
 import qualified Data.DList as DL
+import Data.Either.Extra (mapLeft)
 import Data.Functor.Classes
 import Data.Functor.Contravariant
 import qualified Data.Text as T
@@ -309,7 +306,7 @@ annotate :: ASTElement ast => DynFlags -> Located ast -> TransformT (Either Stri
 annotate dflags ast = do
     uniq <- show <$> uniqueSrcSpanT
     let rendered = render dflags ast
-    (anns, expr') <- lift $ either (Left . show) Right $ parseAST dflags uniq rendered
+    (anns, expr') <- lift $ mapLeft show $ parseAST dflags uniq rendered
     let anns' = setPrecedingLines expr' 0 1 anns
     pure (anns', expr')
 
@@ -318,7 +315,7 @@ annotateDecl :: DynFlags -> LHsDecl GhcPs -> TransformT (Either String) (Anns, L
 annotateDecl dflags ast = do
     uniq <- show <$> uniqueSrcSpanT
     let rendered = render dflags ast
-    (anns, expr') <- lift $ either (Left . show) Right $ parseDecl dflags uniq rendered
+    (anns, expr') <- lift $ mapLeft show $ parseDecl dflags uniq rendered
     let anns' = setPrecedingLines expr' 1 0 anns
     pure (anns', expr')
 ------------------------------------------------------------------------------

ghcide/src/Development/IDE/Plugin/Completions.hs

@@ -30,12 +30,14 @@ import Development.IDE.GHC.Util
 import Development.IDE.LSP.Server
 import TcRnDriver (tcRnImportDecls)
 import Data.Maybe
+import Ide.Plugin.Config (Config(completionSnippetsOn))
+import Ide.PluginUtils (getClientConfig)
 
 #if defined(GHC_LIB)
 import Development.IDE.Import.DependencyInformation
 #endif
 
-plugin :: Plugin c
+plugin :: Plugin Config
 plugin = Plugin produceCompletions setHandlersCompletion
 
 produceCompletions :: Rules ()
@@ -116,7 +118,7 @@ instance Binary   NonLocalCompletions
 
 -- | Generate code actions.
 getCompletionsLSP
-    :: LSP.LspFuncs cofd
+    :: LSP.LspFuncs Config
     -> IdeState
     -> CompletionParams
     -> IO (Either ResponseError CompletionResponseResult)
@@ -142,12 +144,13 @@ getCompletionsLSP lsp ide
                 -> return (Completions $ List [])
               (Just pfix', _) -> do
                 let clientCaps = clientCapabilities $ shakeExtras ide
-                Completions . List <$> getCompletions ideOpts cci' parsedMod bindMap pfix' clientCaps (WithSnippets True)
+                snippets <- WithSnippets . completionSnippetsOn <$> getClientConfig lsp
+                Completions . List <$> getCompletions ideOpts cci' parsedMod bindMap pfix' clientCaps snippets
               _ -> return (Completions $ List [])
           _ -> return (Completions $ List [])
       _ -> return (Completions $ List [])
 
-setHandlersCompletion :: PartialHandlers c
+setHandlersCompletion :: PartialHandlers Config
 setHandlersCompletion = PartialHandlers $ \WithMessage{..} x -> return x{
     LSP.completionHandler = withResponse RspCompletion getCompletionsLSP
     }

ghcide/test/exe/Main.hs

@@ -201,6 +201,17 @@ diagnosticTests = testGroup "diagnostics"
             }
       changeDoc doc [change]
       expectDiagnostics [("Testing.hs", [(DsError, (0, 15), "parse error")])]
+  , testSessionWait "update syntax error" $ do
+      let content = T.unlines [ "module Testing(missing) where" ]
+      doc <- createDoc "Testing.hs" "haskell" content
+      expectDiagnostics [("Testing.hs", [(DsError, (0, 15), "Not in scope: 'missing'")])]
+      let change = TextDocumentContentChangeEvent
+            { _range = Just (Range (Position 0 15) (Position 0 16))
+            , _rangeLength = Nothing
+            , _text = "l"
+            }
+      changeDoc doc [change]
+      expectDiagnostics [("Testing.hs", [(DsError, (0, 15), "Not in scope: 'lissing'")])]
   , testSessionWait "variable not in scope" $ do
       let content = T.unlines
             [ "module Testing where"

hie-cabal.yaml

@@ -79,6 +79,9 @@ cradle:
     - path: "./test/functional"
       component: "haskell-language-server:test:func-test"
 
+    - path: "./plugins/hls-eval-plugin/test/Eval.hs"
+      component: "haskell-language-server:test:func-test"
+
     - path: "./plugins/tactics/src"
       component: "haskell-language-server:test:func-test"
 
@@ -103,9 +106,6 @@ cradle:
     - path: "./hls-plugin-api/src"
       component: "lib:hls-plugin-api"
 
-    - path: "./hls-exactprint-utils/src"
-      component: "lib:hls-exactprint-utils"
-
     - path: "./plugins/hls-class-plugin/src"
       component: "lib:hls-class-plugin"
 

hie-stack.yaml

@@ -34,15 +34,15 @@ cradle:
             - path: "./test/functional"
               component: "haskell-language-server:test:func-test"
 
+            - path: "./plugins/hls-eval-plugin/test/Eval.hs"
+              component: "haskell-language-server:test:func-test"
+
             - path: "./test/wrapper"
               component: "haskell-language-server:test:wrapper-test"
 
             - path: "./hls-plugin-api/src"
               component: "hls-plugin-api:lib"
 
-            - path: "./hls-exactprint-utils/src"
-              component: "hls-exactprint-utils:lib"
-
             # Plugins:
 
             - path: "./plugins/hls-class-plugin/src"