neovim/test/functional/plugin/lsp/inlay_hint_spec.lua

local helpers = require('test.functional.helpers')(after_each)
local lsp_helpers = require('test.functional.plugin.lsp.helpers')
local Screen = require('test.functional.ui.screen')

local eq = helpers.eq
local dedent = helpers.dedent
local exec_lua = helpers.exec_lua
local insert = helpers.insert

local clear_notrace = lsp_helpers.clear_notrace
local create_server_definition = lsp_helpers.create_server_definition

before_each(function()
  clear_notrace()
end)

after_each(function()
  exec_lua("vim.api.nvim_exec_autocmds('VimLeavePre', { modeline = false })")
end)

describe('inlay hints', function()
  local screen
  before_each(function()
    screen = Screen.new(50, 9)
    screen:attach()
  end)

  describe('general', function()
    local text = dedent([[
    auto add(int a, int b) { return a + b; }

    int main() {
        int x = 1;
        int y = 2;
        return add(x,y);
    }
    }]])


    local response = [==[
    [
    {"kind":1,"paddingLeft":false,"label":"-> int","position":{"character":22,"line":0},"paddingRight":false},
    {"kind":2,"paddingLeft":false,"label":"a:","position":{"character":15,"line":5},"paddingRight":true},
    {"kind":2,"paddingLeft":false,"label":"b:","position":{"character":17,"line":5},"paddingRight":true}
    ]
    ]==]


    before_each(function()
      exec_lua(create_server_definition)
      exec_lua([[
        local response = ...
        server = _create_server({
          capabilities = {
            inlayHintProvider = true,
          },
          handlers = {
            ['textDocument/inlayHint'] = function()
              return vim.json.decode(response)
            end,
          }
        })
      ]], response)
    end)

    it(
      'inlay hints are applied when vim.lsp.inlay_hint(true) is called',
      function()
        local res = exec_lua([[
          bufnr = vim.api.nvim_get_current_buf()
          vim.api.nvim_win_set_buf(0, bufnr)
          client_id = vim.lsp.start({ name = 'dummy', cmd = server.cmd })
          local client = vim.lsp.get_client_by_id(client_id)
          return {
            supports_method = client.supports_method("textDocument/inlayHint")
          }
        ]])
        eq(res, { supports_method = true })


        insert(text)
        exec_lua([[vim.lsp.inlay_hint(bufnr, true)]])
        screen:expect({
          grid = [[
  auto add(int a, int b)-> int { return a + b; }    |
                                                    |
  int main() {                                      |
      int x = 1;                                    |
      int y = 2;                                    |
      return add(a: x,b: y);                        |
  }                                                 |
  ^}                                                 |
                                                    |
]]
        })
      end)

    it(
      'inlay hints are cleared when vim.lsp.inlay_hint(false) is called',
      function()
        exec_lua([[
        bufnr = vim.api.nvim_get_current_buf()
        vim.api.nvim_win_set_buf(0, bufnr)
        client_id = vim.lsp.start({ name = 'dummy', cmd = server.cmd })
      ]])

        insert(text)
        exec_lua([[vim.lsp.inlay_hint(bufnr, true)]])
        screen:expect({
          grid = [[
  auto add(int a, int b)-> int { return a + b; }    |
                                                    |
  int main() {                                      |
      int x = 1;                                    |
      int y = 2;                                    |
      return add(a: x,b: y);                        |
  }                                                 |
  ^}                                                 |
                                                    |
]]
        })
        exec_lua([[vim.lsp.inlay_hint(bufnr, false)]])
        screen:expect({
          grid = [[
  auto add(int a, int b) { return a + b; }          |
                                                    |
  int main() {                                      |
      int x = 1;                                    |
      int y = 2;                                    |
      return add(x,y);                              |
  }                                                 |
  ^}                                                 |
                                                    |
]],
          unchanged = true
        })
      end)

    it(
      'inlay hints are cleared when the client detaches',
      function()
        exec_lua([[
          bufnr = vim.api.nvim_get_current_buf()
          vim.api.nvim_win_set_buf(0, bufnr)
          client_id = vim.lsp.start({ name = 'dummy', cmd = server.cmd })
        ]])

        insert(text)
        exec_lua([[vim.lsp.inlay_hint(bufnr, true)]])
        screen:expect({
          grid = [[
  auto add(int a, int b)-> int { return a + b; }    |
                                                    |
  int main() {                                      |
      int x = 1;                                    |
      int y = 2;                                    |
      return add(a: x,b: y);                        |
  }                                                 |
  ^}                                                 |
                                                    |
]]
        })
        exec_lua([[vim.lsp.stop_client(client_id)]])
        screen:expect({
          grid = [[
  auto add(int a, int b) { return a + b; }          |
                                                    |
  int main() {                                      |
      int x = 1;                                    |
      int y = 2;                                    |
      return add(x,y);                              |
  }                                                 |
  ^}                                                 |
                                                    |
]],
          unchanged = true
        })
      end)

    it(
      'inlay hints are not cleared when one of several clients detaches',
      function()
        -- Start two clients
        exec_lua([[
          bufnr = vim.api.nvim_get_current_buf()
          vim.api.nvim_win_set_buf(0, bufnr)
          server2 = _create_server({
            capabilities = {
              inlayHintProvider = true,
            },
            handlers = {
              ['textDocument/inlayHint'] = function()
                return {}
              end,
            }
          })
          client1 = vim.lsp.start({ name = 'dummy', cmd = server.cmd })
          client2 = vim.lsp.start({ name = 'dummy2', cmd = server2.cmd })
        ]])

        insert(text)
        exec_lua([[vim.lsp.inlay_hint(bufnr, true)]])
        screen:expect({
          grid = [[
  auto add(int a, int b)-> int { return a + b; }    |
                                                    |
  int main() {                                      |
      int x = 1;                                    |
      int y = 2;                                    |
      return add(a: x,b: y);                        |
  }                                                 |
  ^}                                                 |
                                                    |
]]
        })

        -- Now stop one client
        exec_lua([[ vim.lsp.stop_client(client2) ]])

        -- We should still see the hints
        screen:expect({
          grid = [[
  auto add(int a, int b)-> int { return a + b; }    |
                                                    |
  int main() {                                      |
      int x = 1;                                    |
      int y = 2;                                    |
      return add(a: x,b: y);                        |
  }                                                 |
  ^}                                                 |
                                                    |
]],
          unchanged = true
        })
      end)
  end)
end)