feat: Prevent Copilot LSP from initializing in temporary or blacklisted buffers

Author: Bassam Data

lsp/copilot_ls.lua

@@ -31,6 +31,10 @@ return {
     root_dir = vim.uv.cwd(),
     on_init = function(client)
         local au = vim.api.nvim_create_augroup("copilotlsp.init", { clear = true })
+        local bufnr = vim.api.nvim_get_current_buf()
+        if not require("copilot-lsp.util").should_attach_to_buffer(bufnr) then
+            return
+        end
         --NOTE: Inline Completions
         --TODO: We dont currently use this code path, so comment for now until a UI is built
         -- vim.api.nvim_create_autocmd("TextChangedI", {

lua/copilot-lsp/config.lua

@@ -16,6 +16,7 @@ M.defaults = {
         clear_on_large_distance = true,
         count_horizontal_moves = true,
         reset_on_approaching = true,
+        buffer_blacklist = {},
     },
 }
 

lua/copilot-lsp/nes/init.lua

@@ -28,8 +28,12 @@ end
 --- Requests the NextEditSuggestion from the current cursor position
 ---@param copilot_lss? vim.lsp.Client|string
 function M.request_nes(copilot_lss)
+    local bufnr = vim.api.nvim_get_current_buf()
+    if not utils.should_attach_to_buffer(bufnr) then
+        return
+    end
     local pos_params = vim.lsp.util.make_position_params(0, "utf-16")
-    local version = vim.lsp.util.buf_versions[vim.api.nvim_get_current_buf()]
+    local version = vim.lsp.util.buf_versions[bufnr]
     if type(copilot_lss) == "string" then
         copilot_lss = vim.lsp.get_clients({ name = copilot_lss })[1]
     end

lua/copilot-lsp/util.lua

@@ -1,4 +1,7 @@
 local M = {}
+local config = require("copilot-lsp.config").config
+local api = vim.api
+
 ---@param edit copilotlsp.InlineEdit
 function M.apply_inline_edit(edit)
     local bufnr = vim.uri_to_bufnr(edit.textDocument.uri)
@@ -7,6 +10,27 @@ function M.apply_inline_edit(edit)
     vim.lsp.util.apply_text_edits({ edit }, bufnr, "utf-16")
 end
 
+--- Checks if Copilot should attach to a buffer
+---@param bufnr integer
+---@return boolean
+function M.should_attach_to_buffer(bufnr)
+    if
+        not vim.fn.getbufvar(bufnr, "&buflisted") == 1
+        or vim.bo[bufnr].buftype ~= ""
+        or not api.nvim_buf_is_valid(bufnr)
+        or not api.nvim_buf_is_loaded(bufnr)
+    then
+        return false
+    end
+    local name = api.nvim_buf_get_name(bufnr)
+    for _, b_name in ipairs(config.nes.buffer_blacklist or {}) do
+        if name:match(b_name) then
+            return false
+        end
+    end
+    return true
+end
+
 ---Debounces calls to a function, and ensures it only runs once per delay
 ---even if called repeatedly.
 ---@param fn fun(...: any)