Merge branch 'Exafunction:main' into main

Author: chenxuan520

README.md

@@ -1,24 +1,26 @@
 <p align="center">
-  <img width="300" alt="Codeium" src="codeium.svg"/>
+  <img width="300" alt="Windsurf" src="windsurf.png"/>
 </p>
 
 ---
 
 [![Discord](https://img.shields.io/discord/1027685395649015980?label=community&color=5865F2&logo=discord&logoColor=FFFFFF)](https://discord.gg/3XFf78nAx5)
-[![Twitter Follow](https://img.shields.io/badge/style--blue?style=social&logo=twitter&label=Follow%20%40codeiumdev)](https://twitter.com/intent/follow?screen_name=codeiumdev)
-![License](https://img.shields.io/github/license/Exafunction/codeium.vim)
-[![built with Codeium](https://codeium.com/badges/main)](https://codeium.com?repo_name=exafunction%2Fcodeium.vim)
+[![Twitter Follow](https://img.shields.io/badge/style--blue?style=social&logo=twitter&label=Follow%20%40windsurf_ai)](https://twitter.com/intent/follow?screen_name=windsurf_ai)
+![License](https://img.shields.io/github/license/Exafunction/windsurf.vim)
+[![Docs](https://img.shields.io/badge/Windsurf%20Docs-09B6A2)](https://docs.windsurf.com)
+[![Canny Board](https://img.shields.io/badge/Feature%20Requests-6b69ff)](https://windsurf.canny.io/feature-requests/)
+[![built with Windsurf](https://windsurf.com/badges/main)](https://windsurf.com?repo_name=exafunction%2Fwindsurf.vim)
 
 [![Visual Studio](https://img.shields.io/visual-studio-marketplace/i/Codeium.codeium?label=Visual%20Studio&logo=visualstudio)](https://marketplace.visualstudio.com/items?itemName=Codeium.codeium)
 [![JetBrains](https://img.shields.io/jetbrains/plugin/d/20540?label=JetBrains)](https://plugins.jetbrains.com/plugin/20540-codeium/)
 [![Open VSX](https://img.shields.io/open-vsx/dt/Codeium/codeium?label=Open%20VSX)](https://open-vsx.org/extension/Codeium/codeium)
 [![Google Chrome](https://img.shields.io/chrome-web-store/users/hobjkcpmjhlegmobgonaagepfckjkceh?label=Google%20Chrome&logo=googlechrome&logoColor=FFFFFF)](https://chrome.google.com/webstore/detail/codeium/hobjkcpmjhlegmobgonaagepfckjkceh)
 
-# codeium.vim
+# windsurf.vim
 
 _Free, ultrafast Copilot alternative for Vim and Neovim_
 
-Codeium autocompletes your code with AI in all major IDEs. We [launched](https://www.codeium.com/blog/codeium-copilot-alternative-in-vim) this implementation of the Codeium plugin for Vim and Neovim to bring this modern coding superpower to more developers. Check out our [playground](https://www.codeium.com/playground) if you want to quickly try out Codeium online.
+Windsurf autocompletes your code with AI in all major IDEs. We [launched](https://www.windsurf.com/blog/codeium-copilot-alternative-in-vim) this implementation of the Windsurf plugin for Vim and Neovim to bring this modern coding superpower to more developers. Check out our [playground](https://www.windsurf.com/playground) if you want to quickly try out Windsurf online.
 
 Contributions are welcome! Feel free to submit pull requests and issues related to the plugin.
 
@@ -33,13 +35,13 @@ Contributions are welcome! Feel free to submit pull requests and issues related
 1. Install [Vim](https://github.com/vim/vim) (at least 9.0.0185) or [Neovim](https://github.com/neovim/neovim/releases/latest) (at
    least 0.6)
 
-2. Install `Exafunction/codeium.vim` using your vim plugin manager of
+2. Install `Exafunction/windsurf.vim` using your vim plugin manager of
    choice, or manually. See [Installation Options](#-installation-options) below.
 
-3. Run `:Codeium Auth` to set up the plugin and start using Codeium.
+3. Run `:Codeium Auth` to set up the plugin and start using Windsurf.
 
 You can run `:help codeium` for a full list of commands and configuration
-options, or see [this guide](https://www.codeium.com/vim_tutorial) for a quick tutorial on how to use Codeium.
+options, or see [this guide](https://www.windsurf.com/vim_tutorial) for a quick tutorial on how to use Windsurf.
 
 ## 🛠️ Configuration
 
@@ -48,17 +50,19 @@ A few of the most popular options are highlighted below.
 
 ### ⌨️ Keybindings
 
-Codeium provides the following functions to control suggestions:
+Windsurf provides the following functions to control suggestions:
 
-| Action                      | Function                       | Default Binding |
-| --------------------------- | ------------------------------ | --------------- |
-| Clear current suggestion    | `codeium#Clear()`              | `<C-]>`         |
-| Next suggestion             | `codeium#CycleCompletions(1)`  | `<M-]>`         |
-| Previous suggestion         | `codeium#CycleCompletions(-1)` | `<M-[>`         |
-| Insert suggestion           | `codeium#Accept()`             | `<Tab>`         |
-| Manually trigger suggestion | `codeium#Complete()`           | `<M-Bslash>`    |
+| Action                       | Function                       | Default Binding |
+| ---------------------------  | ------------------------------ | --------------- |
+| Clear current suggestion     | `codeium#Clear()`              | `<C-]>`         |
+| Next suggestion              | `codeium#CycleCompletions(1)`  | `<M-]>`         |
+| Previous suggestion          | `codeium#CycleCompletions(-1)` | `<M-[>`         |
+| Insert suggestion            | `codeium#Accept()`             | `<Tab>`         |
+| Manually trigger suggestion  | `codeium#Complete()`           | `<M-Bslash>`    |
+| Accept word from suggestion  | `codeium#AcceptNextWord()`     | `<C-k>`         |
+| Accept line from suggestion  | `codeium#AcceptNextLine()`     | `<C-l>`         |
 
-Codeium's default keybindings can be disabled by setting
+Windsurf's default keybindings can be disabled by setting
 
 ```vim
 let g:codeium_disable_bindings = 1
@@ -77,6 +81,8 @@ If you'd like to bind the actions above to different keys, this might look somet
 
 ```vim
 imap <script><silent><nowait><expr> <C-g> codeium#Accept()
+imap <script><silent><nowait><expr> <C-h> codeium#AcceptNextWord()
+imap <script><silent><nowait><expr> <C-j> codeium#AcceptNextLine()
 imap <C-;>   <Cmd>call codeium#CycleCompletions(1)<CR>
 imap <C-,>   <Cmd>call codeium#CycleCompletions(-1)<CR>
 imap <C-x>   <Cmd>call codeium#Clear()<CR>
@@ -87,7 +93,7 @@ Or in Neovim (using [wbthomason/packer.nvim](https://github.com/wbthomason/packe
 ```lua
 -- Remove the `use` here if you're using folke/lazy.nvim.
 use {
-  'Exafunction/codeium.vim',
+  'Exafunction/windsurf.vim',
   config = function ()
     -- Change '<C-g>' here to any keycode you like.
     vim.keymap.set('i', '<C-g>', function () return vim.fn['codeium#Accept']() end, { expr = true, silent = true })
@@ -100,9 +106,9 @@ use {
 
 (Make sure that you ran `:Codeium Auth` after installation.)
 
-### ⛔ Disabling Codeium
+### ⛔ Disabling Windsurf
 
-Codeium can be disabled for particular filetypes by setting the
+Windsurf can be disabled for particular filetypes by setting the
 `g:codeium_filetypes` variable in your vim config file (vimrc/init.vim):
 
 ```vim
@@ -112,7 +118,7 @@ let g:codeium_filetypes = {
     \ }
 ```
 
-Codeium is enabled by default for most filetypes.
+Windsurf is enabled by default for most filetypes.
 
 You can also _disable_ codeium by default with the `g:codeium_enabled` variable,
 and enable it manually per buffer by running `:CodeiumEnable`:
@@ -157,37 +163,38 @@ To disable automatic text rendering of suggestions (the gray text that appears f
 let g:codeium_render = v:false
 ```
 
-### Show Codeium status in statusline
+### Show Windsurf status in statusline
 
-Codeium status can be generated by calling the `codeium#GetStatusString()` function. In
+Windsurf status can be generated by calling the `codeium#GetStatusString()` function. In
 Neovim, you can use `vim.api.nvim_call_function("codeium#GetStatusString", {})` instead.
-It produces a 3 char long string with Codeium status:
+It produces a 3 char long string with Windsurf status:
 
 - `'3/8'` - third suggestion out of 8
-- `'0'` - Codeium returned no suggestions
-- `'*'` - waiting for Codeium response
+- `'0'` - Windsurf returned no suggestions
+- `'*'` - waiting for Windsurf response
 
-In normal mode, status shows if Codeium is enabled or disabled by showing
+In normal mode, status shows if Windsurf is enabled or disabled by showing
 `'ON'` or `'OFF'`.
 
 In order to show it in status line add following line to your `.vimrc`:
 
 ```set statusline+=\{…\}%3{codeium#GetStatusString()}```
 
-Shorter variant without Codeium logo:
+Shorter variant without Windsurf logo:
 
 ```set statusline+=%3{codeium#GetStatusString()}```
 
 Please check `:help statusline` for further information about building statusline in VIM.
 
-vim-airline supports Codeium out-of-the-box since commit [3854429d](https://github.com/vim-airline/vim-airline/commit/3854429d99c8a2fb555a9837b155f33c957a2202).
+vim-airline supports Windsurf out-of-the-box since commit [3854429d](https://github.com/vim-airline/vim-airline/commit/3854429d99c8a2fb555a9837b155f33c957a2202).
 
-### Launching Codeium Chat
+### Launching Windsurf Chat
 
-Calling the `codeium#Chat()` function will enable search and indexing in the current project and launch Codeium Chat in a new browser window.
+Calling the `codeium#Chat()` function or using the `Codeium Chat` command will enable search and indexing in the current project and launch Codeium Chat in a new browser window.
 
 ```vim
 :call codeium#Chat()
+:Codeium Chat
 ```
 
 The project root is determined by looking in Vim's current working directory for some specific files or directories to be present and goes up to parent directories until one is found.  This list of hints is user-configurable and the default value is:
@@ -202,27 +209,27 @@ Note that launching chat enables telemetry.
 
 ```lua
 {
-  'Exafunction/codeium.vim',
+  'Exafunction/windsurf.vim',
   event = 'BufEnter'
 }
 ```
 
 ### 🔌 vim-plug
 
 ```vim
-Plug 'Exafunction/codeium.vim', { 'branch': 'main' }
+Plug 'Exafunction/windsurf.vim', { 'branch': 'main' }
 ```
 
 ### 📦 Vundle
 
 ```vim
-Plugin 'Exafunction/codeium.vim'
+Plugin 'Exafunction/windsurf.vim'
 ```
 
 ### 📦 packer.nvim:
 
 ```vim
-use 'Exafunction/codeium.vim'
+use 'Exafunction/windsurf.vim'
 ```
 
 ### 💪 Manual
@@ -233,7 +240,7 @@ Run the following. On windows, you can replace `~/.vim` with
 `$HOME/vimfiles`:
 
 ```bash
-git clone https://github.com/Exafunction/codeium.vim ~/.vim/pack/Exafunction/start/codeium.vim
+git clone https://github.com/Exafunction/windsurf.vim ~/.vim/pack/Exafunction/start/windsurf.vim
 ```
 
 #### 💻 Neovim
@@ -242,5 +249,5 @@ Run the following. On windows, you can replace `~/.config` with
 `$HOME/AppData/Local`:
 
 ```bash
-git clone https://github.com/Exafunction/codeium.vim ~/.config/nvim/pack/Exafunction/start/codeium.vim
+git clone https://github.com/Exafunction/windsurf.vim ~/.config/nvim/pack/Exafunction/start/windsurf.vim
 ```