LuaLS 语言服务器：提升独立诊断报告在 CI 中的可用性实践

LuaLS（Lua Language Server）作为 Lua 生态中强大的语言服务器，其独立诊断模式（--check）为开发者提供了静态代码分析能力。本文将深入探讨如何优化该功能在持续集成环境中的使用体验。

诊断模式的现状与挑战

LuaLS 的 --check 模式会生成 check.json 文件记录所有诊断结果，但存在两个主要使用痛点：

1. 无论是否发现代码问题，程序始终返回 0 退出码
2. 诊断结果仅输出到文件，不直接显示在控制台

这种设计在 CI/CD 环境中会带来额外处理负担，开发者需要：

• 手动解析 JSON 文件查看问题
• 自行实现退出码判断逻辑

解决方案实践

方案一：使用专用工具 llscheck

社区开发者已经创建了专用工具 llscheck，它封装了 LuaLS 的诊断功能，提供了：

• 自动非零退出码（当发现问题时）
• 格式化控制台输出
• 简化的命令行接口

方案二：基于 jq 的原生方案

对于希望保持最小依赖的团队，可以使用 jq 工具处理 check.json：

${LUALS_PATH}/bin/lua-language-server --check=. --num_threads=2 --checklevel=Error

# 使用jq解析并格式化输出
jq -r '
    to_entries[] |
      (.key | sub("^.*?\\./"; "")) as $file | 
    .value[] |
      .code as $title |
      (.range.start.line + 1) as $line |
      (.range.start.character + 1) as $col |
      .message as $message |
    "\($file):\($line):\($col)::\($message)\n" +
    "::error file=\($file),line=\($line),col=\($col),title=\($title)::\($message)"
' ${LUALS_RESULT_FILE}

# 根据结果数量设置退出码
test "$(jq 'to_entries|length' check.json)" -gt 0

该方案的核心是：

1. 使用 to_entries 将 JSON 对象转换为键值对数组
2. 提取文件名并清理路径
3. 遍历所有诊断结果，提取关键信息
4. 格式化输出为易读的文本
5. 根据结果数量设置适当的退出码

技术原理详解

check.json 采用分层结构存储诊断结果：

{
  "filename1": [
    {诊断结果对象1},
    {诊断结果对象2}
  ]
}

每个诊断结果对象包含：

• code：问题类型标识
• range：问题位置范围（含行列信息）
• message：详细描述

jq 处理流程相当于以下伪代码：

for 文件名, 结果列表 in pairs(诊断数据) do
  for 诊断结果 in ipairs(结果列表) do
    输出格式化信息(文件名, 诊断结果)
  end
end

最佳实践建议

1. 日志级别控制：根据需求设置 --checklevel（Off/Error/Warning/Information/Hint）
2. 线程优化：合理设置 --num_threads 参数提升检查速度
3. 路径处理：注意工作目录和相对路径的转换
4. 结果过滤：可通过 jq 进一步筛选特定类型的问题

未来改进方向

虽然现有方案能解决问题，但理想情况下 LuaLS 应原生支持：

1. 可配置的退出码行为
2. 格式化控制台输出选项
3. 更灵活的结果过滤机制

这些改进将进一步提升 LuaLS 在自动化流程中的易用性。