Friday fixes

.azure/linux-installhs-stack.yml

@@ -29,4 +29,12 @@ jobs:
   - bash: |
       source .azure/linux.bashrc
       stack install.hs help
-    displayName: Run help of `instal.hs`
+    displayName: Run help of `install.hs`
+  - bash: |
+      source .azure/linux.bashrc
+      stack install.hs stack-install-cabal
+    displayName: Run stack-install-cabal target of `install.hs`
+  - bash: |
+      source .azure/linux.bashrc
+      stack install.hs build-latest
+    displayName: Run build-latest target of `install.hs`

.azure/linux-stack.yml

@@ -23,8 +23,6 @@ jobs:
         YAML_FILE: stack-8.4.3.yaml
       stack-8.4.2:
         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:

.azure/macos-installhs-stack.yml

@@ -29,4 +29,12 @@ jobs:
   - bash: |
       source .azure/macos.bashrc
       stack install.hs help
-    displayName: Run help of `instal.hs`
+    displayName: Run help of `install.hs`
+  - bash: |
+      source .azure/macos.bashrc
+      stack install.hs stack-install-cabal
+    displayName: Run stack-install-cabal target of `install.hs`
+  - bash: |
+      source .azure/macos.bashrc
+      stack install.hs build-latest
+    displayName: Run build-latest target of `install.hs`

.azure/macos-stack.yml

@@ -19,10 +19,8 @@ jobs:
         YAML_FILE: stack-8.4.3.yaml
       stack-8.4.2:
         YAML_FILE: stack-8.4.2.yaml
-      stack-8.2.2:
-        YAML_FILE: stack-8.2.2.yaml
   variables:
-    STACK_ROOT: /Users/vsts/.stack
+    STACK_ROOT: $(Build.SourcesDirectory)/.stack
   steps:
   - task: CacheBeta@0
     inputs:

.azure/windows-installhs-stack.yml

@@ -27,4 +27,12 @@ jobs:
   - bash: |
       source .azure/windows.bashrc
       stack install.hs help
-    displayName: Run help of `instal.hs`
+    displayName: Run help of `install.hs`
+  - bash: |
+      source .azure/windows.bashrc
+      stack install.hs stack-install-cabal
+    displayName: Run stack-install-cabal target of `install.hs`
+  - bash: |
+      source .azure/windows.bashrc
+      stack install.hs build-latest
+    displayName: Run build-latest target of `install.hs`

.azure/windows-stack.yml

@@ -21,8 +21,6 @@ jobs:
         YAML_FILE: stack-8.4.3.yaml
       stack-8.4.2:
         YAML_FILE: stack-8.4.2.yaml
-      stack-8.2.2:
-        YAML_FILE: stack-8.2.2.yaml
   variables:
     STACK_ROOT: "C:\\sr"
 

.circleci/config.yml

@@ -101,21 +101,6 @@ defaults: &defaults
 
 version: 2
 jobs:
-  ghc-8.0.2:
-    environment:
-      - STACK_FILE: "stack-8.0.2.yaml"
-    <<: *defaults
-
-  ghc-8.2.1:
-    environment:
-      - STACK_FILE: "stack-8.2.1.yaml"
-    <<: *defaults
-
-  ghc-8.2.2:
-    environment:
-      - STACK_FILE: "stack-8.2.2.yaml"
-    <<: *defaults
-
   ghc-8.4.2:
     environment:
       - STACK_FILE: "stack-8.4.2.yaml"
@@ -199,7 +184,6 @@ workflows:
   version: 2
   multiple-ghcs:
     jobs:
-      - ghc-8.2.2
       - ghc-8.4.2
       - ghc-8.4.3
       - ghc-8.4.4

.gitmodules

@@ -12,7 +12,7 @@
 
 [submodule "submodules/HaRe"]
 	path = submodules/HaRe
-	url = https://github.com/wz1000/HaRe.git
+	url = https://github.com/alanz/HaRe.git
 
 [submodule "submodules/cabal-helper"]
 	path = submodules/cabal-helper

README.md

@@ -178,7 +178,7 @@ sudo dnf install libicu-devel ncurses-devel
 
 In order to avoid problems with long paths on Windows you can do the following:
 
