playwright-ai-codegen-lib
v1.0.2
Published
A utility to auto-generate Playwright PageObjects and test scripts using OpenAI and DOM extraction.
Maintainers
Readme
from pathlib import Path
readme_path = Path("README.md")
readme_content = """# 🎭 playwright-ai-codegen-lib
A powerful utility library to auto-generate Playwright PageObjects and test scripts using the DOM structure of any webpage — powered by OpenAI GPT models.
Perfect for automation engineers and SDETs looking to accelerate test development and bootstrap test coverage with AI assistance.
✨ Features
- ✅ Generates PageObject classes by extracting DOM from any URL
- ✅ Creates functional methods (e.g.,
clickButton,fillInput) using OpenAI - ✅ Builds Playwright test files from generated PageObjects
- ✅ Designed with TypeScript, Playwright, and OpenAI SDK
- ✅ CLI-friendly and easy to integrate into any test automation framework
📦 Installation
npm install playwright-ai-codegen-libFor local development:
git clone https://github.com/mohitkalra610/playwright-ai-codegen-lib.git
cd playwright-ai-codegen-lib
npm install
npm run build🚀 Usage
1️⃣ Generate PageObject from a URL
npm run generate -- https://example.comThis will navigate to the given URL, extract the DOM, and generate a Playwright PageObject file inside pageObjects/.
2️⃣ Generate Interaction Functions from PageObject
npm run generate:functions -- pageObjects/MyPageObject.tsThis enhances the PageObject with useful interaction methods like clickLoginButton, fillUsernameField, etc.
3️⃣ Generate Playwright Test Scripts
npm run generate:tests -- pageObjects/MyPageObject.tsGenerates a full test file inside the tests/ directory based on your PageObject, ready to be executed with Playwright.
🛠️ Requirements
- Node.js >= 18
- Playwright
- OpenAI API Key (set in
.envasOPENAI_API_KEY)
🤝 Contributing
Feel free to open issues, fork the repo, and submit PRs.
📄 License
MIT © Mohit Kalra """
readme_path.write_text(readme_content) readme_path
