Augment Vim v0.25.1

Author: github-actions[bot]

CHANGELOG.md

@@ -0,0 +1,19 @@
+# Augment Vim Plugin Changelog
+
+This file documents the notable changes for each stable version of the Augment
+Vim plugin. The following list is not necessarily comprehensive, but should
+include any changes that may impact the user experience.
+
+## 0.25.1
+
+- Deprecate the `Enable` and `Disable` commands in favor of the
+  `g:augment_disable_completions` option which disables inline completions but
+  not the chat feature. See `:help g:augment_disable_completions` for more
+  details.
+- Check for the `winfixbuf` option before setting it to avoid an error on older
+  versions of Vim.
+- Perform a runtime compatibility check on startup to warn users if they are
+  running an unsupported version of Node.js.
+- Improve the auth flow by significantly shortening the auth URL (addressing
+  issues with truncated URLs) and improving the error messages on failure.
+- Add support for filepaths containing spaces.

README.md

@@ -15,15 +15,21 @@ 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
+## Getting Started
 
-1. Both Vim and Neovim are supported, but the plugin may require a newer version
-   than what's installed on your system by default.
+1. Sign up for a free trial of Augment at
+   [augmentcode.com](https://augmentcode.com).
 
-   - [Vim](https://github.com/vim/vim?tab=readme-ov-file#installation) version 9.1.0 or newer.
+1. Ensure you have a compatible editor version installed. Both Vim and Neovim
+   are supported, but the plugin may require a newer version than what is
+   installed on your system by default.
 
-   - [Neovim](https://github.com/neovim/neovim/tree/master?tab=readme-ov-file#install-from-package), version
-     0.10.0 or newer.
+   - For [Vim](https://github.com/vim/vim?tab=readme-ov-file#installation),
+     version 9.1.0 or newer.
+
+   - For
+     [Neovim](https://github.com/neovim/neovim/tree/master?tab=readme-ov-file#install-from-package),
+     version 0.10.0 or newer.
 
 1. Install [Node.js](https://nodejs.org/en/download/package-manager/all),
    version 22.0.0 or newer, which is a required dependency.
@@ -71,8 +77,6 @@ The following commands are provided:
 :Augment status        " View the current status of the plugin
 :Augment signin        " Start the sign in flow
 :Augment signout       " Sign out of Augment
-:Augment enable        " Globally enable suggestions (on by default)
-:Augment disable       " Globally disable suggestions
 :Augment log           " View the plugin log
 :Augment chat          " Send a chat message to Augment AI
 :Augment chat-new      " Start a new chat conversation
@@ -167,6 +171,10 @@ 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.
 
+Completions can be disabled entirely by setting
+`g:augment_disable_completions = v:true` in your vimrc or at any time during
+editing.
+
 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

autoload/augment.vim

@@ -73,8 +73,8 @@ function! s:RequestCompletion() abort
         return
     endif
 
-    " Don't send a request if disabled
-    if exists('g:augment_enabled') && !g:augment_enabled
+    " Don't send a request if completions are disabled
+    if exists('g:augment_disable_completions') && g:augment_disable_completions
         return
     endif
 
@@ -85,7 +85,16 @@ function! s:RequestCompletion() abort
     endif
     let b:_augment_comp_tick = b:changedtick
 
-    let uri = 'file://' . expand('%:p')
+    if has('nvim')
+        " NOTE(mpauly): On neovim, we use the built-in lsp client which
+        " requires the uri to be in the format defined by
+        " vim.uri_from_fname(). There isn't a straightforward way to format
+        " the uri on vim and it isn't causing any issues, so punting on it for
+        " now.
+        let uri = v:lua.vim.uri_from_fname(expand('%:p'))
+    else
+        let uri = 'file://' . expand('%:p')
+    endif
     let text = join(getline(1, '$'), "\n")
     " TODO: remove version-- we use it elsewhere but it's not in the spec
     call augment#client#Client().Request('textDocument/completion', {
@@ -129,15 +138,21 @@ function! s:CommandSignOut(...) abort
     call augment#client#Client().Request('augment/logout', {})
 endfunction
 
+" NOTE: The enable/disable commands are deprecated
 function! s:CommandEnable(...) abort
-    let g:augment_enabled = v:true
+    call augment#DisplayError('The `Enable` and `Disable` commands are deprecated in favor of the `g:augment_disable_completions` option. See `:help g:augment_disable_completions` for more details.')
 endfunction
 
 function! s:CommandDisable(...) abort
-    let g:augment_enabled = v:false
+    call augment#DisplayError('The `Enable` and `Disable` commands are deprecated in favor of the `g:augment_disable_completions` option. See `:help g:augment_disable_completions` for more details.')
 endfunction
 
 function! s:CommandStatus(...) abort
+    if !exists('g:augment_initialized') || !g:augment_initialized
+        call augment#DisplayError('The Augment plugin failed to initialize. See ":Augment log" for more details.')
+        return
+    endif
+
     if !s:IsRunning()
         echohl WarningMsg
         echo s:NOT_RUNNING_MSG
@@ -149,13 +164,6 @@ function! s:CommandStatus(...) abort
 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
@@ -244,7 +252,14 @@ function! augment#Command(range, args) abort range
         return
     endif
 
+    " If the plugin failed to initialize, only allow status and log commands
     let command = split(a:args)[0]
+    if (!exists('g:augment_initialized') || !g:augment_initialized)
+                \ && command !=# 'status' && command !=# 'log'
+        call augment#DisplayError('The Augment plugin failed to initialize. Only `:Augment status` and `:Augment log` commands are available.')
+        return
+    endif
+
     for [name, Handler] in items(s:command_handlers)
         " Note that ==? is case-insensitive comparison
         if command ==? name
@@ -309,3 +324,22 @@ function! augment#Accept(...) abort
         call feedkeys(fallback, 'nt')
     endif
 endfunction
+
+" Display an error message to the user in addition to logging it
+function! augment#DisplayError(message) abort
+    " If we have already entered the editor, display the error message
+    " immediately. Otherwise, wait for VimEnter.
+    if v:vim_did_enter
+        echohl ErrorMsg | echom 'Augment: ' . a:message | echohl None
+    else
+        " Shadow the message argument with a script-local variable. This means
+        " that subsequent calls will override the previous message, which
+        " should be fine for our use case.
+        let s:error_message = a:message
+        augroup augment_error
+            autocmd!
+            autocmd VimEnter * echohl ErrorMsg | echom 'Augment: ' . s:error_message | echohl None
+        augroup END
+    endif
+    call augment#log#Error(a:message)
+endfunction

autoload/augment/chat.vim

@@ -51,7 +51,10 @@ function! augment#chat#OpenChatPanel() abort
     setlocal buftype=nofile      " Buffer will never be written to a file
     setlocal nomodifiable        " Prevent any modifications
     setlocal noswapfile          " Don't create a swapfile
-    setlocal winfixbuf           " Keep buffer in window when splitting
+    " NOTE(mpauly): winfixbuf is not available in some subversions of vim 9.1
+    if exists('&winfixbuf')
+        setlocal winfixbuf       " Keep buffer in window when splitting
+    endif
     setlocal bufhidden=hide      " When buffer is abandoned, hide it
     setlocal nobuflisted         " Hide from :ls
     setlocal wrap                " Wrap long lines

autoload/augment/client.vim

@@ -3,23 +3,27 @@
 
 " Client for interacting with the server process
 
+" Custom LSP response error codes
+let s:AUGMENT_ERROR_UNAUTHORIZED = 401
+
 let s:client = {}
 
-" If provided, launch the server from a user-provided command
-if exists('g:augment_job_command')
-    let s:job_command = g:augment_job_command
-else
-    let server_file = expand('<sfile>:h:h:h') . '/dist/server.js'
+function! augment#client#GetJobCommand() abort
+    " If provided, launch the server from a user-provided command
+    if exists('g:augment_job_command')
+        return g:augment_job_command
+    endif
+
+    let server_file = expand('<script>:h:h:h') . '/dist/server.js'
 
     " If provided, use a user-provided node command
     if exists('g:augment_node_command')
         let s:node_command = g:augment_node_command
     else
         let s:node_command = 'node'
     endif
-
-    let s:job_command = [s:node_command, server_file, '--stdio']
-endif
+    return [s:node_command, server_file, '--stdio']
+endfunction
 
 function! s:VimNotify(method, params) dict abort
     let message = {
@@ -55,12 +59,27 @@ function! s:NvimRequest(method, params) dict abort
     " For nvim tracking the request methods and params is handled in the lua code
 endfunction
 
-" Handle a chat chunk notification
+" Handle the augment/chatChunk notification
 function! s:HandleChatChunk(client, params) abort
     let text = a:params.text
     call augment#chat#AppendText(text)
 endfunction
 
+" Handle the window/logMessage notification
+function! s:HandleLogMessage(client, params) abort
+    if a:params.type == 1  " Error
+        call augment#log#Error(a:params.message)
+    elseif a:params.type == 2  " Warning
+        call augment#log#Warn(a:params.message)
+    elseif a:params.type == 3 || a:params.type == 4  " Info, Log
+        call augment#log#Info(a:params.message)
+    elseif a:params.type == 5  " Debug
+        call augment#log#Debug(a:params.message)
+    else
+        call augment#log#Warn('Unknown log message type: ' . string(a:params.type) . '. Message: ' . string(a:params.message))
+    endif
+endfunction
+
 " Handle the initialize response
 function! s:HandleInitialize(client, params, result, err) abort
     if a:err isnot v:null
@@ -74,6 +93,11 @@ endfunction
 " Handle the textDocument/completion response
 function! s:HandleCompletion(client, params, result, err) abort
     if a:err isnot v:null
+        " If the user is not logged in, ignore the error
+        if a:err.code == s:AUGMENT_ERROR_UNAUTHORIZED
+            return
+        endif
+
         call augment#log#Error('Recieved error ' . string(a:err) . ' for completion with params: ' . string(a:params))
         return
     endif
@@ -130,7 +154,7 @@ endfunction
 function! s:HandleToken(client, params, result, err) abort
     if a:err isnot v:null
         echohl ErrorMsg
-        echom 'Augment: Error signing in, please try again.'
+        echom 'Augment: Error signing in: ' . a:err.message
         echohl None
         call augment#log#Error('augment/token response error: ' . string(a:err))
         return
@@ -157,7 +181,7 @@ function! s:HandleStatus(client, params, result, err) abort
     endif
 
     let loggedIn = a:result.loggedIn
-    let enabled = exists('g:augment_enabled') ? g:augment_enabled : v:true
+    let disabled = exists('g:augment_disable_completions') && g:augment_disable_completions
     if has_key(a:result, 'syncPercentage')
         let syncPercentage = a:result.syncPercentage == 100 ? 'fully' : printf('%d%%', a:result.syncPercentage)
         let syncText = printf(' (workspace %s synced)', syncPercentage)
@@ -167,16 +191,20 @@ function! s:HandleStatus(client, params, result, err) abort
 
     if !loggedIn
         echom 'Augment: Not signed in. Run ":Augment signin" to start the sign in flow or ":h augment" for more information on the plugin.'
-    elseif !enabled
-        echom printf('Augment%s: Signed in, disabled.', syncText)
+    elseif disabled
+        echom printf('Augment%s: Signed in, completions disabled.', syncText)
     else
-        echom printf('Augment%s: Signed in, enabled.', syncText)
+        echom printf('Augment%s: Signed in.', syncText)
     endif
 endfunction
 
 " Handle the augment/chat response
 function! s:HandleChat(client, params, result, err) abort
     if a:err isnot v:null
+        " NOTE(mpauly): For chat we want to show the error to the user even if
+        " they're not logged in. This helps disambiguate between a
+        " network/slow response error and an authentication error.
+
         call augment#log#Error('augment/chat response error: ' . string(a:err))
         return
     endif
@@ -290,13 +318,27 @@ function! s:GetWorkspaceFolders() abort
         return []
     endif
 
+    " Validate the the workspace folders are a list
+    if type(g:augment_workspace_folders) == v:t_list
+        let folders_list = g:augment_workspace_folders
+    elseif type(g:augment_workspace_folders) == v:t_string
+        let folders_list = [g:augment_workspace_folders]
+    else
+        call augment#log#Error('Workspace folders set to invalid value: ' . string(g:augment_workspace_folders) . '. See `:h g:augment_workspace_folders` for configuration instructions.')
+        return []
+    endif
+
     let valid_folders = []
-    for folder in g:augment_workspace_folders
-        let abs_path = fnamemodify(folder, ':p')
-        if !isdirectory(abs_path)
-            call augment#log#Error('The following workspace folder does not exist: ' . abs_path)
+    for folder in folders_list
+        if type(folder) != v:t_string
+            call augment#log#Error('Expected workspace folder type to be string. Got: ' . string(folder))
         else
-            call add(valid_folders, folder)
+            let abs_path = fnamemodify(folder, ':p')
+            if !isdirectory(abs_path)
+                call augment#log#Error('The following workspace folder does not exist: ' . abs_path)
+            else
+                call add(valid_folders, folder)
+            endif
         endif
     endfor
 
@@ -324,6 +366,7 @@ function! s:New() abort
     " Set the message handlers
     let notification_handlers = {
                 \ 'augment/chatChunk': function('s:HandleChatChunk'),
+                \ 'window/logMessage': function('s:HandleLogMessage'),
                 \ }
     let response_handlers = {
                 \ 'initialize': function('s:HandleInitialize'),
@@ -342,17 +385,11 @@ function! s:New() abort
                 \ 'response_handlers': response_handlers,
                 \ }
 
-
-    " Check that the runtime environment is installed. If not, return a partially initialized client
-    if executable(s:job_command[0]) == 0
-        call augment#log#Error('The Augment runtime (' . s:job_command[0] . ') was not found. If node is available on your system under a different name, you can set the `g:augment_node_command` variable. See `:help g:augment_node_command` for more details.')
-        return client
-    endif
-
     " Convert any workspace folders to URIs for the language server
     let workspace_folders = s:GetWorkspaceFolders()
 
     " Start the server and send the initialize request
+    let job_command = augment#client#GetJobCommand()
     if has('nvim')
         " Nvim-specific client setup
         call extend(client, {
@@ -365,7 +402,7 @@ function! s:New() abort
 
         " If the client exits, lua will notify NvimOnExit()
         let client.client_id = luaeval('require("augment").start_client(_A[1], _A[2], _A[3])',
-                    \ [s:job_command, notification_methods, workspace_folders])
+                    \ [job_command, notification_methods, workspace_folders])
     else
         " Vim-specific client setup
         call extend(client, {
@@ -375,7 +412,7 @@ function! s:New() abort
                     \ 'Request': function('s:VimRequest'),
                     \ })
 
-        let client.job = job_start(s:job_command, {
+        let client.job = job_start(job_command, {
                     \ 'noblock': 1,
                     \ 'stoponexit': 'term',
                     \ 'in_mode': 'lsp',

autoload/augment/version.vim

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