Test Framework Scaffolder

One-stop scaffolder for Playwright functional automation and k6 performance testing.

test-framework-scaffolder is an interactive, composable CLI generator for Playwright projects in TypeScript, JavaScript, Python, and Java, plus k6 performance projects with Grafana dashboards. It supports BDD or TDD/Non-BDD styles, focused UI/API automation, reusable app fixtures, Java with JUnit 5 or TestNG, configurable k6 load profiles, thresholds, Prometheus, and Grafana.

Open the complete illustrated installation and user guide for prompt choices, configuration, execution commands, reporting, CI, and troubleshooting.

Installation and quick start

The easiest option is to run the latest published version without installing it globally:

mkdir my-automation-projects
cd my-automation-projects
npx test-framework-scaffolder@latest

The CLI asks for the project name, language, BDD or Non-BDD style, framework options, and dependency installation. It prints the exact generated location and next commands when finished.

For an optional global installation:

npm install --global test-framework-scaffolder@latest
test-framework-scaffolder

Requirements

Node.js 22 or newer is required. Generated Python, Java, or k6 projects also require their respective runtime; Docker Compose is needed only for the local Grafana dashboard.

Local development

npm install
npm run build
npm link
test-framework-scaffolder

Run the unpublished local build without linking:

node dist/cli/index.js

The prompts choose project name, framework style, test type, Allure, GitHub Actions, and automatic dependency installation. Every project includes smoke and UAT data; runtime selection is centralized in config/run.config.json rather than asked during generation.

Language choices are TypeScript, JavaScript, Python with pytest, Java with Maven, and Performance with k6 + Grafana. BDD uses playwright-bdd for TypeScript/JavaScript, pytest-bdd for Python, Cucumber with either JUnit Platform or TestNG for Java, and a lightweight Given/When/Then specification and step layer for native k6 execution.

For a generated performance project, start Prometheus and Grafana and run the default profile with:

docker compose up -d
npm run test:grafana

Change environment or profile in config/run.config.json; any matching test-data/<environment>.json is loaded automatically. Override them temporarily with npm test -- --env uat --profile load.

Generator architecture

src/
├── cli/                 prompts, presentation, process orchestration
├── generators/          conditional project composition
├── utils/               validation and filesystem utilities
├── templates/
│   ├── common/          config, fixtures, data, scripts, docs
│   ├── bdd/             Gherkin, steps, playwright-bdd config
│   ├── non-bdd/         standard Playwright specs
│   ├── ui/              Page Object layer
│   ├── api/             request/client/service/model/validator layers
│   ├── allure/          runtime metadata
│   └── github/          CI workflow
└── types.ts

Templates are copied and composed based on the selected capabilities; unused test layers are removed. Placeholder substitution is limited to configuration values and small conditional source fragments—project files remain individually maintainable templates.

Development

npm run build
npm run typecheck
npm run lint
npm test
npm run format:check

Generator tests create all BDD/non-BDD × UI/API/UI+API combinations plus both k6 styles in temporary directories and assert inclusion/exclusion rules. See the README generated inside each project for framework commands, architecture, test data, observability, Allure, and CI guidance.

Publishing

Run the quality checks and preview the package before publishing: npm run typecheck, npm run lint, npm test, and npm pack --dry-run. npm package names are lowercase, so the registry name is test-framework-scaffolder; the product title is Test Framework Scaffolder.

License

MIT