Merge branch 'master' into harder_hlint_fixes

Author: peterwicksstringfield

cabal.project

@@ -24,7 +24,7 @@ package ghcide
 
 write-ghc-environment-files: never
 
-index-state: 2021-02-15T19:11:03Z
+index-state: 2021-02-15T19:02:22Z
 
 allow-newer:
 	active:base,

exe/Wrapper.hs

@@ -4,10 +4,11 @@
 module Main where
 
 import Control.Monad.Extra
+import Data.Default
 import Data.Foldable
 import Data.List
 import Data.Void
-import Development.IDE.Session (findCradle, defaultLoadingOptions)
+import Development.IDE.Session (findCradle)
 import HIE.Bios hiding (findCradle)
 import HIE.Bios.Environment
 import HIE.Bios.Types
@@ -140,7 +141,7 @@ getRuntimeGhcVersion' cradle = do
 -- of the project that may or may not be accurate.
 findLocalCradle :: FilePath -> IO (Cradle Void)
 findLocalCradle fp = do
-  cradleConf <- findCradle defaultLoadingOptions fp
+  cradleConf <- findCradle def fp
   crdl       <- case cradleConf of
     Just yaml -> do
       hPutStrLn stderr $ "Found \"" ++ yaml ++ "\" for \"" ++ fp ++ "\""

ghcide/.hlint.yaml

@@ -117,7 +117,7 @@
 #
 - functions:
   # Things that are unsafe in Haskell base library
-  - {name: unsafeInterleaveIO, within: []}
+  - {name: unsafeInterleaveIO, within: [Development.IDE.LSP.LanguageServer]}
   - {name: unsafeDupablePerformIO, within: []}
   - {name: unsafeCoerce, within: [Ide.Plugin.Eval.Code]}
   # Things that are a bit dangerous in the GHC API

ghcide/CHANGELOG.md

@@ -1,5 +1,14 @@
 ### 0.7.5 (2021-02-??)
