@doubao-apps/ai 0.0.33 → 0.0.34

package/dist/contexts/doubao-apps-dev/AGENTS.md

@@ -1,300 +0,0 @@
-# Doubao Apps SDK AI 开发指南
-
-本文件专供 AI coding agents（如 Claude、Copilot、Cursor）和开发者使用，提供 Doubao Apps SDK 框架的快速入门、开发规则和文档导航。
-
----
-
-## 快速开始
-
-### 1. 项目介绍
-
-Doubao Apps SDK 是豆包应用开发框架，基于 React Lynx 框架提供完整的小程序开发、构建和部署能力。
-
-**核心特性**：
-- **React 风格开发**：使用 TSX/JSX 语法和 React Hooks
-- **Lynx 渲染引擎**：跨平台高性能渲染
-- **Bridge API**：150+ 系统能力接口
-- **完整工具链**：CLI、调试工具、部署系统
-
-### 2. 环境准备
-
-**必需环境**：
-- Node.js 20+
-- pnpm（推荐）：`npm install -g pnpm`
-- bnpm 源：`npm config set registry https://bnpm.byted.org`
-
-### 3. 创建项目
-
-```bash
-# 安装依赖
-pnpm install
-
-# 启动开发
-pnpm dev
-```
-
-**开发服务器命令**：
-- `d` - 选择场景/页面/卡片运行
-- `<scene-name>` - 运行指定场景
-- `<page-id>` - 运行指定页面
-- `<widget-id>` - 运行指定卡片
-
-### 4. 项目结构
-
-```
-my-doubao-app/
-├── doubao.config.ts      # 项目配置
-├── package.json          # 依赖管理
-├── pnpm-lock.yaml        # 依赖锁定
-└── src/
-    ├── app.ts            # 应用入口
-    ├── pages/            # 页面目录（全屏UI）
-    │   └── home/
-    │       ├── index.tsx
-    │       └── index.scss
-    └── widgets/          # 卡片目录（聊天UI）
-        └── hello-world/
-            ├── index.tsx
-            └── index.scss
-```
-
----
-
-## 核心规则（必读）
-
-### 推荐做法
-
-- **优先使用 pnpm** 作为包管理器
-- **分离样式文件**：每个组件使用独立的 `.scss` 文件
-- **在 `src/app.config.ts` 中配置 metadata**：为 App、Page 和 Widget 统一配置元数据
-- **使用生命周期钩子**：合理使用 `onShow`、`onMounted` 等
-- **TypeScript 类型**：使用 `getViewData<T>()`、为 props 和 state 提供类型定义
-- **错误处理**：处理边界情况和错误状态
-
-### 禁止做法
-
-- **不写内联样式**：避免在 TSX 中直接写 style
-- **不在 render 中请求**：异步操作应在生命周期钩子中进行
-- **不过度嵌套**：保持组件层级扁平化
-- **不忽略类型**：避免使用 `any` 类型
-
-### ⚠️ 文件命名约束
-
-页面/卡片目录下的入口文件必须命名为 **`index.tsx`**，样式文件为 **`index.scss`**。
-
-**详细规则** → [references/rules/dos-and-donts.md](references/rules/dos-and-donts.md)
-
----
-
-## 组件开发
-
-### Page（页面）
-
-Page 是全屏 UI 组件，支持九宫格、浮窗等变体。
-
-**metadata 配置**：
-```ts
-import { defineAppConfig } from '@doubao-apps/kit';
-
-export default defineAppConfig({
-  pages: {
-    'pages/home': {
-      id: 'my-page',
-      title: '我的页面',
-      description: '页面功能描述'
-    }
-  }
-});
-```
-
-**页面实现**：
-```tsx
-import { definePage, getViewData } from '@doubao-apps/framework';
-import './index.scss';
-
-interface HomePageData {
-  title: string;
-}
-
-export default definePage({
-  onShow() {
-    // 页面显示时触发
-  },
-  render() {
-    const input = getViewData<HomePageData>();
-    return <view>{input.title}</view>;
-  }
-});
-```
-
-**开发指南** → [references/guides/component-development.md](references/guides/component-development.md)
-
-### Widget（卡片）
-
-Widget 是聊天流中的卡片组件，在对话中展示。
-
-**metadata 配置**：
-```ts
-import { defineAppConfig } from '@doubao-apps/kit';
-
-export default defineAppConfig({
-  widgets: {
-    'widgets/my-widget': {
-      id: 'my-widget',
-      name: '我的卡片',
-      description: '卡片功能描述',
-      boxType: 'inbox',
-      border: true
-    }
-  }
-});
-```
-
-**卡片实现**：
-```tsx
-import { defineWidget, getViewData } from '@doubao-apps/framework';
-import './index.scss';
-
-interface MyWidgetData {
-  title: string;
-}
-
-export default defineWidget({
-  onMounted() {
-    // 卡片挂载后触发
-  },
-  render() {
-    const input = getViewData<MyWidgetData>();
-    return <view>{input.title}</view>;
-  }
-});
-```
-
-**开发指南** → [references/guides/component-development.md](references/guides/component-development.md)
-
-**基础示例对比** → [references/examples/component-basics.md](references/examples/component-basics.md)
-
----
-
-## 开发资源
-
-### 开发任务模板
-
-根据不同的开发任务，使用不同的知识文档：
-
-| 任务类型 | 文档 | 适用场景 |
-|---------|-----------|---------|
-| 组件开发 | [component-development.md](references/guides/component-development.md) | Page 和 Widget 完整开发指南 |
-| 最佳实践 | [best-practices.md](references/guides/best-practices.md) | 代码规范、架构设计 |
-| 性能优化 | [performance-optimization.md](references/guides/performance-optimization.md) | 渲染优化、内存管理 |
-| 问题排查 | [troubleshooting.md](references/guides/troubleshooting.md) | 调试技巧、常见问题 |
-
----
-
-## API 参考
-
-完整的 Framework API（框架核心）和 Bridge API（系统能力）列表：
-
-- **[Framework API 快速参考](references/reference/framework-api-quick-ref.md)** - 核心 Framework API 速查
-- **[Open API 目录](references/reference/open-api/README.md)** - 公开可用的端能力（系统能力）目录与详细文档
-- **[组件库快速参考](references/reference/components-quick-ref.md)** - SDK 内置组件（Button、Switch、Swiper 等）
-
-包含：
-- **Framework API**：组件定义（definePage、defineWidget）、生命周期、状态管理
-- **Components**：SDK 内置 UI 组件（Button、Switch、Slider、Swiper、Dialog 等）
-- **Bridge API**：系统能力接口（网络、存储、设备、UI 交互等）
-
-### Playground 测试页范式
-
-当任务涉及 `examples/playground`、Open API 测试页、JSB 验证页或组件 Demo 时，必须按当前 Playground 结构编写：
-
-- **API 测试页**：放在 `examples/playground/src/pages/api/<group>/<api-name>/index.tsx`，并同步 `src/case-metadata.ts` 与 `src/pages/api/registry.ts`；`apiCaseMetas.name` 使用 `<group>/<api-name>`，允许带 `/`。
-- **组件测试页**：放在 `examples/playground/src/pages/component/<component-name>/index.tsx`，并同步 `src/case-metadata.ts` 与 `src/pages/component/registry.ts`。
-- **页面结构**：直接写 `definePage`、`PlaygroundPage`、纵向排列的多个 `TestCase`、`ActionButton` 和真实 API/组件调用，禁止任何页面工厂函数。
-- **覆盖方式**：API 页尽可能覆盖参数组合、边界值、失败路径和事件回调；组件页覆盖默认态、边界态和交互态。不要只写 2～3 个 happy path。
-- **日志隔离**：多个 `TestCase` 不共用同一个日志 state；日志 payload 可带 `case` / `caseName`，避免不同日志面板串扰。
-- **路由编码**：入口页跳转含 `/` 的 case name 时必须 `encodeURIComponent`；开发模式 `delegate-page` 的 query 需要 encode/decode。
-- **响应式主题**：Playground 外壳和示例辅助 UI 使用 `--pg-*` 变量；不要在 Playground 任务中顺手修组件库自身主题。
-
-### API e2e 测试范式
-
-当任务新增或正式暴露 `@doubao-apps/framework/api` / Open API / JSB API 时，必须同步补充 `e2e/api` 自动化测试：
-
-- **测试目录**：Vitest case 放在 `e2e/api/__tests__/`，优先补到已有 domain 文件，如 `basic.test.ts`、`network.test.ts`、`storage.test.ts`、`device.test.ts`、`ui.test.ts`；没有合适分组时新建 `<domain>.test.ts`。
-- **测试小程序**：`examples/e2e-api-runner` 只负责建立 WebSocket 链接、接收 API 调用指令、执行 `@byted-doubao-apps/framework/api` 并回传结果；不要把具体 e2e case 写在小程序或 playground 内。
-- **协议层**：WebSocket server、协议类型和 runner client 由 `@byted-doubao-apps/e2e-runner` 提供；不要在测试用例里重复实现通信协议。
-- **调用方式**：在测试中使用 `const session = await getApiSession()`，再通过 `await session.callApi<TResult>('<apiName>', [params], { timeoutMs })` 调用并在 Vitest 侧断言。
-- **稳定性原则**：只自动化稳定、低副作用、可断言的 API；强交互、权限弹窗、支付、路由退出、账号业务态或设备状态不稳定的 API 应 `it.skip` / `describe.skip` 并写明原因。
-- **本地依赖**：网络类 API 优先使用 `session.httpFixtureServer`，避免依赖公网。
-- **验证命令**：至少运行 `pnpm --filter @byted-doubao-apps/e2e-api typecheck`；有目标设备时再运行 `pnpm --filter @byted-doubao-apps/e2e-api test:api`。
-
-### Lynx 组件
-
-Lynx 组件库完整参考文档请访问官方文档：
-
-👉 **[Lynx 官方文档](https://lynx.bytedance.net/next/llms.txt)**
-
----
-
-## 代码示例
-
-### 常用场景
-
-| 场景 | 示例文档 | 说明 |
-|-----|---------|------|
-| 组件基础 | [component-basics.md](references/examples/component-basics.md) | Page 和 Widget 基础示例对比 |
-| 常用模式 | [common-patterns.md](references/examples/common-patterns.md) | API 集成、状态管理、页面导航 |
-
----
-
-## 外部资源
-
-### 快速参考
-
-API 参考文档
-
-- **[Framework API](references/reference/framework-api-quick-ref.md)** - 核心 Framework API 速查
-- **[组件库](references/reference/components-quick-ref.md)** - SDK 内置组件速查
-- **[Open API](references/reference/open-api/README.md)** - 系统能力 API 目录与详细文档
-
-### 依赖包
-
-- **Framework**：`@doubao-apps/framework` - 核心框架
-- **端能力 API**：`@doubao-apps/framework/api` - 系统能力接口
-- **Kit**：`@doubao-apps/kit` - 开发工具包
-
----
-
-## 获取帮助
-
-### 常见问题
-
-遇到问题？先查看故障排查指南：
-
-👉 **[故障排查指南](references/guides/troubleshooting.md)**
-
-### 最佳实践
-
-想要提升代码质量？查看最佳实践：
-
-👉 **[最佳实践指南](references/guides/best-practices.md)**
-
-### 性能优化
-
-应用性能不佳？查看性能优化指南：
-
-👉 **[性能优化指南](references/guides/performance-optimization.md)**
-
----
-
-## 知识库文档组织
-
-```
-项目根目录/
-├── AGENTS.md            # 主入口文档（AI Agent 必读）
-└── references/          # 详细文档目录
-    ├── guides/          # 开发指南
-    ├── rules/           # 开发规则
-    ├── examples/        # 代码示例
-    └── reference/       # API 参考
-```

package/dist/contexts/doubao-apps-dev/CLAUDE.md

@@ -1,31 +0,0 @@
-# CLAUDE.md - Doubao Apps SDK 开发助手
-
-> 本文件为 Claude AI 助手优化的入口文件，由 `doubao-cli add context --agent claude` 安装。
-
-## 主入口
-
-完整开发指南请参考：**[AGENTS.md](./AGENTS.md)**
-
-## 快速导航
-
-| 开发任务 | 参考文档 |
-|---------|---------|
-| 创建 Page（页面组件） | [references/guides/component-development.md](references/guides/component-development.md) |
-| 创建 Widget（卡片组件） | [references/guides/component-development.md](references/guides/component-development.md) |
-| 最佳实践 | [references/guides/best-practices.md](references/guides/best-practices.md) |
-| 性能优化 | [references/guides/performance-optimization.md](references/guides/performance-optimization.md) |
-| 问题排查 | [references/guides/troubleshooting.md](references/guides/troubleshooting.md) |
-| Framework API | [references/reference/framework-api-quick-ref.md](references/reference/framework-api-quick-ref.md) |
-| Bridge API / 系统能力 | [references/reference/open-api/README.md](references/reference/open-api/README.md) |
-| Playground / API / JSB 验证页 | [AGENTS.md#playground-测试页范式](./AGENTS.md#playground-测试页范式) |
-| API e2e 自动化测试 | [AGENTS.md#api-e2e-测试范式](./AGENTS.md#api-e2e-测试范式) |
-
-## 知识库结构
-
-```
-references/
-├── guides/           # 开发指南（组件开发、最佳实践、性能优化、故障排除）
-├── rules/            # 框架规则（dos-and-donts）
-├── examples/         # 代码示例（组件基础、常用模式）
-└── reference/        # API 参考（Framework API、系统能力）
-```