Merge pull request haskell#8 from fendor/merge-hie-bios

Merge master downstream and update hie-bios

Author: fendor

.azure/linux-stack.yml

@@ -25,13 +25,30 @@ jobs:
         YAML_FILE: stack-8.4.2.yaml
       stack-8.2.2:
         YAML_FILE: stack-8.2.2.yaml
+  variables:
+    STACK_ROOT: /home/vsts/.stack
   steps:
+  - task: CacheBeta@0
+    inputs:
+      key: |
+        "cache"
+        $(Agent.OS)
+        $(Build.SourcesDirectory)/$(YAML_FILE)
+      path: .azure-cache
+      cacheHitVar: CACHE_RESTORED
+    displayName: "Download cache"
+  - bash: |
+      mkdir -p $STACK_ROOT
+      tar -xzf .azure-cache/stack-root.tar.gz -C /
+      mkdir -p .stack-work
+      tar -xzf .azure-cache/stack-work.tar.gz
+    displayName: "Unpack cache"
+    condition: eq(variables.CACHE_RESTORED, 'true')
   - bash: |
       git submodule sync
       git submodule update --init
     displayName: Sync submodules
   - bash: |
-      export STACK_ROOT="$(Build.SourcesDirectory)"/.stack-root
       mkdir -p ~/.local/bin
       curl -L https://get.haskellstack.org/stable/linux-x86_64.tar.gz | \
         tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack'
@@ -52,7 +69,6 @@ jobs:
       source .azure/linux.bashrc
       stack build --stack-yaml $(YAML_FILE) --test --bench --only-dependencies
       stack install --stack-yaml $(YAML_FILE) # `hie` binary required for tests
-      stack --stack-yaml $(YAML_FILE) exec hoogle generate
     displayName: Build Test-dependencies
   - bash: |
       sudo apt update
@@ -66,3 +82,8 @@ jobs:
   #     source .azure/linux.bashrc
   #     stack test --stack-yaml $(YAML_FILE)
   #   displayName: Run Test
+  - bash: |
+      mkdir -p .azure-cache
+      tar -czf .azure-cache/stack-root.tar.gz $STACK_ROOT
+      tar -czf .azure-cache/stack-work.tar.gz .stack-work
+    displayName: "Pack cache"

.azure/macos-stack.yml

@@ -21,13 +21,30 @@ jobs:
         YAML_FILE: stack-8.4.2.yaml
       stack-8.2.2:
         YAML_FILE: stack-8.2.2.yaml
+  variables:
+    STACK_ROOT: /Users/vsts/.stack
   steps:
+  - task: CacheBeta@0
+    inputs:
+      key: |
+        "cache"
+        $(Agent.OS)
+        $(Build.SourcesDirectory)/$(YAML_FILE)
+      path: .azure-cache
+      cacheHitVar: CACHE_RESTORED
+    displayName: "Download cache"
+  - bash: |
+      mkdir -p $STACK_ROOT
+      tar -xzf .azure-cache/stack-root.tar.gz -C /
+      mkdir -p .stack-work
+      tar -xzf .azure-cache/stack-work.tar.gz
+    displayName: "Unpack cache"
+    condition: eq(variables.CACHE_RESTORED, 'true')
   - bash: |
       git submodule sync
       git submodule update --init
     displayName: Sync submodules
   - bash: |
-      export STACK_ROOT="$(Build.SourcesDirectory)"/.stack-root
       mkdir -p ~/.local/bin
       curl -skL https://get.haskellstack.org/stable/osx-x86_64.tar.gz | \
         tar xz --strip-components=1 --include '*/stack' -C ~/.local/bin;
@@ -48,7 +65,6 @@ jobs:
       source .azure/macos.bashrc
       stack build --stack-yaml $(YAML_FILE) --test --bench --only-dependencies
       stack install --stack-yaml $(YAML_FILE) # `hie` binary required for tests
-      stack --stack-yaml $(YAML_FILE) exec hoogle generate
     displayName: Build Test-dependencies
   - bash: |
       ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
@@ -63,3 +79,8 @@ jobs:
   #     source .azure/macos.bashrc
   #     stack test --stack-yaml $(YAML_FILE)
   #   displayName: Run Test
+  - bash: |
+      mkdir -p .azure-cache
+      tar -czf .azure-cache/stack-root.tar.gz $STACK_ROOT
+      tar -czf .azure-cache/stack-work.tar.gz .stack-work
+    displayName: "Pack cache"

