npm - @blueking/bkui-knowledge - Versions diffs - 0.0.1-beta.14 → 0.0.1-beta.15 - Mend

@blueking/bkui-knowledge 0.0.1-beta.14 → 0.0.1-beta.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (991) hide show

package/knowledge/commands/chat-x-git-commit.md ADDED Viewed

@@ -0,0 +1,200 @@
+# Git 智能提交助手
+根据当前暂存的代码改动，自动生成 commit message 并协助完成提交流程。
+## 执行步骤
+### 1. 检查暂存文件
+首先检查是否有已暂存（staged）的文件：
+```bash
+git diff --cached --name-only
+```
+**判断逻辑：**
+- 如果没有任何暂存文件 → 直接告知用户"没有暂存的文件，请先使用 `git add` 添加要提交的文件"，然后**停止执行**
+- 如果有暂存文件 → 继续下一步
+### 2. 分析改动并生成 Commit Message
+#### 2.1 获取改动详情
+```bash
+# 查看暂存的文件列表
+git diff --cached --name-only
+# 查看暂存的代码差异
+git diff --cached
+# 查看最近的 commit 风格（作为参考）
+git log --oneline -5
+```
+#### 2.2 生成 Commit Message
+根据以下规则生成 commit message：
+**Commit 类型判断：**
+| 改动类型               | Commit 类型 | 示例                      |
+| ---------------------- | ----------- | ------------------------- |
+| 新增功能/组件          | feat        | `feat: 新增 xxx 组件`     |
+| 修复 bug               | fix         | `fix: 修复 xxx 问题`      |
+| 代码重构（不改变功能） | refactor    | `refactor: 重构 xxx 逻辑` |
+| 样式调整               | style       | `style: 调整 xxx 样式`    |
+| 文档更新               | docs        | `docs: 更新 xxx 文档`     |
+| 测试相关               | test        | `test: 添加 xxx 测试用例` |
+| 构建/工具配置          | chore       | `chore: 更新依赖`         |
+| 性能优化               | perf        | `perf: 优化 xxx 性能`     |
+**Message 格式：**
+```
+<type>: <subject>
+<body>（可选，描述具体改动）
+```
+#### 2.3 展示并等待确认
+向用户展示：
+1. 暂存的文件列表
+2. 生成的 commit message
+3. 询问用户是否需要修改
+**示例输出：**
+```
+📝 暂存的文件：
+- packages/chat-x/src/components/xxx/xxx.vue
+- packages/chat-x/src/components/xxx/xxx.spec.ts
+📄 生成的 Commit Message：
+---
+feat: 新增 xxx 组件
+- 添加组件基础结构
+- 添加单元测试
+---
+请确认是否使用此 commit message？
+- 如需修改，请直接告诉我新的内容
+- 确认无误请回复"确认"或"ok"
+```
+**等待用户回复后再继续下一步。**
+### 3. 执行 Git Commit
+用户确认后，执行提交：
+```bash
+git commit -m "$(cat <<'EOF'
+<commit message>
+EOF
+)"
+```
+#### 3.1 检查提交结果
+**情况 A：提交成功**
+```
+✅ 提交成功！
+Commit: <commit hash>
+Message: <commit message>
+后续操作建议：
+- git push origin <branch> 推送到远程
+```
+**情况 B：Pre-commit Hook 失败**
+如果 pre-commit 或其他 git hook 报错：
+1. **捕获错误信息**
+2. **分析错误原因**
+3. **输出修复方案**
+4. **等待用户确认**
+**示例输出：**
+```
+❌ Commit 失败 - Pre-commit Hook 报错
+🔍 错误分析：
+- 错误类型：ESLint 检查失败
+- 问题文件：packages/chat-x/src/components/xxx/xxx.vue
+- 具体问题：
+  1. Line 25: 'unusedVar' is defined but never used
+  2. Line 42: Missing semicolon
+🔧 修复方案：
+1. 删除未使用的变量 'unusedVar'
+2. 在第 42 行末尾添加分号
+是否需要我自动修复这些问题？请回复"修复"或告诉我其他处理方式。
+```
+### 4. 修复并重试
+用户确认修复方案后：
+1. **执行修复操作**（编辑文件修复问题）
+2. **重新暂存修改的文件**：`git add <修复的文件>`
+3. **再次尝试提交**
+4. **如果仍有错误，重复步骤 3-4**
+循环直到：
+- ✅ 提交成功
+- 或用户选择放弃
+## 常见错误处理
+### ESLint / Biome 错误
+```
+修复策略：
+1. 未使用的变量 → 删除或添加使用
+2. 格式问题 → 运行 pnpm lint:ui --fix 或手动修复
+3. 导入顺序 → 调整 import 顺序
+```
+### TypeScript 错误
+```
+修复策略：
+1. 类型不匹配 → 修正类型定义
+2. 缺少类型 → 添加类型注解
+3. 属性不存在 → 检查接口定义
+```
+### 测试失败
+```
+修复策略：
+1. 断言失败 → 更新期望值或修复代码
+2. Mock 问题 → 更新 mock 配置
+3. 运行错误 → 检查测试代码逻辑
+```
+## 快捷使用
+直接执行此命令，AI 会自动：
+1. 检查暂存文件
+2. 分析改动
+3. 生成 commit message
+4. 引导完成提交
+## 注意事项
+1. **不会自动推送**：提交成功后不会自动 push，需要用户手动决定
+2. **保留用户控制权**：每个关键步骤都会等待用户确认
+3. **只处理暂存文件**：未 `git add` 的文件不会被提交
+4. **敏感文件检查**：如果发现 `.env`、`credentials` 等敏感文件，会发出警告

