Skip to content
This repository was archived by the owner on Aug 5, 2019. It is now read-only.

Commit 2c7462a

Browse files
authored
Moved
1 parent e16b43b commit 2c7462a

File tree

1 file changed

+1
-120
lines changed

1 file changed

+1
-120
lines changed

README.mkd

+1-120
Original file line numberDiff line numberDiff line change
@@ -1,120 +1 @@
1-
## F# support for Vim through LSP (vim-fsharp-languageclient)
2-
3-
This is a modified version of [fsharp/vim-fsharp](https://github.com/fsharp/vim-fsharp) which uses LSP-mode of [FsAutoComplete](https://github.com/fsharp/FsAutoComplete) as a backend, and is powered by [autozimu/LanguageClient-neovim](https://github.com/autozimu/LanguageClient-neovim).
4-
5-
The original description is as follows:
6-
7-
> Syntax and indent files have been copied from [fsharp-vim](http://github.com/kongo2002/fsharp-vim) with kind permissions from [kongo2002](https://github.com/kongo2002).
8-
>
9-
> > Requires vim 7.3 or higher compiled with python 2 or 3 support.
10-
>
11-
> This was adapted from http://github.com/timrobinson/fsharp-vim. The current aim is to provide a good experience for fsx scripting. On opening an fs or fsi file any project file found in the same directory will be parsed. Multiple projects are supported.
12-
13-
Note that this plugin does not require python support. Also, [LanguageClient-neovim](https://github.com/autozimu/LanguageClient-neovim) requires neovim or vim 8.0+.
14-
15-
### Installing
16-
17-
vim-fsharp-languageclient requires .NET Core Runtime installed. Also it depends on [LanguageClient-neovim](https://github.com/autozimu/LanguageClient-neovim), so make sure it's installed beforehand.
18-
19-
I have only tested vim-plug and _install.sh_(_install.cmd_ should also work).
20-
21-
#### OSX and linux
22-
23-
##### Installing with pathogen
24-
25-
1. Clone vim-fsharp-languageclient into your bundle directory.
26-
27-
2. Run *make* inside the vim directory. This downloads the auto completion server.
28-
29-
##### Installing with [vim-plug][vim-plug]
30-
31-
~~~.vim
32-
Plug 'cannorin/vim-fsharp-languageclient', {
33-
\ 'for': 'fsharp',
34-
\ 'do': 'make fsautocomplete',
35-
\}
36-
~~~
37-
38-
##### Installing with [NeoBundle][NeoBundle]
39-
40-
By VimL way:
41-
~~~.vim
42-
NeoBundle 'cannorin/vim-fsharp-languageclient', {
43-
\ 'description': 'F# support for Vim',
44-
\ 'lazy': 1,
45-
\ 'autoload': {'filetypes': 'fsharp'},
46-
\ 'build': {
47-
\ 'unix': 'make fsautocomplete',
48-
\ },
49-
\ 'build_commands': ['curl', 'make', 'mozroots', 'touch', 'unzip'],
50-
\}
51-
~~~
52-
53-
By using TOML configuration:
54-
~~~.toml
55-
[[plugins]]
56-
description = 'F# support for Vim'
57-
repository = 'cannorin/vim-fsharp-languageclient'
58-
lazy = 1
59-
filetypes = 'fsharp'
60-
build_commands = ['curl', 'make', 'mozroots', 'touch', 'unzip']
61-
[plugins.build]
62-
unix = 'make fsautocomplete'
63-
~~~
64-
65-
#### Windows
66-
67-
1. Run _install.cmd_
68-
69-
### Setting up the language client
70-
71-
Once you installed, add the following to somewhere in your `.vimrc`:
72-
73-
```vim
74-
let g:LanguageClient_serverCommands = {
75-
\ 'fsharp': g:fsharp#languageserver_command
76-
\ }
77-
```
78-
79-
This will configure FSAC to be used from LanguageClient-neovim.
80-
81-
### Usage
82-
83-
Opening either `*.fs`, `*.fsi` or `*.fsx` files should trigger syntax highlighting and other depending runtime files as well.
84-
85-
### Commands
86-
87-
Refer to [LanguageClient-neovim](https://github.com/autozimu/LanguageClient-neovim) for features provided via Language Server Protocol.
88-
89-
To be added as requested for F#-specific features.
90-
91-
##### General
92-
* `:FSharpLoadWorkspaceAuto` Guess a workspace (`sln` or `fsproj`) and then load it. Equivalent to `FSharp.workspaceMode = sln` in Ionide. Automatically called when you open F# files.
93-
* `:FSharpParseProject <files>+` Load specified projects (`fsproj` or `sln`).
94-
* `:FSharpReloadWorkspace` Reload all the projects currently loaded. Automatically called when you edit and save `.fsproj` files.
95-
96-
### Settings
97-
98-
Refer to [LanguageClient-neovim](https://github.com/autozimu/LanguageClient-neovim) for features provided via Language Server Protocol.
99-
100-
101-
To be added as requested for F#-specific features.
102-
103-
Show the type signature at the cursor position (default: 1).
104-
105-
~~~.vim
106-
let g:fsharp#show_signature_on_cursor_move = 1 " 0 to disable.
107-
~~~
108-
109-
Enable/disable automatic calling of `:FSharpLoadWorkspaceAuto`. (default: 1)
110-
111-
~~~.vim
112-
let g:fsharp#automatic_workspace_init = 1 " 0 to disable.
113-
~~~
114-
115-
Enable/disable automatic calling of `:FSharpReloadWorkspace`. (default: 1)
116-
117-
~~~.vim
118-
let g:fsharp#automatic_reload_workspace = 1 " 0 to disable.
119-
~~~
120-
1+
[MOVED](https://github.com/ionide/Ionide-vim)

0 commit comments

Comments
 (0)