cloudcc-cli 2.2.6 → 2.2.7

package/skill/OBJECTS_AND_FIELDS.md

@@ -0,0 +1,120 @@
+## 覆盖范围
+
+本篇聚焦用 `cloudcc-cli` 的 `cc` 命令完成：
+
+- 创建自定义对象（Custom Object）
+- 查询对象列表
+- 查询对象字段
+- 为对象创建字段（支持多字段类型）
+-（可选）创建菜单、创建应用（把对象挂到导航中）
+
+---
+
+## 自定义对象（Custom Object）
+
+### 你需要准备什么信息
+
+- **对象显示标签（label）**：例如“客户”“合同”“付款计划”
+- **项目路径（projectPath）**：模板项目根目录
+
+### CLI 命令（项目已有实现）
+
+```bash
+cc create object <projectPath> <label>
+```
+
+示例：
+
+```bash
+cc create object . 客户
+```
+
+---
+
+## 查询对象列表
+
+### CLI 命令（输出 JSON）
+
+```bash
+# type 可选：standard / custom / both（默认：both）
+cc get object <projectPath> [type]
+```
+
+示例：
+
+```bash
+cc get object . both
+```
+
+用途：
+
+- 获取对象 `objprefix` / 对象 `id`（后续创建字段、触发器会用到）
+
+---
+
+## 查询对象字段列表
+
+### CLI 命令（输出 JSON）
+
+```bash
+cc get fields <projectPath> <objprefix>
+```
+
+示例：
+
+```bash
+cc get fields . a01
+```
+
+用途：
+
+- 在创建字段前，先确认是否已存在同名/同含义字段，避免重复与冲突。
+
+---
+
+## 创建字段（Field）
+
+### CLI 命令形态（项目已有实现）
+
+字段创建命令由工具根据字段类型拼装，典型形态：
+
+```bash
+cc create fields <projectPath> <fieldType> <objid> <nameLabel> [ptext|lookupObj]
+```
+
+### 字段类型选择建议（常用）
+
+- **S**：文本（最常用）
+- **N**：数字
+- **D / F**：日期 / 日期时间
+- **B**：复选框
+- **L / Q**：选项列表（单选/多选）
+- **Y / MR / M**：关系字段（查找/查找多选/主详）
+- **E / H / U**：邮箱/电话/URL
+
+---
+
+## 菜单与应用（让对象可访问）
+
+### 创建菜单（CLI）
+
+```bash
+cc create menu <type> <projectPath> <resourceId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]
+```
+
+示例：
+
+```bash
+cc create menu object . <objectId> "我的对象菜单"
+```
+
+### 创建应用（CLI）
+
+```bash
+cc create application <projectPath> <appName> <appCode> [menuIds]
+```
+
+说明：
+
+- `menuIds`：可选，多个用逗号分隔；系统会确保默认菜单 `acf000001` 被包含。
+

package/skill/REQUIREMENTS_BREAKDOWN.md

@@ -0,0 +1,98 @@
+## 目标
+
+把业务需求翻译成 CloudCC CRM 二开落地项，并选择“应该做什么组件”：自定义对象/字段/菜单/应用/自定义类/定时器/触发器/自定义组件/客户端脚本。
+
+---
+
+## 需求拆解模板（AI 必须输出）
+
+拿到需求后，先输出以下结构（缺信息则显式标注“待确认”）：
+
+- **背景与目标**：要解决什么问题，成功标准是什么。
+- **角色与权限**：涉及哪些用户/简档/权限集，是否需要后台权限调整。
+- **对象与数据模型**：
+  - 需要哪些**自定义对象**（表）？
+  - 需要哪些**字段**（类型、必填/唯一、默认值、选项、查找/主详关系）？
+  - 是否涉及**记录类型**、**布局**、**验证规则**（若 CLI 不覆盖，需在 CRM 配置）？
+- **业务流程**：
+  - 触发时机：保存前/保存后/提交审批/批处理/定时等
+  - 需要哪些自动化：校验、自动赋值、联动更新、异步任务、定时任务
+- **界面与交互**：
+  - 是否需要自定义页面或嵌入式 UI？
+  - 是否需要列表/详情/编辑页的前端交互（客户端脚本 / 自定义组件）？
+- **集成与外部依赖**：第三方接口、鉴权方式、重试/限流、日志与审计。
+- **风险与回滚**：数据迁移、权限影响、性能与批量场景、灰度与回滚方案。
+- **交付物清单**：最终要产出哪些 CloudCC 资产（对象/字段/菜单/应用/类/触发器/定时器/组件/脚本）。
+
+---
+
+## 方案选型决策表（怎么判断用什么）
+
+### 自定义对象（Custom Object）
+
+当出现以下需求时，优先考虑创建自定义对象：
+
+- 需要一个新的业务实体（类似新表），有独立的字段、权限、页面与列表
+- 需要与现有对象建立查找/主详关系
+- 需要支持审批、报表、共享规则等平台能力（通常都围绕对象展开）
+
+### 自定义字段（Field）
+
+当需求是“给已有对象补充数据结构”时：
+
+- 新增文本/数值/日期/选项/查找关系等字段
+- 需要字段级校验、默认值、必填等（部分能力可能需在 CRM 配置完成）
+
+### 触发器（Trigger）
+
+当需求是“数据写入前后做强一致业务逻辑”时：
+
+- 保存前校验/自动赋值/阻止不合法写入（before*）
+- 保存后联动更新、写日志、创建子记录（after*）
+- 批量/审批/提交后回调等特定时机（approval/batch/commitBatch 等）
+
+> 注意：触发器要考虑**批量**、幂等、递归、性能与异常处理。
+
+### 自定义类（Class）
+
+当需求是“可复用的服务逻辑/复杂计算/对外接口封装”时：
+
+- 作为触发器/定时器/页面调用的后端服务类
+- 抽取通用能力（查询封装、校验器、集成适配器）
+
+### 定时类（Scheduled Class / Timer）
+
+当需求是“按时间周期跑任务”时：
+
+- 夜间同步、定时报表、到期提醒、批量修复数据
+- 需要可控的调度表达式与运行日志
+
+### 自定义组件（Vue Custom Component）
+
+当需求是“在 CloudCC UI 中提供复杂交互 UI”时：
+
+- 自定义表单、复杂联动、可视化、批量操作 UI
+- 需要前端框架能力（Vue2.x）与更强的用户体验
+
+### 客户端脚本（Client Script）
+
+当需求是“页面级轻量交互/字段联动/保存前校验”时：
+
+- 列表/详情/编辑/新建页生命周期钩子
+- 字段变更联动、提示、轻量校验
+
+> 客户端脚本更轻量；交互复杂或需要组件化复用，建议升级为自定义组件。
+
+---
+
+## 推荐落地流程（AI 执行顺序）
+
+一般建议按以下顺序落地（从“数据结构”到“业务逻辑”再到“界面”）：
+
+1. **对象与字段**：先把数据模型搭好（对象、字段、关系）
+2. **菜单与应用**：让用户能访问（菜单/应用）
+3. **后端逻辑**：自定义类 / 触发器 / 定时器
+4. **前端交互**：客户端脚本 / 自定义组件
+5. **联调与回归**：核心路径 + 批量场景 + 权限场景
+6. **发布与回滚准备**：版本记录、灰度、回滚策略
+

