https://github.com/echasnovski/mini.completion

Neovim Lua plugin for completion and signature help. Part of 'mini.nvim' library.
https://github.com/echasnovski/mini.completion

lua mini-nvim neovim neovim-plugin

Last synced: about 2 months ago
JSON representation

Neovim Lua plugin for completion and signature help. Part of 'mini.nvim' library.

• Host: GitHub
• URL: https://github.com/echasnovski/mini.completion
• Owner: echasnovski
• License: mit
• Created: 2022-10-24T16:19:08.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-29T16:01:43.000Z (10 months ago)
• Last Synced: 2024-02-29T17:26:25.006Z (10 months ago)
• Topics: lua, mini-nvim, neovim, neovim-plugin
• Language: Lua
• Homepage:
• Size: 69.3 KB
• Stars: 30
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![GitHub license](https://badgen.net/github/license/echasnovski/mini.nvim)](https://github.com/echasnovski/mini.nvim/blob/main/LICENSE)

### Autocompletion and signature help plugin

- Async (with customizable 'debounce' delay) 'two-stage chain completion': first builtin LSP, then configurable fallback.

- Has functionality for completion item info and function signature (both in floating window appearing after customizable delay).

See more details in [Features](#features) and [help file](doc/mini-completion.txt).

---

⦿ This is a part of [mini.nvim](https://github.com/echasnovski/mini.nvim) library. Please use [this link](https://github.com/echasnovski/mini.nvim/blob/main/README.md) if you want to mention this module.

⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.

⦿ See the repository page to learn about common design principles and configuration recipes.

---

If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://github.com/echasnovski/mini.nvim/blob/main/CONTRIBUTING.md) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.

## Demo

https://user-images.githubusercontent.com/24854248/173044355-90bfc230-70c4-4932-b66b-103284558994.mp4

## Features

- Two-stage chain completion:

    - First stage is an LSP completion. Supports `additionalTextEdits`, like auto-import and others.

    - If first stage is not set up or resulted into no candidates, fallback action is executed. The most tested actions are Neovim's built-in insert completion.

- Automatic display in floating window of completion item info (via 'completionItem/resolve' request) and signature help (with highlighting of active parameter if LSP server provides such information).

- Automatic actions are done after some configurable amount of delay. This reduces computational load and allows fast typing (completion and signature help) and item selection (item info)

- User can force two-stage completion via or fallback completion.

- Highlighting of LSP kind (like "Function", "Keyword", etc.). Requires enabled ['mini.icons'](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-icons.md) (uses its "lsp" category) and Neovim>=0.11.

## Dependencies

For full experience needs (still works without any of suggestions):

- Enabled ['mini.icons'](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-icons.md) module to highlight LSP kind (requires Neovim>=0.11). Otherwise `MiniCompletion.default_process_items()` does not add highlighting. Also take a look at `MiniIcons.tweak_lsp_kind()`.

## Installation

This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository.

There are two branches to install from:

- `main` (default, **recommended**) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).

- `stable` will be updated only upon releases with code tested during public beta-testing phase in `main` branch.

Here are code snippets for some common installation methods (use only one):

With mini.deps

    

        

            Github repo

            Branch Code snippet

        

    

    

        

            'mini.nvim' library Main Follow recommended 'mini.deps' installation

        

        

            Stable

        

        

            Standalone plugin Main add('echasnovski/mini.completion')

        

        

            Stable add({ source = 'echasnovski/mini.completion', checkout = 'stable' })

        

    

With folke/lazy.nvim

    

        

            Github repo

            Branch Code snippet

        

    

    

        

            'mini.nvim' library

            Main { 'echasnovski/mini.nvim', version = false },

        

        

            Stable { 'echasnovski/mini.nvim', version = '*' },

        

        

            Standalone plugin

            Main { 'echasnovski/mini.completion', version = false },

        

        

            Stable { 'echasnovski/mini.completion', version = '*' },

        

    

With junegunn/vim-plug

    

        

            Github repo

            Branch Code snippet

        

    

    

        

            'mini.nvim' library

            Main Plug 'echasnovski/mini.nvim'

        

        

            Stable Plug 'echasnovski/mini.nvim', { 'branch': 'stable' }

        

        

            Standalone plugin Main Plug 'echasnovski/mini.completion'

        

        

            Stable Plug 'echasnovski/mini.completion', { 'branch': 'stable' }

        

    




**Important**: don't forget to call `require('mini.completion').setup()` to enable its functionality.

**Note**: if you are on Windows, there might be problems with too long file paths (like `error: unable to create file : Filename too long`). Try doing one of the following:

- Enable corresponding git global config value: `git config --system core.longpaths true`. Then try to reinstall.

- Install plugin in other place with shorter path.

## Default config

```lua

-- No need to copy this inside `setup()`. Will be used automatically.

{

  -- Delay (debounce type, in ms) between certain Neovim event and action.

  -- This can be used to (virtually) disable certain automatic actions by

  -- setting very high delay time (like 10^7).

  delay = { completion = 100, info = 100, signature = 50 },

  -- Configuration for action windows:

  -- - `height` and `width` are maximum dimensions.

  -- - `border` defines border (as in `nvim_open_win()`).

  window = {

    info = { height = 25, width = 80, border = 'none' },

    signature = { height = 25, width = 80, border = 'none' },

  },

  -- Way of how module does LSP completion

  lsp_completion = {

    -- `source_func` should be one of 'completefunc' or 'omnifunc'.

    source_func = 'completefunc',

    -- `auto_setup` should be boolean indicating if LSP completion is set up

    -- on every `BufEnter` event.

    auto_setup = true,

    -- A function which takes LSP 'textDocument/completion' response items

    -- and word to complete. Output should be a table of the same nature as

    -- input items. Common use case is custom filter/sort.

    process_items = --,

  },

  -- Fallback action. It will always be run in Insert mode. To use Neovim's

  -- built-in completion (see `:h ins-completion`), supply its mapping as

  -- string. Example: to use 'whole lines' completion, supply ''.

  fallback_action = --` completion>,

  -- Module mappings. Use `''` (empty string) to disable one. Some of them

  -- might conflict with system mappings.

  mappings = {

    force_twostep = '', -- Force two-step completion

    force_fallback = '', -- Force fallback completion

  },

  -- Whether to set Vim's settings for better experience (modifies

  -- `shortmess` and `completeopt`)

  set_vim_settings = true,

}

```

## Similar plugins

- [hrsh7th/nvim-cmp](https://github.com/hrsh7th/nvim-cmp)

- [Shougo/ddc.vim](https://github.com/Shougo/ddc.vim)