-1. Edit the group policy: set "Enable Win32 long paths" to "Enabled" (Works
+1. In the `Local Group Policy Editor`: `Local Computer Policy -> Computer Configuration -> Administrative Templates -> System -> Filesystem` set `Enable Win32 long paths` to `Enabled` (Works
    only for Windows 10).
 
 2. Clone the `haskell-ide-engine` to the root of your logical drive (e.g. to
@@ -216,7 +216,7 @@ cabal v2-run ./install.hs --project-file install/shake.project <target>
 
 Running the script with cabal on windows requires a cabal version greater or equal to `3.0.0.0`.
 
-Unfortunately, it is still required to have `stack` installed so that the install-script can locate the `local-bin` directory (on Linux `~/.local/bin`) and copy the `hie` binaries to `hie-x.y.z`, which is required for the `hie-wrapper` to function as expected.
+Unfortunately, it is still required to have `stack` installed so that the install-script can locate the `local-bin` directory (on Linux `~/.local/bin`) and copy the `hie` binaries to `hie-x.y.z`, which is required for the `hie-wrapper` to function as expected. There are plans to remove this requirement and let users build hie only with one build tool or another.
 
 For brevity, only the `stack`-based commands are presented in the following sections.
 
@@ -246,13 +246,12 @@ stack ./install.hs hie-8.4.4
 stack ./install.hs build-data
 ```
 
-The Haskell IDE Engine can also be built with `cabal new-build` instead of `stack build`.
+The Haskell IDE Engine can also be built with `cabal v2-build` instead of `stack build`.
 This has the advantage that you can decide how the GHC versions have been installed.
-However, this approach does currently not work for windows due to a missing feature upstream.
 To see what GHC versions are available, the command `stack install.hs cabal-ghcs` can be used.
 It will list all GHC versions that are on the path and their respective installation directory.
 If you think, this list is incomplete, you can try to modify the PATH variable, such that the executables can be found.
-Note, that the targets `cabal-build`, `cabal-build-data` and `cabal-build-all` depend on the found GHC versions.
+Note, that the targets `cabal-build` and `cabal-build-data` depend on the found GHC versions.
 They install Haskell IDE Engine only for the found GHC versions.
 
 An example output is:
@@ -274,12 +273,6 @@ stack install.hs cabal-hie-8.4.4
 stack install.hs cabal-build-data
 ```
 
-To install HIE for all GHC versions that are present on your system, use:
-
-```bash
-stack ./install.hs cabal-build-all
-```
-
 In general, targets that use `cabal` instead of `stack` are prefixed with `cabal-*` and are identical to their counterpart, except they do not install a GHC if it is missing but fail.
 
 ##### Multiple versions of HIE (optional)
@@ -503,7 +496,7 @@ Then issue `:CocConfig` and add the following to your Coc config file.
     "initializationOptions": {
       "languageServerHaskell": {
       }
-    },
+    }
   }
 }
 ```
@@ -800,12 +793,32 @@ If you think `haskell-ide-engine` is using a lot of memory then the most useful
 thing you can do is prepare a profile of the memory usage whilst you're using
 the program.
 
-1. Add `profiling: True` to the cabal.project file of `haskell-ide-engine
+1. Add `profiling: True` to the cabal.project file of `haskell-ide-engine`
 2. `cabal new-build hie`
 3. (IMPORTANT) Add `profiling: True` to the `cabal.project` file of the project you want to profile.
 4. Make a wrapper script which calls the `hie` you built in step 2 with the additional options `+RTS -hd -l-au`
 5. Modify your editor settings to call this wrapper script instead of looking for `hie` on the path
