Merge branch 'master' into add-case-split

Author: alanz

Changelog.md

@@ -1,3 +1,20 @@
+### 0.0.19
+
+* Fix hie launch on windows with logging off (#90). Thanks @Tehnix.
+
+### 0.0.18
+
+* Support GHC 8.4.3 in the wrapper file
+* The `languageServerHaskell.trace.server` parameter now affects
+  `/tmp/hie.log`, as well as ghc-mod `--vomit` output.
+* Add an Import identifier command, by @chrismwendt
+
+### 0.0.17
+
+* Support GHC 8.4.2 in the wrapper file
+* Update dependencies to avoid security vulnerability.
+* Use os.tmpdir() for the hie.log file
+
 ### 0.0.15
 
 Support the new webview-api for the documentation browser, thanks to @AlexeyRaga.
@@ -38,13 +55,13 @@ Add rudimentary support for detecting the project GHC version and using the
 appropriate hie version. This currently only works on Linux (contributors on
 other platforms, please jump in with appropriate scripts) and requires
 `haskell-ide-engine` built via the `Makefile` added in
-https://github.com/haskell/haskell-ide-engine/pull/447.  Thanks to @Tehnix
+https://github.com/haskell/haskell-ide-engine/pull/447. Thanks to @Tehnix
 
 ### 0.0.7
 
 Update `package-lock.json` to fresh dependencies.
 
-Add show type *of selected expression* on hover feature, by @halhenke
+Add show type _of selected expression_ on hover feature, by @halhenke
 
 Added options for how to display the same information when using the show type
 command menu, by @halhenke

README.md

@@ -1,37 +1,42 @@
 # Haskell Language Server Client
+
 Client interface to the Language Server Protocol server for Haskell, as provided by the Haskell IDE Engine. Check the [requirements](#user-content-requirements) for dependencies.
 
-__It is still under development!__ If you want to help, get started by reading [Contributing](https://github.com/alanz/vscode-hie-server/blob/master/Contributing.md) for more details.
+**It is still under development!** If you want to help, get started by reading [Contributing](https://github.com/alanz/vscode-hie-server/blob/master/Contributing.md) for more details.
 
 ## Requirements
+
 The language client requires you to manually install the [HIE](https://github.com/haskell/haskell-ide-engine) language server,
 
 ```bash
-$ git clone https://github.com/haskell/haskell-ide-engine
+$ git clone https://github.com/haskell/haskell-ide-engine --recursive
 $ cd haskell-ide-engine && make build
 ```
 
 Alternatively you can just `stack install`, but `make build` will give you the best setup.
 
 ## Features
+
 Language server client for haskell using the [HIE](https://github.com/haskell/haskell-ide-engine) language server. Supports,
 
-- Diagnostics via HLint and GHC warnings/errors
-- Code actions and quick-fixes via [`apply-refact`](https://github.com/mpickering/apply-refact) (click the lightbulb)
-- Type information and documentation (via hoogle) on hover
-- Jump to definition (`F12` or `Go to Definition` in command palette)
-- List all top level definitions
-- Highlight references in document
-- Completion
-- Formatting via [`brittany`](https://github.com/lspitzner/brittany) (`^ ⌥ B` or `Format Document` in command palette)
-- Renaming via [`HaRe`](https://github.com/alanz/HaRe) (`F2` or `Rename Symbol` in command palette)
-- [Multi-root workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces) support
+* Diagnostics via HLint and GHC warnings/errors
+* Code actions and quick-fixes via [`apply-refact`](https://github.com/mpickering/apply-refact) (click the lightbulb)
+* Type information and documentation (via hoogle) on hover
+* Jump to definition (`F12` or `Go to Definition` in command palette)
+* List all top level definitions
+* Highlight references in document
+* Completion
+* Formatting via [`brittany`](https://github.com/lspitzner/brittany) (`^ ⌥ B` or `Format Document` in command palette)
+* Renaming via [`HaRe`](https://github.com/alanz/HaRe) (`F2` or `Rename Symbol` in command palette)
+* [Multi-root workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces) support
 
 Additionally the language server itself features,
-- Supports plain GHC projects, cabal projects (sandboxed and non sandboxed) and stack projects
-- Fast due to caching of compile info
+
+* Supports plain GHC projects, cabal projects (sandboxed and non sandboxed) and stack projects
+* Fast due to caching of compile info
 
 ## Extension Settings
+
 You can disable HLint and also control the maximum number of reported problems,
 
 ```json
@@ -60,8 +65,8 @@ If you need more control, and want to have a custom wrapper, either in your spec
 
 There are a few placeholders which will be expanded:
 
-- `~`, `${HOME}` and `${home}` will be expanded into your users' home folder.
-- `${workspaceFolder}` and `${workspaceRoot}` will expand into your current project root.
+* `~`, `${HOME}` and `${home}` will be expanded into your users' home folder.
+* `${workspaceFolder}` and `${workspaceRoot}` will expand into your current project root.
 
 This can be beneficial if you are using something like nix, to have a wrapper script tailored to your setup. This will take precedence over `useHieWrapper` and `hieExecutablePath`.
 
@@ -84,6 +89,7 @@ If you `hie` executable is not on your path, you can manually set it,
 The path placeholders work here as well. Note that this adds the `--lsp` argument to the call of this executable.
 
 ## Docs on Hover/Generating Hoogle DB
+
 For the most current documentation on this, see [Docs on Hover/Completion](https://github.com/haskell/haskell-ide-engine#docs-on-hovercompletion).
 
 HIE supports fetching docs from haddock on hover. It will fallback on using a hoogle db(generally located in ~/.hoogle on linux)
@@ -110,6 +116,7 @@ $ stack --stack-yaml=<stack.yaml you used to build hie> exec hoogle generate
 ```
 
 ## Manual Installation
+
 Either install the extension via the marketplace (preferred), or if you are testing an unreleased version by,
 
 ```bash
@@ -127,35 +134,37 @@ In VS Code, open the extensions tab, and click on the `...` at the top right of
 and use the `Install from VSIX...` option to locate and install the generated file.
 
 ## Using multi-root workspaces
+
 First, check out [what multi-root workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces) are. The idea of using multi-root workspaces, is to be able to work on several different Haskell projects, where the GHC version or stackage LTS could differ, and have it work smoothly.
 
 HIE is now started for each workspace folder you have in your multi-root workspace, and several configurations are on a resource (i.e. folder) scope, instead of window (i.e. global) scope.
 
 To showcase the utility of this, let's imagine that we are writing a full-stack Haskell website, and we have three main components:
 
-- a backend using LTS 10.10 and
-- a frontend using GHCJS and LTS 8.11,
-- a common part that is shared between the two, using LTS 8.11.
+* a backend using LTS 10.10 and
+* a frontend using GHCJS and LTS 8.11,
+* a common part that is shared between the two, using LTS 8.11.
 
 One way to be able to work on all these in the same VSCode project is to create a new workspace, and then add each folder to the workspace. This way, they are considered separate entities, and HIE will start separately for each.
 
 You can then define how to start HIE for each of these folders, by going into `Settings` and then choosing `Folder Settings -> <the folder you want>`, or just configure the workspace. E.g. the _backend_ and _common_ projects could have a folder settting,
 
 ```json
 {
-    "languageServerHaskell.useCustomHieWrapper": true,
-    "languageServerHaskell.useCustomHieWrapperPath": "${workspaceFolder}/hie.sh"
+  "languageServerHaskell.useCustomHieWrapper": true,
+  "languageServerHaskell.useCustomHieWrapperPath": "${workspaceFolder}/hie.sh"
 }
 ```
 
 to launch HIE via `hie.sh` inside the _backend_ and _common_ folder, while the _frontend_, because of using GHCJS, might not want to use HIE, and therefore needs to disable HIE,
 
 ```json
 {
-    "languageServerHaskell.useHieWrapper": false
+  "languageServerHaskell.useHieWrapper": false
 }
 ```
- This provides a very flexible way of customizing your setup.
+
+This provides a very flexible way of customizing your setup.
 
 ## Release Notes
 

hie-vscode.bat

@@ -3,11 +3,16 @@
 set HIE_SERVER_PATH=
 for /f "delims=" %%p in ('where hie') do set HIE_SERVER_PATH=%%p
 
-if [%HIE_SERVER_PATH%] == [] (
+set HIE_WRAPPER_PATH=
+for /f "delims=" %%p in ('where hie-wrapper') do set HIE_WRAPPER_PATH=%%p
+
+rem Need to check that neither is found
+if [%HIE_WRAPPER_PATH%] == [] (
   echo Content-Length: 100
   echo:
   echo {"jsonrpc":"2.0","id":1,"error":{"code":-32099,"message":"Cannot find hie.exe in the path"}}
   exit 1
 )
 
-hie --lsp %1 %2 %3 %4 %5 %6 %7 %8 %9
+rem Need to run hie-wrapper if found, else hie
+hie-wrapper --lsp %1 %2 %3 %4 %5 %6 %7 %8 %9

hie-vscode.sh

@@ -1,8 +1,11 @@
 #!/bin/sh
 
 export HIE_SERVER_PATH=`which hie`
+export HIE_WRAPPER_PATH=`which hie-wrapper`
 
-if [ "X" = "X$HIE_SERVER_PATH" ]; then
+if [ "X" = "X$HIE_WRAPPER_PATH" ]; then
+hie-wrapper --lsp $@
+elif [ "X" = "X$HIE_SERVER_PATH" ]; then
   echo "Content-Length: 100\r\n\r"
   echo '{"jsonrpc":"2.0","id":1,"error":{"code":-32099,"message":"Cannot find hie.exe in the path"}}'
   exit 1

hie-wrapper-old.sh

@@ -0,0 +1,104 @@
+#!/usr/bin/env bash
+DEBUG=1
+indent=""
+function debug {
+  if [[ $DEBUG == 1 ]]; then
+    echo "$indent$@" >> /tmp/hie-wrapper.log
+  fi
+}
+
+curDir=`pwd`
+debug "Launching HIE for project located at $curDir"
+indent="  "
+
+GHCBIN='ghc'
+# If a .stack-work exists, assume we are using stack.
+if [ -d ".stack-work" ]; then
+  debug "Using stack GHC version"
+  GHCBIN='stack ghc --'
+else
+  debug "Using plain GHC version"
+fi
+versionNumber=`$GHCBIN --version`
+debug $versionNumber
+
+HIEBIN='hie'
+BACKUP_HIEBIN='hie'
+# Match the version number with a HIE version, and provide a fallback without
+# the patch number.
+
+# GHC 8.0.*
+if [[ $versionNumber = *"8.0.1"* ]]; then
+  debug "Project is using GHC 8.0.1"
+  HIEBIN='hie-8.0.1'
+  BACKUP_HIEBIN='hie-8.0'
+elif [[ $versionNumber = *"8.0.2"* ]]; then
+  debug "Project is using GHC 8.0.2"
+  HIEBIN='hie-8.0.2'
+  BACKUP_HIEBIN='hie-8.0'
+elif [[ $versionNumber = *"8.0"* ]]; then
+  debug "Project is using GHC 8.0.*"
+  HIEBIN='hie-8.0'
+
+# GHC 8.2.*
+elif [[ $versionNumber = *"8.2.1"* ]]; then
+  debug "Project is using GHC 8.2.1"
+  HIEBIN='hie-8.2.1'
+  BACKUP_HIEBIN='hie-8.2'
+elif [[ $versionNumber = *"8.2.2"* ]]; then
+  debug "Project is using GHC 8.2.2"
+  HIEBIN='hie-8.2.2'
+  BACKUP_HIEBIN='hie-8.2'
+elif [[ $versionNumber = *"8.2"* ]]; then
+  debug "Project is using GHC 8.2.*"
+  HIEBIN='hie-8.2'
+
+# GHC 8.4.*
+elif [[ $versionNumber = *"8.4.3"* ]]; then
+  debug "Project is using GHC 8.4.3"
+  HIEBIN='hie-8.4.3'
+  BACKUP_HIEBIN='hie-8.4'
+elif [[ $versionNumber = *"8.4.2"* ]]; then
+  debug "Project is using GHC 8.4.2"
+  HIEBIN='hie-8.4.2'
+  BACKUP_HIEBIN='hie-8.4'
+elif [[ $versionNumber = *"8.4"* ]]; then
+  debug "Project is using GHC 8.4.*"
+  HIEBIN='hie-8.4'
+
+else
+  debug "WARNING: GHC version does not match any of the checked ones."
+fi
+
+if [ -x "$(command -v $HIEBIN)" ]; then
+  debug "$HIEBIN was found on path"
+elif [ -x "$(command -v $BACKUP_HIEBIN)" ]; then
+  debug "Backup $BACKUP_HIEBIN was found on path"
+  HIEBIN=$BACKUP_HIEBIN
+else
+  debug "Falling back to plain hie"
+  HIEBIN='hie'
+fi
+
+debug "Starting HIE"
+
+# Check that HIE is working
+export HIE_SERVER_PATH=`which $HIEBIN`
+
+if [ "X" = "X$HIE_SERVER_PATH" ]; then
+  echo "Content-Length: 100\r\n\r"
+  echo '{"jsonrpc":"2.0","id":1,"error":{"code":-32099,"message":"Cannot find hie in the path"}}'
+  exit 1
+fi
+
+# Run directly
+$HIEBIN --lsp $@
+# $HIEBIN --lsp
+
+# Run with a log
+# $HIEBIN --lsp -d -l /tmp/hie.log $@
+# $HIEBIN --lsp -d -l /tmp/hie.log --ekg $@
+# $HIEBIN --lsp -d -l /tmp/hie.log --vomit $@
+
+# Run with a log and a direct dump of the server output
+# $HIEBIN --lsp -d -l /tmp/hie.log | tee /tmp/hie-wire.log

hie-wrapper.sh

@@ -11,57 +11,8 @@ curDir=`pwd`
 debug "Launching HIE for project located at $curDir"
 indent="  "
 
-GHCBIN='ghc'
-# If a .stack-work exists, assume we are using stack.
-if [ -d ".stack-work" ]; then
-  debug "Using stack GHC version"
-  GHCBIN='stack ghc --'
-else
-  debug "Using plain GHC version"
-fi
-versionNumber=`$GHCBIN --version`
-debug $versionNumber
-
-HIEBIN='hie'
-BACKUP_HIEBIN='hie'
-# Match the version number with a HIE version, and provide a fallback without
-# the patch number.
-if [[ $versionNumber = *"8.0.1"* ]]; then
-  debug "Project is using GHC 8.0.1"
-  HIEBIN='hie-8.0.1'
-  BACKUP_HIEBIN='hie-8.0'
-elif [[ $versionNumber = *"8.0.2"* ]]; then
-  debug "Project is using GHC 8.0.2"
-  HIEBIN='hie-8.0.2'
-  BACKUP_HIEBIN='hie-8.0'
-elif [[ $versionNumber = *"8.0"* ]]; then
-  debug "Project is using GHC 8.0.*"
-  HIEBIN='hie-8.0'
-elif [[ $versionNumber = *"8.2.1"* ]]; then
-  debug "Project is using GHC 8.2.1"
-  HIEBIN='hie-8.2.1'
-  BACKUP_HIEBIN='hie-8.2'
-elif [[ $versionNumber = *"8.2.2"* ]]; then
-  debug "Project is using GHC 8.2.2"
-  HIEBIN='hie-8.2.2'
-  BACKUP_HIEBIN='hie-8.2'
-elif [[ $versionNumber = *"8.2"* ]]; then
-  debug "Project is using GHC 8.2.*"
-  HIEBIN='hie-8.2'
-else
-  debug "WARNING: GHC version does not match any of the checked ones."
-fi
-
-if [ -x "$(command -v $HIEBIN)" ]; then
-  debug "$HIEBIN was found on path"
-elif [ -x "$(command -v $BACKUP_HIEBIN)" ]; then
-  debug "Backup $BACKUP_HIEBIN was found on path"
-  HIEBIN=$BACKUP_HIEBIN
-else
-  debug "Falling back to plain hie"
-  HIEBIN='hie'
-fi
 
+HIEBIN='hie-wrapper'
 debug "Starting HIE"
 
 # Check that HIE is working