README.md

completion-treesitter

Treesitter source and more for completion-nvim.

This is a basic completion source based on the treesitter api of neovim.

Quickstart

Install completion-nvim, and this plugin through your favorite package manager like this :

Plug 'haorenW1025/completion-nvim'
Plug 'vigoux/completion-treesitter'

Then configure completion-nvim as you desire, you can use the ts source for lua, python and c filetypes, for example :

" Configure the completion chains
let g:completion_chain_complete_list = {
			\'default' : {
			\	'default' : [
			\		{'complete_items' : ['lsp', 'snippet']},
			\		{'mode' : 'file'}
			\	],
			\	'comment' : [],
			\	'string' : []
			\	},
			\'vim' : [
			\	{'complete_items': ['snippet']},
			\	{'mode' : 'cmd'}
			\	],
			\'c' : [
			\	{'complete_items': ['ts']}
			\	],
			\'python' : [
			\	{'complete_items': ['ts']}
			\	],
			\'lua' : [
			\	{'complete_items': ['ts']}
			\	],
			\}

" Highlight the node at point, its usages and definition when cursor holds
let g:complete_ts_highlight_at_point = 1

" Use completion-nvim in every buffer
autocmd BufEnter * lua require'completion'.on_attach()

Open a buffer of a supported filetype and enjoy ! Actually, you will see two things : if you go on any identifier, its usages and definition should highlight automatically.

An other thing is that the plugin provides two text objects :

• gn an incrementally growing node (identifier, expression, line, ...)
• gf current context/function.

And as you start typing, suggestions will appear !

Examples usages

Some examples usages of the plugin, not only for completion. All of these functionnalities are available for all supported filetypes.

Incremental selection

Usage and definition highlighting

Intelligent rename

Adding new filetypes

For now, you should look the after/ftplugin/c.vim file, and tree-sitter documentation on queries. Feel free to open an issue if you need help, or open a PR if you don't.

If you find a bug in any filetype, or a weird behaviour, open an issue to describe how the behaviour differs from the expected one.

Current supported filetypes:

Goals

The aim of the plugin is mainly to fiddle a bit with treesitter, and a nice way is completion, but there is many things we can do with it.

There is still some goals for the plugin:

• As hackable as possible
• As fast as possible

TODO

That's the ideas I had in mind at start, but feel free to suggest anything !

• Completion
  • Basic
  • Suggest only symbol in current scope
  • Intelligent suggestions (based on types for examples)
  • Include file handling (:h include-search)
• Text objects
  • Incremental selection gn
  • Current context gf
• Refactoring helpers
  • Highlight identifiers at point
  • Find definition/declaration
  • "Intelligent" rename (completion_treesitter#smart_rename())
  • Signature help