duncanmak / ionide-vscode-fsharp

VS Code plugin for F# development

Ionide-VSCode: FSharp

Enhanced F# Language Features for Visual Studio Code

Part of the Ionide plugin suite.

Getting Started

F# 4.0 needs to be installed on your system in order to use Ionide

For more detailed instructions on installing F# :

• Installing F# on Linux
• Installing F# on OSX
• Installing F# on Windows

FSC (F# Compiler) and FSI/fsharpi on Mono (F# Interactive) need to be added to your system PATH. The default location on Windows is

  64-bit - C:\Program Files (x86)\Microsoft SDKs\F#\4.0\Framework\v4.0\
  32-bit - C:\Program Files\Microsoft SDKs\F#\4.0\Framework\v4.0

Add MSBUILD_PATH environment variable which points to the home of Microsoft Build Tools, e.g., MSBUILD_PATH = D:\Program Files (x86)\MSBuild\14.0\Bin.

Quick Install Guide

Windows

You can download F# 4.0 here for Windows

Install the Microsoft Build Tools 2015

If you use chocolatey, you can install all the pre-requisites easily:

choco install windows-sdk-8.0 -y
choco install visualfsharptools -y
choco install microsoft-build-tools --version 14.0.25420.1 -y
choco install visualstudiocode -y

Mono

• Required: Mono >= 3.10
• Recommended: Mono >= 4.0.2

Features

• Better syntax highlighting
• Auto completions
• Error highlighting and error list
• Tooltips
• Go to Declaration
• Show symbols in file
• Highlighting usages

How to contribute

0. Install nodejs. (On Windows via chocolaty this is C:\> choco install nodejs)
1. Run npm install -g vsce to install vsce globally.
2. Fork the repo to your GitHub account, then clone locally.
3. Run build.cmd Build (or build.sh Build). If you have not done so already you may need to configure a GitHub SSH key.
4. Open folder in VSCode code .
5. Make changes
6. Press F5 to build plugin and start experimental instance of VSCode
7. Make PR ;)

How to get logs for debugging / issue reporting

1. Enable Logging in User settings with

// FSharp configuration
  // Set the verbosity for F# Language Service Output Channel
  "FSharp.logLanguageServiceRequestsOutputWindowLevel": "DEBUG",

  // Enable logging language service requests (FSAC)  to an output channel, the developer tools console, or both
  "FSharp.logLanguageServiceRequests": "both"

2. Open the Output Panel and switch to the F# Language Service Channel
3. Or Toggle Developer Tools (Help |> Toggle Developer Tools) and open the console tab

Contributing and copyright

The project is hosted on GitHub where you can report issues, fork the project and submit pull requests.

The library is available under MIT license, which allows modification and redistribution for both commercial and non-commercial purposes.