Merge branch 'master' of https://github.com/haskell/haskell-ide-engine into completion-contexts

Author: lukel97

.circleci/config.yml

@@ -22,9 +22,9 @@ defaults: &defaults
 
     - restore_cache:
         keys:
-          - stack-cache-08-{{ arch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "stack-build.txt" }}-{{ checksum "all-cabal.txt" }}
-          - stack-cache-08-{{ arch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "stack-build.txt" }}
-          - stack-cache-08-{{ arch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "resolver.txt" }}
+          - stack-cache-10-{{ arch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "stack-build.txt" }}-{{ checksum "all-cabal.txt" }}
+          - stack-cache-10-{{ arch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "stack-build.txt" }}
+          - stack-cache-10-{{ arch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "resolver.txt" }}
 
     - run:
         name: Stack setup
@@ -50,8 +50,12 @@ defaults: &defaults
         name: Generate Hoogle database
         command: stack --stack-yaml=${STACK_FILE} exec hoogle generate
 
+    - run:
+        name: Clear cabal-helper cache
+        command: rm -fr ~/.cache/cabal-helper
+
     - save_cache:
-        key: stack-cache-08-{{ arch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "resolver.txt" }}
+        key: stack-cache-10-{{ arch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "resolver.txt" }}
         paths:
           - ~/.stack
           - ~/.cache
@@ -72,7 +76,7 @@ defaults: &defaults
         path: test-logs
 
     - save_cache:
-        key: stack-cache-08-{{ arch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "stack-build.txt" }}
+        key: stack-cache-10-{{ arch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "stack-build.txt" }}
         paths:
           - ~/.stack
           - ~/.cache
@@ -85,7 +89,7 @@ defaults: &defaults
           - ~/build/submodules/cabal-helper/.stack-work
 
     - save_cache:
-        key: stack-cache-08-{{ arch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "stack-build.txt" }}-{{ checksum "all-cabal.txt" }}
+        key: stack-cache-10-{{ arch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "stack-build.txt" }}-{{ checksum "all-cabal.txt" }}
         paths:
           - ~/.stack
           - ~/.cache
@@ -124,6 +128,12 @@ jobs:
       - STACK_FILE: "stack-8.4.3.yaml"
     <<: *defaults
 
+  ghc-8.4.4:
+    environment:
+      - STACK_FILE: "stack-8.4.4.yaml"
+    <<: *defaults
+
+
   ghc-nightly:
     environment:
       - STACK_FILE: "stack.yaml"
@@ -170,5 +180,6 @@ workflows:
       - ghc-8.2.2
       - ghc-8.4.2
       - ghc-8.4.3
+      - ghc-8.4.4
       - ghc-nightly
       - cabal

.gitignore

@@ -63,3 +63,4 @@ test-logs/
 .DS_Store
 
 .hspec-failures
+/test/testdata/addPragmas/stack.yaml

Makefile

@@ -4,8 +4,8 @@ STACKLOCALBINDIR:=$(shell stack path --local-bin)
 all: help
 .PHONY: all
 
-## Builds hie for all supported GHC versions (8.2.1, 8.2.2, 8.4.2 and 8.4.3)
-build: hie-8.2.1 hie-8.2.2 hie-8.4.2 hie-8.4.3
+## Builds hie for all supported GHC versions (8.2.1, 8.2.2, 8.4.2 and 8.4.3, 8.4.4)
+build: hie-8.2.1 hie-8.2.2 hie-8.4.2 hie-8.4.3 hie-8.4.4
 .PHONY: build
 
 ## Builds hie and hoogle databases for all supported GHC versions
@@ -48,6 +48,14 @@ hie-8.4.3: submodules
 		&& cp '$(STACKLOCALBINDIR)/hie-8.4.3' '$(STACKLOCALBINDIR)/hie-8.4'
 .PHONY: hie-8.4.3
 
