Merge pull request #223 from alanz/backend-config-option

Use enumeration to choose between hie, hls or ghcide

Author: alanz

Changelog.md

@@ -1,3 +1,12 @@
+### 0.0.40
+
+Change the way the backend is configured, simplifying it.
+
+* remove wrapper scripts (hie-vscode.sh/hie-vscode.bat)
+* dropdown choice between `haskell-ide-engine`, `haskell-language-server` or
+  `ghcide` in the `hieVariant` setting.
+* this can be overridden by an explicit `hieExecutablePath`, as before.
+
 ### 0.0.39
 
 Remove verbose logging option, it is not longer supported.

hie-vscode.bat

@@ -2,7 +2,7 @@
   "name": "vscode-hie-server",
   "displayName": "Haskell Language Server",
   "description": "Language Server Protocol for Haskell via HIE",
-  "version": "0.0.39",
+  "version": "0.0.40",
   "license": "MIT",
   "publisher": "alanz",
   "engines": {
@@ -88,33 +88,6 @@
           "default": "brittany",
           "description": "The tool to use for formatting requests."
         },
-        "languageServerHaskell.hieExecutablePath": {
-          "scope": "resource",
-          "type": "string",
-          "default": "",
-          "description":
-            "Set the path to your hie executable, if it's not already on your $PATH. Works with ~, ${HOME} and ${workspaceFolder}."
-        },
-        "languageServerHaskell.useCustomHieWrapper": {
-          "scope": "resource",
-          "type": "boolean",
-          "default": false,
-          "description":
-            "Use your own custom wrapper for hie (remember to specify the path!). This will take precedence over useHieWrapper and hieExecutablePath."
-        },
-        "languageServerHaskell.useCustomHieWrapperPath": {
-          "scope": "resource",
-          "type": "string",
-          "default": "",
-          "description":
-            "Specify the full path to your own custom hie wrapper (e.g. ${HOME}/.hie-wrapper.sh). Works with ~, ${HOME} and ${workspaceFolder}."
-        },
-        "languageServerHaskell.noLspParam": {
-          "scope": "resource",
-          "type": "boolean",
-          "default": false,
-          "description": "Do not set the '--lsp' flag in the hie/hie-wrapper arguments when launching it"
-        },
         "languageServerHaskell.showTypeForSelection.onHover": {
           "scope": "resource",
           "type": "boolean",
@@ -143,6 +116,20 @@
           "default": "",
           "description": "If set, redirects the logs to a file."
         },