package/knowledge/commands/chat-x-update-test.md ADDED Viewed

@@ -0,0 +1,170 @@
+# 更新单元测试
+根据源文件的改动，自动分析并更新对应的单元测试用例。
+## 执行步骤
+### 1. 获取改动的源文件
+首先，获取当前 git staged 或最近修改的源文件列表：
+```bash
+# 获取 staged 的 packages/chat-x/src 下的源文件
+git diff --cached --name-only --diff-filter=ACMR | grep "^packages/chat-x/src" | grep -E "\.(vue|ts)$" | grep -v "\.spec\.ts$" | grep -v "\.d\.ts$"
+```
+如果没有 staged 文件，则获取未提交的改动：
+```bash
+# 获取未 staged 的改动文件
+git diff --name-only | grep "^packages/chat-x/src" | grep -E "\.(vue|ts)$" | grep -v "\.spec\.ts$" | grep -v "\.d\.ts$"
+```
+### 2. 分析每个改动的源文件
+对于每个改动的源文件，执行以下步骤：
+#### 2.1 读取源文件内容
+读取改动后的源文件完整内容，分析：
+- 组件的 Props 定义
+- 组件的 Emits 定义
+- 组件的 Slots 定义
+- 组件的主要逻辑和方法
+- 使用的外部依赖（需要 mock）
+#### 2.2 查看 git diff
+```bash
+git diff HEAD -- <源文件路径>
+```
+分析具体改动了什么：
+- 新增的 Props
+- 新增的事件
+- 修改的渲染逻辑
+- 新增的条件分支
+- 修改的交互行为
+#### 2.3 读取现有测试文件
+测试文件位置规则：
+- 源文件：`packages/chat-x/src/components/xxx/xxx.vue`
+- 测试文件：`packages/chat-x/src/components/xxx/xxx.spec.ts`
+读取现有测试文件，了解：
+- 现有的测试用例结构
+- 已有的 mock 配置
+- 测试覆盖的场景
+### 3. 参考测试规范
+阅读测试 skill 获取规范：
+- `.cursor/skills/unit-test/SKILL.md` - 完整的测试指南和模板
+- `.cursor/skills/unit-test/references/test-qa.md` - 常见问题解决方案
+### 4. 更新测试用例
+根据源文件的改动，更新测试文件：
+#### 4.1 更新策略
+| 源文件改动类型      | 测试更新操作           |
+| ------------------- | ---------------------- |
+| 新增 Props          | 添加 Props 测试用例    |
+| 新增事件 (emits)    | 添加事件触发测试用例   |
+| 新增 Slot           | 添加 Slot 渲染测试用例 |
+| 修改渲染逻辑        | 更新渲染测试的期望值   |
+| 新增条件渲染 (v-if) | 添加条件分支测试       |
+| 新增交互逻辑        | 添加交互测试用例       |
+| 新增依赖组件        | 添加对应的 mock        |
+| 删除功能            | 删除对应的测试用例     |
+#### 4.2 测试用例模板
+**Props 测试：**
+```typescript
+it('应该正确接收 newProp 属性', () => {
+  const newPropValue = 'test-value';
+  wrapper = mount(Component, { props: { newProp: newPropValue } });
+  expect(wrapper.props().newProp).toBe(newPropValue);
+});
+```
+**事件测试：**
+```typescript
+it('应该触发 newEvent 事件', async () => {
+  wrapper = mount(Component);
+  await wrapper.find('.trigger-element').trigger('click');
+  expect(wrapper.emitted('newEvent')).toBeTruthy();
+});
+```
+**条件渲染测试：**
+```typescript
+it('当 condition 为 true 时应该显示元素', () => {
+  wrapper = mount(Component, { props: { condition: true } });
+  expect(wrapper.find('.conditional-element').exists()).toBe(true);
+});
+it('当 condition 为 false 时应该隐藏元素', () => {
+  wrapper = mount(Component, { props: { condition: false } });
+  expect(wrapper.find('.conditional-element').exists()).toBe(false);
+});
+```
+### 5. 运行测试验证
+更新测试后，运行测试验证：
+```bash
+# 运行指定组件的测试
+pnpm --filter @blueking/chat-x exec vitest run <测试文件路径>
+```
+如果测试失败，分析错误原因并修复。
+### 6. 输出总结
+完成后，输出更新总结：
+```
+📝 测试更新完成
+源文件改动：
+- packages/chat-x/src/components/xxx/xxx.vue
+测试文件更新：
+- packages/chat-x/src/components/xxx/xxx.spec.ts
+  - 新增: Props 测试 (newProp)
+  - 新增: 事件测试 (newEvent)
+  - 更新: 渲染测试期望值
+测试结果：✅ 全部通过
+```
+## 注意事项
+1. **保持测试文件结构**：遵循现有测试文件的组织结构（describe 分组）
+2. **复用现有 Mock**：使用测试文件中已有的 mock 配置
+3. **遵循命名规范**：测试用例描述使用中文，清晰说明测试目的
+4. **最小改动原则**：只更新与源文件改动相关的测试，不要重构整个测试文件
+5. **验证测试通过**：更新后必须运行测试确保通过
+## 快捷使用
+直接告诉我需要更新哪个组件的测试：
+> "帮我更新 shortcut-btns 组件的测试"
+或者让我自动检测：
+> "检测当前改动的文件，更新对应的测试"

