Add configuration to set path for the hie executable, fixes #62

Author: Tehnix

Changelog.md

@@ -1,3 +1,8 @@
+### 0.0.13
+
+Add configuration to set the path to your HIE executable, if it's not on your PATH. Note
+that this adds the `--lsp` argument to the call of this executable.
+
 ### 0.0.12
 
 Add configuration to enable/disable HIE, useful for multi-root workspaces.

README.md

@@ -46,7 +46,7 @@ Furthermore, the extension supports multiple ways of initializing hie, depending
 "languageServerHaskell.useHieWrapper": true,
 ```
 
-makes VSCode use the `hie-wrapper.sh` file to start hie through. This does assume that you built the hie executable using make build, but will fall back to plain hie.
+makes VSCode use the `hie-wrapper.sh` file to start hie through. This does assume that you built the hie executable using make build, but will fall back to plain hie. This will take precedence over `hieExecutablePath`.
 
 #### Custom Wrapper
 
@@ -62,7 +62,7 @@ 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.
 
-This can be beneficial if you are using something like nix, to have a wrapper script tailored to your setup.
+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`.
 
 #### Enable/disable HIE
 
@@ -72,6 +72,16 @@ You can enable or disable HIE via configuration. This is useful, because multi-r
 "languageServerHaskell.enableHIE": true
 ```
 
+#### Path for hie executable
+
+If you `hie` executable is not on your path, you can manually set it,
+
+```json
+"languageServerHaskell.hieExecutablePath": "~/.local/bin/hie"
+```
+
+The path placeholders work here as well. Note that this adds the `--lsp` argument to the call of this executable.
+
 ## Manual Installation
 Either install the extension via the marketplace (preferred), or if you are testing an unreleased version by,
 

package.json

@@ -2,7 +2,7 @@
     "name": "vscode-hie-server",
     "displayName": "Haskell Language Server",
     "description": "Language Server Protocol for Haskell via HIE",
-    "version": "0.0.12",
+    "version": "0.0.13",
     "license": "MIT",
     "publisher": "alanz",
     "engines": {
@@ -71,23 +71,29 @@
                     "default": 100,
                     "description": "Controls the maximum number of problems produced by the server."
                 },
+                "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.useHieWrapper": {
                     "scope": "resource",
                     "type": "boolean",
                     "default": false,
-                    "description": "Try to automatically select the correct hie version, based on your projects GHC version. NOTE: Build hie using the Makefile to get all versions."
+                    "description": "Try to automatically select the correct hie version, based on your projects GHC version. NOTE: Build hie using the Makefile to get all versions. This will take precedence over hieExecutablePath."
                 },
                 "languageServerHaskell.useCustomHieWrapper": {
                     "scope": "resource",
                     "type": "boolean",
                     "default": false,
-                    "description": "Use your own custom wrapper for hie (remember to specify the path!). This will take effect over useHieWrapper."
+                    "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. /Users/Alice/.hie-wrapper.sh)."
+                    "description": "Specify the full path to your own custom hie wrapper (e.g. ${HOME}/.hie-wrapper.sh). Works with ~, ${HOME} and ${workspaceFolder}."
                 },
                 "languageServerHaskell.hlintOn": {
                     "scope": "resource",
@@ -126,7 +132,7 @@
                     "scope": "resource",
                     "type": "boolean",
                     "default": true,
-                    "description": "Enable/Disable HIE (useful for multi-root workspaces)."
+                    "description": "Enable/disable HIE (useful for multi-root workspaces)."
                 }
             }
         },

src/extension.ts

@@ -69,8 +69,9 @@ async function activateHie(context: ExtensionContext, document: TextDocument) {
 
   try {
     const useCustomWrapper = workspace.getConfiguration('languageServerHaskell', uri).useCustomHieWrapper;
+    const hieExecutablePath = workspace.getConfiguration('languageServerHaskell', uri).hieExecutablePath;
     // Check if hie is installed.
-    if (!await isHieInstalled() && !useCustomWrapper) {
+    if (!await isHieInstalled() && !useCustomWrapper && hieExecutablePath === '') {
       // TODO: Once haskell-ide-engine is on hackage/stackage, enable an option to install it via cabal/stack.
       const notInstalledMsg: string =
         'hie executable missing, please make sure it is installed, see github.com/haskell/haskell-ide-engine.';
@@ -102,40 +103,67 @@ function activateHieNoCheck(context: ExtensionContext, folder: WorkspaceFolder,
     docsBrowserRegistered = true;
   }
 
-  let hieLaunchScript = 'hie-vscode.sh';
   const useCustomWrapper = workspace.getConfiguration('languageServerHaskell', uri).useCustomHieWrapper;
+  const useHieWrapper = workspace.getConfiguration('languageServerHaskell', uri).useHieWrapper;
+  let hieExecutablePath = workspace.getConfiguration('languageServerHaskell', uri).hieExecutablePath;
   let customWrapperPath = workspace.getConfiguration('languageServerHaskell', uri).useCustomHieWrapperPath;
 
-  // Substitute variables with their corresponding locations.
+  // 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 !== '') {
+    hieExecutablePath = hieExecutablePath
+      .replace('${workspaceFolder}', folder.uri.path)
+      .replace('${workspaceRoot}', folder.uri.path)
+      .replace('${HOME}', os.homedir)
+      .replace('${home}', os.homedir)
+      .replace(/^~/, os.homedir);
   }
 
+  // Set the executable, based on the settings. The order goes:
+  // First check useCustomWrapper, then check useHieWrapper, then
+  // check hieExecutablePath, else retain original path.
+  let hieLaunchScript = 'hie-vscode.sh';
   if (useCustomWrapper) {
     hieLaunchScript = customWrapperPath;
-  } else if (workspace.getConfiguration('languageServerHaskell', uri).useHieWrapper) {
+  } else if (useHieWrapper) {
     hieLaunchScript = 'hie-wrapper.sh';
+  } else if (hieExecutablePath !== '') {
+    hieLaunchScript = hieExecutablePath;
   }
-  // Don't use the .bat launcher, if the user specified a custom wrapper.
-  const startupScript = ( process.platform === 'win32' && !useCustomWrapper ) ? 'hie-vscode.bat' : hieLaunchScript;
-  const serverPath = useCustomWrapper ? startupScript : context.asAbsolutePath(path.join('.', startupScript));
 
+  // Don't use the .bat launcher, if the user specified a custom wrapper or a executable path.
+  const startupScript = ( process.platform === 'win32' && !useCustomWrapper && !hieExecutablePath )
+    ? 'hie-vscode.bat'
+    : hieLaunchScript;
+  // If using a custom wrapper or specificed an executable path, the path is assumed to already
+  // be absolute.
+  const serverPath = useCustomWrapper || hieExecutablePath
+    ? startupScript
+    : context.asAbsolutePath(path.join('.', startupScript));
+
+  const tempDir = ( process.platform === 'win32' ) ? '%TEMP%' : '/tmp';
+  const runArgs = [];
+  const debugArgs = ['-d', '-l', path.join(tempDir, 'hie.log')];
+  if (!useCustomWrapper && !useHieWrapper && hieExecutablePath !== '') {
+    runArgs.unshift('--lsp');
+    debugArgs.unshift('--lsp');
+  }
   // If the extension is launched in debug mode then the debug server options are used,
   // otherwise the run options are used
-  const tempDir = ( process.platform === 'win32' ) ? '%TEMP%' : '/tmp';
   const serverOptions: ServerOptions = {
-    run: { command: serverPath, transport: TransportKind.stdio, },
-    debug: { command: serverPath, transport: TransportKind.stdio, args: ['-d', '-l', path.join(tempDir, 'hie.log')] },
+    run: { command: serverPath, transport: TransportKind.stdio, args: runArgs, },
+    debug: { command: serverPath, transport: TransportKind.stdio, args: debugArgs },
   };
 
+  // Set a unique name per workspace folder (useful for multi-root workspaces).
   const langName = 'Haskell HIE (' + folder.name + ')';
   const outputChannel: OutputChannel = window.createOutputChannel(langName);
-  // Options to control the language client
   const clientOptions: LanguageClientOptions = {
     // Use the document selector to only notify the LSP on files inside the folder
     // path for the specific workspace.
@@ -156,18 +184,18 @@ function activateHieNoCheck(context: ExtensionContext, folder: WorkspaceFolder,
     middleware: {
       provideHover: DocsBrowser.hoverLinksMiddlewareHook,
     },
-    // Set the CWD to the workspace folder.
+    // Set the current working directory, for HIE, to be the workspace folder.
     workspaceFolder: folder,
   };
 
-  // Create the language client and start the client.
+  // Create the LSP client.
   const langClient = new LanguageClient(langName, langName, serverOptions, clientOptions);
 
   if (workspace.getConfiguration('languageServerHaskell', uri).showTypeForSelection.onHover) {
     context.subscriptions.push(ShowTypeHover.registerTypeHover(clients));
   }
+  // Register editor commands for HIE, but only register the commands once.
   if (!hieCommandsRegistered) {
-    // Only register the commands once.
     context.subscriptions.push(InsertType.registerCommand(clients));
     ShowTypeCommand.registerCommand(clients).forEach(x => context.subscriptions.push(x));
     registerHiePointCommand('hie.commands.demoteDef', 'hare:demote', context);
@@ -178,7 +206,7 @@ function activateHieNoCheck(context: ExtensionContext, folder: WorkspaceFolder,
     hieCommandsRegistered = true;
   }
 
-  // langClient.registerProposedFeatures();
+  // Finally start the client and add it to the list of clients.
   langClient.start();
   clients.set(folder.uri.toString(), langClient);
 }
@@ -194,13 +222,19 @@ export function deactivate(): Thenable<void> {
   return Promise.all(promises).then(() => undefined);
 }
 
+/*
+ * Check if HIE is installed.
+ */
 async function isHieInstalled(): Promise<boolean> {
   return new Promise<boolean>((resolve, reject) => {
     const cmd: string = ( process.platform === 'win32' ) ? 'where hie' : 'which hie';
     child_process.exec(cmd, (error, stdout, stderr) => resolve(!error));
   });
 }
 
+/*
+ * Create an editor command that calls an action on the active LSP server.
+ */
 async function registerHiePointCommand(name: string,
                                        command: string,
                                        context: ExtensionContext) {