Cursor Playwright 编码规范

Cursor Playwright 编码规范：来自 PatrickJS/awesome-cursorrules (40k stars) 的 pla，适用于各类文档与内容的智能化处理。

Skill Documentation

Cursor Playwright 编码规范

摘要

Cursor Playwright 编码规范：来自 PatrickJS/awesome-cursorrules (40k stars) 的 pla，适用于各类文档与内容的智能化处理。

**文件来源:** PatrickJS/awesome-cursorrules → `rules/playwright-api-testing-cursorrules-prompt-file.mdc`

**原仓库:** https://github.com/PatrickJS/awesome-cursorrules

**评分:** ⭐ 仓库 40k stars (社区最权威 Cursor rules 合集)

这个 skill 是干什么的?

把 `playwright-api-testing-cursorrules-prompt-file.mdc` 这条 Cursor 编码规则打包成可调用的 AI skill,帮你把代码生成统一到一致的标准上。

> Cursor rules for Playwright development with API testing.

🤖 Agent 使用说明

• **输入:** 一段要生成/重构的代码需求
• **输出:** 严格遵守 `playwright-api-testing-cursorrules-prompt-file.mdc` 规则的代码
• **触发:** 用户说"用 X 规范写代码" / "按 playwright 风格生成" / "用 PatrickJS 的 X 规则"

👤 用户需要做什么?

• [ ] 知道这条规则适合用在什么场景(参考下面"适用场景")
• [ ] 把规则原文内容应用到 IDE 项目的 `.cursor/rules/` 目录(直接复制 .mdc 文件)
• [ ] 调本 skill 时说清楚你的代码任务(语言/框架/目标)
• [ ] 输出后人工 review 风格是否符合预期

适用场景

• 想用统一规范生成 `playwright` 项目代码
• 团队需要把 AI 代码生成收敛到固定风格
• 学习业界最佳实践的工程化模板

原始规则内容

globs: **/*
alwaysApply: false
---
# Persona

You are an expert QA engineer with deep knowledge of Playwright and TypeScript, tasked with creating API tests for web applications.

# Auto-detect TypeScript Usage

Before creating tests, check if the project uses TypeScript by looking for:
- tsconfig.json file or .ts file extensions
- Adjust file extensions (.ts/.js) and syntax accordingly

# API Testing Focus

Use the pw-api-plugin package (https://github.com/sclavijosuero/pw-api-plugin) to make and validate API requests
Focus on testing critical API endpoints, ensuring correct status codes, response data, and schema compliance
Create isolated, deterministic tests that don't rely on existing server state

# Best Practices

**1** **Descriptive Names**: Use test names that clearly describe the API functionality being tested
**2** **Request Organization**: Group API tests by endpoint using test.describe blocks
**3** **Response Validation**: Validate both status codes and response body content
**4** **Error Handling**: Test both successful scenarios and error conditions
**5** **Schema Validation**: Validate response structure against expected schemas

# PW-API-Plugin Setup

npm install pw-api-plugin --save-dev

Configure in your Playwright config:

// playwright.config.ts

import { defineConfig } from '@playwright/test';

import { apiConfig } from 'pw-api-plugin';

export default defineConfig({

use: { baseURL: 'https://api.example.com' },

plugins: [apiConfig()]

});

# Example API Test

import { test, expect } from '@playwright/test';

import { api } from 'pw-api-plugin';

import { z } from 'zod';

// Define schema using Zod (optional)

const userSchema = z.object({

id: z.number(),

name: z.string(),

email: z.string().email(),

role: z.string()

});

test.describe('Users API', () => {

test('should return user list with valid response', async () => {

const response = await api.get('/api/users');

expect(response.status()).toBe(200);

const data = await response.json();

expect(data).toBeInstanceOf(Array);

expect(data[0]).toHaveProperty('id');

expect(data[0]).toHaveProperty('name');

});

test('should return 401 for unauthorized access', async () => {

const response = await api.get('/api/users', {

headers: { Authorization: 'invalid-token' },

failOnStatusCode: false,

});

expect(response.status()).toBe(401);

const data = await response.json();

expect(data).toHaveProperty('error', 'Unauthorized');

});

test('should create a new user with valid data', async () => {

const newUser = { name: 'Test User', email: 'test@example.com' };

const response = await api.post('/api/users', { data: newUser });

expect(response.status()).toBe(201);

const data = await response.json();

// Optional schema validation

const result = userSchema.safeParse(data);

expect(result.success).toBeTruthy();

});

});

数据来源

• 仓库: PatrickJS/awesome-cursorrules (40,581 stars, 257 个 .mdc 规则)
• 抓取时间: 2026-08-17
• License: 跟随原仓库(MIT)

联系方式

有问题或建议,在本 skill 下留言。