Update README.md and CONTRIBUTING.md

Also remove tests since they were only JS stubs

Author: lukel97

Contributing.md

@@ -1,71 +1,46 @@
 # Contributing
 
-This document will briefly outline how to get started contributing to the `vscode-hie-server` Haskell language client for the [Haskell-IDE-Engine](https://github.com/haskell/haskell-ide-engine) language server.
-
 ## Dependencies and Building
 
-For development, all you need is to,
-
-* run `npm install -g typescript` to get [TypeScript](https://www.typescriptlang.org),
-* run `npm install -g webpack` to get [Webpack](https://webpack.js.org),
-* then run `npm install` in the project root to install development dependencies.
+Run `npm install` in the project root to install the development dependencies.
 
-You can now also package up the extension with,
+You can also package up the extension with
 
-* `npm install -g vsce` to get the Extension Manager,
-* `vsce package` which creates an extension package at `vscode-hie-server-<version>.vsix`.
+- `npm install -g vsce` to get the Extension Manager,
+- `vsce package` which creates an extension package at `vscode-hie-server-<version>.vsix`.
 
 _Note:_ that if you get errors running `vsce package`, it might help running `tsc -p ./` directly, since that gives the actual error output of the TypeScript compilation.
 
-## Developing
+## Developing inside VS Code
 
-* Launch VS Code, press `File` > `Open Folder`, open the `vscode-hie-server` folder;
-* press `F5` to open a new window with the `vscode-hie-server` loaded (this will overwrite existing ones, e.g. from the marketplace);
-* open a Haskell file with the **new** editor to test the LSP client;
+- Launch VS Code, press `File` > `Open Folder`, open the `vscode-hie-server` folder;
+- press `F5` to open a new window with the `vscode-hie-server` loaded (this will overwrite existing ones, e.g. from the marketplace);
+- open a Haskell file with the **new** editor to test the LSP client;
 
 You are now ready to make changes and debug. You can,
 
-* set breakpoints in your code inside `src/extension.ts` to debug your extension;
-* find output from your extension in the debug console;
-* make changes to the code, and then
-* relaunch the extension from the debug toolbar
+- set breakpoints in your code inside `src/extension.ts` to debug your extension;
+- find output from your extension in the debug console;
+- make changes to the code, and then
+- relaunch the extension from the debug toolbar
 
 _Note_: you can also reload (`Ctrl+R` or `Cmd+R` on macOS) the VS Code window with your extension to load your changes
 
 #### Formatting
 
-To keep a consistent style, it's best to run [prettier](https://prettier.io) on each save. If you are using VSCode, the settings are set to auto format on save.
-
-There is usually an extension for your editor for prettier, e.g. [`esbenp.prettier-vscode`](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode), which you can install through the marketplace or via `ext install prettier-vscode`.
-
+[prettier](https://prettier.io) is automatically run o neach commit via husky. If you are developing within VS Code, the settings are set to auto format on save.
 The configurations for prettier are located in `.prettierrc`.
 
 ## Navigating the Files
 
 A brief overview of the files,
 
-* `package.json` contains the basic information about the package, see [the full manifest for more](https://code.visualstudio.com/docs/extensionAPI/extension-manifest), such as telling VS Code which scope the LSP works on (Haskell and Literate Haskell in our case), and possible configuration
-* `src/extension.ts` handles activating and deactivating the HIE language server, along with checking if HIE is installed
-* `src/docsBrowser.ts` contains the logic for displaying the documentation browser (e.g. hover over a type like `mapM_` and click `Documentation` or `Source`)
-* `src/commands/constants.ts` simply exports the rest of the commands in folder
-* `src/commands/showType.ts` handles showing a type using `ghcmod:type`
-* `src/commands/insertType.ts` handles inserting a type using the output of `ghcmod:type`
+- `package.json` contains the basic information about the package, see [the full manifest for more](https://code.visualstudio.com/docs/extensionAPI/extension-manifest), such as telling VS Code which scope the LSP works on (Haskell and Literate Haskell in our case), and possible configuration
+- `src/extension.ts` is the main entrypoint to the extension, and handles launching the language server.
+- `src/hlsBinaries.ts` handles automatically installing the pre-built `haskell-language-server` binaries
+- `src/utils.ts` has some functions for downloading files and checking if executables are on the path
+- `src/docsBrowser.ts` contains the logic for displaying the documentation browser (e.g. hover over a type like `mapM_` and click `Documentation` or `Source`)
 
 ## Helpful Reading Material
 
 We recommend checking out [Your First VS Code Extension](https://code.visualstudio.com/docs/extensions/example-hello-world) and [Creating a Language Server](https://code.visualstudio.com/docs/extensions/example-language-server) for some introduction to VS Code extensions.
-
-## Running tests
-
-There are two ways to run (the same) tests, you can either
-
-* press `F8` to run the tests using `npm test`
-
-or
-
-* open the debug viewlet (`Ctrl+Shift+D` or `Cmd+Shift+D` on Mac) and from the launch configuration dropdown pick `Launch Tests`
-* press `F5` to run the tests in a new window with your extension loaded
-* see the output of the test result in the debug console
-* make changes to `test/extension.test.ts` or create new test files inside the `test` folder
-  * by convention, the test runner will only consider files matching the name pattern `**.test.ts`
-  * you can create folders inside the `test` folder to structure your tests any way you want

README.md

@@ -5,14 +5,15 @@ This is the Visual Studio Code extension for the [Haskell programming language](
 ## Features
 
 - Warning and error diagnostics from GHC
-- Code actions and quick-fixes via [`apply-refact`](https://github.com/mpickering/apply-refact) (click the lightbulb)
 - Type information and documentation on hover
 - Jump to definition
 - Document symbols
 - Highlight references in document
 - Code completion
 - Formatting via Brittany, Floskell, Ormolu or Stylish Haskell
 - [Multi-root workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces) support
+<!-- Add this back when hlint support is merged into hls
+- Code actions and quick-fixes via `hlint` and [`apply-refact`](https://github.com/mpickering/apply-refact) (click the lightbulb) -->
 
 ## Requirements
 
@@ -22,23 +23,27 @@ This is the Visual Studio Code extension for the [Haskell programming language](
 
 ## Supported GHC versions
 
+Note that these are the versions of GHC that there are binaries of haskell-language-server for. Building from source may support more versions!
+
 | GHC    | Linux | macOS | Windows |
 | ------ | ----- | ----- | ------- |
 | 8.10.1 | ✓     | ✓     | ✓       |
-| 8.8.3  | ✓     | ✓     |
-| 8.8.2  | ✓     | ✓     |
+| 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:
+This extension is powered by the Haskell Language Server by default, but it also supports several others, 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.
+- [Haskell Language Server](https://github.com/haskell/haskell-language-server#installation): This is the default language server which will automatically be downloaded, so it does not need manual installation. 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 choose which language server to use from the "Haskell > Language Server Variant" configuration option.
+
+## Configuration options
 
 You can disable HLint and also control the maximum number of reported problems,
 
@@ -47,13 +52,6 @@ You can disable HLint and also control the maximum number of reported problems,
 "haskell.maxNumberOfProblems": 100,
 ```
 
-If the liquid haskell executable is installed, enable using it to
-process haskell files on save.
-
-```json
-"haskell.liquidOn": true,
-```
-
 ### 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.
@@ -97,39 +95,31 @@ Or alternatively add the following to your `~/.cabal/config` or `cabal.config[.l
 documentation: True
 ```
 
-### Haskell IDE Engine and Hoogle
+## Haskell IDE Engine specifics
 
-If you are using Haskell IDE Engine as the language server, it pulls in documentation via Hoogle. After installing Hoogle via `cabal install hoogle` or `stack install hoogle`, generate the database with:
+If you are using Haskell IDE Engine as your language server, there are a number of additional configuration options.
 
-```bash
-$ hoogle generate
-```
+### Liquid Haskell
 
-Haskell IDE Engine
+If Liquid Haskell is installed, haskell-ide-engine can be configured to run the `liquidhaskell` executable on save and display diagnostics:
 
-## Manual Installation
+```json
+"haskell.liquidOn": true,
+```
 
-Either install the extension via the marketplace (preferred), or if you are testing an unreleased version by,
+### Hoogle
+
+HIE pulls in documentation via Hoogle. After installing Hoogle via `cabal install hoogle` or `stack install hoogle`, generate the database with:
 
 ```bash
-$ npm install -g vsce
-$ git clone https://github.com/alanz/vscode-hie-server
-$ cd vscode-hie-server
-$ npm ci
-$ vsce package
+$ hoogle generate
 ```
 
-This will create a file something like `vscode-hie-server-<version>.vsix`
-according to the current version.
-
-In VS Code, open the extensions tab, and click on the `...` at the top right of it,
-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.
+The language server 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
 
@@ -141,6 +131,9 @@ This extension will download the language server binaries to a specific location
 | Linux | TODO |
 
 
+Note that if `haskell-language-server-wrapper` is already on the PATH, then the extension will launch it directly instead of downloading binaries.
+
+
 ## Investigating and reporting problems
 
 1.  Go to extensions and right click `Haskell` and choose `Configure Extensions Settings`
@@ -149,7 +142,7 @@ This extension will download the language server binaries to a specific location
 4.  Go to the main menu and choose `View -> Output` (`Ctrl + Shift + U`)
 5.  On the new Output panel that opens on the right side in the drop down menu choose `Haskell`
 
-Now you will see the information which you can use to diagnose or report a problem
+Please include the output when filing any issues on the relevant language server's issue tracker.
 
 ### Troubleshooting
 
@@ -160,6 +153,7 @@ 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.

package-lock.json

@@ -11,6 +11,8 @@
   "keywords": [
     "language",
     "haskell",
+    "cabal",
+    "stack",
     "lsp",
     "multi-root ready"
   ],
@@ -175,7 +177,6 @@
     "compile": "webpack --mode none",
     "watch": "webpack --mode none --watch --info-verbosity verbose",
     "postinstall": "node ./node_modules/vscode/bin/install",
-    "test": "tsc -p . && node ./node_modules/vscode/bin/test",
     "tslint": "tslint -p tsconfig.json -c tslint.json --format stylish 'src/**/*.ts'",
     "tslint-fix": "tslint --fix -p tsconfig.json  -c tslint.json --format stylish 'src/**/*.ts'",
     "precommit": "pretty-quick --staged",
@@ -186,7 +187,6 @@
     "@types/js-yaml": "^3.12.3",
     "@types/lodash-es": "^4.17.3",
     "@types/lru-cache": "^4.1.2",
-    "@types/mocha": "^2.2.46",
     "@types/node": "^14.0.3",
     "@types/request-promise-native": "^1.0.17",
     "husky": "^0.14.3",