| name | scout-create-scaffold |
| description | Generate or repair a Scout test scaffold for a Kibana plugin/package (test/scout*/{api,ui} Playwright configs, fixtures, example specs). Use when you need the initial Scout directory structure; prefer `node scripts/scout.js generate` with flags for non-interactive/LLM execution. |
Create Scout Scaffold (Generator-First)
Related skills
scout-migrate-from-ftr — After generating files, wire TypeScript for CI using Pattern A or Pattern B (Where Scout tests are typechecked in that skill). This skill documents layout; the migration skill has the full rules (relative imports, kbn_references, node scripts/type_check --project …).
Inputs to Collect
- Module root (repo-relative path to the plugin/package directory, e.g.
x-pack/platform/plugins/shared/maps)
- Test type:
api, ui, or both
- Scout root directory name under
<moduleRoot>/test/
- Default:
scout (creates <moduleRoot>/test/scout/...)
- Custom config set:
scout_<configSet> (for example scout_uiam_local, scout_cspm_agentless)
- For UI scaffolds: whether tests can run in parallel (space-isolated). Default is parallel; use sequential when isolation is not possible.
Generate (Preferred)
Run from the Kibana repo root:
node scripts/scout.js generate --path <moduleRoot> --type <api|ui|both>
Common variants:
node scripts/scout.js generate --path <moduleRoot> -- ui --no-ui-parallel
node scripts/scout.js generate --path <moduleRoot> -- both --scout-root scout_<configSet>
node scripts/scout.js generate --path <moduleRoot> -- both --force
