Test Framework Scaffolder

One-stop framework scaffolder for your next Playwright automation solution.

test-framework-scaffolder is an interactive, composable CLI generator for Playwright projects in TypeScript, JavaScript, Python, and Java. Every language supports BDD or TDD/Non-BDD plus focused UI, API, or combined automation scaffolds. Generated tests and steps use thin business calls through reusable app fixtures; Java projects can use either JUnit 5 or TestNG.

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

Requirements

Node.js 22 or newer and npm 10 or newer are recommended for developing and packaging the generator.

Local CLI usage

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

Or test 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, and Java with Maven. BDD uses playwright-bdd for TypeScript/JavaScript, pytest-bdd for Python, and Cucumber with either JUnit Platform or TestNG for Java.

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 six BDD/non-BDD × UI/API/UI+API combinations in temporary directories and assert inclusion/exclusion rules. See the README generated inside each project for framework commands, architecture, test data, secrets, 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