How can I start to contribute?

[sandangel]

I can see lots of TODO in the code, but I don't know which one I should pick up first. Do you have any issue that you can assign to me to get more familiar with the code base?

[noib3]

Hi, thanks for reaching out. I guess this: https://github.com/noib3/nvim-compleet/blob/08cd0763f7ba2f62835565c045933b5f66780061/src/ui/details/positioning.rs#L78

would be a good place to start. It's a bug with the positioning of the details window (i.e. the window next to the completion menu that shows details about a completion) that causes nvim-compleet to panic.

Demo:

to reproduce:

• compile from commit 08cd076;
• set the columns to 173 (altough it's probably possible to reproduce this with a different terminal width);
• open a new vertical split to the right and go to that window;
• type s;
• select the first completion;
• type i.

The reason is that api.win_get_position(menu_winid) (which is just a Rust binding to vim.api.nvim_win_get_position) returns a number of columns bigger than the total terminal width, causing the following unchecked subtractions to overflow.

I believe it's a bug with Neovim itself rather than nvim-compleet, but I haven't looked too much into it.

P.S.: this is just a suggestion, if you'd like to work on something else feel free to do so. Also, if you'd like to contact me send me a DM on Telegram (https://t.me/noib3) or on matrix (@noib3:matrix.org).

[sandangel]

thank you. I will put some time to investigate that one this weekend.

[sandangel]

hmm, I can not reproduce that. set columns=173 and open new vsplit, but don't know why my menu is different with you when I hit <c-n> to go to the next item. I also tried disabling all plugins but still the same. cc @noib3

  use {
    '~/Work/nvim-compleet',
    config = function()
      require('compleet').setup {
        sources = {
          lipsum = {
            enable = true,
          },
        },
      }
    end,
  }

Screen.Recording.2022-04-02.at.20.48.07.mov

[bryant-the-coder]

hmm, I can not reproduce that. set columns=173 and open new vsplit, but don't know why my menu is different with you when I hit <c-n> to go to the next item. I also tried disabling all plugins but still the same. cc @noib3

  use {
    '~/Work/nvim-compleet',
    config = function()
      require('compleet').setup {
        sources = {
          lipsum = {
            enable = true,
          },
        },
      }
    end,
  }

Screen.Recording.2022-04-02.at.20.48.07.mov

what is your dots?

[noib3]

I think you haven't set the mappings to select the first completion. If that still doesn't work, try to replicate it by creating a minimal init.lua and calling neovim with nvim --clean -u ./init.lua.

[nxmxsxs]

Hi, I noticed you've been working on the back2rpc branch recently. Is that going to be the final architecture? Are you going to merge that eventually into master?

[noib3]

The short answer is yes, but please open a new discussion and we can talk about it.

[nxmxsxs]

I don't have much experience with rust but I would like to, as a way to learn more about neovim plugins ecosystem/git, contribute in any way possible but I'm exactly sure what I would work on. Could you point me in the right direction?

[noib3]

Well this issue would be a good place to start. Also, if you'd like to learn more about both Rust and neovim then look at the compleet-client crate of the back2rpc branch. The server is what I'm currently working on but that's got nothing to do with neovim per se.

[sandangel]

hi @noib3 , I still can not reproduce. the only issue is the menu window disappeared, and the preview window keep showing.

Screen.Recording.2022-04-03.at.19.56.16.mov

Screen.Recording.2022-04-03.at.19.53.33.mov

[nxmxsxs]

That's strange. I'm able to reproduce it on my machine

[nxmxsxs]

Hello, I noticed you don't 'vim.schedule' the win_set_config function. I was messing around in lua with floating windows and cursormoved autocommands and I noticed the floating windows don't follow the cursor as you would expect.

2022-04-05.22-20-06.mov

[nxmxsxs]

nvm, you don't need to vim.schedule CursorMovedI autocmds.

2022-04-06.11-02-25.mov

[noib3]

Hello, I noticed you don't 'vim.schedule' the win_set_config function. I was messing around in lua with floating windows and cursormoved autocommands and I noticed the floating windows don't follow the cursor as you would expect.

2022-04-05.22-20-06.mov

Mh, I wonder if this might be related.

[nxmxsxs]

possibly. I assumed it was just neovim's single thread scheduling shenanigans.

[nxmxsxs]

Hi, looking through the codebase, I can understand marginally how the client comunicates with the server via rpc but I can't figure out how the server would produce lsp completions (in particular) for the client.

[noib3]

Yep, shouldn't bee to hard using serde.

[sandangel]

I'm trying to compile the project with latest master, but cargo build failed with error:

= note: Undefined symbols for architecture x86_64:

I'm using rust nightly 1.62 on mac os 2019

[noib3]

@sandangel Mh, does it compile if you move /compleet-client/.cargo to /.cargo?

[nxmxsxs]

Yep, shouldn't bee to hard using serde.

Maybe, we could use jsonrpsee?

[sandangel]

@sandangel Mh, does it compile if you move /compleet-client/.cargo to /.cargo?

yeah it does compile now.

[nxmxsxs]

Hi, would you happen to know of a way to check if a win is split (vertical or horizontal).
I've tried with win_height <= lines/2 or win_width <= columns/2 but this doesn't cover all edge cases.

[noib3]

Look into vim.fn.winlayout. I'm using it in nvim-cokeline here to check for vertical splits.

[nxmxsxs]

thanks. I'll look into it.

[nxmxsxs]

Hello, I'm working on a branch which changes the available screen space calculation but upon testing, compleet panics when I enable a source. Is it possible that this behaviour is from your part?

[noib3]

It could be. When does it panic and what's the error message?

[nxmxsxs]

the error message is attempt to index local 'error_msg' (a userdata value) and it happens when I enable any source.

[noib3]

But is it a Lua error or a Rust panic? If it's a panic, what's the line that caused it? Also, make sure to update your branch by pulling in master. A lot changed in the past week.

[nxmxsxs]

The issue only happens when I call setup and enable one of the sources so I assume it's a rust panic.
I've also tried cloning your master but same result.

2022-04-15.15-37-21.mp4

[nxmxsxs]

Yeah, that disables the plugin as expected and eliminates the error message as well

[nxmxsxs]

It seems the error message originates from command::setup

[noib3]

Ah, then I'm pretty sure one of the functions exposed by Neovim to set user commands changed its api. When did you start experiencing this? Does it still happen if you use a Neovim version compiled from one of last week's commits?

[nxmxsxs]

oh right, I forgor they changed nvim_add_user_command to nvim_create_user_command. Yeah that fixes it

[noib3]

Cool, if you send a PR I'll merge it right away. You need to update these lines

https://github.com/noib3/nvim-compleet/blob/063ca8932a834bc8cdbbf0db6a7b0e027f4aaa26/compleet-client/src/commands/setup.rs#L39-L40

https://github.com/noib3/nvim-compleet/blob/063ca8932a834bc8cdbbf0db6a7b0e027f4aaa26/compleet-client/src/bindings/api/global.rs#L8-L17

[nxmxsxs]

Had this already been fixed in master?

2022-04-15.22-32-54.mp4

[noib3]

nope

[nxmxsxs]

Hello, What would you think about all the crates into a single compleet lib crate?

[nxmxsxs]

Hmm, I didn't know about the build time improvement. How do you plan on letting users add new sources via rust? I was thinking maybe users would be able to add compleet to the dependencies list with only sources feature or something similar.

[noib3]

All the sources are in the compleet-sources crate. If contributors want to add new Rust sources they'll send a PR.

[sandangel]

I dont think it is a scalable approach. you will introduce a bottle neck and create a burden for yourself reviewing all the code. The best way is you publish the interface and all devs can create their own source by using that interface.

[noib3]

@sandangel what I've described is the process for sources everyone would want to use, things like lsp, filepaths, snippets, etc. Those are part of the core plugin. Scalability shouldn't be a problem, there's a limited amount of such "global" sources. If users want to add a custom source that's only useful to them they can just add it to their copy of the source w/o sending a PR.

[sandangel]

oh, that makes sense now. 😊

[sandangel]

@noib3 as I check the source code, it seems like we need to bind any neovim API we need to call in the rust code by adding an enum value in BridgeRequest, and a new method in impl Neovim. Is there a more generic way to do that? Like how we call vim.cmd in lua code, the vim.cmd can run any arbitrary vim command. I think the current approach will need us to bind every lua function/method we need to use, which is a lot of work and hard to maintain 😣

[sandangel]

I found https://github.com/little-dude/rmp-rpc , a message pack rpc implementation in rust. Message Pack RPC is used by neovim for programmatically control neovim and listen to its events. I think we can use that instead

[noib3]

it seems like we need to bind any neovim API we need to call in the rust code by adding an enum value in BridgeRequest, and a new method in impl Neovim. Is there a more generic way to do that?

That's correct. I don't see how to avoid this, every request has different parameters, different return types and different ways to handle it (e.g. LpsBufGetClients and LspClientRequest are handled way differently than ApiBufGetName and ApiGetCurrentBuf.

I found https://github.com/little-dude/rmp-rpc , a message pack rpc implementation in rust. Message Pack RPC is used by neovim for programmatically control neovim and listen to its events. I think we can use that instead

That would require nvim-compleet to be spawned as an external process and communicate with the client via rpc. I tried that approach already but ultimately decided against it: implementing an rpc server and serializing/deserializing messages introduces way more complexity that adding a few enum variants to BridgeRequest as they become necessary.

[marvindore]

Hello thank you for creating nvim_completion it seems very interesting. I am currently teaching myself Rust so I am lacking in Rust specific knowledge.
Are there instructions on how to get this plugin to work?

I forked the repo and loaded it using Packer.nvim but after running my configuration file it says cannot find module nvim_completion. Any setup steps to get this running is appreciated. Below is my config.

use { '~/home/nvim-completion', branch = 'master' }

require('nvim_completion').setup {
sources = {
lipsum = { enable = function(_buf) return true end },
lsp = { enable = true },
},
}