Neotest-Go 使用教程

Neotest-Go 使用教程

neotest-go项目地址:https://gitcode.com/gh_mirrors/ne/neotest-go

项目介绍

neotest-go 是一个为 Neotest 框架提供的 Go(lang) 适配器插件。Neotest 是一个用于 Neovim 的测试框架，支持多种编程语言的测试。neotest-go 插件使得在 Neovim 中运行和管理 Go 语言的测试变得更加方便。

项目快速启动

安装

使用 packer 进行安装：

use({
  "nvim-neotest/neotest",
  requires = {
    "nvim-neotest/neotest-go",  -- 你的其他测试适配器
  },
  config = function()
    -- 获取 neotest 命名空间（API 调用创建或返回命名空间）
    local neotest_ns = vim.api.nvim_create_namespace("neotest")
    vim.diagnostic.config({
      virtual_text = {
        format = function(diagnostic)
          local message = diagnostic.message:gsub("\n", " "):gsub("\t", " "):gsub("%s+", " "):gsub("^%s+", "")
          return message
        end
      }
    }, neotest_ns)

    require("neotest").setup({
      adapters = {
        require("neotest-go")
      }
    })
  end
})

配置

你可以通过 setup 函数提供可选参数来启用实验性功能或提供更多参数给 go test 命令：

require("neotest").setup({
  adapters = {
    require("neotest-go")({
      experimental = {
        test_table = true
      },
      args = {
        "-count=1",
        "-timeout=60s"
      }
    })
  }
})

使用

测试单个函数

将光标悬停在测试函数上并运行：

require('neotest').run.run()

测试文件

运行当前文件的测试：

require('neotest').run.run(vim.fn.expand('%'))

测试目录

运行指定目录的测试：

require('neotest').run.run("path/to/directory")

测试套件

运行整个项目的测试：

require('neotest').run.run(vim.fn.getcwd())

应用案例和最佳实践

案例一：使用 neotest-go 进行单元测试

假设你有一个 Go 项目，包含多个测试文件。你可以使用 neotest-go 插件来运行这些测试，并查看详细的测试结果。

1. 安装并配置 neotest-go：

   use({
     "nvim-neotest/neotest",
     requires = {
       "nvim-neotest/neotest-go",
     },
     config = function()
       require("neotest").setup({
         adapters = {
           require("neotest-go")
         }
       })
     end
   })
   

2. 运行测试：

   在 Neovim 中打开你的 Go 项目，然后运行：

   require('neotest').run.run(vim.fn.getcwd())
   

最佳实践

• 使用虚拟文本显示诊断信息：

  local neotest_ns = vim.api.nvim_create_namespace("neotest")
  vim.diagnostic.config({
    virtual_text = {
      format = function(diagnostic)
        local message = diagnostic.message:gsub("\n", " "):gsub("\t", " "):gsub("%s+", " "):gsub("^%s+", "")
        return message
      end
    }
  }, neotest_ns)
  

• 启用实验性功能：

  require("neotest").setup({
    adapters = {
      require("neotest-go")({
  
  

neotest-go项目地址:https://gitcode.com/gh_mirrors/ne/neotest-go