cloudcc-cli 2.2.5 → 2.2.7

package/src/plugin/index.js

@@ -4,6 +4,7 @@ cc.publish = require("./publish1")
 cc.get = require("./get")
 cc.detail = require("./detail")
 cc.pull = require("./pull")
+cc.doc = require("./doc")
 function Plugin(action, argvs) {
     cc[action](argvs)
 }

package/src/plugin/pull.js

@@ -100,6 +100,9 @@ async function pullById(pluginId, projectPath) {
 
             // 遍历所有文件并保存
             Object.entries(contentMap).forEach(([filePath, content]) => {
+                // 统一路径分隔符（服务端可能返回 Windows 风格的反斜杠）
+                filePath = filePath.replace(/\\/g, '/');
+
                 // 获取文件名（不包含路径）
                 const fileName = path.basename(filePath);
 

package/src/project/doc.js

@@ -0,0 +1,378 @@
+function generateFullMarkdownDoc() {
+    const lines = [
+        "# CloudCC Project 文档（全量）",
+        "",
+        "## 开发环境搭建（env-setup）",
+        "",
+        "> 来源：`.cursor/skills/cloudcc-crm-dev-guide/env-setup.md`",
+        "",
+        "# CloudCC CRM 前后端开发环境搭建指南",
+        "",
+        "> 本文档基于 CloudCC",
+        "> 官方「开发环境」文档整理而成，原文参见：[CloudCC 开发环境](https://help.cloudcc.cn/product03/kai-fa-huan-jing/)。\\",
+        "> 目标：指导开发者完成本地 Node / VS Code / cloudcc-cli / MCP / 模板项目 /",
+        "> 密钥配置等端到端环境搭建。",
+        "",
+        "---",
+        "",
+        "## 1. 前置条件与总体说明",
+        "",
+        "- 适用人群：CloudCC 前端组件、客户端脚本、后端类/触发器/定时器等二次开发工程师。",
+        "- 基本流程：",
+        "  1. 安装 Node 与 npm，并切换 npm 源",
+        "  2. 安装 `cloudcc-cli` 全局依赖",
+        "  3. 安装 VS Code 与 CloudCC 插件",
+        "  4. 配置本地 MCP（`cc-mcp`）",
+        "  5. 使用 CLI 创建模板项目并安装依赖",
+        "  6. 通过 CRM 获取开发者密钥、安全标记并写入 `cloudcc-cli.config.js`",
+        "  7. 视情况配置私有云与多环境参数",
+        "",
+        "---",
+        "",
+        "## 2. 安装 Node 与 npm 源配置",
+        "",
+        "### 2.1 安装 Node",
+        "",
+        "- **推荐版本**：`v20.19.5`（官方示例）",
+        "- **下载地址**：",
+        "  - Node 官方历史版本下载：`https://nodejs.org/download/release/v20.19.5/`",
+        "- **建议**：使用 `nvm` 等 Node 多版本管理工具切换版本，保证与 CloudCC",
+        "  官方推荐版本一致。",
+        "",
+        "安装完成后，在终端中验证：",
+        "",
+        "```bash",
+        "node -v",
+        "```",
+        "",
+        "### 2.2 切换 npm 源到阿里镜像",
+        "",
+        "为加速依赖安装，建议设置 npm 源为阿里镜像：",
+        "",
+        "```bash",
+        "npm config set registry https://registry.npmmirror.com",
+        "```",
+        "",
+        "验证是否设置成功：",
+        "",
+        "```bash",
+        "npm config get registry",
+        "```",
+        "",
+        "返回 `https://registry.npmmirror.com/` 即表示生效。",
+        "",
+        "---",
+        "",
+        "## 3. 安装 cloudcc-cli（全局）",
+        "",
+        "### 3.1 Windows 用户",
+        "",
+        "在命令行中执行：",
+        "",
+        "```bash",
+        "npm install -g cloudcc-cli",
+        "```",
+        "",
+        "### 3.2 macOS 用户",
+        "",
+        "在终端中执行（需要 sudo）：",
+        "",
+        "```bash",
+        "sudo npm install -g cloudcc-cli",
+        "```",
+        "",
+        "### 3.3 验证安装",
+        "",
+        "查看全局依赖列表，确认 `cloudcc-cli` 已安装：",
+        "",
+        "```bash",
+        "npm ls -g --depth=0",
+        "```",
+        "",
+        "在 macOS 上如需查看 sudo 下的全局包，可使用：",
+        "",
+        "```bash",
+        "sudo npm ls -g --depth=0",
+        "```",
+        "",
+        "---",
+        "",
+        "## 4. 安装 VS Code 与 CloudCC 插件",
+        "",
+        "### 4.1 安装 VS Code",
+        "",
+        "- 下载地址：`https://code.visualstudio.com/download`",
+        "- 安装完成后，用 VS Code 作为主要开发编辑器。",
+        "",
+        "### 4.2 安装 CloudCC 插件",
+        "",
+        "1. 打开 VS Code，点击左侧扩展（Extensions）图标",
+        "2. 搜索 `CloudCC`",
+        "3. 选择官方 CloudCC 插件并安装",
+        "",
+        "> 若在 Cursor 中开发，可参考 CloudCC 帮助中心中关于「常用工具 / Cursor",
+        "> 安装方式」的说明：`https://help.cloudcc.cn/product03/chang-yong-gong-ju/`",
+        "",
+        "---",
+        "",
+        "## 5. 安装并配置本地 MCP（cc-mcp）",
+        "",
+        "在支持 MCP 的开发工具中（如 Cursor），需要在 MCP 配置文件中添加：",
+        "",
+        "```json",
+        "{",
+        "    \"mcpServers\": {",
+        "        \"cloudcc-cli\": {",
+        "            \"command\": \"cc-mcp\"",
+        "        }",
+        "    }",
+        "}",
+        "```",
+        "",
+        "说明：",
+        "",
+        "- `cloudcc-cli`：MCP 服务器标识，用于在工具中调用 CloudCC 相关能力",
+        "- `command: \"cc-mcp\"`：实际执行的命令，通常由 `cloudcc-cli` 提供",
+        "",
+        "---",
+        "",
+        "## 6. 创建模板项目并本地运行",
+        "",
+        "### 6.1 使用 CLI 创建项目",
+        "",
+        "在终端中切换到你的开发目录（如 `Documents`）：",
+        "",
+        "```bash",
+        "cd ~/Documents",
+        "cc create project demo1",
+        "```",
+        "",
+        "`demo1` 为示例项目名，可按需替换。",
+        "",
+        "### 6.2 安装依赖并启动",
+        "",
+        "1. 使用 VS Code 打开刚创建的项目目录",
+        "2. 在 VS Code 中选择菜单：`终端 → 新建终端`",
+        "3. 在项目根目录安装依赖：",
+        "",
+        "```bash",
+        "npm i",
+        "```",
+        "",
+        "4. 依赖安装完成后启动本地开发服务器：",
+        "",
+        "```bash",
+        "npm run serve",
+        "```",
+        "",
+        "5. 在浏览器访问：",
+        "",
+        "```text",
+        "http://localhost:8080/",
+        "```",
+        "",
+        "看到模板页面即表示前端本地环境搭建成功。",
+        "",
+        "---",
+        "",
+        "## 7. 获取并配置开发者密钥",
+        "",
+        "> 目的：将本地项目与指定 CloudCC",
+        "> 环境（Org）关联，需使用具备「开发者权限」的账号在 CRM",
+        "> 中获取密钥和安全标记，然后配置到项目根目录下的 `cloudcc-cli.config.js`。",
+        "",
+        "### 7.1 创建开发者账号",
+        "",
+        "前提：拥有系统管理员账号。",
+        "",
+        "1. 使用系统管理账号登录 CRM",
+        "2. 点击右上角齿轮，进入后台设置",
+        "3. 进入 `用户管理 → 新建` 创建新用户",
+        "4. 为新用户分配**具有开发者权限**的简档：",
+        "   - 路径：`管理用户 → 简档 → 对应简档 → 普通用户权限 → 代码管理`",
+        "   - 确认「代码管理」权限已开启",
+        "",
+        "### 7.2 获取开发者密钥（CloudCCDev）",
+        "",
+        "1. 使用开发者账号登录 CRM",
+        "2. 点击右上角齿轮，进入后台设置",
+        "3. 路径：`用户及控制 → 安全性控制 → 连接的应用程序 → 新建`",
+        "4. 填写：",
+        "   - 连接的应用程序名称",
+        "   - API 名称",
+        "   - 联系人电子邮件",
+        "5. 创建完成后，在详情页中找到",
+        "   `CloudCC Dev`，点击后面的复制按钮，得到开发者密钥，妥善保管。",
+        "",
+        "### 7.3 获取安全标记（safetyMark）",
+        "",
+        "1. 使用同一开发者账号登录 CRM",
+        "2. 路径：`常规 → 个人设置 → 重置我的安全标记`",
+        "3. 点击后，安全标记会发送到用户邮箱，在邮箱中查收并记录。",
+        "",
+        "### 7.4 配置 `cloudcc-cli.config.js`",
+        "",
+        "在模板项目根目录找到并打开 `cloudcc-cli.config.js`，参考官方示例填写：",
+        "",
+        "```javascript",
+        "module.exports = {",
+        "    // 当前使用的环境标记",
+        "    use: \"dev\",",
+        "",
+        "    // dev 环境密钥",
+        "    dev: {",
+        "        safetyMark: \"必填，安全标记\",",
+        "        CloudCCDev: \"必填，开发者密钥\",",
+        "        username: \"选填，开发者用户名，会覆盖 CloudCCDev 中的 username\",",
+        "    },",
+        "",
+        "    // prod 环境密钥",
+        "    prod: {",
+        "        safetyMark: \"必填，安全标记\",",
+        "        CloudCCDev: \"必填，开发者密钥\",",
+        "        username: \"选填，开发者用户名，会覆盖 CloudCCDev 中的 username\",",
+        "    },",
+        "};",
+        "```",
+        "",
+        "说明：",
+        "",
+        "- `use` 决定当前连接哪个环境（如 `\"dev\"` / `\"prod\"` 等）",
+        "- 不要把真实密钥提交到 Git 仓库（应在 `.gitignore` 中忽略）",
+        "",
+        "---",
+        "",
+        "## 8. 私有云与特殊参数配置",
+        "",
+        "### 8.1 私有云标记",
+        "",
+        "在私有云场景下，需要额外增加 `version: \"private\"` 字段示意：",
+        "",
+        "```javascript",
+        "module.exports = {",
+        "    use: \"dev\",",
+        "    dev: {",
+        "        safetyMark: \"必填，安全标记\",",
+        "        CloudCCDev: \"必填，开发者密钥\",",
+        "        version: \"必填，private\",",
+        "        username: \"选填，开发者用户名，会覆盖 CloudCCDev 中的 username\",",
+        "    },",
+        "    prod: {",
+        "        safetyMark: \"必填，安全标记\",",
+        "        CloudCCDev: \"必填，开发者密钥\",",
+        "        version: \"必填, private\",",
+        "        username: \"选填，开发者用户名，会覆盖 CloudCCDev 中的 username\",",
+        "    },",
+        "};",
+        "```",
+        "",
+        "### 8.2 baseUrl 与网关前缀",
+        "",
+        "示例配置（精简自官方文档）：",
+        "",
+        "```javascript",
+        "dev: {",
+        "  // 服务访问地址：",
+        "  // 国内默认：https://developer.apis.cloudcc.cn",
+        "  // 海外默认：https://developer.apis.cloudcc.com",
+        "  // 私有云：可在登录 CRM 后，右键 → 检查 → 控制台，执行 $CCDK.CCConfig.getBaseUrl()",
+        "  baseUrl: \"http://xxx\",",
+        "",
+        "  // 组件进入后台后自动销毁时间（毫秒），如 10 分钟：10 * 60 * 1000",
+        "  destroyTimeout: 600000,",
+        "",
+        "  // 开发者平台在网关配置的前缀名，注意 URL 不要以 / 结尾",
+        "  devSvcDispatch: \"/devconsole\",",
+        "",
+        "  // api-service-svc 访问网关前缀地址",
+        "  apiSvcPrefix: \"/xxx\",",
+        "",
+        "  // setup-svc 访问网关前缀地址",
+        "  setupSvcPrefix: \"/xxx\"",
+        "}",
+        "```",
+        "",
+        "---",
+        "",
+        "## 9. 多环境配置示例",
+        "",
+        "`cloudcc-cli.config.js` 支持配置多个环境，通过 `use` 字段选择当前使用的环境：",
+        "",
+        "```javascript",
+        "module.exports = {",
+        "    // 使用 dev 环境密钥，与 dev 环境连接",
+        "    use: \"dev\",",
+        "",
+        "    // dev 环境密钥",
+        "    dev: {",
+        "        safetyMark: \"xxx\",",
+        "        CloudCCDev: \"xxx\",",
+        "    },",
+        "",
+        "    // prod 环境密钥",
+        "    prod: {",
+        "        safetyMark: \"xxx\",",
+        "        CloudCCDev: \"xxx\",",
+        "    },",
+        "};",
+        "```",
+        "",
+        "建议：",
+        "",
+        "- 本地调试使用 `dev` 或测试环境",
+        "- 合并上线前在 `uat` 或类似环境进行回归验证",
+        "- 生产配置应仅在 CI/CD 或受控环境中可见，避免在开发机上长期保存生产密钥",
+        "",
+        "---",
+        "",
+        "## 10. 开发工具与代码规范补充",
+        "",
+        "### 10.1 推荐开发工具组合",
+        "",
+        "- 编辑器：VS Code（配合 CloudCC 插件）",
+        "- 包管理：npm（建议配置阿里源）",
+        "- 版本控制：Git",
+        "",
+        "官方文档中的推荐插件示例：",
+        "",
+        "- `ESLint`：代码规范检查",
+        "- `Vetur` / 对应 Vue 插件：Vue 语法高亮与提示",
+        "- `GitLens`：Git 历史与责任人查看",
+        "- `Live Server`：静态资源快速预览（如需）",
+        "",
+        "### 10.2 代码规范（简要）",
+        "",
+        "详细 JS/CSS/注释规范可参考官方文档「开发规范」小节，这里仅保留关键点：",
+        "",
+        "- 启用 ESLint 作为基础校验",
+        "- 在项目根目录维护 `README.md`，记录每次发布版本与更新内容",
+        "- Vue 组件中使用 `scoped` 样式或统一引入的样式变量文件，避免污染全局",
+        "",
+        "---",
+        "",
+        "## 11. 小结：环境搭建 Checklist",
+        "",
+        "在实际项目中，可使用以下清单快速自检：",
+        "",
+        "- [ ] 已安装 Node（推荐 v20.19.5）并通过 `node -v` 验证",
+        "- [ ] npm 源已切换到 `https://registry.npmmirror.com`",
+        "- [ ] 已全局安装 `cloudcc-cli` 并验证",
+        "- [ ] 已安装 VS Code 与 CloudCC 插件（或已按官方指引配置 Cursor）",
+        "- [ ] MCP 已配置 `cloudcc-cli → cc-mcp`",
+        "- [ ] 已通过 `cc create project` 创建模板项目并成功 `npm i` + `npm run serve`",
+        "- [ ] 已创建开发者账号并确认「代码管理」权限开启",
+        "- [ ] 已获取开发者密钥与安全标记并正确配置 `cloudcc-cli.config.js`",
+        "- [ ] 如为私有云，已配置 `version: \"private\"` 与正确的 `baseUrl`/网关前缀",
+        "- [ ] 多环境（dev/prod/uat 等）配置与 `use` 字段已核对无误",
+    ];
+
+    return lines.join("\n");
+}
+
+function doc(argvs) {
+    const content = generateFullMarkdownDoc();
+    console.log(content);
+    return content;
+}
+
+module.exports = doc;

package/src/project/index.js

@@ -1,5 +1,6 @@
 const cc = {}
 cc.create = require("./create1")
+cc.doc = require("./doc")
 function Plugin(action, argvs) {
     cc[action](argvs)
 }

package/src/script/doc.js

@@ -0,0 +1,259 @@
+/**
+ * script 文档统一入口（全量一次性输出）
+ */
+const fs = require("fs");
+const path = require("path");
+
+function generateFullMarkdownDoc() {
+    const lines = [
+        "# CloudCC 客户端脚本开发指南",
+        "",
+        "> 本文档参考 CloudCC 官方「客户端脚本」文档整理而成：[客户端脚本](https://help.cloudcc.cn/product03/ke-hu-duan-jiao-ben/)。  ",
+        "> 目标：指导开发者在不同页面（列表、新建/编辑、详情、全局）特定时机运行 JavaScript，基于 CCDK 能力实现字段控制、布局调整等前端增强。",
+        "",
+        "---",
+        "",
+        "## 1. 概念与入口",
+        "",
+        "### 1.1 什么是客户端脚本",
+        "",
+        "- 客户端脚本是在 **浏览器端**、特定页面和时机执行的一段 JavaScript。  ",
+        "- 依托 `$CCDK` 提供的桥接能力，可以：",
+        "  - 显示提示信息",
+        "  - 控制字段显隐 / 只读",
+        "  - 调整页面 DOM 结构",
+        "  - 在保存前/后执行校验或自定义逻辑",
+        "",
+        "### 1.2 进入客户端脚本设置页面",
+        "",
+        "1. 登录 CloudCC 系统  ",
+        "2. 点击右上角头像，选择「开发者平台」（仅管理员简档可见）  ",
+        "3. 左侧菜单：`扩展 → 客户端脚本`",
+        "",
+        "---",
+        "",
+        "## 2. 创建第一个客户端脚本",
+        "",
+        "### 2.1 新建脚本",
+        "",
+        "1. 在「客户端脚本」列表页，点击右上角「新建」  ",
+        "2. 填写基本信息（名称、适用对象/页面/事件等），进入代码编辑页面  ",
+        "3. 在代码输入区输入示例代码：",
+        "",
+        "```javascript",
+        "$CCDK.CCMessage.showMessage('hello cloudCC');",
+        "```",
+        "",
+        "4. 点击右上角「保存」",
+        "",
+        "### 2.2 回到前台查看效果",
+        "",
+        "例如：  ",
+        "- 配置为在「客户详情页 onLoad」执行  ",
+        "- 返回前台 → 打开客户菜单 → 进入任意一条客户详情  ",
+        "- 页面加载完成后，会看到 `hello cloudCC` 提示信息",
+        "",
+        "---",
+        "",
+        "## 3. 利用 devid 精确控制页面元素",
+        "",
+        "> 为方便控制页面元素，平台在关键 DOM 节点上添加了 `devid` 自定义属性，并使用特定业务 ID 绑定。可通过 F12 查看并用于脚本选择器。",
+        "",
+        "### 3.1 示例：禁用编辑页的「分级」字段",
+        "",
+        "#### 第一步：查看 devid",
+        "",
+        "1. 按 `F12` 打开浏览器开发者工具  ",
+        "2. 切换到「元素」(Elements) 面板  ",
+        "3. 使用元素选择器选中「分级」字段对应 DOM  ",
+        "4. 在右侧/标签属性中查找并复制该元素的 `devid` 值备用",
+        "",
+        "#### 第二步：创建客户端脚本",
+        "",
+        "在客户端脚本中，根据 `devid` 操作 DOM：",
+        "",
+        "```javascript",
+        "// 方式一：通过动态插入样式禁用点击",
+        "let style = document.createElement('style');",
+        "style.type = 'text/css';",
+        "style.innerHTML = '[devid=\"ffe201100003855g6Ipz\"]{pointer-events:none}';",
+        "document.getElementsByTagName('head').item(0).appendChild(style);",
+        "",
+        "// 方式二：直接隐藏某个元素",
+        "let dd = document.querySelector('div[devid=\"ffe201100003428r65pk\"]');",
+        "if (dd) {",
+        "  dd.style.display = \"none\";",
+        "}",
+        "```",
+        "",
+        "保存后回到前台，进入对应页面查看效果。",
+        "",
+        "### 3.2 示例：隐藏详情页某个字段",
+        "",
+        "同样通过 `devid` 精确定位字段，再注入样式：",
+        "",
+        "```javascript",
+        "// 隐藏并不占用空间",
+        "let style = document.createElement('style');",
+        "style.type = 'text/css';",
+        "style.innerHTML = '[devid=\"ffe20220523account01\"]{display:none !important}';",
+        "document.getElementsByTagName('head').item(0).appendChild(style);",
+        "```",
+        "",
+        "```javascript",
+        "// 隐藏但保留空间",
+        "let style = document.createElement('style');",
+        "style.type = 'text/css';",
+        "style.innerHTML = '[devid=\"ffe20220523account01\"]{visibility:hidden !important}';",
+        "document.getElementsByTagName('head').item(0).appendChild(style);",
+        "```",
+        "",
+        "### 3.3 示例：移动页面元素到其他位置",
+        "",
+        "```javascript",
+        "// 获取要移动的节点",
+        "const moveNode = document.querySelector('[devid=\"aee2024EFBBA5EEfs1Ta\"]');",
+        "// 目标节点",
+        "const targetNode = document.querySelector('[devid=\"adf2024D33E03DA6xzBj\"]');",
+        "// 目标节点的父节点",
+        "const targetParentNode = targetNode.parentNode;",
+        "",
+        "// 将需要移动的节点插入到目标节点前面",
+        "if (moveNode && targetNode && targetParentNode) {",
+        "  targetParentNode.insertBefore(moveNode, targetNode);",
+        "}",
+        "```",
+        "",
+        "**注意**：DOM 可能尚未渲染完成，可结合定时器或 `MutationObserver` 等机制等待节点出现。",
+        "",
+        "---",
+        "",
+        "## 4. 页面类型与脚本事件映射",
+        "",
+        "> 系统页面大致分为「全局、列表、新建/编辑、详情」等类型，每种页面支持不同事件，脚本在对应时机执行。",
+        "",
+        "以下是官方提供的主要事件（简化说明）：",
+        "",
+        "### 4.1 全局类型",
+        "",
+        "- **onCreate**",
+        "  - 适用：PC / HS",
+        "  - 函数签名：`function test($CCDK, obj = {})`",
+        "  - 说明：项目启动时触发（业务页面代码尚未执行）",
+        "",
+        "- **onLoad**",
+        "  - 适用：PC / HS",
+        "  - 场景：全局 UI 首次展示后",
+        "",
+        "- **onDestroy**",
+        "  - 适用：PC / HS",
+        "  - 场景：关闭 Tab / 更改流程等导致当前应用关闭时",
+        "",
+        "### 4.2 视图页（列表页面）",
+        "",
+        "事件函数统一形如：`function test($CCDK, obj = {})`",
+        "",
+        "- **onCreated**",
+        "  - 时机：进入视图页，但 DOM 还未创建  ",
+        "- **onLoad**",
+        "  - 时机：首次进入，或点击搜索刷新列表数据后  ",
+        "- **onDestroy**",
+        "  - 时机：离开列表页（如进入详情页等）",
+        "",
+        "### 4.3 新建/编辑页",
+        "",
+        "同样使用 `function test($CCDK, obj = {})`：",
+        "",
+        "- **onCreated**",
+        "  - 时机：进入新建/编辑页面，但 DOM 尚未创建  ",
+        "- **onLoad**",
+        "  - 时机：详情数据加载完成、页面渲染结束  ",
+        "- **onDestroy**",
+        "  - 时机：离开新建/编辑页面  ",
+        "- **beforeSave**",
+        "  - 参数：`obj.detailData` 为 key-value 形式的详情数据，**可以在这里修改**  ",
+        "  - 时机：点击保存按钮时触发，适合做前端校验与补充字段赋值  ",
+        "- **afterSave**",
+        "  - 时机：保存接口请求完成后触发  ",
+        "- **onChange**",
+        "  - 时机：编辑某个字段、光标失焦，且 value 有变化时触发",
+        "",
+        "### 4.4 详情页",
+        "",
+        "- **onLoad**",
+        "  - 适用：PC / HS  ",
+        "  - 时机：获取详情基础数据并完成 DOM 渲染后触发  ",
+        "",
+        "---",
+        "",
+        "## 5. 实战建议与注意事项",
+        "",
+        "### 5.1 DOM 渲染时机",
+        "",
+        "- 部分页面在脚本执行时 DOM 可能尚未完全渲染，建议：",
+        "  - 使用 `setTimeout` / 轮询检查目标节点是否存在  ",
+        "  - 或配合 `MutationObserver` 监听 DOM 变化后再操作  ",
+        "",
+        "### 5.2 与 CCDK 的配合",
+        "",
+        "- `$CCDK` 提供了多种能力，如：",
+        "  - `CCMessage`：消息提示  ",
+        "  - `CCLoad`：脚本/样式加载  ",
+        "  - 其他与对象/类交互的桥接能力  ",
+        "- 客户端脚本中应优先调用 `$CCDK` 而非自行拼接接口。",
+        "",
+        "### 5.3 与自定义组件的边界",
+        "",
+        "- 客户端脚本更适合：",
+        "  - 简单的字段控制",
+        "  - 小范围布局微调",
+        "  - 轻量交互增强  ",
+        "- 更复杂的 UI、交互与业务逻辑推荐用「自定义组件」实现（详见 `custom-component-dev.md`）。",
+        "",
+        "---",
+        "",
+        "## 6. 客户端脚本开发 Checklist",
+        "",
+        "- [ ] 已在「开发者平台 → 客户端脚本」正确选择对象、页面类型与事件（onLoad / beforeSave 等）  ",
+        "- [ ] 使用 `$CCDK` 能力而非手工拼接接口或直接依赖不稳定的全局变量  ",
+        "- [ ] 所有 DOM 操作都考虑了渲染时机，避免因节点不存在而报错  ",
+        "- [ ] 通过 `devid` 精确定位关键元素，避免依赖脆弱的层级或 class 选择器  ",
+        "- [ ] 对性能敏感操作（如定时器、频繁 DOM 查询）做了节流或销毁处理  ",
+        "- [ ] 已区分客户端脚本与自定义组件的职责，将复杂 UI / 交互放到组件中实现  ",
+        "- [ ] 在目标环境中完整测试：列表 / 新建 / 编辑 / 详情等场景，确认无脚本错误和布局异常  ",
+        "",
+    ];
+
+    const base = lines.join("\n");
+    const ccdkPath = path.join(__dirname, "..", "api", "ccdk-sdk.md");
+    let ccdkContent = "";
+    try {
+        ccdkContent = fs.readFileSync(ccdkPath, "utf8");
+    } catch (e) {
+        ccdkContent = `# CloudCC 前端 SDK（cloudcc-ccdk）使用指南\n\n（未找到文件：${ccdkPath}）\n`;
+    }
+
+    return [
+        base,
+        "",
+        "---",
+        "",
+        "## 附录：CCDK SDK 速查",
+        "",
+        "> 来源：`src/api/ccdk-sdk.md`",
+        "",
+        ccdkContent.trim(),
+        "",
+    ].join("\n");
+}
+
+function doc() {
+    const content = generateFullMarkdownDoc();
+    console.log(content);
+    return content;
+}
+
+// 兼容旧调用方：仍提供同名入口（但都返回全量文档）
+doc.getEditGuide = doc;
+
+module.exports = doc;

package/src/script/index.js

@@ -5,6 +5,7 @@ cc.pull = require("./pull")
 cc.get = require("./get")
 cc.pullList = require("./pullList")
 cc.detail = require("./detail")
+cc.doc = require("./doc")
 function main(action, argvs) {
   cc[action](argvs)
 }

package/src/timer/index.js

@@ -4,6 +4,7 @@ cc.publish = require("./publish")
 cc.pull = require("./pull")
 cc.get = require("./get")
 cc.pullList = require("./pullList")
+cc.detail = require("./detail")
 function Timer(action, argvs) {
   cc[action](argvs[2], argvs[3])
 }