feat(vim): rework vim plugin with lsp client. bump version to 2.0.0-dev.

.github/workflows/release-vim.yml

@@ -2,6 +2,9 @@ name: Release Vim Plugin
 
 on:
   workflow_dispatch:
+  push:
+    tags:
+      - 'vim@*'
 
 jobs:
   release:
@@ -21,13 +24,13 @@ jobs:
         path: vim-tabby
     - name: Copy files
       run: |
+        find vim-tabby/ -mindepth 1 ! -regex '^vim-tabby/\.git\(/.*\)?' -delete
+        cp -r tabby/clients/vim/.gitignore vim-tabby/
         cp -r tabby/clients/vim/* vim-tabby/
-        rm vim-tabby/package.json
     - name: Get version
       id: get_version
       run: |
-        cd vim-tabby/autoload/tabby/
-        version=$(cat globals.vim | grep "let g:tabby_version" | sed -e 's/.*"\(.*\)".*/\1/')
+        version=$(cat vim-tabby/autoload/tabby.vim | grep "let g:tabby_version" | sed -e 's/.*"\(.*\)".*/\1/')
         echo "::set-output name=version::$version"
     - name: Commit files
       run: |

.github/workflows/release.yml

@@ -8,6 +8,7 @@ on:
       - 'nightly'
       - "!*-dev.*"
       - '!vscode@*'
+      - '!vim@*'
   pull_request:
     branches: [ "main" ]
     paths:

clients/vim/.gitignore

@@ -1,2 +1 @@
 /doc/tags
-node_modules

clients/vim/CHANGELOG.md

@@ -1,83 +1,10 @@
-## 1.4.0
-
-### Features
-
-- Added support for loading system-wide CA certificates. Previously, only Node.js bundled CA certificates were used.
-- Added support for loading configurations from Tabby server, including `Disabling Client-side Telemetry`.
-
-## 1.3.2
-
-### Fixes:
-
-- Disabled experimental features by default:
-  - Stripping auto-closing characters in prompt suffix.
-  - Syntax-based code completion scope limit.
-  - Syntax-based replace range calculation.
-
-## 1.3.0
-
-### Features:
-
-- Removed the completion request timeout limit.
-- Enabled the experimental feature of stripping auto-closing characters in the prompt suffix by default.
-- Enabled the experimental feature of syntax-based post-processing by default.
-- Added support for logging completion dismiss events.
-
-### Fixes:
-
-- Fixed health checking to be compatible with Tabby server version 0.2.0 or earlier.
-
-## 1.2.0
-
-### Features:
-
-- The status "Authorization required" has been updated to be more commonly used, as it was previously only used for Tabby Cloud users.
-- Removed command `:Tabby auth` for opening the authentication page and fetching the token when using Tabby Cloud.
-  - To connect to Tabby Cloud server, you need to manually set the token instead. The token already in use will remain usable.
-
-### Fixes:
-
-- Fixed a bug that caused a script error when attempting to map the `<Tab>` key with a fallback to an original mapping that had an empty `rhs`.
-- Corrected invalid online documentation links.
-- Resolved a bug that resulted in empty log files being generated even when the logging level is set to `silent`.
-- Fixed bugs related to the experimental syntax-based post-processing.
-
-## 1.1.1
-
-### Fixes:
-
-- Fix a bug cause the completion does not show up if the completion cache is missing.
-
-## 1.1.0
-
-### Features:
-
-- Updated the config.toml file to include new configuration options: `server.auth` and `completion.timeout`.
-- Added a command `:Tabby version` to print the current version of Tabby plugin.
-- Added experimental features aimed at fine-tuning completion quality. These features are disabled by default but can be enabled by setting the corresponding config flag to `true` in the `config.toml` file, include:
-    - `completion.prompt.experimentalStripAutoClosingCharacters`: Strip auto-closing brackets and quotes in prompt suffix, to generate more lines in FIM mode.
-    - `postprocess.limitScope.indentation.experimentalKeepBlockScopeWhenCompletingLine`: Use the block scope instead of line scope when using indentation to limit the completion scope and the completion is continuing the current line.
-    - `postprocess.limitScope.experimentalSyntax`: Use syntax parser to limit the completion scope.
-    - `postprocess.calculateReplaceRange.experimentalSyntax`: Use syntax parser to calculate the completion replace range, to avoid duplicated auto-closing brackets and quotes.
-
-### Fixes:
-
-- Fixed a bug causing the `<Tab>` key to input unexpected characters when fallback to another plugin script.
-
-## 1.0.2
-
-### Fixes:
-
-- Fixed a bug causing status stuck in 'initializing' when script not found.
-
-## 1.0.1
-
-### Fixes:
-
-- Fixed when resolving the server address, it will now try to prefer to use ipv4 over ipv6. 
-- Fixed a bug causing the `<Tab>` key can not fallback to the default behavior.
-- Fixed a bug causing the completion replace range is rendered incorrectly.
-
-## 1.0.0
-
-### Initial release
+## 2.0.0
+
+Since version 2.0, the vim-tabby plugin is designed as two parts:
+1. **LSP Client Extension**:
+   - Relies on an LSP client and extends it with methods (such as `textDocument/inlineCompletion`) to communicate with the tabby-agent.
+   - Note: The Node.js script of tabby-agent is no longer a built-in part of the vim-tabby plugin. You need to install tabby-agent separately via npm, and the LSP client will launch it using the command `npx tabby-agent --stdio`.
+2. **Inline Completion UI**:
+   - Automatically triggers inline completion requests when typing.
+   - Renders the inline completion text as ghost text.
+   - Sets up actions with keyboard shortcuts to accept or dismiss the inline completion.