-6. Try using `h-i-e` as normal and then process the `*.eventlog` which will be created using  `eventlog2html`.
+6. Try using `h-i-e` as normal and then process the `*.eventlog` which will be created using  [`eventlog2html`](http://hackage.haskell.org/package/eventlog2html).
 7. Repeat the process again using different profiling options if you like.
 
+#### Using `ghc-events-analyze`
+
+`haskell-ide-engine` contains the necessary tracing functions to work with [`ghc-events-analyze`](http://www.well-typed.com/blog/2014/02/ghc-events-analyze/). Each
+request which is made will emit an event to the eventlog when it starts and finishes. This way you
+can see if there are any requests which are taking a long time to complete or are blocking.
+
+1. Make sure that `hie` is linked with the `-eventlog` option. This can be achieved by adding the flag
+to the `ghc-options` field in the cabal file.
+2. Run `hie` as normal but with the addition of `+RTS -l`. This will produce an eventlog called `hie.eventlog`.
+3. Run `ghc-events-analyze` on the `hie.eventlog` file to produce the rendered SVG. Warning, this might take a while and produce a big SVG file.
+
+The default options for `ghc-events-analyze` will produce quite a wide chart which is difficult to view. You can try using less buckets in order
+to make the chart quicker to generate and faster to render.
+
+```
+ghc-events-analyze hie.eventlog -b 100
+```
+
+This support is similar to the logging capabilities [built into GHC](https://www.haskell.org/ghc/blog/20190924-eventful-ghc.html).
+
 

appveyor.yml

@@ -7,7 +7,6 @@ environment:
   - GHCVER: 8.4.4
   - GHCVER: 8.4.3
   - GHCVER: 8.4.2
-  - GHCVER: 8.2.2
 install:
 - cmd: >-
     git submodule update --init --recursive

docs/Build.md

@@ -13,7 +13,6 @@ The design of the build system has the following main goals:
     - `stack`
     - `git`
 * is completely functional right after a simple `git clone` and after every `git pull`
-* one-stop-shop for building and naming all executables required for using `hie` in IDEs.
 * prevents certain build failures by either identifying a failed precondition (such as wrong `stack` version) or by performing the necessary steps so users can't forget them (such as invoking `git` to update submodules)
 
 
@@ -28,8 +27,9 @@ See the project's `README` for detailed information about installing `hie`.
 The build script `install.hs` defines several targets using the `shake` build system. The targets are roughly:
 
 * `hie-*`: builds and installs the `hie` binaries. Also renames the binaries to contain the correct version-number.
-* `build`: builds and installs `hie` binaries for all supported `ghc` versions.
+* `build-latest`: builds and installs `hie` for the latest available and supported `ghc` version.
 * `build-data`: builds the hoogle-db required by `hie`
+* `build`:  builds and installs `hie` for the latest supported `ghc` version (like `build-latest`) and the hoogle-db (like `build-data`)
 * `cabal-*`: execute the same task as the original target, but with `cabal` instead of `stack`
 
 Each `stack-*.yaml` contains references to packages in the submodules. Calling `stack` with one of those causes the build to fail if the submodules have not been initialized already. The file `shake.yaml` solves this issue invoking the `git` binary itself to update the submodules. Moreover, it specifies the correct version of `shake` and is used for installing all run-time dependencies such as `cabal` and `hoogle` if necessary.
@@ -38,7 +38,7 @@ Each `stack-*.yaml` contains references to packages in the submodules. Calling `
 
 `hie` depends on a correct environment in order to function properly:
 
-* `cabal-install`: If no `cabal` executable can be found or has an outdated version, `cabal-install` is installed via `stack`.
+* `cabal-install`: This dependency is required by `hie` to handle correctly projects that are not `stack` based (without `stack.yaml`). You can install an appropiate version using `stack` with the `stack-install-cabal` target.
 * The `hoogle` database: `hoogle generate` needs to be called with the most-recent `hoogle` version.
 
 ### Steps to build `hie`
@@ -47,16 +47,15 @@ Installing `hie` is a multi-step process:
 
 1. `git submodule sync && git submodule update --init`
 2. `hoogle generate` (`hoogle>=5.0.17` to be safe)
-3. ensure that `cabal-install` is installed in the correct version
-4. `stack --stack-yaml=stack-<X>.yaml install` or `cabal new-install -w ghc-<X>`
-5. rename `hie` binary to `hie-<X>` in `$HOME/.local/bin`, where `<X>` is the GHC version used
-6. repeat step 4 and 5 for all desired GHC versions
+3. `stack --stack-yaml=stack-<X>.yaml install` or `cabal v2-install -w ghc-<X>`
+4. rename `hie` binary to `hie-<X>` in `$HOME/.local/bin`, where `<X>` is the GHC version used
+5. repeat step 3 and 4 for all desired GHC versions
 
 This ensures that a complete install is always possible after each `git pull` or a `git clone`.
 
 #### Building `hie` with profiling support
 
-To build `hie` with profiling enabled `cabal new-install` needs to be used instead of `stack`.
+To build `hie` with profiling enabled `cabal v2-install` needs to be used instead of `stack`.
 
 Configure `cabal` to enable profiling by setting `profiling: True` in `cabal.project.local` for all packages. If that file does not already exist, create it as follows:
 
@@ -71,7 +70,7 @@ Then `hie` can be compiled for a specific GHC version:
 
 ```bash
 export GHCP=<path-to-ghc-binary>
-cabal new-install exe:hie -w $GHCP \
+cabal v2-install exe:hie -w $GHCP \
   --write-ghc-environment-files=never --symlink-bindir=$HOME/.local/bin \
   --overwrite-policy=always --reinstall
 ```
@@ -90,19 +89,17 @@ The final step is to configure the `hie` client to use a custom `hie-wrapper` sc
 The `install.hs` script performs some checks to ensure that a correct installation is possible and provide meaningful error messages for known issues.
 
 * `stack` needs to be up-to-date. Version `1.9.3` is required
+* `cabal` needs to be up-to-date. Version `2.4.1.0` is required to *use* haskell-ide-engine until the pull request #1126 is merged. Unfortunately cabal version `3.0.0.0` is needed to *install* hie in windows systems but that inconsistence will be fixed by the mentioned pull request.
 * `ghc-8.6.3` is broken on windows. Trying to install `hie-8.6.3` on windows is not possible.
-* `cabal new-build` does not work on windows at the moment. All `cabal-*` targets exit with an error message about that.
 * When the build fails, an error message, that suggests to remove `.stack-work` directory, is displayed.
 
 ### Tradeoffs
 
 #### `stack` is a build dependency
 
-Currently, it is not possible to build all `hie-*` executables automatically without `stack`, since the `install.hs` script is executed by `stack`.
+Currently, `stack` is needed even if you run the script with `cabal` to get the path where install the binaries but there are plans to remove that dependency (see #1380).
 
-We are open to suggestions of other build systems that honor the requirements above, but are executable without `stack`.
-
-#### `install.hs` installs a GHC before running
+#### run `install.hs` with `stack` installs a GHC before running
 
 Before the code in `install.hs` can be executed, `stack` installs a `GHC`, depending on the `resolver` field in `shake.yaml`. This is necessary if `install.hs` should be completely functional right after a fresh `git clone` without further configuration.
 

haskell-ide-engine.cabal

@@ -1,5 +1,5 @@
 name:                haskell-ide-engine
-version:             0.13.0.0
+version:             1.0.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
@@ -69,8 +69,8 @@ library
                      , gitrev >= 1.1
                      , haddock-api
                      , haddock-library
-                     , haskell-lsp == 0.17.*
-                     , haskell-lsp-types == 0.17.*
+                     , haskell-lsp == 0.18.*
+                     , haskell-lsp-types == 0.18.*
                      , haskell-src-exts
                      , hie-plugin-api
                      , hoogle >= 5.0.13
@@ -98,10 +98,7 @@ library
                      , hie-bios
                      , bytestring-trie
                      , unliftio
-  if impl(ghc < 8.4)
-    build-depends:     hlint >= 2.0.11 && < 2.1.18
-  else
-    build-depends:     hlint >= 2.2.2
+                     , hlint >= 2.2.2
 
   ghc-options:         -Wall -Wredundant-constraints
   if flag(pedantic)
@@ -203,11 +200,12 @@ test-suite unit-test
                      , free
                      , ghc
                      , haskell-ide-engine
-                     , haskell-lsp-types == 0.17.*
+                     , haskell-lsp-types == 0.18.*
                      , hie-test-utils
                      , hie-plugin-api
                      , hoogle > 5.0.11
                      , hspec
+                     , process
                      , quickcheck-instances
                      , text
                      , unordered-containers
@@ -292,8 +290,8 @@ test-suite func-test
                      , filepath
                      , lsp-test >= 0.8.0.0
                      , haskell-ide-engine
-                     , haskell-lsp-types == 0.17.*
-                     , haskell-lsp == 0.17.*
+                     , haskell-lsp-types == 0.18.*
+                     , haskell-lsp == 0.18.*
                      , hie-test-utils
                      , hie-plugin-api
                      , hspec