@be-link/smart-test 1.0.1-beta.10 → 1.0.1-beta.12

package/README.md

@@ -17,19 +17,33 @@ pnpm add -D @be-link/smart-test
 
 ## 🚀 快速开始
 
-### 1. 配置 AI API
+### 1. 初始化配置
 
-```typescript
-import { configure } from '@be-link/smart-test';
+首先在项目中初始化配置文件：
 
-configure({
-  apiKey: process.env.AI_API_KEY,
-  baseURL: 'https://dashscope.aliyuncs.com/compatible-mode/v1',
-  visionModel: 'qwen3-vl-plus',
-  codeModel: 'qwen3-coder-plus',
-});
+```bash
+# 在项目根目录运行
+smart-test init
+```
+
+然后编辑 `tests/smart-test.config.cjs`，配置 AI API 密钥：
+
+```javascript
+module.exports = {
+  ai: {
+    apiKey: process.env.VITE_AI_API_KEY || '',
+    baseURL: 'https://dashscope.aliyuncs.com/compatible-mode/v1',
+    visionModel: 'qwen3-vl-plus',
+    codeModel: 'qwen3-coder-plus',
+  },
+  // ... 其他配置
+};
 ```
 
+> **注意**：配置文件使用 `.cjs` 扩展名，确保在 ESM 项目（`"type": "module"`）中也能正常使用。
+
+配置文件会在使用 AI 功能时自动加载，无需手动调用配置函数。
+
 ### 2. AI 视觉检查
 
 在 Playwright 测试中使用 AI 检查页面截图：
@@ -286,22 +300,6 @@ interface AiCodeGenerationResult {
 }
 ```
 
-### configure
-
-配置全局 AI 设置。
-
-```typescript
-function configure(config: Partial<AiBaseConfig>): void;
-
-interface AiBaseConfig {
-  apiKey?: string; // AI API 密钥
-  baseURL?: string; // AI 服务地址
-  visionModel?: string; // 视觉模型名称
-  codeModel?: string; // 代码模型名称
-  timeout?: number; // 请求超时时间（毫秒）
-}
-```
-
 ## 🎯 使用场景
 
 ### 场景 1：视觉回归测试
@@ -387,45 +385,9 @@ const result = await aiGenerateMock({
 }
 ```
 
-### 自定义配置
-
-可以在全局配置中设置默认值，也可以在每次调用时覆盖：
-
-```typescript
-// 全局配置
-configure({
-  apiKey: process.env.AI_API_KEY,
-  visionModel: 'custom-vision-model',
-});
-
-// 单次调用覆盖
-await aiReviewScreenshot(page, {
-  expected: '...',
-  visionModel: 'another-model', // 仅此次调用使用
-});
-```
-
 ## 🔍 最佳实践
 
-### 1. 环境变量管理
-
-建议将 API Key 存储在环境变量中：
-
-```typescript
-// playwright.config.ts
-import { defineConfig } from '@playwright/test';
-import { configure } from '@be-link/smart-test';
-
-configure({
-  apiKey: process.env.AI_API_KEY,
-});
-
-export default defineConfig({
-  // ... 其他配置
-});
-```
-
-### 2. 合理使用 AI 检查
+### 1. 合理使用 AI 检查
 
 AI 视觉检查适合用于：
 
@@ -439,7 +401,7 @@ AI 视觉检查适合用于：
 - ❌ 颜色值精确匹配
 - ❌ 性能敏感的场景
 
-### 3. 组合使用
+### 2. 组合使用
 
 将 AI 检查与传统断言结合使用，获得最佳效果：
 

package/dist/bin/smart-test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=smart-test.d.ts.map

package/dist/bin/smart-test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"smart-test.d.ts","sourceRoot":"","sources":["../../src/bin/smart-test.ts"],"names":[],"mappings":""}