https://github.com/influxdata/flux-lsp
Implementation of Language Server Protocol for the flux language
https://github.com/influxdata/flux-lsp
Last synced: about 2 months ago
JSON representation
Implementation of Language Server Protocol for the flux language
- Host: GitHub
- URL: https://github.com/influxdata/flux-lsp
- Owner: influxdata
- License: mit
- Created: 2019-10-14T21:54:21.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-19T07:45:01.000Z (7 months ago)
- Last Synced: 2025-04-09T16:04:54.447Z (about 2 months ago)
- Language: Rust
- Homepage:
- Size: 1.55 MB
- Stars: 29
- Watchers: 37
- Forks: 5
- Open Issues: 22
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Flux LSP
[](https://github.com/influxdata/flux-lsp/blob/master/LICENSE)
[](https://www.influxdata.com/slack)
An implementation of the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) for the [Flux language](https://github.com/influxdata/flux).
# LSP Development
* LSP development requires rust version of 1.40.0 or newer.
* run tests with `cargo test`
# Installing command line server
```
cargo install --locked --git https://github.com/influxdata/flux-lsp
```
NOTE: previously, `flux-lsp` was installed via `npm`. If you have installed `flux-lsp`
with this method, please remove that version before installing this one.
This will allow you to run an LSP instance with the command `flux-lsp`. Like other
command-line lsp servers, communication with the lsp server is via stdin/stdout. To use
this utility in your editor of choice, you'll need to use a plugin that supports
command-line lsp servers.
If you find a plugin for your editor that doesn't work with `flux-lsp`, please file a bug.
# Vim setup
There are a lot of plugins that are capable of running language servers. This section will cover the one we use or know about.
In any case, you need to recognize the `filetype`. This is done looking at the file extension, in our case `.flux`. You should place this in your `vimrc` file:
```vimrc
" Flux file type
au BufRead,BufNewFile *.flux set filetype=flux
```
### with neovim-lspconfig
Requires [neovim-lspconfig](https://github.com/neovim/nvim-lspconfig)
in your init.vim
```vimrc
require'lspconfig'.flux_lsp.setup{}
```
See [here](https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#flux_lsp) for more details.
### with vim-lsp
Requires [vim-lsp](https://github.com/prabirshrestha/vim-lsp)
in your .vimrc
```vimrc
let g:lsp_diagnostics_enabled = 1
if executable('flux-lsp')
au User lsp_setup call lsp#register_server({
\ 'name': 'flux lsp',
\ 'cmd': {server_info->[&shell, &shellcmdflag, 'flux-lsp']},
\ 'whitelist': ['flux'],
\ })
endif
autocmd FileType flux nmap gd (lsp-definition)
```
### with vim-coc
Requires [vim-coc](https://github.com/neoclide/coc.nvim). `vim-coc` uses a `coc-settings.json` file and it is located in your `~/.vim` directory. In order to run the `flux-lsp` you need to add the `flux` section in the `languageserver`.
```json
{
"languageserver": {
"flux": {
"command": "flux-lsp",
"filetypes": ["flux"]
}
}
}
```
If you need to debug what flux-lsp is doing, you can configure it to log to `/tmp/fluxlsp`:
```json
{
"languageserver": {
"flux": {
"command": "flux-lsp",
"args": ["-l", "/tmp/fluxlsp"],
"filetypes": ["flux"]
}
}
}
```
### with webpack
This package is distributed as a wasm file, and since wasm files cannot be included in the main bundle, you need to import the library a little differently:
```javascript
import('@influxdata/flux-lsp-browser')
.then(({Server}) => {
let server = new Server(false);
// The LSP server is now ready to use
});
```
Also ensure that the wasm file is not being parsed by any file loader plugins, as this will interfere with it's proper instantiation.
# Supported LSP features
- completionItem/resolve
- initialize
- shutdown
- textDocument/completion
- textDocument/definition
- textDocument/didChange
- textDocument/didOpen
- textDocument/didSave
- textDocument/documentHighlight
- textDocument/documentSymbol
- textDocument/foldingRange
- textDocument/hover
- textDocument/references
- textDocument/rename