package/skill/SKILL.md

@@ -0,0 +1,33 @@
+---
+name: cloudcc-cli-dev
+description: CloudCC CRM 二次开发 CLI 助手。用于需求拆解与方案选型，并通过 cloudcc-cli（cc 命令）创建/拉取/发布自定义对象、字段、菜单/应用、自定义类、定时器、触发器与 Vue 自定义组件等资产。用户提到 CloudCC、cloudcc-cli、cc 命令、对象/字段/触发器/定时器/自定义组件 时应优先使用。
+---
+
+# CloudCC CLI Development Skill
+
+## 使用方式（AI 必须遵循）
+
+- 先阅读 `REQUIREMENTS_BREAKDOWN.md`，输出需求拆解与交付物清单，再进入落地步骤。
+- 需要环境/密钥 配置时，阅读 `INSTALL_AND_BOOTSTRAP.md`。
+- 需要建模时（对象/字段/菜单/应用），阅读 `OBJECTS_AND_FIELDS.md`。
+- 需要后端逻辑时（类/定时器/触发器），阅读 `BACKEND_CODE.md`。
+- 需要自定义组件时，阅读 `VUE_CUSTOM_COMPONENT.md`。
+- 需要快速对照命令与参数时，阅读 `CLI_CHEATSHEET.md`。
+
+## 强制安全边界
+
+- 不要在输出/代码/提交中包含真实密钥（`CloudCCDev`、`safetyMark`、`secretKey`、`openSecretKey`、token
+  等）。
+- 后端类/触发器/定时器遵守片段同步：仅在
+  `@SOURCE_CONTENT_START`~`@SOURCE_CONTENT_END` 内编写可发布逻辑。
+- 客户端脚本遵守片段同步：仅在 `function main($CCDK, obj) { ... }`
+  的函数体内编写可发布逻辑。
+
+## 快速入口
+
+- 安装与初始化：`INSTALL_AND_BOOTSTRAP.md`
+- 需求拆解与方案选择：`REQUIREMENTS_BREAKDOWN.md`
+- 自定义对象与字段：`OBJECTS_AND_FIELDS.md`
+- 自定义类/定时器/触发器：`BACKEND_CODE.md`
+- Vue 自定义组件：`VUE_CUSTOM_COMPONENT.md`
+- CLI 速查：`CLI_CHEATSHEET.md`

package/skill/VUE_CUSTOM_COMPONENT.md

@@ -0,0 +1,50 @@
+## 覆盖范围
+
+本篇聚焦 CloudCC Vue2.x 自定义组件（Custom Component）：
+
+- 创建组件骨架
+- 编辑与最佳实践入口
+- 编译与发布到服务器
+
+---
+
+## 创建自定义组件
+
+### CLI 命令
+
+```bash
+# 在项目根目录执行（会生成到 plugins/<pluginName>/）
+cc create plugin <pluginName>
+```
+
+创建后会生成组件主文件、子组件目录与配置文件（以项目模板为准）。
+
+---
+
+## 发布组件
+
+```bash
+cc publish plugin <pluginName>
+```
+
+> 发布会执行编译/打包/上传；如果组件依赖复杂，注意依赖收集与发布策略。
+
+---
+
+## 编辑要点（CLI 项目约束）
+
+- 组件目录通常为 `plugins/<pluginName>/`
+- 确保所有 `<style>` 标签带 `scoped`，避免全局样式污染
+- 发布通过 `cc publish plugin <pluginName>` 执行编译与上传
+
+---
+
+## 选型建议（组件 vs 客户端脚本）
+
+- **自定义组件**：复杂交互、强 UI、可复用组件化、需要更完整工程化能力。
+- **客户端脚本**：轻量联动、页面钩子逻辑、少量 UI 提示与校验。
+
+一般建议：
+
+- 先用脚本满足基础联动；当逻辑与 UI 复杂度上升时，再升级为组件方案。
+