Refactor(keymaps): export keymaps

[aarondill]

This PR implements accept_suggestion, dismiss_suggestion, and has_suggestion to be used from user mappings.

It also permits setting accept_keymap and dismiss_keymap to false to avoid setting it (nil defaults to the default settings)

fixes #149

I've included an example use case under a new header in the README.

copied from the readme:

--- Example integration with Tabnine and LuaSnip; falling back to inserting tab if neither has a completion
vim.keymap.set("i", "<tab>", function()
  if require("tabnine.keymaps").has_suggestion() then
    return require("tabnine.keymaps").accept_suggestion()
  elseif require("luasnip").jumpable(1) then
    return require("luasnip").jump(1)
  else
    return "<tab>"
  end
end, { expr = true })

[amirbilu]

Hi @aarondill
Sorry about the delay. Super busy week. Will try to get it by next week.

Did you get the swag already 😎?

[aarondill]

Hi @aarondill Sorry about the delay. Super busy week. Will try to get it by next week.

No problem, take your time.

Did you get the swag already sunglasses?

I did! I sent a few images to your email address already, did you not receive them?

[amirbilu]

I haven't! to amirbilu@tabnine or to support@tabnine? If you have a twitter handle - let us know so we can share your images & story at https://twitter.com/tabnine

[aarondill]

@amirbilu any word on this PR? I'm still thinking perhaps exporting these under tabnine rather than tabnine.keymaps, but i'd like your input on that, as well as their final names.

[aarondill]

@amirbilu what are your thoughts on this patch? I can say I've been happily using this in my own config for a month with no issues (see here), and would love to get it merged into the main repo. I'd still like your input on the module name, whether tabnine.keymaps.accept_completion() or else tabnine.accept_completion(), or perhaps even just tabnine.accept(), and same for dismiss.

[aarondill]

@amirbilu please let me know how you would like this change to continue. This is vital to my personal use of the project, and I'd like to finalize the PR so it can be merged.

[aarondill]

@amirbilu have you had a chance to take a look at this yet?

[aarondill]

@amirbilu sorry if it feels like I'm pestering you about this PR, but this is an extremely important use case to me, and as you seem to be the sole owner/maintainer of this repo, I don't know who else to ping to get this reviewed and merged.

I am currently maintaining a fork to implement this behavior for my own use and I'd love to be able to resume using upstream if this could get merged.

My stated use case is to remap the tab key (usually used for completion) to a function callback that completes Tabnine if available, otherwise uses cmp (my lsp completion client). This allows seemless integration of the two, and avoids my current problem of the two fighting over my tab key (and Tabnine winning, regardless of completion availability, removing my ability to use cmp).

[aarondill]

@amirbilu here's a friendly ping on this PR. It's now been waiting over 6 months for a review and I'd appreciate if you could take a quick look at it.

[aarondill]

@amirbilu any update on this PR?

[amirbilu]

@aarondill to be honest it feels like a big change and I can't find the time to think of the consequences

[aarondill]

@amirbilu this is a fairly advanced use case, but i've been using it in my own configuration without issue for the last 9 months (I'm maintaining a fork with all my prs)

[aarondill]

@amirbilu this pr would also solve #149 with slight modification (which i'm happy to make)

if I make these modifications, would you be interested in merging this PR now?

[amirbilu]

@amirbilu this pr would also solve #149 with slight modification (which i'm happy to make)

if I make these modifications, would you be interested in merging this PR now?

willing to add this if it does not break anything

[aarondill]

@amirbilu I've rewritten this PR with has_suggestion in mind.
Please review the new commits when possible 😄

[amirbilu]

Awesome contribution