playwright-smart-test 1.0.1 → 1.0.3

package/README.md

@@ -76,31 +76,50 @@ Static AST import analyzers often fail in E2E environments because:
 
 ---
 
-## 📦 Installation
+## 📦 Installation & Quick Start
 
-Install as a development dependency:
+### 1. Install as a dev dependency
 
 ```bash
+# npm
 npm install --save-dev playwright-smart-test
+
+# pnpm
+pnpm add -D playwright-smart-test
+
+# yarn
+yarn add -D playwright-smart-test
 ```
 
-Or run directly with `npx`:
+### 2. Configure Gemini API Key
+Obtain a free API key from [Google AI Studio](https://aistudio.google.com/). Set it in your environment or in a `.env` file in your project root:
 
 ```bash
-npx playwright-smart-test analyze
+export GEMINI_API_KEY="your-gemini-api-key"
 ```
 
----
+### 3. Initialize Configuration
+Generate `playwright-smart-test.config.json` in your repository root:
 
-## ⚙️ Configuration (`smart-regression.config.json`)
+```bash
+npx playwright-smart-test init
+```
 
-Generate a starter configuration:
+### 4. Run Analysis or Execute Tests
 
 ```bash
-npx playwright-smart-test init
+# Analyze PR diff against main branch (preview selection)
+npx playwright-smart-test analyze --base origin/main
+
+# Run only the impacted Playwright tests
+npx playwright-smart-test run --base origin/main
 ```
 
-Or create `smart-regression.config.json` in your repository root:
+---
+
+## ⚙️ Configuration (`playwright-smart-test.config.json`)
+
+Generate a starter configuration with `npx playwright-smart-test init` or create `playwright-smart-test.config.json` manually:
 
 ```json
 {
@@ -157,7 +176,7 @@ Or create `smart-regression.config.json` in your repository root:
 | `playwright-smart-test analyze` | Analyzes Git diff and outputs terminal impact table without executing tests. |
 | `playwright-smart-test run` | Analyzes Git diff and executes **only** the impacted Playwright specs. |
 | `playwright-smart-test comment` | Analyzes diff, generates GitHub Flavored Markdown, and outputs PR report. |
-| `playwright-smart-test init` | Generates a starter `smart-regression.config.json` configuration file. |
+| `playwright-smart-test init` | Generates a starter `playwright-smart-test.config.json` configuration file. |
 
 ### CLI Options
 * `-b, --base <ref>`: Target Git branch or commit to diff against (e.g. `origin/main` or `HEAD~1`).

package/dist/cli/index.js

@@ -14,7 +14,7 @@ const program = new Command();
 program
     .name('playwright-smart-test')
     .description('AI-Powered Smart Regression Test Selection Agent for Playwright')
-    .version('1.0.1');
+    .version('1.0.2');
 async function executeAnalysis(options) {
     const cwd = options.cwd ? path.resolve(options.cwd) : process.cwd();
     const config = loadConfig(cwd, options.config);
@@ -114,11 +114,11 @@ program
 });
 program
     .command('init')
-    .description('Create a sample smart-regression.config.json file')
+    .description('Create a sample playwright-smart-test.config.json file')
     .option('--cwd <dir>', 'Target directory', process.cwd())
     .action((options) => {
     const targetDir = options.cwd ? path.resolve(options.cwd) : process.cwd();
-    const filePath = path.join(targetDir, 'smart-regression.config.json');
+    const filePath = path.join(targetDir, 'playwright-smart-test.config.json');
     const sample = {
         testDir: 'tests',
         testMatch: ['**/*.spec.ts'],

package/dist/config/index.js

@@ -9,6 +9,8 @@ export function loadConfig(cwd = process.cwd(), customConfigPath) {
     const possiblePaths = customConfigPath
         ? [path.resolve(cwd, customConfigPath)]
         : [
+            path.resolve(cwd, 'playwright-smart-test.config.json'),
+            path.resolve(cwd, '.playwright-smart-testrc.json'),
             path.resolve(cwd, 'smart-regression.config.json'),
             path.resolve(cwd, '.smart-regressionrc.json'),
             path.resolve(cwd, 'smart-regression.json'),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "playwright-smart-test",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "type": "module",
   "description": "AI-Powered Smart Regression Test Selection Agent for Playwright",
   "main": "dist/index.js",
@@ -20,6 +20,9 @@
     "type": "git",
     "url": "git+https://github.com/Ujjwal-S-S/playwright-smart-test.git"
   },
+  "engines": {
+    "node": ">=22.0.0"
+  },
   "scripts": {
     "build": "tsc",
     "test": "vitest run",
@@ -65,4 +68,4 @@
   "overrides": {
     "minimatch": "^11.0.3"
   }
-}
+}