scout-create-scaffold

Generates Scout test scaffolds for Kibana plugins and packages.

21.2k|8.6k|Updated Jan 26, 2013
One-click install
npx skills add https://github.com/elastic/kibana --skill scout-create-scaffold
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: scout-create-scaffold
Source: https://github.com/elastic/kibana/tree/main/.agents/skills/scout-create-scaffold
Command: npx skills add https://github.com/elastic/kibana --skill scout-create-scaffold

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automates the creation of initial directory structures and configuration files for Scout tests within Kibana plugins or packages, streamlining the setup process for new test suites.

Core Features & Use Cases

  • Scaffold Generation: Creates Playwright configurations, fixtures, and example specs for API and/or UI tests.
  • Customizable Scaffolding: Allows specifying the module path, test type (API, UI, or both), and custom Scout directory names.
  • Use Case: When starting a new Kibana plugin that requires automated testing, use this Skill to quickly set up the necessary test/scout/api and test/scout/ui directories with all essential files.

Quick Start

Run the scout-create-scaffold skill to generate an API and UI test scaffold for the 'maps' module.

Frequently Asked Questions about scout-create-scaffold

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate Playwright test scaffolds for Kibana plugins?

You can generate Playwright test scaffolds for Kibana plugins by running an interactive Node.js script that creates the necessary directory structures, configurations, fixtures, and example specifications.

Can I create both API and UI test configurations at the same time?

Yes, you can create both API and UI test configurations simultaneously by specifying both test types during scaffold generation, which sets up `test/scout/api` and `test/scout/ui` directories with all essential files.

What is a Scout test scaffold used for in Kibana?

A Scout test scaffold in Kibana is used to establish the initial directory structure and configuration files for automated Playwright testing, streamlining the setup process for new test suites.

Does Scout scaffold generation support custom directory naming and parallel execution?

Yes, Scout scaffold generation supports custom directory naming and includes options for parallel execution when creating Playwright configurations and fixtures for Kibana packages.

How do I repair existing Scout test configurations for a Kibana package?

To repair existing Scout test configurations, run the scaffold generation script to fix or regenerate Playwright configurations, fixtures, and example specifications for your Kibana packages.