.azure/windows-stack.yml

@@ -23,7 +23,26 @@ jobs:
         YAML_FILE: stack-8.4.2.yaml
       stack-8.2.2:
         YAML_FILE: stack-8.2.2.yaml
+  variables:
+    STACK_ROOT: "C:\\sr"
+
   steps:
+  - task: CacheBeta@0
+    inputs:
+      key: |
+        "stack-root"
+        $(Agent.OS)
+        $(Build.SourcesDirectory)/$(YAML_FILE)
+      path: $(STACK_ROOT)
+    displayName: "Cache stack-root"
+  - task: CacheBeta@0
+    inputs:
+      key: |
+        "stack-work"
+        $(Agent.OS)
+        $(Build.SourcesDirectory)/$(YAML_FILE)
+      path: .stack-work
+    displayName: "Cache stack-work"
   - bash: |
       git submodule sync
       git submodule update --init
@@ -48,7 +67,6 @@ jobs:
       source .azure/windows.bashrc
       stack build --stack-yaml $(YAML_FILE) --test --bench --only-dependencies
       stack install --stack-yaml $(YAML_FILE) # `hie` binary required for tests
-      stack exec --stack-yaml $(YAML_FILE) hoogle generate
     displayName: Build Test-dependencies
   - bash: |
       # TODO: try to install automatically (`choco install z3` fails and pacman is not installed)

.azure/windows.bashrc

@@ -1,4 +1,3 @@
-export STACK_ROOT="C:\\sr"
 export LOCAL_BIN_PATH=$(cygpath $APPDATA\\local\\bin)
 export Z3_BIN_PATH=/usr/local/z3-4.8.5-x64-win/bin
 export PATH=$Z3_BIN_PATH:$LOCAL_BIN_PATH:$PATH

.gitignore

@@ -74,3 +74,6 @@ _build/
 # stack 2.1 stack.yaml lock files
 stack*.yaml.lock
 shake.yaml.lock
+
+# ignore hie.yaml's for testdata 
+test/**/*.yaml

.gitmodules

@@ -26,6 +26,8 @@
 	# url = https://github.com/arbor/ghc-mod.git
 	url = https://github.com/alanz/ghc-mod.git
   #url = https://github.com/mpickering/ghc-mod.git
+
 [submodule "hie-bios"]
 	path = hie-bios
-	url = https://github.com/mpickering/hie-bios
+	url = https://github.com/mpickering/hie-bios.git
+	branch = multi-cradle

Changelog.md

