Merge remote-tracking branch 'origin/master' into hie-bios

Author: mpickering

Changelog.md

@@ -1,3 +1,18 @@
+# 0.8.0.0
+
+- GHC 8.6.4 support added.
+- Resolver bumped, LTS 13.10 for GHC 8.6.3, LTS 13.15 for GHC 8.6.4 (@alanz)
+- Clarify install section of README.md (@antonlogvinenko)
+- Clarify the spacemacs installation (@chkl)
+- Further install.hs improvements
+  - idempotent builds (@fendor)
+  - Shake is now the only supported method of building HIE,
+    remove no longer needed Makefile and build-all.ps1 (@Anrock)
+  - only generate the hoogle database once (@fendor)
+  - install hoogle if not found (@fendor)
+- Add support for pattern synonyms in ghc-mod plugin (@anton-dessiatov)
+- prevent hie crash if hlint crashes (@fendor)
+
 # 0.7.0.0
 
 - Resolver bumped, LTS 13.9 for GHC 8.6.3 (@alanz)

haskell-ide-engine.cabal

@@ -1,5 +1,5 @@
 name:                haskell-ide-engine
-version:             0.7.0.0
+version:             0.8.0.0
 synopsis:            Provide a common engine to power any Haskell IDE
 description:         Please see README.md
 homepage:            http://github.com/githubuser/haskell-ide-engine#readme
@@ -19,23 +19,20 @@ flag pedantic
 
 library
   hs-source-dirs:      src
-  exposed-modules:     Haskell.Ide.Engine.Plugin.Base
-                       Haskell.Ide.Engine.Channel
-                       Haskell.Ide.Engine.Scheduler
+  exposed-modules:     Haskell.Ide.Engine.Channel
                        Haskell.Ide.Engine.LSP.CodeActions
+                       Haskell.Ide.Engine.Plugin.Base
                        Haskell.Ide.Engine.LSP.Reactor
                        Haskell.Ide.Engine.Options
                        Haskell.Ide.Engine.Plugin.ApplyRefact
                        Haskell.Ide.Engine.Plugin.Brittany
                        Haskell.Ide.Engine.Plugin.Build
                        Haskell.Ide.Engine.Plugin.Example2
                        Haskell.Ide.Engine.Plugin.Floskell
-                       Haskell.Ide.Engine.Plugin.Fuzzy
                        Haskell.Ide.Engine.Plugin.GhcMod
                        Haskell.Ide.Engine.Plugin.Bios
                        Haskell.Ide.Engine.Plugin.HaRe
                        Haskell.Ide.Engine.Plugin.Haddock
-                       Haskell.Ide.Engine.Plugin.HieExtras
                        Haskell.Ide.Engine.Plugin.HfaAlign
                        Haskell.Ide.Engine.Plugin.Hoogle
                        Haskell.Ide.Engine.Plugin.HsImport
@@ -44,6 +41,9 @@ library
                        Haskell.Ide.Engine.Plugin.Package.Compat
                        Haskell.Ide.Engine.Plugin.Pragmas
                        Haskell.Ide.Engine.Plugin.Generic
+                       Haskell.Ide.Engine.Scheduler
+                       Haskell.Ide.Engine.Support.Fuzzy
+                       Haskell.Ide.Engine.Support.HieExtras
                        Haskell.Ide.Engine.Transport.JsonStdio
                        Haskell.Ide.Engine.Transport.LspStdio
                        Haskell.Ide.Engine.Types
@@ -269,6 +269,7 @@ test-suite func-test
                      , ReferencesSpec
                      , RenameSpec
                      , SymbolsSpec
+                     , TypeDefinitionSpec
                      , Utils
   -- This cannot currently be handled by hie (cabal-helper)
   -- build-tool-depends:  haskell-ide-engine:hie

hie-plugin-api/Haskell/Ide/Engine/PluginsIdeMonads.hs

@@ -210,9 +210,20 @@ type HoverProvider = Uri -> Position -> IdeM (IdeResult [Hover])
 
 type SymbolProvider = Uri -> IdeDeferM (IdeResult [DocumentSymbol])
 
