vscode-ghc-mod

Linux, OS X:

ghc-mod language extension for VS Code.

Overview

The extension follows the client/server model for language extensions from the VS Code docs. The client is a normal VS Code extension and the server is a node program which runs in a seperate process. The two communicate through a connection object.

To properly run and debug the extension, the client and server directories should be opened in seperate instances of VS Code.

Prerequisites

The extension assumes ghc-mod is installed and on the system PATH OR is configured via haskell.ghc-mod.executablePath in user or workspace settings. I installed ghc-mod on windows via cabal using these instructions and it is working. New symbol support also assumes fast-tags or hasktags are installed in a similar manner to ghc-mod.

Running the extension

To get the application running, clone the whole repository and run npm install and npm run compile in both the client and server directories. Then open the client folder in an instance of VS Code and press F5 to start debugging. This will launch the extension in a new instance of VS Code called the extension host.

Debugging the extension

After running the extension as explained above, press F5 in a seperate instance of VS Code that has the server directory open. This will attach the debugger to the extension host.

Modifying the extension

Run npm run compile from the client and server directories depending on which files changed, or use the build tasks (from command palette or ctrl+shift+b) to start the build tasks in "watch" mode which will build changes as files change.

Testing the extension

Mocha test runner via npm

npm test from the server directory will run tests against the most recently compiled version of the code. The test command does NOT currently build the application. npm run tslint from the server and client directories will run tslint. tslint must pass for the build to pass.

Wallabyjs

This project includes a wallaby.js configuration file which should automatically work if the wallabyjs extension is installed. Simply open the server folder in VS Code and issue the start command to wallabyjs (ctrl+shift+R, R).

Server Components

There are three main components with distinct responsibilities. server.ts is responsible for all communication with VS Code and decides when to issue ghc-mod commands (i.e. check when documents change, info on hover, etc.). ghcMod.ts is a wrapper around the ghc-mod process running in interactive mode and handles reading and writing to the process vs stdin/stdout to issue commands and process output. It implements the IGhcMod interface. This allows it to be swapped out with a non-interactive implementation of IGhcMod. ghcModProvider.ts is the middleman and implements the IGhcModProvider interface which exposes the supported ghc-mod commands to server.ts via public methods such as getType and doCheck and issues properly formed commands to an object that implements IGhcMod.ts. It returns the results via promises.

Features

• ghc-mod check
• ghc-mod info
• ghc-mod type
• Go to definition
• Insert type
• Go to symbol
• Show all symbols

Publishing

From the client directory: vsce publish --baseImagesUrl https://raw.githubusercontent.com/hoovercj/vscode-ghc-mod/master/client/

Next steps

• Add new commands
• Add completion backend