refactor(nes): add calc helper and type annotations (#1)

* refactor(nes): add calc helper and type annotations

* ci: add format, lint, test, typecheck workflows

Introduce GitHub workflows for Lua formatting, linting, testing, and
type checking. Also update luacheck globals, add a minimal init, and
provide a Makefile test target to streamline local test execution.

* fixup

Author: tris203

.github/workflows/format.yml

@@ -0,0 +1,33 @@
+---
+name: Format
+
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+    branches:
+      - "main"
+
+jobs:
+  format:
+    name: Stylua
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: date +%W > weekly
+
+      - name: Restore cache
+        id: cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/bin
+          key: ${{ runner.os }}-cargo-${{ hashFiles('weekly') }}
+
+      - name: Install
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: cargo install stylua
+
+      - name: Format
+        run: stylua --check lua/ --config-path=.stylua.toml

.github/workflows/lint.yml

@@ -0,0 +1,25 @@
+---
+name: Lint
+
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+    branches:
+      - "main"
+
+jobs:
+  lint:
+    name: Luacheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup
+        run: |
+            sudo apt-get update
+            sudo apt-get install luarocks -y
+            sudo luarocks install luacheck
+
+      - name: Lint
+        run: luacheck lua/ --globals vim

.github/workflows/tests.yml

@@ -0,0 +1,30 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+    branches:
+      - "main"
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        nvim-versions: ['stable', 'nightly']
+        os: [ubuntu-latest, windows-latest, macos-latest]
+      fail-fast: false
+    name: Plenary Tests
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+
+      - uses: rhysd/action-setup-vim@v1
+        with:
+          neovim: true
+          version: ${{ matrix.nvim-versions }}
+
+      - name: run tests
+        run: make test

.github/workflows/typecheck.yml

@@ -0,0 +1,22 @@
+---
+name: lua_ls-typecheck
+
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+    branches:
+      - "main"
+
+jobs:
+  build:
+    name: Type Check Code Base
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: stevearc/nvim-typecheck-action@v2
+        with:
+          level: Warning
+          configpath: ".luarc.json"

.luacheckrc

@@ -1 +1 @@
-globals = { "vim", "describe", "it", "before_each", "after_each", "assert", "async" }
+globals = { "vim", "describe", "it", "before_each", "after_each", "assert", "async", "MiniTest" }

.luarc.json

@@ -10,6 +10,7 @@
         "describe",
         "it",
         "before_each",
+        "MiniTest",
         "after_each"
     ]
 }

Makefile

@@ -0,0 +1,11 @@
+TESTS_INIT=scripts/minimal_init.lua
+TESTS_DIR=tests/
+
+.PHONY: test
+
+test:
+	@nvim \
+		--headless \
+		--noplugin \
+		-u ${TESTS_INIT} \
+		-c "lua MiniTest.run()" \

lua/copilot-lsp/completion/init.lua

@@ -1,26 +1,26 @@
 local M = {}
 
----@param results table<integer, { err: lsp.ResponseError, result: lsp.InlineCompletionList}>
+---@param _results table<integer, { err: lsp.ResponseError, result: lsp.InlineCompletionList}>
 ---@param _ctx lsp.HandlerContext
 ---@param _config table
-local function handle_inlineCompletion_response(results, _ctx, _config)
-    -- Filter errors from results
-    local results1 = {} --- @type table<integer,lsp.InlineCompletionList>
-
-    for client_id, resp in pairs(results) do
-        local err, result = resp.err, resp.result
-        if err then
-            vim.lsp.log.error(err.code, err.message)
-        elseif result then
-            results1[client_id] = result
-        end
-    end
-
-    for _, result in pairs(results1) do
-        --TODO: Ghost text for completions
-        -- This is where we show the completion results
-        -- However, the LSP being named "copilot" is enough for blink-cmp to show the completion
-    end
+local function handle_inlineCompletion_response(_results, _ctx, _config)
+    -- -- Filter errors from results
+    -- local results1 = {} --- @type table<integer,lsp.InlineCompletionList>
+    --
+    -- for client_id, resp in pairs(results) do
+    --     local err, result = resp.err, resp.result
+    --     if err then
+    --         vim.lsp.log.error(err.code, err.message)
+    --     elseif result then
+    --         results1[client_id] = result
+    --     end
+    -- end
+    --
+    -- for _, result in pairs(results1) do
+    --     --TODO: Ghost text for completions
+    --     -- This is where we show the completion results
+    --     -- However, the LSP being named "copilot" is enough for blink-cmp to show the completion
+    -- end
 end
 
 ---@param type lsp.InlineCompletionTriggerKind

lua/copilot-lsp/nes/ui.lua

@@ -23,6 +23,53 @@ function M.clear_suggestion(bufnr, ns_id)
     vim.b[bufnr].nes_state = nil
 end
 
