create-playwright-seed

CLI tool for advanced configuration of Playwright projects. It first runs the standard Playwright initializer and then offers additional options for configuring TypeScript, ESLint, and Prettier.

Prerequisites

• Node.js: Recommended: 20.x LTS or 22.x LTS.

Usage

The simplest way is to use npm init:

npm init playwright-seed

Or run directly via npx:

npx create-playwright-seed

How It Works

1. Playwright Initialization: First, the official npm init playwright@latest command is executed, guiding you through the standard setup steps (choosing language, test folder, etc.).
2. Additional Configuration: After the basic setup is complete, the CLI will prompt you to select additional options (navigate with arrows, select with space):
   • Install TypeScript: Installs the typescript package as a dev dependency.
   • Add Recommended tsconfig.json: Adds a tsconfig.json with recommended settings for modern TypeScript (ES2022, NodeNext).
   • Setup ESLint + Prettier + Plugins:
     • Installs eslint, prettier, and a set of plugins: typescript-eslint, eslint-plugin-playwright, eslint-plugin-prettier, eslint-config-prettier.
     • Generates eslint.config.mts (or .mjs) with configured rules for Playwright and TypeScript.
   • Setup Husky & lint-staged:
     • Installs husky and lint-staged to automatically format and lint your code before committing.
     • Configures a pre-commit hook that runs prettier and eslint on staged files.
   • Add Pull Request Checklist to .github:
     • Creates a .github/pull_request_template.md file with a ready-to-use checklist for your Pull Requests.

Technologies & Repositories

This tool integrates and configures the following open-source projects:

• Playwright - End-to-end testing framework.
• TypeScript - Typed superset of JavaScript.
• ESLint - Pluggable JavaScript linter.
• Prettier - Opinionated code formatter.
• Husky - Git hooks made easy.
• lint-staged - Run linters on git staged files.
• typescript-eslint - Tooling which enables ESLint to support TypeScript.
• eslint-plugin-playwright - ESLint plugin for Playwright.