+-- | Format the document either as a whole or only a given Range of it.
 data FormattingType = FormatDocument
                     | FormatRange Range
-type FormattingProvider = Uri -> FormattingType -> FormattingOptions -> IdeDeferM (IdeResult [TextEdit])
+
+-- | Formats the given Uri with the given options.
+-- A formatting type can be given to either format the whole document or only a Range.
+-- Fails if the formatter can not parse the source.
+-- Failing menas here that a IdeResultFail is returned.
+-- This can be used to display errors to the user, unless the error is an Internal one.
+-- The record 'IdeError' and 'IdeErrorCode' can be used to determine the type of error.
+type FormattingProvider = Uri -- ^ Uri to the file to format. Can be mapped to a file with `pluginGetFile`
+        -> FormattingType  -- ^ How much to format
+        -> FormattingOptions -- ^ Options for the formatter
+        -> IdeDeferM (IdeResult [TextEdit]) -- ^ Result of the formatting or the unchanged text.
 
 data PluginDescriptor =
   PluginDescriptor { pluginId                 :: PluginId

src/Haskell/Ide/Engine/Plugin/Bios.hs

@@ -25,7 +25,7 @@ import           GHC.Generics
 import           Haskell.Ide.Engine.MonadFunctions
 import           Haskell.Ide.Engine.MonadTypes
 import           Haskell.Ide.Engine.PluginUtils
-import qualified Haskell.Ide.Engine.Plugin.HieExtras as Hie
+--import qualified Haskell.Ide.Engine.Plugin.HieExtras as Hie
 import           Haskell.Ide.Engine.ArtifactMap
 import qualified Language.Haskell.LSP.Types        as LSP
 

src/Haskell/Ide/Engine/Plugin/Brittany.hs

@@ -36,6 +36,9 @@ brittanyDescriptor plId = PluginDescriptor
   , pluginFormattingProvider = Just provider
   }
 
+-- | Formatter provider of Brittany.
+-- Formats the given source in either a given Range or the whole Document.
+-- If the provider fails an error is returned that can be displayed to the user.
 provider :: FormattingProvider
 provider uri formatType opts = pluginGetFile "brittanyCmd: " uri $ \file -> do
   confFile <- liftIO $ getConfFile file
@@ -65,6 +68,8 @@ normalize (Range (Position sl _) (Position el _)) =
   -- Extend to the line below to replace newline character, as above
   Range (Position sl 0) (Position (el + 1) 0)
 
+-- | Recursively search in every directory of the given filepath for brittany.yaml
+-- If no such file has been found, return Nothing.
 getConfFile :: FilePath -> IO (Maybe FilePath)
 getConfFile = findLocalConfigPath . takeDirectory
 
@@ -100,4 +105,3 @@ showErr (ErrorUnusedComment s)  = s
 showErr (LayoutWarning s)       = s
 showErr (ErrorUnknownNode s _)  = s
 showErr ErrorOutputCheck        = "Brittany error - invalid output"
-

src/Haskell/Ide/Engine/Plugin/Floskell.hs

@@ -27,6 +27,9 @@ floskellDescriptor plId = PluginDescriptor
   , pluginFormattingProvider = Just provider
   }
 
+-- | Format provider of Floskell.
+-- Formats the given source in either a given Range or the whole Document.
+-- If the provider fails an error is returned that can be displayed to the user.
 provider :: FormattingProvider
 provider uri typ _opts =
   pluginGetFile "Floskell: " uri $ \file -> do
@@ -43,8 +46,10 @@ provider uri typ _opts =
               Left  err -> return $ IdeResultFail (IdeError PluginError (T.pack err) Null)
               Right new -> return $ IdeResultOk [TextEdit range (T.decodeUtf8 (BS.toStrict new))]
 
-
-
+-- | Find Floskell Config, user and system wide or provides a default style.
+-- Every directory of the filepath will be searched to find a user configuration.
+-- Also looks into places such as XDG_CONFIG_DIRECTORY<https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html>.
+-- This function may not throw an exception and returns a default config.
 findConfigOrDefault :: FilePath -> IO AppConfig
 findConfigOrDefault file = do
   mbConf <- findAppConfigIn file

