Add some plugins as kite
This commit is contained in:
parent
e078673bcc
commit
2f05fa2626
@ -1,31 +1,58 @@
|
||||
# Vim/Neovim plugin for Kite
|
||||
# Kite Python Plugin for Vim/Neovim
|
||||
|
||||
Kite is an AI-powered programming assistant that helps you write Python code inside Vim. Kite helps you write code faster by showing you the right information at the right time. Learn more about how Kite helps you while you're using Vim at https://kite.com/integrations/vim/.
|
||||
|
||||
At a high level, Kite provides you with:
|
||||
* 🧠 __[Line-of-Code Completions](#Line-of-Code-Completions)__ powered by machine learning models trained on the entire open source code universe
|
||||
* 📝 __[Intelligent Snippets](#Intelligent-Snippets)__ that automatically provide context-relevant code snippets for your function calls
|
||||
* 🔍 __[Instant documentation](#Kite-Copilot-for-Python-Documentation)__ for the symbol underneath your cursor so you save time searching for Python docs
|
||||
|
||||
|
||||
### Features
|
||||
## Requirements
|
||||
|
||||
- [Integrates with Kite Copilot (macOS)](#kite-copilot)
|
||||
- [Completions](#completions)
|
||||
- [Documentation](#documentation)
|
||||
- [Statusline](#statusline)
|
||||
* macOS 10.10+ or Windows 7+ or Linux (Ubuntu, Debian, Fedora, Arch Linux, Linux Mint, openSUSE, KDE, XFCE, Gnome 2, Gnome 3)
|
||||
* Vim 8 or Neovim
|
||||
* [Kite Engine](https://kite.com/)
|
||||
|
||||
Use another editor? Check out [Kite’s other editor integrations](https://kite.com/integrations/).
|
||||
|
||||
|
||||
### Installation
|
||||
## Installation
|
||||
|
||||
Requires Vim 8 or NeoVim.
|
||||
### Installing the Kite Engine
|
||||
|
||||
Download Kite from https://kite.com. During Kite's installation process, select Vim and/or Neovim in the list of editors and Kite will install this plugin for you.
|
||||
The [Kite Engine](https://kite.com/) needs to be installed and running on your computer in order for the package to work properly. The package itself provides the frontend that interfaces with the Kite Engine, which performs all the code analysis and machine learning 100% locally on your computer (no code is sent to a cloud server).
|
||||
|
||||
Kite will also keep the plugin up to date automatically.
|
||||
__macOS Instructions__
|
||||
1. Download the [installer](https://kite.com/download/) and open the downloaded `.dmg` file.
|
||||
2. Drag the Kite icon into the `Applications` folder.
|
||||
3. Run `Kite.app` to start the Kite Engine.
|
||||
|
||||
[Learn more about Kite for Vim.](https://www.kite.com/integrations/vim)
|
||||
__Windows Instructions__
|
||||
1. Download the [installer](https://kite.com/download/) and run the downloaded `.exe` file.
|
||||
2. The installer should run the Kite Engine automatically after installation is complete.
|
||||
|
||||
__Linux Instructions__
|
||||
1. Visit https://kite.com/linux/ to learn how to install Kite.
|
||||
2. The installer should run the Kite Engine automatically after installation is complete.
|
||||
|
||||
### Installing the Kite plugin for Vim/Neovim
|
||||
|
||||
When running the Kite Engine for the first time, you'll be guided through a setup process which will allow you to install the Vim/Neovim plugin. You can also install or uninstall the Vim plugin at any time using the Kite Engine's [plugin manager](https://help.kite.com/article/62-managing-editor-plugins).
|
||||
|
||||
Alternatively, you can follow the instructions in the [DEVELOPMENT.md](https://github.com/kiteco/vim-plugin/blob/master/DEVELOPMENT.md) file to learn how to manually install the Vim/Neovim plugin.
|
||||
|
||||
Once installed, the plugin will be automatically updated by Kite when necessary.
|
||||
|
||||
[Learn more about why Kite is the best autocomplete for Vim.](https://kite.com/integrations/vim/)
|
||||
|
||||
|
||||
### Kite Copilot
|
||||
## Features
|
||||
|
||||
As you edit your code in Vim/Neovim, the Kite Copilot will show completions, examples, and docs for the code under the cursor.
|
||||
Kite's Vim/Neovim plugin provides a number of features to help you code better and faster.
|
||||
|
||||
|
||||
### Completions
|
||||
### Line-of-Code Completions
|
||||
|
||||
Kite's ranked completions are integrated with Vim's insert-mode completion, specifically the user-defined completion. Kite shows normal completions or signature-completions as appropriate for the cursor position.
|
||||
|
||||
@ -76,9 +103,9 @@ set belloff+=ctrlg " if vim beeps during completion
|
||||
```
|
||||
|
||||
|
||||
#### Placeholders
|
||||
### Intelligent Snippets
|
||||
|
||||
Some completions have placeholders which can be filled in. These will be highlighted with the Underline highlight group.
|
||||
Some completions are actually autogenerated code snippets which can be filled in. These will be highlighted with the Underline highlight group.
|
||||
|
||||
You can navigate between placeholders with `<CTRL-J>` (forward) and `<CTRL-K>` (backward), even after you have typed over the original placeholder text.
|
||||
|
||||
@ -99,13 +126,13 @@ To turn it on: `:KiteShowPopularPatterns`.
|
||||
To turn it off: `:KiteHidePopularPatterns`.
|
||||
|
||||
|
||||
### Documentation
|
||||
### Kite Copilot for Python Documentation
|
||||
|
||||
Press `K` when the cursor is on a keyword to view its documentation in Kite Copilot.
|
||||
As you edit your code, the [Kite Copilot](https://kite.com/copilot/) will automatically show examples and docs for the code under your cursor.
|
||||
|
||||
If you have mapped `K` already, the plugin won't overwrite your mapping.
|
||||
Alternatively, you can press `K` when the cursor is on a symbol to view its documentation in Kite Copilot.
|
||||
|
||||
You can set an alternative mapping, e.g. to `gK`, like this:
|
||||
If you have mapped `K` already, the plugin won't overwrite your mapping. You can set an alternative mapping, e.g. to `gK`, like this:
|
||||
|
||||
```viml
|
||||
nmap <silent> <buffer> gK <Plug>(kite-docs)
|
||||
@ -151,7 +178,7 @@ Use `let g:kite_log=1` to switch on logging. Logs are written to `kite-vim.log`
|
||||
|
||||
Kite is built by a team in San Francisco devoted to making programming easier and more enjoyable for all. Follow Kite on
|
||||
[Twitter](https://twitter.com/kitehq) and get the latest news and programming tips on the
|
||||
[Kite Blog](https://kite.com/blog).
|
||||
[Kite Blog](https://kite.com/blog/).
|
||||
Kite has been featured in [Wired](https://www.wired.com/2016/04/kites-coding-asssitant-spots-errors-finds-better-open-source/),
|
||||
[VentureBeat](https://venturebeat.com/2019/01/28/kite-raises-17-million-for-its-ai-powered-developer-environment/),
|
||||
[The Next Web](https://thenextweb.com/dd/2016/04/14/kite-plugin/), and
|
||||
|
||||
@ -1 +1 @@
|
||||
1.0.41
|
||||
1.0.42
|
||||
|
||||
@ -25,11 +25,14 @@ Plug 'flazz/vim-colorschemes'
|
||||
Plug 'xero/sourcerer.vim'
|
||||
Plug 'romainl/apprentice'
|
||||
Plug 'dracula/vim', { 'as': 'dracula' }
|
||||
Plug 'sainnhe/edge', { 'as': 'edge' }
|
||||
Plug 'plasticboy/vim-markdown', { 'for': 'markdown' }
|
||||
Plug 'scrooloose/nerdtree'
|
||||
Plug 'junegunn/goyo.vim'
|
||||
Plug 'junegunn/limelight.vim'
|
||||
Plug 'itchyny/lightline.vim'
|
||||
Plug 'tpope/vim-fugitive'
|
||||
Plug 'tpope/vim-surround'
|
||||
|
||||
" required !
|
||||
filetype plugin indent on
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user