Giter VIP home page Giter VIP logo

fsharp-language-server's Introduction

F# Language Server

This project is an implementation of the language server protocol using the F# Compiler Service.

https://ci.appveyor.com/api/projects/status/github/fsprojects/fsharp-language-server?svg=true

Features

Hover

Hover

Autocomplete

Autocomplete

Method signature help

Signature help

Find symbols in document

Document symbols

Find symbols in workspace

Workspace symbols

Go-to-definition

Go to definition

Find references

Find references

Rename symbol

Rename symbol

Show errors on save

Show errors

Run & Debug tests

Debug test

Code structure

The language server protocol (LSP) is very similar to the API defined by the F# compiler service (FCS); most of the implementation is devoted to translating between the types used by FCS and the JSON representation of LSP.

  • client/extension.ts: Client-side VSCode launcher
  • sample: Example projects used by tests
  • scripts: Scripts for building and testing
  • src/LSP: Server-side implementation of language server protocol
  • src/ProjectCracker: Figures out F# compiler options using Buildalyzer and the MSBuild API.
  • src/FSharpLanguageServer: F# language server
  • tests/LSP.Tests
  • tests/ProjectCracker.Tests
  • tests/FSharpLanguageServer.Tests
  • videos: Animated GIFs on this page

Installation

VSCode

Install from the VSCode extension marketplace

Vim

Clone this repo to your system and build it:

npm install
dotnet build -c Release

If using a distribution based on Arch Linux, you can also install it from the AUR

Install LanguageClient-neovim

Update your vim config to point LanguageClient-neovim to the FSharp Language Server for fsharp filetypes:

let g:LanguageClient_serverCommands = {
    \ 'fsharp': ['dotnet', '/Users/name/code/fsharp-language-server/src/FSharpLanguageServer/bin/Release/netcoreapp3.0/target/FSharpLanguageServer.dll']
    \ }

Open an fsharp file, move the cursor, and call functions. Mappings are up to you:

  • Hover call LanguageClient#textDocument_hover()
  • Rename: call LanguageClient#textDocument_rename()
  • Definition: call LanguageClient#textDocument_definition()
  • etc...

Neovim with Deoplete completion:
VimDeoplete

(alternatively there is another vim language server plugin vim-lsp but this one hasn't been tried.

Emacs

Spacemacs

Clone this repo to your system and build it:

npm install

# Pick the appropriate target based upon your OS 
dotnet publish -c Release -r linux-x64 src/FSharpLanguageServer
dotnet publish -c Release -r osx.10.11-x64 src/FSharpLanguageServer
dotnet publish -c Release -r win10-x64 src/FSharpLanguageServer

Make sure that the FSharpLanguageServer (in src/FSharpLanguageServer/bin/Release/netcoreapp3.0/PLATFORM/publish) is in your PATH. Alternatively, you can set the path to the server executable manually within your .spacemacs user-config:

(setq fsharp2-lsp-executable "/path/to/FSharpLanguageServer")

Since the stock fsharp layer does not currently include LSP support, you will need to use the fsharp2 layer (a fork of fsharp) which does. To use fsharp2, copy the custom layer into your Spacemacs private layers directory. In order for this layer to work, you must be on the Spacemacs develop branch, since the LSP layer is not yet available in Spacemacs master.

cp -r spacemacs/fsharp2 ~/.emacs.d/private

Finally, make sure that you have these layers enabled in your dotspacemacs-configuration-layers. You will need to remove the fsharp layer if you have it, since fsharp2 conflicts with it.

  • lsp
  • fsharp2
  • syntax-checking
  • auto-completion

EmacsLspMode

How is this project different than Ionide?

Ionide is a suite of F# plugins for VSCode; F# language server is analagous to the FSAC component. While FSAC is based on a custom JSON protocol; F#LS is based on the language server protocol standard.

The implementation is a thin wrapper around F# Compiler Service and is heavily focused on performance. For example, autocompleting in medium-sized file in F# Language Server (left) and Ionide (right):

Autocomplete warm

fsharp-language-server's People

Contributors

adam-becker avatar adamnew123456 avatar georgewfraser avatar herr-felix avatar hoetz avatar inosik avatar joerobich avatar johngalambos avatar mdarocha avatar mistiara avatar mrbech avatar tboby avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.