SuperAPI AI 工具集

scout-create-scaffold

编程与开发

查看项目

更新于 10-15 21:37

技能介绍

用途:为 Kibana 插件/包生成或修复 Scout 测试脚手架,覆盖 API 与 UI 的 Playwright 配置、fixtures 和示例 spec。

主要能力:通过生成器创建 API 脚手架(playwright.config.ts、fixtures/constants.ts、fixtures/index.ts、tests/example.spec.ts)与 UI 脚手架(顺序模式含 page_objects;并行模式含 parallel.playwright.config.ts、parallel_tests 示例与 global.setup.ts)。支持自定义 Scout 根目录(scout_<configSet>)和大型插件的功能命名空间。

使用方式:在 Kibana 仓库根运行 node scripts/scout generate --path <moduleRoot> --type <api|ui|both>。常用变体:--no-ui-parallel 生成顺序 UI;--scout-root scout_<configSet> 指定自定义根;--namespace <namespace> 生成命名空间;已存在 Scout 目录时需加 --force。生成后按 Pattern A(插件根 tsconfig include test/<scout-root>/**/* 并加 kbn_references)或 Pattern B(在 <scout-content-root>/{ui,api} 下建独立 tsconfig.json)接入类型检查,再运行 yarn kbn bootstrap,并用 node scripts/type_check --project <tsconfig> 验证。

适用场景:新建 Kibana 插件/包的 Scout 测试、为大型插件划分功能区域、需要并行或顺序 UI 测试、使用自定义 server config set 时。

限制:生成器不修改已存在的 test/<scout-root>/{api,ui} 或命名空间子目录;不创建 tsconfig.json;不生成 global.teardown.ts,需自行添加 globalTeardownHook(...);同一 Scout 根下不可混用根级 {ui,api} 与命名空间;Pattern B 不允许从 ui/api 目录相对导入到 server/ 或 public/;自定义 config set 通常还需在 kbn-scout 的 config_sets 下提供匹配 server 配置,start-server 需 --serverConfigSet。无需运行 node scripts/scout update-test-config-manifests。