+## Builds hie for GHC version 8.4.4 only
+hie-8.4.4: submodules
+	stack --stack-yaml=stack-8.4.4.yaml build
+	stack --stack-yaml=stack-8.4.4.yaml install                                      \
+		&& cp '$(STACKLOCALBINDIR)/hie' '$(STACKLOCALBINDIR)/hie-8.4.4'    \
+		&& cp '$(STACKLOCALBINDIR)/hie-8.4.4' '$(STACKLOCALBINDIR)/hie-8.4'
+.PHONY: hie-8.4.4
+
 # ------------------------------------------------------
 
 ## Updates local git submodules

app/HieWrapper.hs

@@ -54,9 +54,7 @@ main = do
 
 run :: GlobalOpts -> IO ()
 run opts = do
-  let mLogFileName = case optLogFile opts of
-        Just f  -> Just f
-        Nothing -> Nothing
+  let mLogFileName = optLogFile opts
 
       logLevel = if optDebugOn opts
                    then L.DEBUG
@@ -85,20 +83,18 @@ run opts = do
 
   let
     hieBin = "hie-" ++ ghcVersion
-    backupHieBin = "hie-" ++ reverse (tail $ dropWhile (/='.') $ reverse ghcVersion)
+    backupHieBin = "hie-" ++ init (dropWhileEnd (/='.') ghcVersion)
+    candidates' = [hieBin, backupHieBin, "hie"]
+    candidates = map (++ exeExtension) candidates'
 
-  logm $ "hie exe candidates :" ++ show (hieBin,backupHieBin)
-
-  let candidates' = [hieBin, backupHieBin, "hie"]
-      candidates = map (++ exeExtension) candidates'
+  logm $ "hie exe candidates :" ++ show candidates
 
   mexes <- traverse findExecutable candidates
 
   case asum mexes of
     Nothing -> logm $ "cannot find any hie exe, looked for:" ++ intercalate ", " candidates
     Just e -> do
       logm $ "found hie exe at:" ++ e
-      -- putStrLn $ "found hie exe at:" ++ e
       args <- getArgs
       logm $ "args:" ++ show args
       logm "launching ....\n\n\n"

app/MainHie.hs

@@ -27,19 +27,19 @@ import qualified System.Remote.Monitoring.Wai          as EKG
 -- plugins
 
 import           Haskell.Ide.Engine.Plugin.ApplyRefact
+import           Haskell.Ide.Engine.Plugin.Base
 import           Haskell.Ide.Engine.Plugin.Brittany
 import           Haskell.Ide.Engine.Plugin.Build
-import           Haskell.Ide.Engine.Plugin.Base
 import           Haskell.Ide.Engine.Plugin.Example2
 import           Haskell.Ide.Engine.Plugin.GhcMod
 import           Haskell.Ide.Engine.Plugin.HaRe
+import           Haskell.Ide.Engine.Plugin.Haddock
+import           Haskell.Ide.Engine.Plugin.HfaAlign
 import           Haskell.Ide.Engine.Plugin.Hoogle
 import           Haskell.Ide.Engine.Plugin.HsImport
 import           Haskell.Ide.Engine.Plugin.Liquid
 import           Haskell.Ide.Engine.Plugin.Package
-import           Haskell.Ide.Engine.Plugin.Haddock
-import           Haskell.Ide.Engine.Plugin.HfaAlign
-
+import           Haskell.Ide.Engine.Plugin.Pragmas
 
 -- ---------------------------------------------------------------------
 
@@ -51,17 +51,18 @@ plugins includeExamples = pluginDescToIdePlugins allPlugins
                    then basePlugins ++ examplePlugins
                    else basePlugins
     basePlugins =
