cmp-tabnine

Install

Dependencies

On Linux and Mac, you will need curl and unzip in your $PATH.

On windows, you just need powershell. If you get a PSSecurityException while trying to install, try the following command in powershell:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

For more information, see about_Execution_Policies.

Using a plugin manager

Using plug:

Plug 'tzachar/cmp-tabnine', { 'do': './install.sh' }

Using plug on windows:

Plug 'tzachar/cmp-tabnine', { 'do': 'powershell ./install.ps1' }

Using Lazy:

return require("lazy").setup({
 {
     'tzachar/cmp-tabnine',
     build = './install.sh',
     dependencies = 'hrsh7th/nvim-cmp',
 }})

Using Packer:

return require("packer").startup(
 function(use)
 	use "hrsh7th/nvim-cmp" --completion
 	use {'tzachar/cmp-tabnine', run='./install.sh', requires = 'hrsh7th/nvim-cmp'}
 end
)

Using Packer on windows:

return require("packer").startup(
 function(use)
 	use "hrsh7th/nvim-cmp" --completion
 	use {'tzachar/cmp-tabnine', after = "nvim-cmp", run='powershell ./install.ps1', requires = 'hrsh7th/nvim-cmp'}
 end
)

And later, enable the plugin:

require'cmp'.setup {
 sources = {
 	{ name = 'cmp_tabnine' },
 },
}

Using NvChad

see this issue

Setup

local tabnine = require('cmp_tabnine.config')

tabnine:setup({
	max_lines = 1000,
	max_num_results = 20,
	sort = true,
	run_on_every_keystroke = true,
	snippet_placeholder = '..',
	ignored_file_types = {
		-- default is not to ignore
		-- uncomment to ignore in lua:
		-- lua = true
	},
	show_prediction_strength = false,
        binary = { -- default is to use binary managed by plugin
		-- uncomment to use cusom binary
		-- path = "/my/custom/TabNine",
		-- version = "4.4.265"
        },
})

Please note the use of : instead of a .

Configure Tabnine or Log in to Your Account

On Tabnine Hub

`max_lines`

How many lines of buffer context to pass to TabNine

`max_num_results`

How many results to return

`sort`

Sort results by returned priority

`run_on_every_keystroke`

Generate new completion items on every keystroke. For more info, check out #18

`snippet_placeholder`

Indicates where the cursor will be placed in case a completion item is a snippet. Any string is accepted.

For this to work properly, you need to setup snippet support for nvim-cmp.

`ignored_file_types` `(table: <string:bool>)`

Which file types to ignore. For example:

ignored_file_types = {
	html = true;
}

will make cmp-tabnine not offer completions when vim.bo.filetype is html.

`show_prediction_strength`

When show_prediction_strength is true, cmp-tabnine will display the prediction strength as a percentage by assigning entry.completion_item.data.detail. This was previously the default behavior.

`binary` `(table: <string:string>)`

A custom path/version for the TabNine binary. For example:

binary = {
	path = "/my/custom/TabNine",
	version = "4.4.265",
}

will make cmp-tabnine use a manually installed binary.

Pretty Printing Menu Items

You can use the following to pretty print the completion menu (requires lspkind and patched fonts (https://www.nerdfonts.com)):

local lspkind = require('lspkind')

local source_mapping = {
	buffer = "[Buffer]",
	nvim_lsp = "[LSP]",
	nvim_lua = "[Lua]",
	cmp_tabnine = "[TN]",
	path = "[Path]",
}

require'cmp'.setup {
	sources = {
		{ name = 'cmp_tabnine' },
	},
	formatting = {
		format = function(entry, vim_item)
			-- if you have lspkind installed, you can use it like
			-- in the following line:
	 		vim_item.kind = lspkind.symbolic(vim_item.kind, {mode = "symbol"})
	 		vim_item.menu = source_mapping[entry.source.name]
	 		if entry.source.name == "cmp_tabnine" then
	 			local detail = (entry.completion_item.data or {}).detail
	 			vim_item.kind = ""
	 			if detail and detail:find('.*%%.*') then
	 				vim_item.kind = vim_item.kind .. ' ' .. detail
	 			end

	 			if (entry.completion_item.data or {}).multiline then
	 				vim_item.kind = vim_item.kind .. ' ' .. '[ML]'
	 			end
	 		end
	 		local maxwidth = 80
	 		vim_item.abbr = string.sub(vim_item.abbr, 1, maxwidth)
	 		return vim_item
	  end,
	},
}

Sorting

cmp-tabnine adds a priority entry to each completion item, which can be used to override cmp's default sorting order:

local compare = require('cmp.config.compare')
cmp.setup({
  sorting = {
    priority_weight = 2,
    comparators = {
      require('cmp_tabnine.compare'),
      compare.offset,
      compare.exact,
      compare.score,
      compare.recently_used,
      compare.kind,
      compare.sort_text,
      compare.length,
      compare.order,
    },
  },
})

Prefetch

TabNine supports prefetching files, preprocessing them before users ask for completions. Prefetching is supported through a command:

:CmpTabninePrefetch file_path

and also directly using lua:

require('cmp_tabnine'):prefetch(file_path)

The lua api can be used to prefetch a project, or a file on open:

local prefetch = vim.api.nvim_create_augroup("prefetch", {clear = true})

vim.api.nvim_create_autocmd('BufRead', {
  group = prefetch,
  pattern = '*.py',
  callback = function()
    require('cmp_tabnine'):prefetch(vim.fn.expand('%:p'))
  end
})

Multi-Line suggestions

TabNine supports multi-line suggestions in Pro mode. If a suggestions is multi-line, we add the entry.completion_item.data.detail.multiline flag to the completion entry and the entire suggestion to the documentation property of the entry, such that cmp will display the suggested lines in the documentation panel.

To enable multi-line completions, you should (a) have a Pro account and (b) select either the hybrid or cloud completion models in the TabNine Hub.

Moreover, TabNine tends to suggest multi-line completions only on a new line (usually after a comment describing what you are expecting to get). The easiest way to trigger the completion is by manually invoking cmp on a new line.

Support for multi-line completions in cmp works only from version 4.4.213 of TabNine (see this issue).

More Commands

:CmpTabnineHub: Open Tabnine Hub
:CmpTabnineHubUrl: Show the link to Tanine Hub

jeanmertz / cmp-tabnine Goto Github PK

cmp-tabnine's Introduction

cmp-tabnine

Install

Dependencies

Using a plugin manager

Using NvChad

Setup

Configure Tabnine or Log in to Your Account

max_lines

max_num_results

sort

run_on_every_keystroke

snippet_placeholder

ignored_file_types (table: <string:bool>)

show_prediction_strength

binary (table: <string:string>)