jest-lua Companion CLI

致谢：

• jackTabsCode
• charm-example

功能

• 通过命令行运行, 命令Roblox Studio运行测试
• 在命令行打印测试结果
• 将测试结果中的堆栈信息, 转化为本地路径

配置

在项目根目录下创建 jest-lua-companion.config.json 文件：

{
  "roots": ["ServerScriptService/TS/Runtime"],
  "runCLI-options": {
    "ci": true,
    "clearMocks": true,
    "testNamePattern": "test.*",
    "testMatch": ["**/*.spec.lua"],
    "verbose": true
  },
  "rojoSourceMapCommand": "rojo sourcemap"
}

• roots: 待测试的 DataModel 路径,以 / 分割. 必填
• runCLI-options: 默认为空
  • 文档, 数组以 | 分割
  • 特例,SetupFiles: 在littensy的例子中, 将 SetupFiles 对象也放到了 runCLI-options 中, 而在官方文档中, 没有获得明确信息.
  • 此处我选择为例子中的SetupFile提供默认支持,硬编码到了插件内.
  • 如果你配置更多的SetupFiles, 请在runCLI-options中配置以 |分割的DataModel路径, 同 roots 配置方式.
• rojoSourceMapCommand: 用于获取 rojo sourcemap 的 stdout 的指令. 默认为空.

安装

注意: 仅支持windows

安装包

npm install jest-lua-companion-cli

安装插件

复制 Plugin/jest-lua-companion-plugin.server.lua 到 roblox 插件目录.

用法

查看帮助

npx jest-lua-companion-cli -h

运行测试

npx jest-lua-companion-cli

cli选项

支持所有 jest-lua 的 CLI 选项, 比如:

npx jest-lua-companion-cli -t "testName"

只需在终端运行 jest-lua-companion-cli。如果有多个 Place 打开，会提示你选择一个。随后会输出测试结果！

你也可以将其加入 pre-commit 钩子，在提交前确保测试通过（当然，需要你的 Place 已在 Studio 中打开）。

FFlag

必须配置指定FFlag后, 才能在Studio中运行测试.

• shell:charm-example
• windows: npx jest-lua-companion init, 本指令会同时复制插件到 roblox 插件目录, 并进行FFlag修改.
• 手工: 修改 Studio 安装目录下的 ClientSettings/ClientAppSettings.json 文件, 设置FFlagEnableLoadModule 为 true.

其他

• 本地服务和roblox插件指向: http://127.0.0.1:28860