This directory contains the implementation of the LSP server for SixtyFPS featuring diagnostics, code completion, goto definition, and more importantly, live-preview
- Build or install the lsp binary:
cargo install sixtyfps-lsp
for the released version. Or, to install the develoment version:
cargo install sixtyfps-lsp --git https://github.com/sixtyfpsui/sixtyfps --force
- Configure your editor to use the
$HOME/.cargo/bin/sixtyfps-lsp
binary (path may vary depending on the platform), no arguments required
Bellow is a list of editors which have been tested
For VSCode, we have an extension in this repository, you can install it directly from the market place.
Kate relies on the presence of syntax highlighting file for the usage of the LSP so we'll setup that first. The file sixtyfps.ksyntaxhighlighter.xml needs to be copied in a location where kate can find it. See the kate documentation
On Linux, this can be done by running this command
mkdir -p ~/.local/share/org.kde.syntax-highlighting/syntax/
wget https://raw.githubusercontent.com/sixtyfpsui/sixtyfps/master/tools/lsp/sixtyfps.ksyntaxhighlighter.xml -O ~/.local/share/org.kde.syntax-highlighting/syntax/sixtyfps.xml
On Windows, download sixtyfps.ksyntaxhighlighter.xml in %USERPROFILE%\AppData\Local\org.kde.syntax-highlighting\syntax
To setup the LSP, install the sixtyfps-lsp binary as explained in the generic usage section
cargo install sixtyfps-lsp
Then go to Settings > Configure Kate. In the Plugins section, enable the LSP-Client plugin. This will add a LSP Client section in the settings dialog. In that LSP Client section, go to the User Server Settings, and enter the following in the text area: (Replace YOUR_USER by your username)
{
"servers": {
"SixtyFPS": {
"command": ["/home/YOUR_USER/.cargo/bin/sixtyfps-lsp"],
"highlightingModeRegex": "SixtyFPS" }
}
}
To setup the lsp:
- Install the
sixtyfps-lsp
binary withcargo install
as explained in the generic usage section above. - Then in Qt creator, go to Tools > Option and select the Language Client section.
- Click Add
- As a name, use "SixtyFPS"
- use
*.60
as a file pattern. (don't use MIME types) - As executable, select the
~/.cargo/bin/sixtyfps-lsp
binary (no arguments required) - Click Apply or Ok
In order to preview a component, when you have a .60 file open, place your cursor to the name of the component you would like to preview and press Alt + Enter to open the code action menu. Select Show Preview from that menu.
For the syntax highlighting, QtCreator supports the same format as Kate, with the xml file at the same location. Refer to the instruction from the previous section to enable syntax highlighting.
Vim and neovim support the Language Server Protocol via different plugins. We recommend the
Conquer of Completion plugin. Together with the
SixtyFPS LSP server, this enables inline diagnostics and code completion when editing .60
files.
After installing the extension, for example via vim-plug, two additional configuration changes are needed to integrate the LSP server with vim:
- Make vim recognize the
.60
files with the correct file type
In your vim configuration file (for example ~/.vimrc
) add the following to enable the
automatic recognition when opening .60
files:
autocmd BufEnter *.60 :setlocal filetype=sixtyfps
- Configure Conquer of Completion to use the SixtyFPS LSP server
Start vim
and run the :CocConfig
command to bring up the buffer that allows editing
the JSON configuration file (coc-settings.json
), and make sure the following mapping
exists under the language
server section:
{
"languageserver": {
"sixtyfps": {
"command": "sixtyfps-lsp",
"filetypes": ["sixtyfps"]
}
}
}
To setup the lsp:
- Install the sixtyfps-lsp binary with
cargo install
as explained in the Generic Usage section above. - Using Package Control in Sublime Text, install the LSP package (sublimelsp/LSP)
- Download the SixtyFPS syntax highlighting files into your User Package folder,
e.g. on macOS
~/Library/Application Support/Sublime Text/Packages/User/
: https://raw.githubusercontent.com/sixtyfpsui/sixtyfps/master/tools/lsp/sublime/SixtyFPS.sublime-syntax https://raw.githubusercontent.com/sixtyfpsui/sixtyfps/master/tools/lsp/sublime/SixtyFPS.tmPreferences - Download the LSP package settings file into your User Package folder: https://raw.githubusercontent.com/sixtyfpsui/sixtyfps/master/tools/lsp/sublime/LSP.sublime-settings
- Modify the sixtyfps command path in
LSP.sublime-settings
to point to the cargo instalation path in your home folder (Replace YOUR_USER by your username):"command": ["/home/YOUR_USER/.cargo/bin/sixtyfps-lsp"]
- Run "LSP: Enable Language Server Globally" or "LSP: Enable Lanuage Server in Project" from Sublime's Command Palette to allow the server to start.
- Open a .60 file - if the server starts its name will be in the left side of the status bar.
In order to preview a component, when you have a .60 file open, place your cursor to the name of the component you would like to preview and select the "Show preview" button that will appear on the right of the editor pane.