src/Haskell/Ide/Engine/Plugin/Generic.hs

@@ -23,7 +23,7 @@ import qualified GhcMod.SrcUtils                   as GM
 import           Haskell.Ide.Engine.MonadFunctions
 import           Haskell.Ide.Engine.MonadTypes
 import           Haskell.Ide.Engine.PluginUtils
-import qualified Haskell.Ide.Engine.Plugin.HieExtras as Hie
+import qualified Haskell.Ide.Engine.Support.HieExtras as Hie
 import           Haskell.Ide.Engine.ArtifactMap
 import qualified Language.Haskell.LSP.Types        as LSP
 import qualified Language.Haskell.LSP.Types.Lens   as LSP

src/Haskell/Ide/Engine/Plugin/GhcMod.hs

@@ -35,7 +35,7 @@ import qualified GhcMod.Utils                      as GM
 import           Haskell.Ide.Engine.MonadFunctions
 import           Haskell.Ide.Engine.MonadTypes
 import           Haskell.Ide.Engine.PluginUtils
-import qualified Haskell.Ide.Engine.Plugin.HieExtras as Hie
+import qualified Haskell.Ide.Engine.Support.HieExtras as Hie
 import           Haskell.Ide.Engine.ArtifactMap
 import qualified Language.Haskell.LSP.Types        as LSP
 import qualified Language.Haskell.LSP.Types.Lens   as LSP

src/Haskell/Ide/Engine/Plugin/HaRe.hs

@@ -28,7 +28,7 @@ import           Haskell.Ide.Engine.ArtifactMap
 import           Haskell.Ide.Engine.MonadFunctions
 import           Haskell.Ide.Engine.MonadTypes
 import           Haskell.Ide.Engine.PluginUtils
-import qualified Haskell.Ide.Engine.Plugin.HieExtras          as Hie
+import qualified Haskell.Ide.Engine.Support.HieExtras         as Hie
 import           Language.Haskell.GHC.ExactPrint.Print
 import qualified Language.Haskell.LSP.Core                    as Core
 import qualified Language.Haskell.LSP.Types                   as J

src/Haskell/Ide/Engine/Plugin/Haddock.hs

@@ -17,21 +17,21 @@ import           Data.IORef
 import Data.Function
 import Data.Maybe
 import Data.List
-import           System.Directory
-import           System.FilePath
 import           GHC
-import           GhcMonad
-import qualified GhcMod.Monad                                 as GM
 import qualified GhcMod.LightGhc                              as GM
-import           Haskell.Ide.Engine.MonadTypes
+import qualified GhcMod.Monad                                 as GM
+import           GhcMonad
 import           Haskell.Ide.Engine.MonadFunctions
-import           Haskell.Ide.Engine.Plugin.HieExtras
+import           Haskell.Ide.Engine.MonadTypes
 import qualified Haskell.Ide.Engine.Plugin.Hoogle             as Hoogle
 import           Haskell.Ide.Engine.PluginUtils
-import qualified Language.Haskell.LSP.Types as J
+import           Haskell.Ide.Engine.Support.HieExtras
 import           HscTypes
+import qualified Language.Haskell.LSP.Types as J
 import           Name
 import           Packages
+import           System.Directory
+import           System.FilePath
 
 
 import Documentation.Haddock

src/Haskell/Ide/Engine/Plugin/Fuzzy.hs renamed to src/Haskell/Ide/Engine/Support/Fuzzy.hs

@@ -4,7 +4,7 @@
 -- | Forked from: Text.Fuzzy (MIT)
 -- Original Author: Joomy Korkut, http://github.com/joom/fuzzy
 -- Uses 'TextualMonoid' to be able to run on different types of strings.
-module Haskell.Ide.Engine.Plugin.Fuzzy where
+module Haskell.Ide.Engine.Support.Fuzzy where
 
 import Prelude hiding (filter, null)