Better way of listing workspaces

[iamim]

Currently, the user is required to list the workspaces in a global variable. Because it has to be done before the plugin is loaded, hardcoding the value in init.lua or similar becomes the most natural approach. It becomes a problem for those who want to make the (neo)vim setup reproducible or public (I don't always want to show which projects I have or have my setup break when I init it on a different machine). I guess it's possible to hide this with shada or loading from a file that is excluded from git, but it does not feel like the intended solution.

Perhaps it would be a better approach to store it in ~/.local/state so that it's local per machine? If coupled with a simple way to query whether :pwd is in the workspace list, it could be integrated in lualine or similar.

[bchopson]

If you are using neovim with lazy.nvim (https://github.com/folke/lazy.nvim) for plugin management, you can configure workspaces in .lazy.lua on a per-project basis:

return {
    {
        "augmentcode/augment.vim",
        config = function()
            vim.g.augment_workspace_folders = { "~/path/to/your/project/" }
        end,
    },
}

[iamim]

@bchopson I agree that this option is possible. However, it feels tedious to add this to each of the project repos.
Additionally, Augment should already store the workspaces that are authorized for indexing if using VSCode or IntelliJ, it feels logical to share the state between the apps in ~/.augment or similar.

[V4G4X]

Whichever project I want Augment to index, I simply copy this snippet to that workspace.

.init.lua:

if not vim.g.vscode then
	local workspace_folders = vim.g.augment_workspace_folders or {}
	local current_dir = vim.fn.expand("%:p:h") -- Gets the directory of the current file
	-- Alternative: local current_dir = vim.fn.getcwd()  -- Gets the current working directory

	-- Add the current directory to workspace folders
	table.insert(workspace_folders, current_dir)
	vim.g.augment_workspace_folders = workspace_folders
end

Prerequisite:
Required exrc to be enabled:

vim.o.exrc = true

Opening neovim inside this workspace will first confirm that you want this init.lua script to be run each time.
(You have to confirm again every time you update this script)

Bonus:
With this you can also configure over workspace only settings like extra linters you want to run in a particular workspace,
or linters you DON'T want running in your workspace.

Like if you want cfn-lint to run in your AWS project's workspace that has cloudformation templates.
But you don't want it to run in you OpenAPI's workspace.

That looks like:

-- Configure nvim-lint for linting
local nvim_lint = require("lint")
nvim_lint.linters_by_ft = nvim_lint.linters_by_ft or {}
nvim_lint.linters_by_ft.yaml = nvim_lint.linters_by_ft.yaml or {}
table.insert(nvim_lint.linters_by_ft.yaml, "cfn_lint")

[iamim]

If I understood it right, the workspaces should be set before the plugin loads. Correct me if I'm wrong, but it means the lazy.init/exrc would not work if you navigate into a project after you started nvim. It means that it would work when starting an nvim session as nvim . or nvim ~/my-project but would not work for those relying on project selection in a dashboard or such after running nvim. I am one of "those" :)

[V4G4X]

Considering there's no explicit require("augment") type of a command needed to start augment.
Maybe this could still work?

Why not give it a try?

[iamim]

I just realized that listed workspaces are loaded for each open session. In my case, if I add ~/projectA and ~/projectB globally and open projectB in neovim and type :Augment chat What is this repo? is starts telling me about projectA.

Is this expected?

[NobbZ]

As I always load nvim from a terminal from within the project, and as I also need a way to easily enable/disable augment for certain projects, I use an environment variable in my direnv-.envrc and lazy loading with the following lz.n spec:

local augment_workspace = vim.env.AUGMENT_WORKSPACE
local augment_node = vim.env.AUGMENT_NODE

require("nobbz.lazy").add_specs({ {
  "augment",
  enabled = function()
    return augment_workspace ~= nil and augment_node ~= nil
  end,
  before = function(plugin)
    vim.g.augment_workspace_folders = { augment_workspace, }
    vim.g.augment_node_command = augment_node
  end,
  cmd = "Augment",
}, })

The AUGMENT_NODE is used to ensure that I do not get into trouble while working on some legacy JS projects.

[reavessm]

I think it would also be nice to include something like git rev-parse --show-toplevel to automatically add the entire git repo to the workspace list if you open inside of one. My workflow involves adding multiple git-worktrees and this would dynamically scope it based on where I open the file

[Mulchman]

I do something similar to @NobbZ to enable/disable augment based on the cwd that I open Neovim in, and dynamically set the workspace directory-

return {
  "augmentcode/augment.vim",
  enabled = function()
    local cwd = vim.loop.cwd()
    local file = cwd .. "/.augmentignore"
    local enabled = vim.loop.fs_stat(file) ~= nil
    return enabled
  end,
  config = function()
    local cwd = vim.loop.cwd()
    vim.g.augment_workspace_folders = { cwd }
    -- key binds
  end
}

[Dillpickleschmidt]

I just realized that listed workspaces are loaded for each open session. In my case, if I add ~/projectA and ~/projectB globally and open projectB in neovim and type :Augment chat What is this repo? is starts telling me about projectA.

Is this expected?

Here's the solution I got from Claude inspired by the above solutions. It only chats about the cwd, but you can specify both ~/projectA and ~/projectB in the list.
Basically, I can manually define a "whitelist" of directories, and it will only do indexing if the current working directory matches one of those paths. Otherwise, it will only chat about the opened file (without indexing any folders).

return {
  'augmentcode/augment.vim',
  event = "BufReadPost",
  init = function()
    local cwd = vim.loop.cwd()
    local whitelist = {
      '~/personal/my-app/',
      '~/work/some-project/',
    }

    for _, dir in ipairs(whitelist) do
      if cwd and cwd:find(vim.fn.expand(dir), 1, true) then
        vim.g.augment_workspace_folders = { vim.loop.cwd() }
        return
      end
    end

    vim.g.augment_workspace_folders = {}
  end,
}

vim.fn.expand just lets you specify your home directory using the alias ~/. You could change/hardcode this instead if you like.

The nice thing about this is that it's all just defined in 1 lua file. I don't do anything like looking for git files or .augmentignore (I wanted something more simple & universal).

(Haven't tested extensively, so take with a grain of salt. Seems to work well enough from my 5 min of testing so far...)

[alerque]

[…] Otherwise, it will only chat about the opened file (without indexing any folders).

This will still upload every file you ever open with VIM to Augment's cloud. It will keep it from indexing whole directories, but everything you open whether in a white listed directory or not will get exfiltrated and leave your control.