@@ -1,3 +1,58 @@
+# 0.12.0.0
+
+- Monthly resolver bump, `lts-13.30` for GHC 8.6.5, and `nightly-2019-07-31` for
+  nightly build, rest are unchanged.
+([#1352](https://github.com/haskell/haskell-ide-engine/pull/1352), by @alanz)
+
+- Log OS in hie-wrapper
+([#1351](https://github.com/haskell/haskell-ide-engine/pull/1351), by @chrismwendt)
+
+- Fix completionItem/resolve sending snippets as plain text
+([#1349](https://github.com/haskell/haskell-ide-engine/pull/1349), by @Avi-D-coder)
+
+- Bump hlint to 2.2.2
+([#1347](https://github.com/haskell/haskell-ide-engine/pull/1347), by @alanz)
+
+- fail installation if cabal-version is too low
+([#1344](https://github.com/haskell/haskell-ide-engine/pull/1344), by @power-fungus)
+
+- Update vim links in TOC
+([#1341](https://github.com/haskell/haskell-ide-engine/pull/1341), by @adamse)
+
+- lift required stack-version to 2.1.1
+([#1338](https://github.com/haskell/haskell-ide-engine/pull/1338), by @power-fungus)
+
+- Replace every occurrence of build-doc by build-data
+([#1336](https://github.com/haskell/haskell-ide-engine/pull/1336), by @w1gz)
+
+- Use preview of pipeline caching in azure builds
+([#1335](https://github.com/haskell/haskell-ide-engine/pull/1335), by @jneira)
+
+- Simpler completion
+([#1334](https://github.com/haskell/haskell-ide-engine/pull/1334), by @wz1000)
+
+- Clarify README.md for Vim users
+([#1331](https://github.com/haskell/haskell-ide-engine/pull/1331), by @mb720)
+
+- Fix typos in Challenges.md
+([#1329](https://github.com/haskell/haskell-ide-engine/pull/1329), by @mb720)
+
+- Remove unnecesary extra-dep unix-time
+([#1326](https://github.com/haskell/haskell-ide-engine/pull/1326), by @jneira)
+
+- Use hlint-2.2
+([#1325](https://github.com/haskell/haskell-ide-engine/pull/1325), by @alanz)
+
+- Remove "hybrid" test cases
+([#1324](https://github.com/haskell/haskell-ide-engine/pull/1324), by @fendor)
+
+- Reuse unHTML for searchModules'
+([#1323](https://github.com/haskell/haskell-ide-engine/pull/1323), by @fendor)
+
+- add possibility to run `install.hs` from cabal
+([#1221](https://github.com/haskell/haskell-ide-engine/pull/1221), by @power-fungus)
+
+
 # 0.11.0.0
 
 - Bump resolvers. `lts-13.27` for GHC 8.6.5, `nightly-2019-07-07` for

README.md

@@ -4,6 +4,7 @@
 [![License BSD3][badge-license]][license]
 [![CircleCI][badge-circleci]][circleci]
 [![AppVeyor][badge-appveyor]][appveyor]
+[![Open Source Helpers](https://www.codetriage.com/haskell/haskell-ide-engine/badges/users.svg)](https://www.codetriage.com/haskell/haskell-ide-engine)
 
 [badge-license]: https://img.shields.io/badge/license-BSD3-green.svg?dummy
 [license]: https://github.com/haskell/haskell-ide-engine/blob/master/LICENSE
@@ -37,9 +38,11 @@ we talk to clients.__
       - [Using VS Code with Nix](#using-vs-code-with-nix)
     - [Using HIE with Sublime Text](#using-hie-with-sublime-text)
     - [Using HIE with Vim or Neovim](#using-hie-with-vim-or-neovim)
-      - [vim-plug](#vim-plug)
-      - [Vim 8.0](#vim-80)
-      - [Sample `~/.vimrc`](#sample-vimrc)
+      - [Coc](#Coc)
+      - [LanguageClient-neovim](#LanguageClient-neovim)
+        - [vim-plug](#vim-plug)
+        - [Clone the LanguageClient-neovim repo](#clone-the-languageclient-neovim-repo)
+        - [Sample `~/.vimrc`](#sample-vimrc)
     - [Using HIE with Atom](#using-hie-with-atom)
     - [Using HIE with Emacs](#using-hie-with-emacs)
     - [Using HIE with Spacemacs](#using-hie-with-spacemacs)
@@ -368,9 +371,40 @@ Now open a Haskell project with Sublime Text. You should have these features ava
 
 ### Using HIE with Vim or Neovim
 
-As above, make sure HIE is installed. These instructions are for using the [LanguageClient-neovim](https://github.com/autozimu/LanguageClient-neovim) client.
+As above, make sure HIE is installed.
+Then you can use [Coc](https://github.com/neoclide/coc.nvim), [LanguageClient-neovim](https://github.com/autozimu/LanguageClient-neovim)
+or any other vim Langauge server protocol client.
+Coc is recommend since it is the only complete LSP implementation for Vim and Neovim and offers snippets and floating documentation out of the box.
+
+#### Coc
+Follow Coc's [installation instructions](https://github.com/neoclide/coc.nvim),
+Then issue `:CocConfig` and add the following to your Coc config file.
+
+```jsonc
+"languageserver": {
+  "haskell": {
+    "command": "hie-wrapper",
+    "rootPatterns": [
+      ".stack.yaml",
+      "cabal.config",
+      "package.yaml"
+    ],
+    "filetypes": [
+      "hs",
+      "lhs",
+      "haskell"
+    ],
+    "initializationOptions": {
+      "languageServerHaskell": {
+      }
+    },
+  }
+}
+```
+
+#### LanguageClient-neovim
 
-#### vim-plug
+##### vim-plug
 If you use [vim-plug](https://github.com/junegunn/vim-plug), then you can do this by e.g.,
 including the following line in the Plug section of your `init.vim` or `~/.vimrc`:
 
@@ -383,11 +417,11 @@ Plug 'autozimu/LanguageClient-neovim', {
 
 and issuing a `:PlugInstall` command within Neovim or Vim.
 
-#### Clone the LanguageClient-neovim repo
+##### Clone the LanguageClient-neovim repo
 As an alternative to using [vim-plug](https://github.com/junegunn/vim-plug) shown above, clone [LanguageClient-neovim](https://github.com/autozimu/LanguageClient-neovim)
 into `~/.vim/pack/XXX/start/`, where `XXX` is just a name for your "plugin suite".
 
-#### Sample `~/.vimrc`
+##### Sample `~/.vimrc`
 
 ```vim
 set rtp+=~/.vim/pack/XXX/start/LanguageClient-neovim
@@ -625,7 +659,12 @@ These builds have a dependency on [homebrew](https://brew.sh)'s `gmp` library. I
 ### cannot satisfy -package-id \<package\>
 
 #### Is \<package\> base-x?
-Make sure that you are running the correct version of hie for your version of ghc, or check out hie-wrapper.
+Make sure that the GHC version of HIE matches the one of the project. After that run
+```
+$ cabal configure
+```
+
+and then restart HIE (e.g. by restarting your editor).
 
 #### Is there a hash (#) after \<package\>?
 Delete any `.ghc.environment*` files in your project root and try again. (At the time of writing, cabal new-style projects are not supported with ghc-mod)

app/HieWrapper.hs

@@ -11,6 +11,7 @@ import           Data.Foldable
 import           Data.Version                          (showVersion)
 import           HIE.Bios
 import           Haskell.Ide.Engine.MonadFunctions
+import           Haskell.Ide.Engine.Cradle (findLocalCradle)
 import           Haskell.Ide.Engine.Options
 import           Haskell.Ide.Engine.Plugin.Base
 import qualified Language.Haskell.LSP.Core             as Core
@@ -20,6 +21,8 @@ import           System.Directory
 import           System.Environment
 import qualified System.Log.Logger as L
 import           System.Process
+import           System.Info
+import           System.FilePath
 
 -- ---------------------------------------------------------------------
 
@@ -68,14 +71,15 @@ run opts = do
   logm $  "run entered for hie-wrapper(" ++ progName ++ ") " ++ version
   d <- getCurrentDirectory
   logm $ "Current directory:" ++ d
+  logm $ "Operating system:" ++ os
 
   -- Get the cabal directory from the cradle
-  cr <- findCradle d
-  let dir = cradleRootDir cr
+  cradle <- findLocalCradle (d </> "File.hs")
+  let dir = cradleRootDir cradle
   logm $ "Cradle directory:" ++ dir
   setCurrentDirectory dir
 
-  ghcVersion <- getProjectGhcVersion
+  ghcVersion <- getProjectGhcVersion cradle
   logm $ "Project GHC version:" ++ ghcVersion
 
   let

app/MainHie.hs

@@ -5,6 +5,7 @@ module Main where
 import           Control.Monad
 import           Data.Monoid                           ((<>))
 import           Data.Version                          (showVersion)
+import           Haskell.Ide.Engine.Cradle (findLocalCradle)
 import           Haskell.Ide.Engine.MonadFunctions
 import           Haskell.Ide.Engine.MonadTypes
 import           Haskell.Ide.Engine.Options
@@ -15,10 +16,11 @@ import qualified Language.Haskell.LSP.Core             as Core
 import           Options.Applicative.Simple
 import qualified Paths_haskell_ide_engine              as Meta
 import           System.Directory
+import           System.FilePath ((</>))
 import           System.Environment
 import qualified System.Log.Logger                     as L
-import HIE.Bios.Types
-import System.IO
+import           HIE.Bios.Types
+import           System.IO
 
 -- ---------------------------------------------------------------------
 -- plugins
@@ -112,7 +114,11 @@ run opts = do
 
   Core.setupLogger mLogFileName ["hie"] logLevel
 
-  projGhcVersion <- getProjectGhcVersion
+  d <- getCurrentDirectory
+  -- Get the cabal directory from the cradle
+  cradle <- findLocalCradle (d </> "File.hs")
+
+  projGhcVersion <- getProjectGhcVersion cradle
   when (projGhcVersion /= hieGhcVersion) $
     warningm $ "Mismatching GHC versions: Project is " ++ projGhcVersion
             ++ ", HIE is " ++ hieGhcVersion
@@ -123,7 +129,6 @@ run opts = do
 
   progName <- getProgName
   logm $  "Run entered for HIE(" ++ progName ++ ") " ++ version
-  d <- getCurrentDirectory
   logm $ "Current directory:" ++ d
 
   let initOpts = defaultCradleOpts { cradleOptsVerbosity = verbosity }