package/knowledge/commands/chat-x-update-wiki.md ADDED Viewed

@@ -0,0 +1,221 @@
+# 更新 Wiki 文档
+根据源文件的改动，自动分析并更新对应的 Wiki 文档。
+## 执行步骤
+### 1. 获取改动的源文件
+首先，获取当前 git staged 或最近修改的源文件列表：
+```bash
+# 获取 staged 的 packages/chat-x/src 下的源文件
+git diff --cached --name-only --diff-filter=ACMR | grep "^packages/chat-x/src" | grep -E "\.(vue|ts)$" | grep -v "\.spec\.ts$" | grep -v "\.d\.ts$"
+```
+如果没有 staged 文件，则获取未提交的改动：
+```bash
+# 获取未 staged 的改动文件
+git diff --name-only | grep "^packages/chat-x/src" | grep -E "\.(vue|ts)$" | grep -v "\.spec\.ts$" | grep -v "\.d\.ts$"
+```
+### 2. 源文件与 Wiki 文档的映射关系
+Wiki 文档位于 `packages/chat-x/wikis/` 目录，根据源文件类型对应不同的文档位置：
+| 源文件路径                                                      | Wiki 文档路径                                  |
+| --------------------------------------------------------------- | ---------------------------------------------- |
+| `src/components/ai-shortcut/shortcut-btn/shortcut-btn.vue`      | `wikis/components/atomic/shortcut-btn.md`      |
+| `src/components/ai-shortcut/shortcut-btns/shortcut-btns.vue`    | `wikis/components/atomic/shortcut-btns.md`     |
+| `src/components/chat-input/chat-input.vue`                      | `wikis/components/molecular/chat-input.md`     |
+| `src/components/chat-message/message-render/message-render.vue` | `wikis/components/molecular/message-render.md` |
+| `src/composables/use-clipboard.ts`                              | `wikis/composables/use-clipboard.md`           |
+| `src/composables/use-container-scroll.ts`                       | `wikis/composables/use-container-scroll.md`    |
+| `src/directives/overflow-tips.ts`                               | `wikis/directives/overflow-tips.md`            |
+| `src/plugins/markdown-latex.ts`                                 | `wikis/plugins/markdown-latex.md`              |
+**映射规则：**
+1. **组件文档**：
+   - 原子组件 (`ai-buttons/`, `ai-shortcut/`, `markdown-token/`) → `wikis/components/atomic/`
+   - 分子组件 (`chat-input/`, `chat-message/`, `chat-content/`, `tool-call/`, `message-tools/`, `ai-selection/`) → `wikis/components/molecular/`
+   - 文档名：取组件文件夹名（如 `shortcut-btn/shortcut-btn.vue` → `shortcut-btn.md`）
+2. **Composables 文档**：
+   - `src/composables/xxx.ts` → `wikis/composables/xxx.md`
+3. **指令文档**：
+   - `src/directives/xxx.ts` → `wikis/directives/xxx.md`
+4. **插件文档**：
+   - `src/plugins/xxx.ts` → `wikis/plugins/xxx.md`
+### 3. 分析源文件改动
+对于每个改动的源文件：
+#### 3.1 读取源文件内容
+分析组件/模块的：
+- Props 定义及类型
+- Emits 定义
+- Slots 定义
+- Expose 暴露的方法/属性
+- 导出的函数/类型
+#### 3.2 查看 git diff
+```bash
+git diff HEAD -- <源文件路径>
+```
+分析具体改动：
+- 新增/删除/修改的 Props
+- 新增/删除/修改的事件
+- 新增/删除/修改的 Slots
+- 功能行为变更
+### 4. 读取现有 Wiki 文档
+读取对应的 Wiki 文档，了解现有结构和内容。
+### 5. 更新 Wiki 文档
+根据源文件改动更新文档，遵循以下结构：
+```markdown
+# 组件名称 中文名称
+简短描述。
+## 基础用法
+\`\`\`vue
+<template>
+  <!-- 基础使用示例 -->
+</template>
+<script setup lang="ts">
+// 导入和基础配置
+</script>
+\`\`\`
+## 进阶用法（如需要）
+\`\`\`vue
+<!-- 更多使用场景 -->
+\`\`\`
+## API
+### Props
+| 属性名   | 类型   | 默认值   | 说明 |
+| -------- | ------ | -------- | ---- |
+| propName | `类型` | `默认值` | 说明 |
+### Events
+| 事件名    | 参数           | 说明 |
+| --------- | -------------- | ---- |
+| eventName | `(参数: 类型)` | 说明 |
+### Slots
+| 插槽名   | 说明 |
+| -------- | ---- |
+| slotName | 说明 |
+### Expose
+| 属性名     | 类型   | 说明 |
+| ---------- | ------ | ---- |
+| exposeName | `类型` | 说明 |
+## 类型定义
+\`\`\`typescript
+// 相关类型定义
+\`\`\`
+## 样式变量（如适用）
+\`\`\`scss
+// 可覆盖的样式
+\`\`\`
+## 使用场景
+- 场景 1
+- 场景 2
+```
+### 6. 更新策略
+| 源文件改动类型  | Wiki 更新操作             |
+| --------------- | ------------------------- |
+| 新增 Props      | 在 Props 表格中添加新行   |
+| 修改 Props 类型 | 更新 Props 表格中的类型列 |
+| 删除 Props      | 从 Props 表格中删除对应行 |
+| 新增事件        | 在 Events 表格中添加新行  |
+| 新增 Slot       | 在 Slots 表格中添加新行   |
+| 新增功能        | 添加使用示例              |
+| 行为变更        | 更新相关说明和示例        |
+| 新增类型        | 更新类型定义部分          |
+### 7. 验证文档
+更新后检查：
+- Markdown 格式是否正确
+- 代码示例是否可用
+- 表格对齐是否正确
+- 导入路径是否正确（使用 `@blueking/chat-x`）
+### 8. 输出总结
+完成后，输出更新总结：
+```
+📝 Wiki 文档更新完成
+源文件改动：
+- packages/chat-x/src/components/xxx/xxx.vue
+Wiki 文档更新：
+- packages/chat-x/wikis/components/atomic/xxx.md
+  - 更新: Props 表格 (新增 newProp)
+  - 更新: Events 表格 (新增 newEvent)
+  - 新增: 使用示例
+```
+## 注意事项
+1. **保持文档风格一致**：参考现有 Wiki 文档的格式和风格
+2. **使用中文描述**：属性说明、事件说明等使用中文
+3. **示例代码完整**：确保代码示例可以直接复制使用
+4. **类型定义准确**：从源文件中提取准确的类型定义
+5. **最小改动原则**：只更新与源文件改动相关的部分
+## 快捷使用
+直接告诉我需要更新哪个组件的文档：
+> "帮我更新 shortcut-btn 组件的 wiki 文档"
+或者让我自动检测：
+> "检测当前改动的文件，更新对应的 wiki 文档"
+## 相关文件
+- Wiki 文档目录：`packages/chat-x/wikis/`
+- 组件源码：`packages/chat-x/src/components/`
+- Composables 源码：`packages/chat-x/src/composables/`

