Augment Vim v0.3.0

Author: github-actions[bot]

README.md

@@ -64,8 +64,47 @@ The following commands are provided:
 :Augment enable     " Globally enable suggestions (on by default)
 :Augment disable    " Globally disable suggestions
 :Augment log        " View the plugin log
+:Augment chat       " Start a chat with Augment AI
 ```
 
+## Chat
+
+The chat command allows you to interact with Augment AI in a conversational
+manner. You can use it in two ways:
+
+1. Direct command with message:
+
+    ```vim
+    :Augment chat How do I implement binary search?
+    ```
+
+2. With selected text:
+
+   - Select text in visual mode
+
+   - 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
+
+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.
+
+Note: This option must be set before the plugin is loaded.
+
 ## Alternate Keybinds
 
 By default, tab is used to accept a suggestion. If you want to use a
@@ -85,6 +124,11 @@ inoremap <cr> <cmd>call augment#Accept("\n")<cr>
 The default tab mapping can be disabled by setting
 `g:augment_disable_tab_mapping = v:true` before the plugin is loaded.
 
+If another plugin uses tab in insert mode, the Augment tab mapping may be
+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.
+
 ## Licensing and Distribution
 
 This repository includes two main components:

autoload/augment.vim

@@ -12,6 +12,11 @@ endfunction
 
 let s:NOT_RUNNING_MSG = 'The Augment language server is not running. See ":Augment log" for more details.'
 
+" Get the text of the current buffer, accounting for the newline at the end
+function! s:GetBufText() abort
+    return join(getline(1, '$'), "\n") . "\n"
+endfunction
+
 " Notify the server that a buffer has been opened
 function! s:OpenBuffer() abort
     if !s:IsRunning()
@@ -23,7 +28,7 @@ function! s:OpenBuffer() abort
         call luaeval('require("augment").open_buffer(_A[1], _A[2])', [client.client_id, bufnr('%')])
     else
         let uri = 'file://' . expand('%:p')
-        let text = join(getline(1, '$'), "\n")
+        let text = s:GetBufText()
         call client.Notify('textDocument/didOpen', {
                     \ 'textDocument': {
                     \   'uri': uri,
@@ -51,7 +56,7 @@ function! s:UpdateBuffer() abort
         let b:_augment_buf_tick = b:changedtick
 
         let uri = 'file://' . expand('%:p')
-        let text = join(getline(1, '$'), "\n")
+        let text = s:GetBufText()
         call augment#client#Client().Notify('textDocument/didChange', {
                     \ 'textDocument': {
                     \   'uri': uri,
@@ -96,12 +101,12 @@ function! s:RequestCompletion() abort
 endfunction
 
 " Show the log
-function! s:CommandLog() abort
+function! s:CommandLog(...) abort
     call augment#log#Show()
 endfunction
 
 " Send sign-in request to the language server
-function! s:CommandSignIn() abort
+function! s:CommandSignIn(...) abort
     if !s:IsRunning()
         echohl WarningMsg
         echo s:NOT_RUNNING_MSG
@@ -113,7 +118,7 @@ function! s:CommandSignIn() abort
 endfunction
 
 " Send sign-out request to the language server
-function! s:CommandSignOut() abort
+function! s:CommandSignOut(...) abort
     if !s:IsRunning()
         echohl WarningMsg
         echo s:NOT_RUNNING_MSG
@@ -124,15 +129,15 @@ function! s:CommandSignOut() abort
     call augment#client#Client().Request('augment/logout', {})
 endfunction
 
-function! s:CommandEnable() abort
+function! s:CommandEnable(...) abort
     let g:augment_enabled = v:true
 endfunction
 
-function! s:CommandDisable() abort
+function! s:CommandDisable(...) abort
     let g:augment_enabled = v:false
 endfunction
 
-function! s:CommandStatus() abort
+function! s:CommandStatus(...) abort
     if !s:IsRunning()
         echohl WarningMsg
         echo s:NOT_RUNNING_MSG
@@ -143,6 +148,73 @@ function! s:CommandStatus() abort
     call augment#client#Client().Request('augment/status', {})
 endfunction
 
+function! s:CommandChat(range, args) abort
+    if exists('g:augment_enabled') && !g:augment_enabled
+        echohl WarningMsg
+        echo 'Augment: Not enabled. Run ":Augment enable" to enable the plugin.'
+        echohl None
+        return
+    endif
+
+    if !s:IsRunning()
+        echohl WarningMsg
+        echo s:NOT_RUNNING_MSG
+        echohl None
+        return
+    endif
+
+    " If range arguments were provided (when using :Augment chat) or in visual
+    " mode, get the selected text
+    if a:range == 2 || mode() ==# 'v' || mode() ==# 'V'
+        let selected_text = augment#chat#GetSelectedText()
+    else
+        let selected_text = ''
+    endif
+
+    " Use the message from the additional command arguments if provided, or
+    " prompt the user for a message
+    let message = empty(a:args) ? input('Message: ') : a:args
+
+    " Handle cancellation or empty input
+    if message ==# '' || message =~# '^\s*$'
+        redraw
+        echo 'Chat cancelled'
+        return
+    endif
+
+    " Create new buffer for chat response
+    let chat_bufname = 'AugmentChat-' . strftime("%Y%m%d-%H%M%S")
+    let current_win = bufwinid(bufnr('%'))
+    call augment#chat#CreateBuffer(chat_bufname)
+    call win_gotoid(current_win)
+
+    call augment#log#Info(
+                \ 'Making chat request in buffer ' . chat_bufname
+                \ . ' with selected_text="' . selected_text
+                \ . '"' . ' message="' . message . '"')
+
+    let params = {
+        \ 'textDocumentPosition': {
+        \     'textDocument': {
+        \         'uri': 'file://' . expand('%:p'),
+        \     },
+        \     'position': {
+        \         'line': line('.') - 1,
+        \         'character': col('.') - 1,
+        \     },
+        \ },
+        \ 'message': message,
+    \ 'partialResultToken': chat_bufname,
+    \ }
+
+    " Add selected text if available
+    if !empty(selected_text)
+        let params['selectedText'] = selected_text
+    endif
+
+    call augment#client#Client().Request('augment/chat', params)
+endfunction
+
 " Handle user commands
 let s:command_handlers = {
     \ 'log': function('s:CommandLog'),
@@ -151,24 +223,30 @@ let s:command_handlers = {
     \ 'enable': function('s:CommandEnable'),
     \ 'disable': function('s:CommandDisable'),
     \ 'status': function('s:CommandStatus'),
+    \ 'chat': function('s:CommandChat'),
     \ }
 
-function! augment#Command(command) abort
-    if empty(a:command)
+function! augment#Command(range, args) abort range
+    if empty(a:args)
         call s:command_handlers['status']()
         return
     endif
 
+    let command = split(a:args)[0]
     for [name, Handler] in items(s:command_handlers)
         " Note that ==? is case-insensitive comparison
-        if a:command ==? name
-            call Handler()
+        if command ==? name
+            " Call the command handler with the count of range arguments as
+            " the first parameter, followed by the rest of the arguments to
+            " the command as a single string
+            let command_args = substitute(a:args, '^\S*\s*', '', '')
+            call Handler(a:range, command_args)
             return
         endif
     endfor
 
     echohl WarningMsg
-    echo 'Augment: Unknown command: "' . a:command . '"'
+    echo 'Augment: Unknown command: "' . command . '"'
     echohl None
 endfunction
 

autoload/augment/chat.vim

@@ -0,0 +1,77 @@
+" Copyright (c) 2025 Augment
+" MIT License - See LICENSE.md for full terms
+
+" Utilities for chat
+
+function! s:GetBufSelection(line_start, col_start, line_end, col_end) abort
+    if a:line_start == a:line_end
+        return getline(a:line_start)[a:col_start - 1:a:col_end - 1]
+    endif
+
+    let lines = []
+    call add(lines, getline(a:line_start)[a:col_start - 1:])
+    call extend(lines, getline(a:line_start + 1, a:line_end - 1))
+    call add(lines, getline(a:line_end)[0:a:col_end - 1])
+    return join(lines, "\n")
+endfunction
+
+function! augment#chat#GetSelectedText() abort
+    " If in visual mode use the current selection
+    if mode() ==# 'v' || mode() ==# 'V'
+        let [line_one, col_one] = getpos('.')[1:2]
+        let [line_two, col_two] = getpos('v')[1:2]
+
+        " . may be before or after v, so need to do some sorting
+        if line_one < line_two
+            let line_start = line_one
+            let col_start = col_one
+            let line_end = line_two
+            let col_end = col_two
+        elseif line_one > line_two
+            let line_start = line_two
+            let col_start = col_two
+            let line_end = line_one
+            let col_end = col_one
+        else
+            " If the lines are the same, the columns may be different
+            let line_start = line_one
+            let line_end = line_two
+            if col_one <= col_two
+                let col_start = col_one
+                let col_end = col_two
+            else
+                let col_start = col_two
+                let col_end = col_one
+            endif
+        endif
+
+        " . and v return column positions one lower than '< and '>
+        let col_start += 1
+        let col_end += 1
+
+        " In visual line mode, the columns will be incorrect
+        if mode() ==# 'V'
+            let col_start = 1
+            let col_end = v:maxcol
+        endif
+
+        return s:GetBufSelection(line_start, col_start, line_end, col_end)
+    endif
+
+    " Otherwise, assume '< and '> are populated with the correct selection
+    let [line_start, col_start] = getpos("'<")[1:2]
+    let [line_end, col_end] = getpos("'>")[1:2]
+    return s:GetBufSelection(line_start, col_start, line_end, col_end)
+endfunction
+
+function! augment#chat#CreateBuffer(bufname) abort
+    botright vnew
+    setlocal buftype=nofile
+    setlocal bufhidden=hide
+    setlocal noswapfile
+    setlocal wrap
+    setlocal linebreak
+    execute 'file ' . a:bufname
+    setlocal readonly
+    setlocal filetype=markdown
+endfunction