Augment Vim v0.14.1

Author: github-actions[bot]

README.md

@@ -1,11 +1,19 @@
 # Augment Vim & Neovim Plugin
 
-> [!WARNING]
-> This plugin is in early alpha development stage. Features may be incomplete,
-> unstable, or change without notice. While basic functionality is available,
-> you may encounter bugs, performance issues, or unexpected behavior. Current
-> platform support is limited to MacOS and Linux, with Windows to be added at a
-> later date.
+## A Quick Tour
+
+Augment's Vim/Neovim plugin provides inline code completions and multi-turn
+chat conversations specially tailored to your codebase. The plugin is designed
+to work with any modern Vim or Neovim setup, and features the same underlying
+context engine that powers our VSCode and IntelliJ plugins.
+
+Once you've installed the plugin, tell Augment about your project by adding
+[workspace folders](#workspace-folders) to your config file, and then sign-in
+to the Augment service. You can now open a source file in your project, begin
+typing, and you should receive context-aware code completions. Use tab to
+accept a suggestion, or keep typing to refine the suggestions. To ask questions
+about your codebase or request specific changes, use the `:Augment chat` command
+to start a chat conversation.
 
 ## Installation
 
@@ -48,6 +56,8 @@
         { 'augmentcode/augment.vim' },
         ```
 
+1. Add workspace folders to your config file. This is really essential to getting the most out of augment! See the [Workspace Folders](#workspace-folders) section for more information.
+
 1. Open Vim and sign in to Augment with the `:Augment signin` command.
 
 ## Basic Usage
@@ -69,10 +79,53 @@ The following commands are provided:
 :Augment chat-toggle   " Toggle the chat panel visibility
 ```
 
+## Workspace Folders
+
+Workspace folders help Augment understand your codebase better by providing
+additional context. Adding your project's root directory as a workspace folder
+allows Augment to take advantage of context from across your project, rather
+than just the currently open file, improving the accuracy and style of
+completions and chat.
+
+You can configure workspace folders by setting
+`g:augment_workspace_folders` in your vimrc:
+
+```vim
+let g:augment_workspace_folders = ['/path/to/project', '~/another-project']
+```
+
+Workspace folders can be specified using absolute paths or paths relative to
+your home directory (~). Adding your project's root directory as a workspace
+folder helps Augment generate completions that match your codebase's patterns
+and conventions.
+
+Note: This option must be set before the plugin is loaded.
+
+After adding a workspace folder and restarting vim, the output of the
+`:Augment status` command will include the syncing progress for the added
+folder.
+
+If you want to ignore particular files or directories from your workspace, you
+can create a `.augmentignore` file in the root of your workspace folder. This
+file is treated similar to a `.gitignore` file. For example, to ignore all
+files within the `node_modules` directory, you can add
+the following lines to your `.augmentignore` file:
+
+```
+node_modules/
+```
+
+For more information on how to use the `.augmentignore` file, see the [documentation](https://docs.augmentcode.com/setup-augment/sync).
+
+
 ## Chat
 
-The chat command allows you to interact with Augment AI in a conversational
-manner. You can use it in two ways:
+Augment chat supports multi-turn conversations using your project's full
+context. Once a conversation is started, subsequent chat exchanges will include
+the history from the previous exchanges. This is useful for asking follow-up
+questions or getting context-specific help.
+
+You can interact with chat in two ways:
 
 1. Direct command with message:
 
@@ -86,32 +139,20 @@ manner. You can use it in two ways:
 
    - Type `:Augment chat` followed by your question about the selection
 
-The response will appear in a new buffer with markdown formatting. Note that
-chat is currently limited to single-turn conversations - each chat command
-starts a new conversation.
-
-## Workspace Folders
+The response will appear in a separate chat buffer with markdown formatting.
 
-Workspace folders help Augment understand your codebase better by providing
-additional context. You can configure workspace folders by setting
-`g:augment_workspace_folders` in your vimrc:
-
-```vim
-let g:augment_workspace_folders = ['/path/to/project', '~/another-project']
-```
-
-Workspace folders can be specified using absolute paths or paths relative to
-your home directory (~). Adding your project's root directory as a workspace
-folder helps Augment generate completions that match your codebase's patterns
-and conventions.
+To start a new conversation, use the `:Augment chat-new` command. This will
+clear the chat history from your context.
 
-Note: This option must be set before the plugin is loaded.
+Use the `:Augment chat-toggle` command to open and close the chat panel. When
+the chat panel is closed, the chat conversation will be preserved and can be
+reopened with the same command.
 
 ## Alternate Keybinds
 
 By default, tab is used to accept a suggestion. If you want to use a
 different key, create a mapping that calls `augment#Accept()`. The function
-takes an optional arugment used to specify the fallback text to insert if no
+takes an optional argument used to specify the fallback text to insert if no
 suggestion is available.
 
 ```vim
@@ -131,6 +172,42 @@ overridden depending on the order in which the plugins are loaded. If tab isn't
 working for you, the `imap <tab>` command can be used to check if the mapping is
 present.
 
+## FAQ
+
+**Q: I'm not seeing any completions. Is the plugin working?**
+
+A: You may want to first check the output of the `:Augment status` command.
+This command will show the current status of the plugin, including whether
+you're signed in and whether your workspace folders are synced. If you're not
+signed in, you'll need to sign in using the `:Augment signin` command. If those
+are not indicating a problem, you can check the plugin log using the `:Augment
+log` command. This will show any errors that may have occurred.
+
+**Q: Can I create shortcuts for the Augment commands?**
+
+A: Absolutely! You can create mappings for any of the Augment commands. For
+example, to create a shortcut for the `:Augment chat*` commands, you can add the
+following to your vimrc:
+
+```vim
+nnoremap <leader>ac :Augment chat<CR>
+vnoremap <leader>ac :Augment chat<CR>
+nnoremap <leader>an :Augment chat-new<CR>
+nnoremap <leader>at :Augment chat-toggle<CR>
+```
+
+**Q: My workspace is taking a long time to sync. What should I do?**
+
+A: It may take a while to sync if you have a very large codebase that has not
+been synced before. It's also not uncommon to inadvertenly include a large
+directory like `node_modules/`. You can use `:Augment status` to see the
+progress of the sync. If the sync is making progress but just slow, it may be
+worth checking if you have a large directory that you don't need to sync. You
+can add these directories to your `.augmentignore` file to exclude it from the
+sync. If you're still having trouble, please file a github issue with a
+description of the problem and include the output of `:Augment log`.
+
+
 ## Licensing and Distribution
 
 This repository includes two main components:

autoload/augment/chat.vim

@@ -11,7 +11,7 @@ function! s:ResetChatContents() abort
     endif
 
     call setbufvar(chat_buf, '&modifiable', v:true)
-    call deletebufline(chat_buf, 1, '$')
+    silent call deletebufline(chat_buf, 1, '$')
     call augment#chat#AppendText('# Augment Chat History'
                 \ . "\n\n"
                 \ . '`:Augment chat`         Send a chat message in the current conversation'

autoload/augment/client.vim

@@ -92,6 +92,11 @@ function! s:HandleCompletion(client, params, result, err) abort
         return
     endif
 
+    " If the user has exited insert mode, ignore the response
+    if mode() !=# 'i'
+        return
+    endif
+
     " Show the completion
     let text = a:result[0].insertText
     let request_id = a:result[0].label
@@ -198,7 +203,7 @@ function! s:HandlePluginVersion(client, params, result, err) abort
     let current_version = augment#version#Version()
     if latest_version !=# current_version
         let is_prerelease = a:result.isPrerelease
-        let warning_message = printf('Your plugin version %s is lower than the latest %s version %s. Please update your plugin to receive the latest features and bug fixes.',
+        let warning_message = printf('Your plugin version v%s is lower than the latest %s version v%s. Please update your plugin to receive the latest features and bug fixes.',
                     \ current_version,
                     \ is_prerelease ? 'prerelease' : 'stable',
                     \ latest_version)

autoload/augment/version.vim

@@ -2,5 +2,5 @@
 " MIT License - See LICENSE.md for full terms
 
 function! augment#version#Version() abort
-    return '0.10.1'
+    return '0.14.1'
 endfunction