+* Tone down some logInfos to logDebug (#1385) - Pepe Iborra
+* Show window message when auto extending import lists (#1371) - Potato Hatsue
+* Catch GHC errors in listing module names (#1367) - Potato Hatsue
+* Upgrade to lsp-1.0 (#1284) - wz1000
 * Added Development.IDE.Main (#1338) - Pepe Iborra
+* Fix completion snippets on DuplicateRecordFields (#1360) - Potato Hatsue
+* Add code action for hiding shadowed identifiers from imports (#1322) - Potato Hatsue
+* Make find-definition work better with multi-components (#1357) - wz1000
+* Index files on first open (#1358) - wz1000
+* Fix code actions regression (#1349) - Pepe Iborra
 
 ### 0.7.4 (2021-02-08)
 * Support for references via hiedb (#704) - wz1000

ghcide/exe/Main.hs

@@ -20,7 +20,7 @@ import Development.IDE.Core.OfInterest (kick)
 import Development.IDE.Core.Rules (mainRule)
 import qualified Development.IDE.Plugin.HLS.GhcIde as GhcIde
 import qualified Development.IDE.Plugin.Test as Test
-import Development.IDE.Session (setInitialDynFlags, getHieDbLoc, runWithDb)
+import Development.IDE.Session (setInitialDynFlags, getHieDbLoc)
 import Development.IDE.Types.Options
 import qualified Development.IDE.Main as Main
 import Development.Shake (ShakeOptions(shakeThreads))
@@ -56,9 +56,6 @@ main = do
 
     whenJust argsCwd IO.setCurrentDirectory
 
-    dir <- IO.getCurrentDirectory
-    dbLoc <- getHieDbLoc dir
-
     -- lock to avoid overlapping output on stdout
     lock <- newLock
     let logger = Logger $ \pri msg -> when (pri >= logLevel) $ withLock lock $
@@ -67,7 +64,9 @@ main = do
 
     case argFilesOrCmd of
       DbCmd opts cmd -> do
-        mlibdir <- setInitialDynFlags
+        dir <- IO.getCurrentDirectory
+        dbLoc <- getHieDbLoc dir
+        mlibdir <- setInitialDynFlags def
         case mlibdir of
           Nothing -> exitWith $ ExitFailure 1
           Just libdir -> runCommand libdir opts{database = dbLoc} cmd
@@ -80,40 +79,39 @@ main = do
                 hPutStrLn stderr "If you are seeing this in a terminal, you probably should have run ghcide WITHOUT the --lsp option!"
               _ -> return ()
 
-          runWithDb dbLoc $ \hiedb hiechan ->
-              Main.defaultMain (Main.defArguments hiedb hiechan)
-                {Main.argFiles = case argFilesOrCmd of
-                    Typecheck x | not argLSP -> Just x
-                    _ -> Nothing
-
-                ,Main.argsLogger = logger
-
-                ,Main.argsRules = do
-                    -- install the main and ghcide-plugin rules
-                    mainRule
-                    -- install the kick action, which triggers a typecheck on every
-                    -- Shake database restart, i.e. on every user edit.
-                    unless argsDisableKick $
-                        action kick
-
-                ,Main.argsHlsPlugins =
-                    pluginDescToIdePlugins $
-                    GhcIde.descriptors
-                    ++ [Test.blockCommandDescriptor "block-command" | argsTesting]
-
-                ,Main.argsGhcidePlugin = if argsTesting
-                    then Test.plugin
-                    else mempty
-
-                ,Main.argsIdeOptions = \(fromMaybe def -> config) sessionLoader ->
-                    let defOptions = defaultIdeOptions sessionLoader
-                    in defOptions
-                      { optShakeProfiling = argsShakeProfiling
-                      , optOTMemoryProfiling = IdeOTMemoryProfiling argsOTMemoryProfiling
-                      , optTesting = IdeTesting argsTesting
-                      , optShakeOptions = (optShakeOptions defOptions){shakeThreads = argsThreads}
-                      , optCheckParents = pure $ checkParents config
-                      , optCheckProject = pure $ checkProject config
-                      }
-                }
+          Main.defaultMain def
+            {Main.argFiles = case argFilesOrCmd of
+                Typecheck x | not argLSP -> Just x
+                _ -> Nothing
+
+            ,Main.argsLogger = logger
+
+            ,Main.argsRules = do
+                -- install the main and ghcide-plugin rules
+                mainRule
+                -- install the kick action, which triggers a typecheck on every
+                -- Shake database restart, i.e. on every user edit.
+                unless argsDisableKick $
+                    action kick
+
+            ,Main.argsHlsPlugins =
+                pluginDescToIdePlugins $
+                GhcIde.descriptors
+                ++ [Test.blockCommandDescriptor "block-command" | argsTesting]
+
+            ,Main.argsGhcidePlugin = if argsTesting
+                then Test.plugin
+                else mempty
+
+            ,Main.argsIdeOptions = \(fromMaybe def -> config) sessionLoader ->
+                let defOptions = defaultIdeOptions sessionLoader
+                in defOptions
+                  { optShakeProfiling = argsShakeProfiling
+                  , optOTMemoryProfiling = IdeOTMemoryProfiling argsOTMemoryProfiling
+                  , optTesting = IdeTesting argsTesting
+                  , optShakeOptions = (optShakeOptions defOptions){shakeThreads = argsThreads}
+                  , optCheckParents = pure $ checkParents config
+                  , optCheckProject = pure $ checkProject config
+                  }
+            }
 

ghcide/ghcide.cabal

@@ -27,11 +27,6 @@ source-repository head
     type:     git
     location: https://github.com/haskell/ghcide.git
 
-flag ghc-lib
-  description: build against ghc-lib instead of the ghc package
-  default: False
-  manual: True
-
 library
     default-language:   Haskell2010
     build-depends:
@@ -62,7 +57,7 @@ library
         lens,
         hiedb == 0.3.0.1,
         lsp-types == 1.1.*,
-        lsp == 1.1.*,
+        lsp == 1.1.1.0,
         mtl,
         network-uri,
         parallel,
@@ -92,19 +87,10 @@ library
         opentelemetry >=0.6.1,
         heapsize ==0.3.*,
         unliftio,
-        unliftio-core
-    if flag(ghc-lib)
-      build-depends:
-        ghc-lib >= 8.8,
-        ghc-lib-parser >= 8.8
-      cpp-options: -DGHC_LIB
-    else
-      build-depends:
+        unliftio-core,
         ghc-boot-th,
         ghc-boot,
         ghc >= 8.6,
-        -- These dependencies are used by Development.IDE.Session and are
-        -- Haskell specific. So don't use them when building with -fghc-lib!
         ghc-check >=0.5.0.1,
         ghc-paths,
         cryptohash-sha1 >=0.11.100 && <0.12,
@@ -141,6 +127,7 @@ library
 
     hs-source-dirs:
         src
+        session-loader
     include-dirs:
         include
     exposed-modules:
@@ -169,6 +156,7 @@ library
         Development.IDE.LSP.LanguageServer
         Development.IDE.LSP.Outline
         Development.IDE.LSP.Server
+        Development.IDE.Session
         Development.IDE.Spans.Common
         Development.IDE.Spans.Documentation
         Development.IDE.Spans.AtPoint
@@ -191,26 +179,14 @@ library
         Development.IDE.Plugin.Test
         Development.IDE.Plugin.TypeLenses
 
-    -- Unfortunately, we cannot use loadSession with ghc-lib since hie-bios uses
-    -- the real GHC library and the types are incompatible. Furthermore, when
-    -- building with ghc-lib we need to make this Haskell agnostic, so no
-    -- hie-bios!
-    -- We also put these modules into a separate hs-source-dirs so we can avoid
-    -- compiling them at all if ghc-lib is not set
-    if !flag(ghc-lib)
-      hs-source-dirs:
-        session-loader
-      exposed-modules:
-        Development.IDE.Session
-      other-modules:
-        Development.IDE.Session.VersionCheck
     other-modules:
         Development.IDE.Core.FileExists
         Development.IDE.GHC.CPP
         Development.IDE.GHC.Warnings
         Development.IDE.LSP.Notifications
         Development.IDE.Plugin.CodeAction.PositionIndexed
         Development.IDE.Plugin.Completions.Logic
+        Development.IDE.Session.VersionCheck
         Development.IDE.Types.Action
     ghc-options: -Wall -Wno-name-shadowing -Wincomplete-uni-patterns -Wno-unticked-promoted-constructors
 
@@ -261,8 +237,6 @@ benchmark benchHist
         yaml
 
 executable ghcide
-    if flag(ghc-lib)
-      buildable: False
     default-language:   Haskell2010
     include-dirs:
         include
@@ -322,8 +296,6 @@ executable ghcide
         ViewPatterns
 
 test-suite ghcide-tests
-    if flag(ghc-lib)
-      buildable: False
     type: exitcode-stdio-1.0
     default-language: Haskell2010
     build-tool-depends:

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

@@ -8,7 +8,6 @@ The logic for setting up a ghcide session by tapping into hie-bios.
 module Development.IDE.Session
   (SessionLoadingOptions(..)
   ,CacheDirs(..)
-  ,defaultLoadingOptions
   ,loadSession
   ,loadSessionWithOptions
   ,setInitialDynFlags
@@ -34,6 +33,7 @@ import qualified Data.Text as T
 import Data.Aeson
 import Data.Bifunctor
 import qualified Data.ByteString.Base16 as B16
+import Data.Default
 import Data.Either.Extra
 import Data.Function
 import Data.Hashable
@@ -98,30 +98,38 @@ data SessionLoadingOptions = SessionLoadingOptions
   --   return the path for storing generated GHC artifacts,
   --   or 'Nothing' to respect the cradle setting
   , getCacheDirs :: String -> [String] -> IO CacheDirs
+  -- | Return the GHC lib dir to use for the 'unsafeGlobalDynFlags'
+  , getInitialGhcLibDir :: IO (Maybe LibDir)
   }
 
-defaultLoadingOptions :: SessionLoadingOptions
-defaultLoadingOptions = SessionLoadingOptions
-    {findCradle = HieBios.findCradle
-    ,loadCradle = HieBios.loadCradle
-    ,getCacheDirs = getCacheDirsDefault
-    }
+instance Default SessionLoadingOptions where
+    def = SessionLoadingOptions
+        {findCradle = HieBios.findCradle
+        ,loadCradle = HieBios.loadCradle
+        ,getCacheDirs = getCacheDirsDefault
+        ,getInitialGhcLibDir = getInitialGhcLibDirDefault
+        }
 
--- | Sets `unsafeGlobalDynFlags` on using the hie-bios cradle and returns the GHC libdir
-setInitialDynFlags :: IO (Maybe LibDir)
-setInitialDynFlags = do
+getInitialGhcLibDirDefault :: IO (Maybe LibDir)
+getInitialGhcLibDirDefault = do
   dir <- IO.getCurrentDirectory
   hieYaml <- runMaybeT $ yamlConfig dir
-  cradle <- maybe (HieBios.loadImplicitCradle $ addTrailingPathSeparator dir) HieBios.loadCradle hieYaml
+  cradle <- maybe (loadImplicitHieCradle $ addTrailingPathSeparator dir) HieBios.loadCradle hieYaml
+  hPutStrLn stderr $ "setInitialDynFlags cradle: " ++ show cradle
   libDirRes <- getRuntimeGhcLibDir cradle
-  libdir <- case libDirRes of
+  case libDirRes of
       CradleSuccess libdir -> pure $ Just $ LibDir libdir
       CradleFail err -> do
         hPutStrLn stderr $ "Couldn't load cradle for libdir: " ++ show (err,dir,hieYaml,cradle)
         pure Nothing
       CradleNone -> do
         hPutStrLn stderr "Couldn't load cradle (CradleNone)"
         pure Nothing
+
+-- | Sets `unsafeGlobalDynFlags` on using the hie-bios cradle and returns the GHC libdir
+setInitialDynFlags :: SessionLoadingOptions -> IO (Maybe LibDir)
+setInitialDynFlags SessionLoadingOptions{..} = do
+  libdir <- getInitialGhcLibDir
   dynFlags <- mapM dynFlagsForPrinting libdir
   mapM_ setUnsafeGlobalDynFlags dynFlags
   pure libdir
@@ -176,7 +184,7 @@ getHieDbLoc dir = do
 -- components mapping to the same hie.yaml file are mapped to the same
 -- HscEnv which is updated as new components are discovered.
 loadSession :: FilePath -> IO (Action IdeGhcSession)
-loadSession = loadSessionWithOptions defaultLoadingOptions
+loadSession = loadSessionWithOptions def
 
 loadSessionWithOptions :: SessionLoadingOptions -> FilePath -> IO (Action IdeGhcSession)
 loadSessionWithOptions SessionLoadingOptions{..} dir = do
@@ -613,7 +621,7 @@ should be filtered out, such that we dont have to re-compile everything.
 -- For the exact reason, see Note [Avoiding bad interface files].
 setCacheDirs :: MonadIO m => Logger -> CacheDirs -> DynFlags -> m DynFlags
 setCacheDirs logger CacheDirs{..} dflags = do
-    liftIO $ logInfo logger $ "Using interface files cache dir: " <> T.pack cacheDir
+    liftIO $ logInfo logger $ "Using interface files cache dir: " <> T.pack (fromMaybe cacheDir hiCacheDir)
     pure $ dflags
           & maybe id setHiDir hiCacheDir
           & maybe id setHieDir hieCacheDir