Rename extension to just 'Haskell'

Also update README and use throwing to propagate ghc version errors

Author: lukel97

README.md

@@ -1,89 +1,73 @@
-# Haskell Language Server Client
+# Haskell for Visual Studio Code
 
-Client interface to the Language Server Protocol server for Haskell, as provided by the [Haskell IDE Engine](https://github.com/haskell/haskell-ide-engine), [ghcide](https://github.com/digital-asset/ghcide) or the new [Haskell Language Server](https://github.com/haskell/haskell-language-server).
-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.
-
-## Requirements
-
-The language client requires you to manually install at least one of:
-
-- [Haskell IDE Engine](https://github.com/haskell/haskell-ide-engine#installation): It was the unique haskell LSP server supported by this extension until version `0.40.0`. It is stable and functional but it will be replaced sooner or later by the new Haskell Language Server (see below).
-- [ghcide](https://github.com/digital-asset/ghcide#install-ghcide): A fast and reliable LSP server with the [main basic features](https://github.com/digital-asset/ghcide#features). Supported since the `0.40.0` version of the extension.
-- [Haskell language server](https://github.com/haskell/haskell-language-server#installation): The future successor of haskell-ide-engine. It is still under heavy development and it does not have all the features of haskell-ide-engine, yet, so use at your own risk! It is supported since the `0.40.0` version of the extension.
+This is the Visual Studio Code extension for the [Haskell programming language](https://haskell.org), powered by the [Haskell Langauge Server](https://github.com/haskell/haskell-language-server).
 
 ## 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
+- Warning and error diagnostics
 - 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)
+- Type information and documentation on hover
+- Jump to definition (`F12` or `Go to Definition` in the command palette)
 - List all top level definitions
 - Highlight references in document
-- Completion
+- Code 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 and stack projects
-- Fast due to caching of compile info
+## Requirements
 
-The other two language servers ([ghcide](https://github.com/digital-asset/ghcide#features) and haskell-language-server) have a subset of the features described above.
+- For standalone `.hs`/`.lhs` files, [ghc](https://www.haskell.org/ghc/) must be installed and on the PATH. The easiest way to install it is with [ghcup](https://www.haskell.org/ghcup/).
+- For Cabal based projects, [cabal-install](https://www.haskell.org/cabal/) must be installed and on the PATH. It can also be installed with [ghcup](https://www.haskell.org/ghcup/).
+- For Stack based projects, [stack](http://haskellstack.org) must be installed and on the PATH.
 
 ## Supported GHC versions
 
-vscode-hie-server depends on the chosen haskell language server to support different versions of GHC. At the moment of writing the following versions are supported using Haskell Ide Engine: 8.4, 8.6 and 8.8. ghcide and Haskell Language Server also have support for ghc 8.10. If your project uses any other GHC version it won't work.
+| GHC    | Linux | macOS | Windows |
+| ------ | ----- | ----- | ------- |
+| 8.10.1 | ✓     | ✓     | ✓       |
+| 8.8.3  | ✓     | ✓     |
+| 8.8.2  | ✓     | ✓     |
+| 8.6.5  | ✓     | ✓     | ✓       |
+| 8.6.4  | ✓     | ✓     | ✓       |
+
+## Language Servers
+
+This extension also supports several other language servers for Haskell, some which need to be manually installed:
+
+- [Haskell Language Server](https://github.com/haskell/haskell-language-server#installation): This is the default language server which will automatically be downloaded, so no installation should be needed. It builds upon ghcide by providing extra plugins and features.
+- [ghcide](https://github.com/digital-asset/ghcide#install-ghcide): A fast and reliable LSP server with support for [basic features](https://github.com/digital-asset/ghcide#features).
+- [Haskell IDE Engine](https://github.com/haskell/haskell-ide-engine#installation): A stable and mature language server, but note that development has moved from this to the Haskell Language Server.
 
 ## Extension Settings
 
 You can disable HLint and also control the maximum number of reported problems,
 
 ```json
-"languageServerHaskell.hlintOn": true,
-"languageServerHaskell.maxNumberOfProblems": 100,
+"haskell.hlintOn": true,
+"haskell.maxNumberOfProblems": 100,
 ```
 
 If the liquid haskell executable is installed, enable using it to
 process haskell files on save.
 
 ```json
-"languageServerHaskell.liquidOn": true,
+"haskell.liquidOn": true,
 ```
 
-### HIE Variant
-
-Since `0.40` the extension has a selection over the three supported language servers:
-`haskell-ide-engine`, `ghcide` and `haskell-language-server`.
-The default one is `haskell-ide-engine`, although it will be changed by `haskell-language-server`
-when it will be stable enough.
-
-The extension will look for the language server executable in `$PATH` and it will call it
-with the appropiate params depending on the extension settings.
-However, not all extension settings can be applied to all the language servers:
-
-- `haskell-ide-engine`: It supports all of them.
-- `ghcide`: It does not support any of them.
-- `haskell-language-server`: For now it only supports the log related settings: `Log File` and `Trace:server`. The goal is to support the same settings as `haskell-ide-engine`.
-
-### Enable/disable HIE
+### Enable/disable server
 
 You can enable or disable the chosen haskell language server via configuration. This is sometimes useful at workspace level, because multi-root workspaces do not yet allow you to manage extensions at the folder level, which can be necessary.
 
 ```json
-"languageServerHaskell.enableHIE": true
+"haskell.enable": true
 ```
 
-### Path for hie executable
+### Path to server executable executable
 
-If your chosen haskell language server executable is not on your path, you can manually set it,
+If your server is manually installed and not on your path, you can also manually set the path to the executable.
 
 ```json
-"languageServerHaskell.serverExecutablePath": "~/.local/bin/hie"
+"haskell.serverExecutablePath": "~/.local/bin/hie"
 ```
 
 There are a few placeholders which will be expanded:
@@ -145,6 +129,16 @@ First, check out [what multi-root workspaces](https://code.visualstudio.com/docs
 
 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.
 
+## Downloaded language servers
+
+This extension will download the language server binaries to a specific location depending on your system. If you find yourself running out of disk space, you can try deleting old versions of language servers in this directory. The extension will redownload them, no strings attached.
+| Platform | Path |
+|----------|------|
+| macOS | `~/Library/Application\ Support/Code/User/globalStorage/alanz.vscode-hie-server/` |
+| Windows | `%APPDATA%\Code\User\globalStorage\alanz.vscode-hie-server` |
+| Linux | TODO |
+
+
 ## Investigating and reporting problems
 
 1.  Go to extensions and right click `Haskell Language Server` and choose `Configure Extensions Settings`
@@ -164,6 +158,9 @@ Now you will see the information which you can use to diagnose or report a probl
 * *Common issues*:
   * For now, the extension is not able to open a single haskell source file. You need to open a workspace or folder, configured to be built with cabal, stack or other hie-bios compatible program.
   * Check you don't have other haskell extensions active, they can interfere with each other.
+## Contributing
+
+If you want to help, get started by reading [Contributing](https://github.com/alanz/vscode-hie-server/blob/master/Contributing.md) for more details.
 
 ## Release Notes
 

images/HIE_logo_128.png

@@ -1,8 +1,8 @@
 {
   "name": "vscode-hie-server",
-  "displayName": "Haskell Language Server",
-  "description": "Haskell language support powered by HLS, ghcide or HIE",
-  "version": "0.0.40",
+  "displayName": "Haskell",
+  "description": "Haskell language support powered by the Haskell Language Server, ghcide or HIE",
+  "version": "0.1.0",
   "license": "MIT",
   "publisher": "alanz",
   "engines": {
@@ -28,7 +28,7 @@
     "Linters",
     "Other"
   ],
-  "icon": "images/HIE_logo_128.png",
+  "icon": "images/haskell-logo.png",
   "galleryBanner": {
     "color": "#22172A",
     "theme": "dark"
@@ -63,47 +63,47 @@
     ],
     "configuration": {
       "type": "object",
-      "title": "Haskell Language Server",
+      "title": "Haskell",
       "properties": {
-        "languageServerHaskell.hlintOn": {
+        "haskell.hlintOn": {
           "title": "Hlint",
           "scope": "resource",
           "type": "boolean",
           "default": true,
           "description": "Get suggestions from hlint"
         },
-        "languageServerHaskell.maxNumberOfProblems": {
+        "haskell.maxNumberOfProblems": {
           "scope": "resource",
           "type": "number",
           "default": 100,
           "description": "Controls the maximum number of problems produced by the server"
         },
-        "languageServerHaskell.diagnosticsOnChange": {
+        "haskell.diagnosticsOnChange": {
           "scope": "resource",
           "type": "boolean",
           "default": true,
           "description": "Compute diagnostics continuously as you type. Turn off to only generate diagnostics on file save."
         },
-        "languageServerHaskell.liquidOn": {
+        "haskell.liquidOn": {
           "scope": "resource",
           "type": "boolean",
           "default": false,
           "description": "Get diagnostics from liquid haskell"
         },
-        "languageServerHaskell.completionSnippetsOn": {
+        "haskell.completionSnippetsOn": {
           "title": "Completion Snippets",
           "scope": "resource",
           "type": "boolean",
           "default": true,
           "description": "Show snippets with type information when using code completion"
         },
-        "languageServerHaskell.formatOnImportOn": {
+        "haskell.formatOnImportOn": {
           "scope": "resource",
           "type": "boolean",
           "default": true,
           "description": "When adding an import, use the formatter on the result"
         },
-        "languageServerHaskell.formattingProvider": {
+        "haskell.formattingProvider": {
           "scope": "resource",
           "type": "string",
           "enum": [
@@ -116,7 +116,7 @@
           "default": "brittany",
           "description": "The tool to use for formatting requests"
         },
-        "languageServerHaskell.trace.server": {
+        "haskell.trace.server": {
           "scope": "resource",
           "type": "string",
           "enum": [
@@ -126,13 +126,13 @@
           "default": "off",
           "description": "Traces the communication between VS Code and the language server."
         },
-        "languageServerHaskell.logFile": {
+        "haskell.logFile": {
           "scope": "resource",
           "type": "string",
           "default": "",
           "description": "If set, redirects the logs to a file."
         },
-        "languageServerHaskell.serverVariant": {
+        "haskell.languageServerVariant": {
           "scope": "resource",
           "type": "string",
           "enum": [
@@ -143,13 +143,13 @@
           "default": "haskell-language-server",
           "description": "Which language server to use."
         },
-        "languageServerHaskell.serverExecutablePath": {
+        "haskell.serverExecutablePath": {
           "scope": "resource",
           "type": "string",
           "default": "",
           "description": "Set the path to your language server executable, if it's not already on your $PATH. Works with ~, ${HOME} and ${workspaceFolder}."
         },
-        "languageServerHaskell.enableHIE": {
+        "haskell.enable": {
           "scope": "resource",
           "type": "boolean",
           "default": true,

images/HaskellLogo.png

@@ -63,7 +63,7 @@ export async function activate(context: ExtensionContext) {
 }
 
 function findManualExecutable(uri: Uri, folder?: WorkspaceFolder): string | null {
-  let exePath = workspace.getConfiguration('languageServerHaskell', uri).serverExecutablePath;
+  let exePath = workspace.getConfiguration('haskell', uri).serverExecutablePath;
   if (exePath === '') {
     return null;
   }
@@ -82,7 +82,7 @@ function findManualExecutable(uri: Uri, folder?: WorkspaceFolder): string | null
 
 /** Searches the PATH for whatever is set in serverVariant */
 function findLocalServer(context: ExtensionContext, uri: Uri, folder?: WorkspaceFolder): string | null {
-  const serverVariant = workspace.getConfiguration('languageServerHaskell', uri).serverVariant;
+  const serverVariant = workspace.getConfiguration('haskell', uri).languageServerVariant;
 
   // Set the executable, based on the settings.
   let exes: string[] = []; // should get set below
@@ -130,13 +130,13 @@ async function activateHie(context: ExtensionContext, document: TextDocument) {
 
 async function activateHieNoCheck(context: ExtensionContext, uri: Uri, folder?: WorkspaceFolder) {
   // Stop right here, if HIE is disabled in the resource/workspace folder.
-  const enableHIE = workspace.getConfiguration('languageServerHaskell', uri).enableHIE;
-  if (!enableHIE) {
+  const enable = workspace.getConfiguration('haskell', uri).enable;
+  if (!enable) {
     return;
   }
 
-  const logLevel = workspace.getConfiguration('languageServerHaskell', uri).trace.server;
-  const logFile = workspace.getConfiguration('languageServerHaskell', uri).logFile;
+  const logLevel = workspace.getConfiguration('haskell', uri).trace.server;
+  const logFile = workspace.getConfiguration('haskell', uri).logFile;
 
   let serverExecutable;
   try {
@@ -158,7 +158,7 @@ async function activateHieNoCheck(context: ExtensionContext, uri: Uri, folder?:
   const runArgs: string[] = ['--lsp'];
   let debugArgs: string[] = ['--lsp'];
 
-  const serverVariant = workspace.getConfiguration('languageServerHaskell', uri).serverVariant;
+  const serverVariant = workspace.getConfiguration('haskell', uri).languageServerVariant;
   // ghcide does not accept -d and -l params
   if (serverVariant !== 'ghcide') {
     if (logLevel === 'messages') {
@@ -201,8 +201,8 @@ async function activateHieNoCheck(context: ExtensionContext, uri: Uri, folder?:
       { scheme: 'file', language: 'literate haskell', pattern: pat },
     ],
     synchronize: {
-      // Synchronize the setting section 'languageServerHaskell' to the server.
-      configurationSection: 'languageServerHaskell',
+      // Synchronize the setting section 'haskell' to the server.
+      configurationSection: 'haskell',
     },
     diagnosticCollectionName: langName,
     revealOutputChannelOn: RevealOutputChannelOn.Never,
@@ -249,7 +249,7 @@ export function deactivate(): Thenable<void> {
 }
 
 function showNotInstalledErrorMessage(uri: Uri) {
-  const variant = workspace.getConfiguration('languageServerHaskell', uri).serverVariant;
+  const variant = workspace.getConfiguration('haskell', uri).languageServerVariant;
   let projectUrl = '';
   switch (variant) {
     case 'haskell-ide-engine':