create-unified-playwright
v1.0.3
Published
A beautiful, colorful CLI to scaffold Playwright projects with TypeScript or JavaScript - inspired by GitHub Copilot CLI
Maintainers
Readme
Unified Playwright
A beautiful CLI tool to quickly scaffold Playwright projects with TypeScript or JavaScript.
🎭 Features
- Beautiful CLI Interface - Animated, colorful terminal interface inspired by GitHub CLI
- TypeScript & JavaScript Support - Choose your preferred language
- Pre-configured Templates - Ready-to-use Playwright configurations
- Example Tests - Get started immediately with sample test files
- Professional Setup - Best practices and recommended configurations out of the box
🚀 Quick Start
Create a new Playwright project with a single command:
npm init unified-playwright@latestOr using other package managers:
# Using yarn
yarn create unified-playwright
# Using pnpm
pnpm create unified-playwright📦 What You Get
When you run the CLI, it will:
- Display a beautiful welcome screen
- Ask for your project name
- Let you choose between TypeScript or JavaScript
- Create a complete project structure
- Install all necessary dependencies
- Provide helpful next steps
🛠️ Project Structure
TypeScript Template
my-playwright-project/
├── tests/
│ └── example.spec.ts
├── playwright.config.ts
├── tsconfig.json
├── package.json
└── .gitignoreJavaScript Template
my-playwright-project/
├── tests/
│ └── example.spec.js
├── playwright.config.js
├── package.json
└── .gitignore📝 Available Commands
Once your project is created, you can run:
# Run all tests
npx playwright test
# Open interactive UI mode
npx playwright test --ui
# Run tests in a specific browser
npx playwright test --project=chromium
# Run a specific test file
npx playwright test example
# Debug tests
npx playwright test --debug
# Generate tests with Codegen
npx playwright codegen
# View HTML report
npm run show-report🎨 CLI Features
- Gradient animations for a modern look
- Spinner animations during setup
- Interactive prompts for configuration
- Colorful output for better readability
- Progress indicators for installation steps
📋 Requirements
- Node.js 18.0.0 or higher
- npm, yarn, or pnpm
🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
📄 License
MIT
🌟 Credits
Built with:
- Playwright - Modern web testing framework
- Inquirer - Interactive prompts
- Chalk - Terminal styling
- Figlet - ASCII art
- Ora - Elegant terminal spinners
Happy Testing! 🎭