clients/vim/README.md

@@ -1,182 +1,100 @@
-# Tabby Plugin for Vim and NeoVim
-
-Tabby is a self-hosted AI coding assistant that can suggest multi-line code or full functions in real-time. For more information, please check out our [website](https://tabbyml.com/) and [github](https://github.com/TabbyML/tabby).  
-If you encounter any problem or have any suggestion, please [open an issue](https://github.com/TabbyML/tabby/issues/new) or join our [Slack community](https://links.tabbyml.com/join-slack) for support.
-
-## Table of Contents
-
-- Tabby Plugin for Vim and NeoVim
-  - [Table of Contents](#table-of-contents)
-  - [Requirements](#requirements)
-  - [Installation](#installation)
-    - [🔌 Vim-plug](#-vim-plug)
-    - [📦 Packer.nvim](#-packernvim)
-    - [💤 Lazy.nvim](#-lazynvim)
-  - [Usage](#usage)
-  - [Configuration](#configuration)
-    - [Tabby Server](#tabby-server)
-    - [Node.js Binary Path](#nodejs-binary-path)
-    - [Completion Trigger Mode](#completion-trigger-mode)
-    - [KeyBindings](#keybindings)
-  - [Known Conflicts](#known-conflicts)
-  - [Contributing](#contributing)
-  - [License](#license)
+# Tabby Plugin for Vim and Neovim
 
-## Requirements
-
-Tabby plugin requires the following dependencies:
-
-- Vim 9.0+ with `+job` and `+textprop` features enabled, or NeoVim 0.6.0+.
-- Tabby server. You can install Tabby server locally or have it hosted on a remote server. For Tabby server installation, please refer to this [documentation](https://tabby.tabbyml.com/docs/installation/).
-- [Node.js](https://nodejs.org/en/download/) version v18.0+.
-  - If you need have multiple Node.js versions installed, you can use Node.js version manager such as [nvm](https://github.com/nvm-sh/nvm).
-- Vim filetype plugin enabled. You can add following lines in vim config file (`~/.vimrc`). For NeoVim, filetype plugin is enabled by default, you don't need to add these lines.
-
-  ```vim
-  filetype plugin on
-  ```
-
-## Installation
+Tabby is a self-hosted AI coding assistant that can suggest multi-line code or full functions in real-time. For more information, please check out our [website](https://tabbyml.com/) and [GitHub](https://github.com/TabbyML/tabby).  
+If you encounter any problems or have any suggestions, please [open an issue](https://github.com/TabbyML/tabby/issues/new) or join our [Slack community](https://links.tabbyml.com/join-slack) for support.
 
-You can install Tabby plugin using your favorite plugin manager. Here are some examples using popular plugin managers, you can choose one to follow.
-
-### 🔌 [Vim-plug](https://github.com/junegunn/vim-plug)
-
-```vim
-" Example ~/.vimrc configuration
-filetype plugin on
-
-" Section for plugins managed by vim-plug
-call plug#begin()
-
-" Tabby plugin
-Plug 'TabbyML/vim-tabby'
-" Add config here. Example config:
-let g:tabby_keybinding_accept = '<Tab>'
-
-call plug#end()
-```
+## Notable Changes in vim-tabby Plugin 2.0
 
-### 🥡 [Vundle.vim](https://github.com/VundleVim/Vundle.vim)
+Since version 2.0, the vim-tabby plugin is designed as two parts:
+1. **LSP Client Extension**:
+   - Relies on an LSP client and extends it with methods (such as `textDocument/inlineCompletion`) to communicate with the tabby-agent.
+   - Note: The Node.js script of tabby-agent is no longer a built-in part of the vim-tabby plugin. You need to install tabby-agent separately via npm, and the LSP client will launch it using the command `npx tabby-agent --stdio`.
+2. **Inline Completion UI**:
+   - Automatically triggers inline completion requests when typing.
+   - Renders the inline completion text as ghost text.
+   - Sets up actions with keyboard shortcuts to accept or dismiss the inline completion.
 
-```vim
---- Example ~/.vim configuration
-filetype plugin on
-
-" Section for plugins managed vundle.vim
-call vundle#begin()
-
-" Tabby plugin
-Plugin 'TabbyML/vim-tabby'
-" Add config here. Example config:
-let g:tabby_keybinding_accept = '<Tab>'
-
-call vundle#end()
-```
+## Requirements
 
-### 📦 [Packer.nvim](https://github.com/wbthomason/packer.nvim)
+The Tabby plugin requires the following dependencies:
 
-```lua
---- Example Packer plugin specification
+- **Tabby Server**: The backend LLM server. You can install the Tabby server locally or have it hosted on a remote server. For Tabby server installation, please refer to this [documentation](https://tabby.tabbyml.com/docs/installation/).
+- **Tabby Agent (LSP server)**: Requires [Node.js](https://nodejs.org/en/download/) version v18.0+ and [tabby-agent](https://www.npmjs.com/package/tabby-agent) installed.
+    ```sh
+    npm install --global tabby-agent
+    ```
+- **LSP Client**: The Neovim built-in LSP client, or a Vim plugin that provides an LSP client. Supported LSP clients include:
+    - The Neovim built-in LSP client, with the [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) plugin installed.
+    - More clients are in development.
+- **Textprop Support**: Neovim, or Vim v9.0+ with `+textprop` features enabled. This is required for inline completion ghost text rendering.
 
---- Add config here. Example config:
-vim.g.tabby_keybinding_accept = '<Tab>'
+## Installation
 
-return require('packer').startup(function(use)
-  --- Tabby plugin
-  use { 'TabbyML/vim-tabby' }
-end)
-```
+You can install the Tabby plugin using your favorite plugin manager by simply adding `TabbyML/vim-tabby` to the registry.  
 
-### 💤 [Lazy.nvim](https://github.com/folke/lazy.nvim)
+Here is a detailed example setup with advanced options, based on [Neovim](https://neovim.io/), [Lazy.nvim](https://github.com/folke/lazy.nvim), and [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig).
 
 ```lua
---- Example Lazy plugin specification
-
---- Add config here. Example config:
-vim.g.tabby_keybinding_accept = '<Tab>'
-
-return {
-  { 'TabbyML/vim-tabby' }
-}
-```
-
-## Usage
-
-After installation, please exit and restart Vim or NeoVim. Then you can check the Tabby plugin status by running `:Tabby` in your vim command line. If you see any message reported by Tabby, it means the plugin is installed successfully. If you see `Not an editor command: Tabby` or any other error message, please check the installation steps.
-
-In insert mode, Tabby plugin will show inline completion automatically when you stop typing. You can simply press `<Tab>` to accept the completion. If you want to dismiss the completion manually, you can press `<C-\>` to dismiss, and press `<C-\>` again to show the completion again.
-
-## Configuration
-
-### Tabby Server
-
-You need to start the Tabby server before using the plugin. For Tabby server installation, please refer to this [documentation](https://tabby.tabbyml.com/docs/installation/).
-
-If your Tabby server endpoint is different from the default `http://localhost:8080`, please set the endpoint in `~/.tabby-client/agent/config.toml`.
-
-If your Tabby server requires an authentication token, remember to set it here.
-
-```toml
-# Server
-# You can set the server endpoint here.
-[server]
-endpoint = "http://localhost:8080" # http or https URL
-token = "your-auth-token"
+-- ~/.config/nvim/init.lua
+require("lazy").setup({
+  -- other plugins
+  -- ...
+  -- Tabby plugin
+  { 
+    "TabbyML/vim-tabby",
+    event = "VimEnter",
+    dependencies = {
+      "neovim/nvim-lspconfig",
+    },
+    init = function()
+      vim.g.tabby_agent_start_command = {"npx", "tabby-agent", "--stdio"}
+      vim.g.tabby_inline_completion_trigger = "auto"
+    end,
+  },
+})
 ```
+After setting up the plugin, you can open a file in Neovim and use `:LspInfo` to check if the Tabby plugin is successfully connected.
 
-### Node.js Binary Path
+## Getting Started
 
-Normally, this config is not required as the Tabby plugin will try to find the Node.js binary in your `PATH` environment variable.  
-But if you have installed Node.js in a non-standard location, or you are using a Node.js version manager such as nvm, you can set the Node.js binary path in your vim config file (`~/.vimrc` for Vim and `~/.config/nvim/init.vim` or `~/.config/nvim/init.lua` for NeoVim).
+### 1. Setup Tabby Server
+The Tabby plugin requires a Tabby server to work. Follow the [documentation](https://tabby.tabbyml.com/docs/installation/) to install and [create your account](https://tabby.tabbyml.com/docs/quick-start/register-account/).
 
-```vim
-let g:tabby_node_binary = '/path/to/node'
-```
+### 2. Connect to the Server
+Edit the tabby-agent config file located at `~/.tabby-client/agent/config.toml` to set up the server endpoint and token. This file may have been auto-created if you have previously used the tabby-agent or Tabby plugin for other IDEs. You can also manually create this file.
 
-```lua
---- lua
-vim.g.tabby_node_binary = '/path/to/node'
-```
+    ```toml
+    [server]
+    endpoint = "http://localhost:8080"
+    token = "your-auth-token"
+    ```
 
-### Completion Trigger Mode
+### 3. Code Completion 
+Tabby suggests code completions in real-time as you write code. You can also trigger the completion manually by pressing `<C-\>`. To accept suggestions, simply press the `<Tab>` key. You can also continue typing or explicitly press `<C-\>` again to dismiss it.
 
-Completion trigger mode is set to `auto` by default, Tabby plugin will show inline completion automatically when you stop typing.  
-If you prefer to trigger code completion manually, add this config in your vim config file. Tabby plugin will not show inline completion automatically, you can trigger the completion manually by pressing `<C-\>`.
-
-```vim
-let g:tabby_trigger_mode = 'manual'
-```
-
-```lua
---- lua
-vim.g.tabby_trigger_mode = 'manual'
-```
-
-### KeyBindings
+## Known Conflicts
 
-The default key bindings for accept completion(`<Tab>`), manual trigger/dismiss(`<C-\>`) can be customized with the following global settings.
+- Tabby will attempt to set up the `<Tab>` key mapping to accept the inline completion and will fall back to the original function mapped to it. There could be a conflict with other plugins that also map the `<Tab>` key. In such cases, you can use a different keybinding to accept the completion to avoid conflicts.
 
-```vim
-let g:tabby_keybinding_accept = '<Tab>'
-let g:tabby_keybinding_trigger_or_dismiss = '<C-\>'
-```
+- Tabby internally utilizes the `<C-R><C-O>` command to insert the completion. If you have mapped it to other functions, the insertion of the completion text may fail.
 
-```lua
---- lua
-vim.g.tabby_keybinding_accept = '<Tab>'
-vim.g.tabby_keybinding_trigger_or_dismiss = '<C-\\>'
-```
+## Configurations
 
-## Known Conflicts
+You can find a detailed explanation of tabby-agent configurations in the [Tabby online documentation](https://tabby.tabbyml.com/docs/extensions/configurations/).
 
-- For the default settings, Tabby will attempt to set up the `<Tab>` key mapping. If Tabby's inline completion is not displayed, it will fall back to the original mapping. However, this approach might not work when there is a conflict with other plugins that also map the `<Tab>` key, as they could overwrite Tabby's mapping. In such cases, you can use a different keybinding to accept the completion and avoid conflicts.
+Here is a table of all configuration variables that can be set when the Tabby plugin initializes:
 
-- Tabby internally utilizes the `<C-R><C-O>` command to insert the completion. If you have mapped `<C-R>` to other functions, you won't be able to accept the completion. In such scenarios, you may need to manually modify the function `tabby#Accept()` in [`autoload/tabby.vim`](https://github.com/TabbyML/tabby/tree/main/clients/vim/autoload/tabby.vim).
+| Variable | Default | Description |
+| --- | --- | --- |
+| `g:tabby_agent_start_command` | `["npx", "tabby-agent", "--stdio"]` | The command to start the tabby-agent |
+| `g:tabby_inline_completion_trigger` | `"auto"` | The trigger mode of inline completion, can be `"auto"` or `"manual"` |
+| `g:tabby_inline_completion_keybinding_accept` | `"<Tab>"` | The keybinding to accept the inline completion |
+| `g:tabby_inline_completion_keybinding_trigger_or_dismiss` | `"<C-\>"` | The keybinding to trigger or dismiss the inline completion |
+| `g:tabby_inline_completion_insertion_leading_key` | `"\<C-R>\<C-O>="` | The leading key sequence to insert the inline completion text |
 
 ## Contributing
 
-Repository [TabbyML/vim-tabby](https://github.com/TabbyML/vim-tabby) is for releasing Tabby plugin for Vim and NeoVim. If you want to contribute to Tabby plugin, please check our main repository [TabbyML/tabby](https://github.com/TabbyML/tabby/tree/main/clients/vim).
+Repository [TabbyML/vim-tabby](https://github.com/TabbyML/vim-tabby) is for releasing Tabby plugin for Vim and Neovim. If you want to contribute to Tabby plugin, please check our main repository [TabbyML/tabby](https://github.com/TabbyML/tabby/tree/main/clients/vim).
 
 ## License