package/knowledge/component-apis/vue2/affix.json ADDED Viewed

@@ -0,0 +1,33 @@
+{
+  "description": "使用图钉，可以将内容固定在屏幕上，并且不随页面的滚动而滚动。",
+  "events": {
+    "change": {
+      "description": "在固定状态发生改变时触发",
+      "params": "(status: boolean)"
+    }
+  },
+  "name": "bk-affix",
+  "props": {
+    "offset-bottom": {
+      "default": "-",
+      "description": "距离窗口底部达到指定偏移量后触发",
+      "type": "Number"
+    },
+    "offset-top": {
+      "default": "0",
+      "description": "距离窗口顶部达到指定偏移量后触发",
+      "type": "Number"
+    },
+    "target": {
+      "default": "window",
+      "description": "设置 affix 需要监听其滚动事件容器的id",
+      "type": "String"
+    },
+    "z-index": {
+      "default": "1000",
+      "description": "设置 affix 对象的层级",
+      "type": "Number"
+    }
+  },
+  "slots": {}
+}

package/knowledge/component-apis/vue2/alert.json ADDED Viewed

@@ -0,0 +1,42 @@
+{
+  "description": "页面上面的提示信息",
+  "events": {
+    "close": {
+      "description": "关闭事件",
+      "params": "(event: Event)"
+    }
+  },
+  "name": "bk-alert",
+  "props": {
+    "close-text": {
+      "default": "-",
+      "description": "自定义关闭按钮",
+      "type": "String"
+    },
+    "closable": {
+      "default": "false",
+      "description": "是否可以关闭",
+      "type": "Boolean"
+    },
+    "show-icon": {
+      "default": "true",
+      "description": "是否显示按钮",
+      "type": "Boolean"
+    },
+    "title": {
+      "default": "-",
+      "description": "标题",
+      "type": "String"
+    },
+    "type": {
+      "default": "info",
+      "description": "主题",
+      "type": "'info' | 'success' | 'warning' | 'error'"
+    }
+  },
+  "slots": {
+    "title": {
+      "description": "自定义标题内容"
+    }
+  }
+}

package/knowledge/component-apis/vue2/animate-number.json ADDED Viewed

@@ -0,0 +1,23 @@
+{
+  "description": "给数字加上动画效果",
+  "events": {},
+  "name": "bk-animate-number",
+  "props": {
+    "digits": {
+      "default": "0",
+      "description": "数字的位数",
+      "type": "Number"
+    },
+    "ext-cls": {
+      "default": "-",
+      "description": "配置自定义样式类名，传入的类会被加在组件最外层的 DOM span 上",
+      "type": "String"
+    },
+    "value": {
+      "default": "-",
+      "description": "显示的数字",
+      "type": "Number"
+    }
+  },
+  "slots": {}
+}