-      [applyRefactDescriptor "applyrefact"
-      ,baseDescriptor        "base"
-      ,brittanyDescriptor    "brittany"
-      ,buildPluginDescriptor "build"
-      ,ghcmodDescriptor      "ghcmod"
-      ,hareDescriptor        "hare"
-      ,hoogleDescriptor      "hoogle"
-      ,hsimportDescriptor    "hsimport"
-      ,liquidDescriptor      "liquid"
-      ,packageDescriptor     "package"
-      ,haddockDescriptor     "haddock"
+      [ applyRefactDescriptor "applyrefact"
+      , baseDescriptor        "base"
+      , brittanyDescriptor    "brittany"
+      , buildPluginDescriptor "build"
+      , ghcmodDescriptor      "ghcmod"
+      , haddockDescriptor     "haddock"
+      , hareDescriptor        "hare"
+      , hoogleDescriptor      "hoogle"
+      , hsimportDescriptor    "hsimport"
+      , liquidDescriptor      "liquid"
+      , packageDescriptor     "package"
+      , pragmasDescriptor     "pragmas"
       ]
     examplePlugins =
       [example2Descriptor "eg2"
@@ -100,9 +101,7 @@ main = do
 
 run :: GlobalOpts -> IO ()
 run opts = do
-  let mLogFileName = case optLogFile opts of
-        Just f  -> Just f
-        Nothing -> Nothing
+  let mLogFileName = optLogFile opts
 
       logLevel = if optDebugOn opts
                    then L.DEBUG

docs/Hacking.md

@@ -17,6 +17,9 @@ To build and test with all of them, use
 make test
 ```
 
+Note that some tests require `liquid` binary to be present in your PATH. 
+To install it follow the instructions in [liquidhaskell](https://github.com/ucsd-progsys/liquidhaskell/blob/develop/INSTALL.md).
+
 To see what version/compiler you are running
 
 ```bash
@@ -130,7 +133,7 @@ the `plugins` table.
 
 ### Operation
 
-When a request is recived from any of the frontends, this is routed to the
+When a request is received from any of the frontends, this is routed to the
 central dispatcher via a `Chan`. Based on the specified plugin name and
 `IdeRequest` `ideCommand` value the appropriate `UiCommand` is identified and
 its `uiFunc` is called.
@@ -144,5 +147,5 @@ type Dispatcher = forall m. (MonadIO m,GHC.GhcMonad m,HasIdeState m) => IdeReque
 This type is not the monad used in `HIE`, but does guarantee that it can access
 IO and the `HIE` state, which is currently only the table of plugins.
 
-It also makes the `GhcMonad` available. In a fully general version this my not
+It also makes the `GhcMonad` available. In a fully general version this may not
 be necessary.

docs/Protocol.md

@@ -4,7 +4,7 @@
 
 https://github.com/Microsoft/language-server-protocol/blob/master/protocol.md
 
-Advantages include widespread tooling and IDE support, and standarisation.
+Advantages include widespread tooling and IDE support, and standardization.
 
 Implemented in [LspStdio.hs](../src/Haskell/Ide/Engine/Transport/LspStdio.hs)
 

docs/hcar/2015.tex

@@ -25,7 +25,7 @@
 Idris community has done toward an interactive editing environment as well. This
 is a deliberately broad scope, the initial versions will be very limited at
 first. The sooner we can get started the sooner we will have something concrete
-to criticise and improve.
+to criticize and improve.
 
 Help is very much needed and wanted so if this is a problem that interests you,
 please pitch in! This is not a project just for a small inner circle. Anyone

haskell-ide-engine.cabal

@@ -40,6 +40,7 @@ library
                        Haskell.Ide.Engine.Plugin.Liquid
                        Haskell.Ide.Engine.Plugin.Package
                        Haskell.Ide.Engine.Plugin.Package.Compat
+                       Haskell.Ide.Engine.Plugin.Pragmas
                        Haskell.Ide.Engine.Transport.JsonStdio
                        Haskell.Ide.Engine.Transport.LspStdio
                        Haskell.Ide.Engine.Types

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

@@ -111,21 +111,18 @@ getProjectGhcVersion = do
   if isStackProject && isStackInstalled
     then do
       L.infoM "hie" "Using stack GHC version"
-      catch (tryCommand "stack ghc -- --version") $ \e -> do
+      catch (tryCommand "stack ghc -- --numeric-version") $ \e -> do
         L.errorM "hie" $ show (e :: SomeException)
         L.infoM "hie" "Couldn't find stack version, falling back to plain GHC"
-        tryCommand "ghc --version"
+        tryCommand "ghc --numeric-version"
     else do
       L.infoM "hie" "Using plain GHC version"
-      tryCommand "ghc --version"
+      tryCommand "ghc --numeric-version"
 
   where
     tryCommand cmd =
-      crackGhcVersion <$> readCreateProcess (shell cmd) ""
-    -- "The Glorious Glasgow Haskell Compilation System, version 8.4.3\n"
-    -- "The Glorious Glasgow Haskell Compilation System, version 8.4.2\n"
-    crackGhcVersion :: String -> String
-    crackGhcVersion st = reverse $ takeWhile (/=' ') $ tail $ reverse st
+      -- Drop '\n' from the output like "7.10.3\n", "8.4.3\n"
+      init <$> readCreateProcess (shell cmd) ""
 
 hieGhcVersion :: String
 hieGhcVersion = VERSION_ghc

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

@@ -410,10 +410,13 @@ codeActionProvider' supportsDocChanges _ docId _ _ _ context =
       typedHoleActions = concatMap mkTypedHoleActions (mapMaybe getTypedHoles diags)
       missingSignatures = mapMaybe getMissingSignatures diags
       topLevelSignatureActions = map (uncurry mkMissingSignatureAction) missingSignatures
+      unusedTerms = mapMaybe getUnusedTerms diags
+      unusedTermActions = map (uncurry mkUnusedTermAction) unusedTerms
   in return $ IdeResultOk $ concat [ renameActions
                                    , redundantActions
                                    , typedHoleActions
                                    , topLevelSignatureActions
+                                   , unusedTermActions
                                    ]
 
   where
@@ -512,6 +515,26 @@ codeActionProvider' supportsDocChanges _ docId _ _ _ context =
             kind = LSP.CodeActionQuickFix
             codeAction = LSP.CodeAction title (Just kind) (Just diags) (Just edit) Nothing
 
+    getUnusedTerms :: LSP.Diagnostic -> Maybe (LSP.Diagnostic, T.Text)
+    getUnusedTerms diag@(LSP.Diagnostic _ _ _ (Just "ghcmod") msg _) =
+      case extractUnusedTerm msg of
+        Nothing -> Nothing
+        Just signature -> Just (diag, signature)
+    getUnusedTerms _ = Nothing
+
+    mkUnusedTermAction :: LSP.Diagnostic -> T.Text -> LSP.CodeAction
+    mkUnusedTermAction diag term = LSP.CodeAction title (Just kind) (Just diags) Nothing (Just cmd)
+      where title :: T.Text
+            title = "Prefix " <> term <> " with _"
+            diags = LSP.List [diag]
+            newTerm = "_" <> term
+            pos = diag ^. (LSP.range . LSP.start)
+            kind = LSP.CodeActionQuickFix
+            cmdArgs = LSP.List
+              [ Object $ HM.fromList [("file", toJSON docUri),("pos", toJSON pos), ("text", toJSON newTerm)]]
+            -- The command label isen't used since the command is never presented to the user
+            cmd  = LSP.Command "Unused command label" "hare:rename" (Just cmdArgs)
+
 extractRenamableTerms :: T.Text -> [T.Text]
 extractRenamableTerms msg
   -- Account for both "Variable not in scope" and "Not in scope"
@@ -601,6 +624,14 @@ extractMissingSignature msg = extractSignature <$> stripMessageStart msg
                       . T.strip
     extractSignature = T.strip
 
+extractUnusedTerm :: T.Text -> Maybe T.Text
+extractUnusedTerm msg = extractTerm <$> stripMessageStart msg
+  where
+    stripMessageStart = T.stripPrefix "Defined but not used:"
+                      . T.strip
+    extractTerm       = T.dropWhile (== '‘')
+                      . T.dropWhileEnd (== '’')
+                      . T.dropAround (\c -> c /= '‘' && c /= '’')
 
 -- ---------------------------------------------------------------------