+        "languageServerHaskell.hieVariant": {
+          "scope": "resource",
+          "type": "string",
+          "enum": ["haskell-ide-engine", "haskell-language-server", "ghcide"],
+          "default": "haskell-ide-engine",
+          "description": "Which haskell language server to use."
+        },
+        "languageServerHaskell.hieExecutablePath": {
+          "scope": "resource",
+          "type": "string",
+          "default": "",
+          "description":
+            "Set the path to your hie executable, if it's not already on your $PATH. Works with ~, ${HOME} and ${workspaceFolder}."
+        },
         "languageServerHaskell.enableHIE": {
           "scope": "resource",
           "type": "boolean",

hie-vscode.sh

@@ -1,7 +1,6 @@
 'use strict';
 import * as child_process from 'child_process';
 import * as os from 'os';
-import * as path from 'path';
 import {
   commands,
   ExtensionContext,
@@ -69,13 +68,33 @@ async function activateHie(context: ExtensionContext, document: TextDocument) {
   }
 
   try {
-    const useCustomWrapper = workspace.getConfiguration('languageServerHaskell', uri).useCustomHieWrapper;
+    const hieVariant = workspace.getConfiguration('languageServerHaskell', uri).hieVariant;
     const hieExecutablePath = workspace.getConfiguration('languageServerHaskell', uri).hieExecutablePath;
     // Check if hie is installed.
-    if (!await isHieInstalled() && !useCustomWrapper && hieExecutablePath === '') {
+    let exeName = 'hie';
+    switch (hieVariant) {
+      case 'haskell-ide-engine':
+        break;
+      case 'haskell-language-server':
+      case 'ghcide':
+        exeName = hieVariant;
+        break;
+    }
+    if (!await isHieInstalled(exeName) && hieExecutablePath === '') {
       // TODO: Once haskell-ide-engine is on hackage/stackage, enable an option to install it via cabal/stack.
+      let hieProjectUrl = '/haskell/haskell-ide-engine';
+      switch (hieVariant) {
+        case 'haskell-ide-engine':
+          break;
+        case 'haskell-language-server':
+          hieProjectUrl = '/haskell/haskell-language-server';
+          break;
+        case 'ghcide':
+          hieProjectUrl = '/digital-asset/ghcide';
+          break;
+      }
       const notInstalledMsg: string =
-        'hie executable missing, please make sure it is installed, see github.com/haskell/haskell-ide-engine.';
+        exeName + ' executable missing, please make sure it is installed, see https://github.com' + hieProjectUrl + '.';
       const forceStart: string = 'Force Start';
       window.showErrorMessage(notInstalledMsg, forceStart).then(option => {
         if (option === forceStart) {
@@ -104,22 +123,13 @@ function activateHieNoCheck(context: ExtensionContext, folder: WorkspaceFolder,
     docsBrowserRegistered = true;
   }
 
-  const useCustomWrapper = workspace.getConfiguration('languageServerHaskell', uri).useCustomHieWrapper;
+  const hieVariant = workspace.getConfiguration('languageServerHaskell', uri).hieVariant;
   let hieExecutablePath = workspace.getConfiguration('languageServerHaskell', uri).hieExecutablePath;
-  let customWrapperPath = workspace.getConfiguration('languageServerHaskell', uri).useCustomHieWrapperPath;
-  const noLspParam = workspace.getConfiguration('languageServerHaskell', uri).noLspParam;
   const logLevel = workspace.getConfiguration('languageServerHaskell', uri).trace.server;
   const logFile = workspace.getConfiguration('languageServerHaskell', uri).logFile;
 
   // Substitute path variables with their corresponding locations.
-  if (useCustomWrapper) {
-    customWrapperPath = customWrapperPath
-      .replace('${workspaceFolder}', folder.uri.path)
-      .replace('${workspaceRoot}', folder.uri.path)
-      .replace('${HOME}', os.homedir)
-      .replace('${home}', os.homedir)
-      .replace(/^~/, os.homedir);
-  } else if (hieExecutablePath !== '') {
+  if (hieExecutablePath !== '') {
     hieExecutablePath = hieExecutablePath
       .replace('${workspaceFolder}', folder.uri.path)
       .replace('${workspaceRoot}', folder.uri.path)
@@ -128,32 +138,39 @@ function activateHieNoCheck(context: ExtensionContext, folder: WorkspaceFolder,
       .replace(/^~/, os.homedir);
   }
 
-  // Set the executable, based on the settings. The order goes: First
-  // check useCustomWrapper, then check hieExecutablePath, else retain
-  // original path.
-  let hieLaunchScript = process.platform === 'win32' ? 'hie-vscode.bat' : 'hie-vscode.sh';
-  if (useCustomWrapper) {
-    hieLaunchScript = customWrapperPath;
-  } else if (hieExecutablePath !== '') {
+  // Set the executable, based on the settings.
+  let hieLaunchScript = 'hie'; // should get set below
+  switch (hieVariant) {
+    case 'haskell-ide-engine':
+      hieLaunchScript = 'hie-wrapper';
+      break;
+    case 'haskell-language-server':
+      hieLaunchScript = 'haskell-language-server-wrapper';
+      break;
+    case 'ghcide':
+      hieLaunchScript = 'ghcide';
+      break;
+  }
+  if (hieExecutablePath !== '') {
     hieLaunchScript = hieExecutablePath;
   }
 
   // If using a custom wrapper or specificed an executable path, the path is assumed to already
   // be absolute.
-  const serverPath =
-    useCustomWrapper || hieExecutablePath ? hieLaunchScript : context.asAbsolutePath(path.join('.', hieLaunchScript));
+  const serverPath = hieLaunchScript;
 
-  const runArgs: string[] = [];
-  let debugArgs: string[] = [];
-  if (logLevel === 'messages') {
-    debugArgs = ['-d'];
-  }
-  if (!noLspParam) {
-    runArgs.unshift('--lsp');
-    debugArgs.unshift('--lsp');
-  }
-  if (logFile !== '') {
-    debugArgs = debugArgs.concat(['-l', logFile]);
+  const runArgs: string[] = ['--lsp'];
+  let debugArgs: string[] = ['--lsp'];
+
+  // ghcide does not accept -d and -l params
+  if (hieVariant !== 'ghcide') {
+    if (logLevel === 'messages') {
+      debugArgs = debugArgs.concat(['-d']);
+    }
+
+    if (logFile !== '') {
+      debugArgs = debugArgs.concat(['-l', logFile]);
+    }
   }
 
   // If the extension is launched in debug mode then the debug server options are used,
@@ -166,6 +183,8 @@ function activateHieNoCheck(context: ExtensionContext, folder: WorkspaceFolder,
   // Set a unique name per workspace folder (useful for multi-root workspaces).
   const langName = 'Haskell HIE (' + folder.name + ')';
   const outputChannel: OutputChannel = window.createOutputChannel(langName);
+  outputChannel.appendLine('[client] run command = "' + serverPath + ' ' + runArgs.join(' ') + '"');
+  outputChannel.appendLine('[client] debug command = "' + serverPath + ' ' + debugArgs.join(' ') + '"');
   const clientOptions: LanguageClientOptions = {
     // Use the document selector to only notify the LSP on files inside the folder
     // path for the specific workspace.
@@ -242,9 +261,9 @@ export function deactivate(): Thenable<void> {
 /*
  * Check if HIE is installed.
  */
-async function isHieInstalled(): Promise<boolean> {
+async function isHieInstalled(exeName: string): Promise<boolean> {
   return new Promise<boolean>((resolve, reject) => {
-    const cmd: string = process.platform === 'win32' ? 'where hie' : 'which hie';
+    const cmd: string = process.platform === 'win32' ? 'where ' + exeName : 'which ' + exeName;
     child_process.exec(cmd, (error, stdout, stderr) => resolve(!error));
   });
 }