Zig Language Extras：提升Zig开发效率的VSCode扩展

Zig Language Extras是一款专为Zig开发者设计的VSCode扩展，旨在简化和优化您的开发流程。它提供了以下命令，帮助您更高效地进行Zig开发：

• Zig extras: Run single test：运行单个测试
• Zig extras: Run file tests：运行文件中的所有测试
• Zig extras: Test workspace：测试整个工作空间
• Zig extras: Build workspace：构建整个工作空间
• Zig extras: Debug test：调试单个测试
• Zig extras: Debug binary：调试二进制文件

此外，该扩展还会在测试上方显示代码镜头（code lenses），方便您运行或调试单个测试，并在文件的第一行显示代码镜头，运行所有测试。

Zig Language Extras依赖于以下几个扩展：

• Zig Language：用于定位Zig二进制文件
• Native Debug：用于在Linux上进行调试
• CodeLLDB：用于在MacOS上进行调试
• C/C++：用于在Windows上进行调试

开发此扩展的主要动机是为了从Zig命令输出中创建精细的VSCode问题描述。测试运行时，输出可能会有几种不同的版本，例如构建失败、测试失败或运行测试时触发断言。所有这些输出的格式都不同，难以用单一的正则表达式处理。因此，我采用了更程序化的方法，通过逐行分析Zig命令输出。

大多数命令期望使用'zig init-exe'或'zig init-lib'构建的文件夹结构，根目录下有build.zig文件，源文件位于src文件夹下。包含build.zig的文件夹被认为是VSCode工作空间的根目录。

测试

• 'Test workspace'：在工作空间根目录运行zig build test，依赖于build.zig中的测试定义。
• 'Run file tests'：运行当前文件中的所有测试，即zig test {file_name}。
• 'Run single tests'：尝试从当前位置查找测试名称。首先向上搜索以找到测试名称，如果未找到则向下搜索。如果您位于测试中，将运行该测试。如果您位于代码中且测试位于代码下方，将找到第一个测试。

如果需要使用额外的测试命令参数，请在工作空间配置中设置testArgs变量。例如，在依赖zlib的项目中，我使用以下配置：

{
    "zig-language-extras.testArgs": "--deps zlib=zlib --mod zlib::../zig-zlib/src/main.zig --library z",
}

构建

• 'Build workspace'：在工作空间根目录运行zig build。

调试

有两个调试命令：

• 'Debug test'：为测试构建二进制文件（二进制文件位置：zig-out/debug/test），并在该二进制文件上启动调试器。在运行命令前，请在测试中设置断点。
• 'Debug binary'：首先构建工作空间，然后启动二进制文件zig-out/bin/{name}。如果当前文件位于src文件夹中，名称设置为src文件夹上方的文件夹名称，预期为工作空间的根目录。如果当前文件位于其他文件夹中，则使用当前文件的名称作为二进制文件的名称，除非该文件名为main.zig，则使用该文件所在文件夹的名称作为预期的二进制文件名称。

您可以通过设置来修改调试器："zig-language-extras.debugType": "type"。Type指的是您在launch.json文件中使用的具体"type"字段。

各个平台的默认调试器类型如下：

• "lldb" for darwin platform
• "cppvsdbg" for win32 platform
• "gdb" for other platforms

快捷键提示

在添加快捷键时，您可以限制其仅在Zig语言文件中使用：

  // Zig extras: Run file tests
  {
      "key": "ctrl j t",
      "command": "zig-language-extras.runFileTests",
      "when": "editorLangId == 'zig'"
  },
  // Zig extras: Run single test
  {
      "key": "ctrl j s",
      "command": "zig-language-extras.runSingleTest",
      "when": "editorLangId == 'zig'"
  },

扩展开发

Zig命令输出解析器位于src/parser.ts，对应的测试位于src/test/suite/parser.test.ts。

解析器测试用例位于src/test/suite/testdata中的文件中。每个用例的.txt文件都有对应的预期解析输出在_expected.json文件中。解析器测试加载所有txt文件，并期望得到与预期文件中的解析结果一致。

解析器不依赖于VSCode，因此可以在不运行VSCode的情况下进行测试：

mocha -ui tdd out/test/suite/parser.test.js

致谢

代码镜头的实现来自于Jarred-Sumner对原始vscode-zig扩展的拉取请求。