+---@private
+---@param suggestion copilotlsp.InlineEdit
+---@return nes.LineCalculationResult
+function M._calculate_lines(suggestion)
+    local deleted_lines_count = suggestion.range["end"].line - suggestion.range.start.line
+    local added_lines = vim.split(suggestion.newText, "\n")
+    local added_lines_count = suggestion.newText == "" and 0 or #added_lines
+    local same_line = 0
+
+    if deleted_lines_count == 0 and added_lines_count == 1 then
+        ---changing within line
+        deleted_lines_count = 1
+        same_line = 1
+    end
+
+    -- Calculate positions for delete highlight extmark
+    ---@type nes.DeleteExtmark
+    local delete_extmark = {
+        row = suggestion.range.start.line,
+        end_row = suggestion.range["end"].line + 1,
+    }
+
+    -- Calculate positions for virtual lines extmark
+    ---@type nes.VirtLinesExtmark
+    local virt_lines_extmark = {
+        row = suggestion.range["end"].line,
+        virt_lines_count = added_lines_count,
+    }
+
+    -- Calculate positions for floating window
+    ---@type nes.FloatWin
+    local float_win = {
+        height = #added_lines,
+        row = suggestion.range["end"].line + deleted_lines_count + 1,
+    }
+
+    return {
+        deleted_lines_count = deleted_lines_count,
+        added_lines = added_lines,
+        added_lines_count = added_lines_count,
+        same_line = same_line,
+        delete_extmark = delete_extmark,
+        virt_lines_extmark = virt_lines_extmark,
+        float_win = float_win,
+    }
+end
+
 ---@private
 ---@param edits copilotlsp.InlineEdit[]
 ---@param ns_id integer
@@ -36,38 +83,29 @@ function M._display_next_suggestion(edits, ns_id)
     local suggestion = edits[1]
 
     local ui = {}
-    local deleted_lines_count = suggestion.range["end"].line - suggestion.range.start.line
-    local added_lines = vim.split(suggestion.newText, "\n")
-    local added_lines_count = suggestion.newText == "" and 0 or #added_lines
-    local same_line = 0
-
-    if deleted_lines_count == 0 and added_lines_count == 1 then
-        ---changing within line
-        deleted_lines_count = 1
-        same_line = 1
-    end
+    local lines = M._calculate_lines(suggestion)
 
-    if deleted_lines_count > 0 then
+    if lines.deleted_lines_count > 0 then
         -- Deleted range red highlight
-        vim.api.nvim_buf_set_extmark(bufnr, ns_id, suggestion.range.start.line, 0, {
+        vim.api.nvim_buf_set_extmark(bufnr, ns_id, lines.delete_extmark.row, 0, {
             hl_group = "NesDelete",
-            end_row = suggestion.range["end"].line + 1,
+            end_row = lines.delete_extmark.end_row,
         })
     end
-    if added_lines_count > 0 then
+    if lines.added_lines_count > 0 then
         -- Create space for float
         local virt_lines = {}
-        for _ = 1, added_lines_count do
+        for _ = 1, lines.virt_lines_extmark.virt_lines_count do
             table.insert(virt_lines, {
                 { "", "Normal" },
             })
         end
-        vim.api.nvim_buf_set_extmark(bufnr, ns_id, suggestion.range["end"].line, 0, {
+        vim.api.nvim_buf_set_extmark(bufnr, ns_id, lines.virt_lines_extmark.row, 0, {
             virt_lines = virt_lines,
         })
 
         local preview_bufnr = vim.api.nvim_create_buf(false, true)
-        vim.api.nvim_buf_set_lines(preview_bufnr, 0, -1, false, added_lines)
+        vim.api.nvim_buf_set_lines(preview_bufnr, 0, -1, false, lines.added_lines)
         vim.bo[preview_bufnr].modifiable = false
         vim.bo[preview_bufnr].buflisted = false
         vim.bo[preview_bufnr].bufhidden = "wipe"
@@ -79,8 +117,8 @@ function M._display_next_suggestion(edits, ns_id)
         local preview_winnr = vim.api.nvim_open_win(preview_bufnr, false, {
             relative = "cursor",
             width = win_width - offset,
-            height = #added_lines,
-            row = (suggestion.range["end"].line + deleted_lines_count + 1) - cursor[1],
+            height = lines.float_win.height,
+            row = lines.float_win.row - cursor[1],
             col = 0,
             style = "minimal",
             border = "none",

lua/copilot-lsp/types.lua

@@ -15,3 +15,28 @@
 ---@class nes.Apply.Opts
 ---@field jump? boolean | { hl_timeout: integer? } auto jump to the end of the new edit
 ---@field trigger? boolean auto trigger the next edit suggestion
+
+---@class nes.DeleteExtmark
+--- Holds row information for delete highlight extmark.
+---@field row number
+---@field end_row number
+
+---@class nes.VirtLinesExtmark
+-- Holds row and virtual lines count for virtual lines extmark.
+---@field row number
+---@field virt_lines_count number
+
+---@class nes.FloatWin
+--- Defines dimensions and position for the floating window.
+---@field height number
+---@field row number
+
+---@class 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 float_win nes.FloatWin