Connect IQ LSP

Hi, I'm working with the Garmin Connect IQ SDK and looking for detailed API documentation for the language server. I’ve located LanguageServer.jar in the SDK and would like to know if there’s an API available for this LSP. I’m planning to use it with Vim instead of Visual Studio Code. Any pointers or resources would be appreciated!

Top Replies

Vangelis 16 days ago +3

Managed to get the LSP to work with neovim and lspconfig. Have a look here for the configuration: https://pastebin.com/zQZJhkwk

Auto-completion, errors, warnings, and variable renaming that I tried all…
FlowState 16 days ago in reply to Vangelis +1

Vangelis said:
The caveat is that you have to compile your project manually first, and then start nvim.

I know it's not exactly the same thing, but even in VS Code you have to manually build your project…
Vangelis 15 days ago +1

Made a few more improvements, and the go-to-definition functionality also works.

Uploaded the lspconfig in https://github.com/cyberang3l/garmin-monkey-c-neovim-language-server so that I don't have to keep…

All Replies

FlowState 14 days ago in reply to Vangelis

Vangelis said:
> non-standard path used for the ConnectIQ/ folder ... ~/Library/Application Support/Garmin/ConnectIQ/

You are probably on Mac as I understand from the "~/Library/Application Support..." path. I'm on Linux on an Ubuntu-based distribution. I can try to update the lua code to identify the OS, and use a different default for Mac or Linux (https://www.reddit.com/r/neovim/comments/pc7in0/detect_os_in_lua/)

Oh sorry, I made a foolish assumption (that you were also on mac) haha. You are absolutely correct.

I guess I am used to Linux being a distant 3rd in the OS of choice for CIQ development (especially since the support from Garmin isn't great.)

In general it would probably be even easier to simply try each of the three default paths for Linux, MacOS and Windows. (Not suggesting you are obligated to do this ofc).

Vangelis said:
(that's what I was hopping the `or vim.fn.getcwd()` would do).

Unfortunately it doesn't work as written :/. root(vim.fn.getcwd()) ends up being nil, which causes an error when it's concatenated with "monkey.jungle".

local root = lspconfig.util.root_pattern("manifest.xml") or vim.fn.getcwd()

I think it's because "lspconfig.util.root_pattern("manifest.xml")" is a function [*], which is non-nil, so "or vim.fn.getcwd()" is never evaluated.

[*] after all, this is why "root(vim.fn.getcwd())" is used everywhere that a path string is needed (not including the root_dir option, which is a function)

Also note that root_pattern explicitly returns a function which takes startpath as its argument: github.com/.../util.lua

I think the fix is:

local root = lspconfig.util.root_pattern("manifest.xml") -- dynamic root folder as function (if there's no monkey c project, returns nil)
local root_path = root(vim.fn.getcwd()) or vim.fn.getcwd() -- static root folder as string (if there's no monkey c project, returns cwd)

2) Leave the following line alone - you don't want the language server to start unless it's a valid Monkey C project folder (and root_dir is supposed to be a function):

root_dir = root,

3) Change all existing instances of root(vim.fn.getcwd()) to root_path

Thanks again for working on this!

FlowState 14 days ago in reply to FlowState

FlowState said:
you don't want the language server to start unless it's a valid Monkey C project folder

[**] for this reason, I think it's ok for root_pattern to only consider monkey c specific files like manifest.xml or monkey.jungle, as opposed to generic files/folders like".git". it's even arguable that monkey.jungle would be a better choice *instead of* manifest.xml, as it's more likely to be unused by any other project type other than CIQ.