style: naming-convention (#32)

add plugin prefix

* `CopilotLsp` for highlight groups
* `copilotlsp.` for augroups, namespace and type annotations

Author: Xuyuanp

lsp/copilot_ls.lua

@@ -30,11 +30,11 @@ return {
     }),
     root_dir = vim.uv.cwd(),
     on_init = function(client)
-        vim.api.nvim_set_hl(0, "NesAdd", { link = "DiffAdd", default = true })
-        vim.api.nvim_set_hl(0, "NesDelete", { link = "DiffDelete", default = true })
-        vim.api.nvim_set_hl(0, "NesApply", { link = "DiffText", default = true })
+        vim.api.nvim_set_hl(0, "CopilotLspNesAdd", { link = "DiffAdd", default = true })
+        vim.api.nvim_set_hl(0, "CopilotLspNesDelete", { link = "DiffDelete", default = true })
+        vim.api.nvim_set_hl(0, "CopilotLspNesApply", { link = "DiffText", default = true })
 
-        local au = vim.api.nvim_create_augroup("copilot-language-server", { clear = true })
+        local au = vim.api.nvim_create_augroup("copilotlsp.init", { clear = true })
         --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/nes/init.lua

@@ -4,7 +4,7 @@ local utils = require("copilot-lsp.util")
 
 local M = {}
 
-local nes_ns = vim.api.nvim_create_namespace("copilot-nes")
+local nes_ns = vim.api.nvim_create_namespace("copilotlsp.nes")
 
 ---@param err lsp.ResponseError?
 ---@param result copilotlsp.copilotInlineEditResponse

lua/copilot-lsp/nes/ui.lua

@@ -31,7 +31,7 @@ end
 
 ---@private
 ---@param suggestion copilotlsp.InlineEdit
----@return nes.LineCalculationResult
+---@return copilotlsp.nes.LineCalculationResult
 function M._calculate_lines(suggestion)
     local deleted_lines_count = suggestion.range["end"].line - suggestion.range.start.line
     local added_lines = vim.split(trim_end(suggestion.newText), "\n")
@@ -54,7 +54,7 @@ function M._calculate_lines(suggestion)
     -- end
 
     -- Calculate positions for delete highlight extmark
-    ---@type nes.DeleteExtmark
+    ---@type copilotlsp.nes.DeleteExtmark
     local delete_extmark = {
         row = suggestion.range.start.line,
         end_row = (
@@ -64,7 +64,7 @@ function M._calculate_lines(suggestion)
     }
 
     -- Calculate positions for virtual lines extmark
-    ---@type nes.VirtLinesExtmark
+    ---@type copilotlsp.nes.AddExtmark
     local virt_lines_extmark = {
         row = (
             suggestion.range["end"].character ~= 0 and suggestion.range["end"].line
@@ -104,7 +104,7 @@ function M._display_next_suggestion(edits, ns_id)
     if lines.deleted_lines_count > 0 then
         -- Deleted range red highlight
         vim.api.nvim_buf_set_extmark(bufnr, ns_id, lines.delete_extmark.row, 0, {
-            hl_group = "NesDelete",
+            hl_group = "CopilotLspNesDelete",
             end_row = lines.delete_extmark.end_row,
         })
     end

lua/copilot-lsp/types.lua

@@ -8,24 +8,24 @@
 ---@class copilotlsp.copilotInlineEditResponse
 ---@field edits copilotlsp.InlineEdit[]
 
----@class nes.EditSuggestionUI
+---@class copilotlsp.nes.EditSuggestionUI
 ---@field preview_winnr? integer
 
----@class nes.DeleteExtmark
+---@class copilotlsp.nes.DeleteExtmark
 --- Holds row information for delete highlight extmark.
 ---@field row number
 ---@field end_row number
 
----@class nes.VirtLinesExtmark
+---@class copilotlsp.nes.AddExtmark
 -- Holds row and virtual lines count for virtual lines extmark.
 ---@field row number
 ---@field virt_lines_count number
 
----@class nes.LineCalculationResult
+---@class copilotlsp.nes.LineCalculationResult
 --- The result of calculating lines for inline suggestion UI.
 ---@field deleted_lines_count number
 ---@field added_lines string[]
 ---@field added_lines_count number
 ---@field same_line number
----@field delete_extmark nes.DeleteExtmark
----@field virt_lines_extmark nes.VirtLinesExtmark
+---@field delete_extmark copilotlsp.nes.DeleteExtmark
+---@field virt_lines_extmark copilotlsp.nes.AddExtmark

lua/copilot-lsp/util.lua

@@ -109,7 +109,7 @@ end
 function M.hl_text_to_virt_lines(text, lang)
     local lines = vim.split(text, "\n")
     local normal_hl = "Normal"
-    local bg_hl = "NesAdd"
+    local bg_hl = "CopilotLspNesAdd"
 
     local function hl_chunk(chunk, hl)
         if not hl then

tests/nes/test_nes.lua

@@ -112,8 +112,8 @@ T["nes"]["highlights replacement"] = function()
     child.lua_func(function()
         vim.cmd([[colorscheme vim]])
         vim.treesitter.start(0)
-        vim.cmd([[hi! NesAdd guifg=NONE guibg=NONE]])
-        vim.cmd([[hi! NesDelete guifg=NONE guibg=NONE]])
+        vim.cmd([[hi! CopilotLspNesAdd guifg=NONE guibg=NONE]])
+        vim.cmd([[hi! CopilotLspNesDelete guifg=NONE guibg=NONE]])
     end)
     ref(child.get_screenshot())
     vim.uv.sleep(500)

tests/nes/test_ui.lua

@@ -4,7 +4,7 @@ local nes_ui = require("copilot-lsp.nes.ui")
 local T = MiniTest.new_set()
 
 T["diff placement calculations"] = MiniTest.new_set({
-    ---@type [ copilotlsp.InlineEdit, nes.LineCalculationResult][]
+    ---@type [ copilotlsp.InlineEdit, copilotlsp.nes.LineCalculationResult][]
     parametrize = {
         {
             --- Same line edit
@@ -149,7 +149,7 @@ T["diff placement calculations"] = MiniTest.new_set({
 
 T["diff placement calculations"]["calculates locations"] =
     ---@param edit copilotlsp.InlineEdit
-    ---@param result nes.LineCalculationResult
+    ---@param result copilotlsp.nes.LineCalculationResult
     function(edit, result)
         local placement = nes_ui._calculate_lines(edit)
         eq(result, placement)