cloudcc-cli 2.3.3 → 2.3.5

package/src/validationRule/delete.js

@@ -0,0 +1,60 @@
+const chalk = require("chalk");
+const { postClass } = require("../../utils/http");
+const { getPackageJson } = require("../../utils/config");
+
+/**
+ * 删除验证规则
+ * 用法：cc delete validationRule <projectPath> <ruleId>
+ */
+async function remove(argvs) {
+    try {
+        const projectPath = argvs[2] || process.cwd();
+        const ruleId = argvs[3];
+
+        if (!ruleId) {
+            console.error();
+            console.error(chalk.red("Error: 缺少规则 ID"));
+            console.error(chalk.yellow("用法: cc delete validationRule <projectPath> <ruleId>"));
+            console.error();
+            throw new Error("缺少必需参数: ruleId");
+        }
+
+        const config = await getPackageJson(projectPath);
+        if (!config || !config.accessToken) {
+            console.error();
+            console.error(chalk.red("Error: 配置未找到或 accessToken 缺失"));
+            console.error();
+            throw new Error("配置未找到或 accessToken 缺失");
+        }
+
+        console.error();
+        console.error(chalk.green(`Deleting validation rule (${ruleId}), please wait...`));
+        console.error();
+
+        const result = await postClass(
+            config.setupSvc + "/api/validateRule/delete",
+            { id: ruleId },
+            config.accessToken
+        );
+
+        if (result && result.result) {
+            console.error();
+            console.error(chalk.green("Success! Validation rule deleted."));
+            console.error(chalk.blue("返回结果:"), JSON.stringify(result, null, 2));
+            console.error();
+            return result;
+        }
+
+        const msg = result && (result.returnInfo || result.message) ? (result.returnInfo || result.message) : "Unknown error";
+        console.error();
+        console.error(chalk.red("Error: " + msg));
+        console.error();
+        throw new Error("Delete ValidationRule Failed: " + msg);
+    } catch (error) {
+        console.error();
+        console.error(chalk.red("验证规则删除失败:"), error);
+        throw error;
+    }
+}
+
+module.exports = remove;

package/src/validationRule/doc.js

@@ -0,0 +1,46 @@
+/**
+ * validationRule 文档入口：正文均在 `docs/` 目录。
+ */
+const fs = require("fs");
+const path = require("path");
+
+const DOCS_DIR = path.join(__dirname, "docs");
+
+function readDocFile(basename) {
+    return fs.readFileSync(path.join(DOCS_DIR, `${basename}.md`), "utf8");
+}
+
+/** 介绍文档：验证规则能力 */
+function getIntroductionDoc() {
+    return readDocFile("introduction");
+}
+
+/** 开发指导：CLI 创建/查询/删除等 */
+function getDevGuideDoc() {
+    return readDocFile("devguide");
+}
+
+/**
+ * cc doc validationRule <introduction|devguide>
+ * @param {string[]} argvs [doc, type, introduction|devguide, ...]
+ */
+function doc(argvs) {
+    const subType = argvs[2];
+    const key = String(subType || "").trim().toLowerCase();
+    if (!key) {
+        throw new Error("cc doc validationRule 需要子命令：introduction 或 devguide");
+    }
+    if (key === "introduction") {
+        const content = getIntroductionDoc();
+        console.log(content);
+        return content;
+    }
+    if (key === "devguide") {
+        const content = getDevGuideDoc();
+        console.log(content);
+        return content;
+    }
+    throw new Error(`doc 不支持的子命令: ${subType}，请使用 introduction 或 devguide`);
+}
+
+module.exports = doc;

package/src/validationRule/docs/devguide.md

@@ -0,0 +1,76 @@
+# CloudCC 验证规则 CLI 命令说明
+
+## 支持的命令
+
+| 操作 | 说明 |
+|------|------|
+| `create` | 创建新验证规则 |
+| `get` | 查询验证规则列表 |
+| `delete` | 删除验证规则 |
+
+## CLI 命令详解
+
+### 创建验证规则
+
+```bash
+cc create validationRule <path> <objectPrefix> [ruleName] [ruleContent] [errorMessage]
+```
+
+**参数说明：**
+
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `path` | 是 | 项目路径，`.` 表示当前目录 |
+| `objectPrefix` | 是 | 对象前缀，如 `b00` |
+| `ruleName` | 否 | 规则名称（不传则交互式输入） |
+| `ruleContent` | 否 | 规则内容，如 `Batch_Size__c__f==5`（不传则交互式输入） |
+| `errorMessage` | 否 | 错误提示信息（不传则交互式输入） |
+
+**示例：**
+
+```bash
+# 交互式输入所有信息
+cc create validationRule . "b00"
+
+# 非交互式创建
+cc create validationRule . "b00" "规则1" "Batch_Size__c__f==5" "数量必须是5"
+```
+
+### 查询验证规则列表
+
+```bash
+cc get validationRule <projectPath> <objectPrefix>
+```
+
+**参数说明：**
+
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `projectPath` | 否 | 项目路径，默认当前目录 |
+| `objectPrefix` | 是 | 对象前缀，如 `b00` |
+
+**示例：**
+
+```bash
+# 获取对象 b00 的所有验证规则
+cc get validationRule . "b00"
+```
+
+### 删除验证规则
+
+```bash
+cc delete validationRule <projectPath> <ruleId>
+```
+
+**参数说明：**
+
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `projectPath` | 否 | 项目路径，默认当前目录 |
+| `ruleId` | 是 | 规则 ID |
+
+**示例：**
+
+```bash
+cc delete validationRule . 202689E55795D38oAQlN
+```

package/src/validationRule/docs/introduction.md

@@ -0,0 +1,122 @@
+# CloudCC 验证规则使用总结
+
+验证规则（Validation Rule）用于在数据保存前进行校验，确保数据的完整性和正确性。当数据不符合规则时，系统会显示错误信息阻止保存。
+
+---
+
+## 快速开始（CLI 命令）
+
+### 支持的验证规则操作
+
+| 操作 | 说明 |
+|------|------|
+| `create` | 创建新验证规则 |
+| `get` | 查询验证规则列表 |
+| `delete` | 删除验证规则 |
+
+---
+
+## CLI 命令详解
+
+### 创建验证规则
+
+创建一个新的 CloudCC 验证规则。
+
+```bash
+cc create validationRule <path> <objectPrefix> [ruleName] [ruleContent] [errorMessage]
+```
+
+**参数说明：**
+
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `path` | 是 | 项目路径，`.` 表示当前目录 |
+| `objectPrefix` | 是 | 对象前缀，如 `b00` |
+| `ruleName` | 否 | 规则名称（不传则交互式输入） |
+| `ruleContent` | 否 | 规则内容，如 `Batch_Size__c__f==5`（不传则交互式输入） |
+| `errorMessage` | 否 | 错误提示信息（不传则交互式输入） |
+
+**示例：**
+
+```bash
+# 交互式输入所有信息
+cc create validationRule . "b00"
+
+# 非交互式创建
+cc create validationRule . "b00" "规则1" "Batch_Size__c__f==5" "数量必须是5"
+```
+
+---
+
+### 查询验证规则列表
+
+获取指定对象的所有验证规则列表。
+
+```bash
+cc get validationRule <projectPath> <objectPrefix>
+```
+
+**参数说明：**
+
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `projectPath` | 否 | 项目路径，默认当前目录 |
+| `objectPrefix` | 是 | 对象前缀，如 `b00` |
+
+**示例：**
+
+```bash
+# 获取对象 b00 的所有验证规则
+cc get validationRule . "b00"
+```
+
+---
+
+### 删除验证规则
+
+删除指定的验证规则。
+
+```bash
+cc delete validationRule <projectPath> <ruleId>
+```
+
+**参数说明：**
+
+| 参数 | 必填 | 说明 |
+|------|------|------|
+| `projectPath` | 否 | 项目路径，默认当前目录 |
+| `ruleId` | 是 | 规则 ID |
+
+**示例：**
+
+```bash
+# 删除指定规则
+cc delete validationRule . 202689E55795D38oAQlN
+```
+
+---
+
+## 完整工作流示例
+
+### 场景：为订单对象创建验证规则
+
+```bash
+# 1. 确认项目已初始化（有 cloudcc-cli.config.js）
+cat cloudcc-cli.config.js
+
+# 2. 查询对象现有的验证规则
+cc get validationRule . "b00"
+
+# 3. 创建新验证规则
+cc create validationRule . "b00"
+
+# 4. 验证规则创建成功
+cc get validationRule . "b00"
+
+# 5. 如需删除
+# cc delete validationRule . <ruleId>
+```
+
+---
+
+*文档版本：1.0 | 最后更新：2026-03-27*

package/src/validationRule/get.js

@@ -0,0 +1,47 @@
+const { postClass } = require("../../utils/http");
+const { getPackageJson } = require("../../utils/config");
+
+/**
+ * 查询验证规则列表
+ * 用法：cc get validationRule <projectPath> <objectPrefix>
+ * 接口：POST /api/validateRule/queryByPrefix
+ * 参数：{ prefix: "b00" }
+ */
+async function get(argvs, isMcp = false) {
+    const projectPath = argvs[2] || process.cwd();
+    const objectPrefix = argvs[3];
+
+    if (!objectPrefix) {
+        const msg = "缺少对象前缀参数";
+        if (!isMcp) {
+            console.error(msg);
+        }
+        throw new Error("Get ValidationRule Failed: " + msg);
+    }
+
+    const body = { prefix: objectPrefix };
+
+    const config = await getPackageJson(projectPath);
+    const res = await postClass(
+        config.setupSvc + "/api/validateRule/queryByPrefix",
+        body,
+        config.accessToken
+    );
+
+    if (res && res.result) {
+        const data = res.data;
+        let rawList = [];
+        if (data && Array.isArray(data.list)) {
+            rawList = data.list;
+        }
+        if (!isMcp) {
+            console.log(JSON.stringify(rawList));
+        }
+        return rawList;
+    }
+
+    const msg = res && (res.returnInfo || res.message) ? (res.returnInfo || res.message) : "Unknown error";
+    throw new Error("Get ValidationRule Failed: " + msg);
+}
+
+module.exports = get;

package/src/validationRule/index.js

@@ -0,0 +1,10 @@
+const cc = {}
+cc.create = require("./create")
+cc.delete = require("./delete")
+cc.get = require("./get")
+cc.doc = require("./doc")
+function main(action, argvs) {
+  cc[action](argvs)
+}
+
+module.exports = main;

package/src/version/actionHelp.js

@@ -0,0 +1,25 @@
+const chalk = require("chalk")
+const { getResourcesForAction } = require("./listModuleCommands")
+
+function actionHelp(argvs) {
+  const action = argvs[0]
+  const list = getResourcesForAction(action)
+  console.error()
+  if (list.length === 0) {
+    console.error(chalk.yellow(`没有 resource 支持 action「${action}」。`))
+    console.error(chalk.gray("运行 ") + chalk.green("cc --help") + chalk.gray(" 查看全部命令。"))
+    console.error()
+    return
+  }
+  console.error(chalk.bold.cyan(`cc ${action}`) + chalk.gray(" <resource> [args...]"))
+  console.error()
+  console.error(chalk.yellow("可用的 resource："))
+  for (const r of list) {
+    console.error("  " + chalk.green(r))
+  }
+  console.error()
+  console.error(chalk.gray("示例：") + chalk.green(`cc ${action} ${list[0]}`) + chalk.gray(" <后续参数见各模块文档>"))
+  console.error()
+}
+
+module.exports = actionHelp

package/src/version/docs.js

@@ -0,0 +1,26 @@
+const { spawn } = require("child_process")
+const chalk = require("chalk")
+
+const HELP_CENTER = "https://help.cloudcc.cn/"
+
+function docs() {
+  const url = HELP_CENTER
+  try {
+    if (process.platform === "win32") {
+      spawn("cmd", ["/c", "start", "", url], { detached: true, stdio: "ignore" }).unref()
+    } else if (process.platform === "darwin") {
+      spawn("open", [url], { detached: true, stdio: "ignore" }).unref()
+    } else {
+      spawn("xdg-open", [url], { detached: true, stdio: "ignore" }).unref()
+    }
+    console.error()
+    console.error(chalk.green("已在浏览器打开：") + chalk.cyan(url))
+    console.error()
+  } catch (e) {
+    console.error()
+    console.error(chalk.yellow("无法自动打开浏览器，请手动访问："), chalk.cyan(url))
+    console.error()
+  }
+}
+
+module.exports = docs

package/src/version/doctor.js

@@ -0,0 +1,25 @@
+const fs = require("fs")
+const path = require("path")
+const chalk = require("chalk")
+const pkg = require("../../package.json")
+
+function doctor() {
+  console.error()
+  console.error(chalk.bold.cyan("cc doctor") + chalk.gray(" — 环境自检"))
+  console.error()
+  console.error(chalk.green("✓") + " Node " + process.version)
+  console.error(chalk.green("✓") + " cloudcc-cli v" + pkg.version)
+
+  const cwd = process.cwd()
+  const configPath = path.join(cwd, "cloudcc-cli.config.js")
+  if (fs.existsSync(configPath)) {
+    console.error(chalk.green("✓") + " 当前目录存在 cloudcc-cli.config.js")
+  } else {
+    console.error(
+      chalk.yellow("○") + " 当前目录未找到 cloudcc-cli.config.js（若在本目录开发 CloudCC 项目，请先初始化或放入配置）"
+    )
+  }
+  console.error()
+}
+
+module.exports = doctor

package/src/version/get.js

@@ -1,9 +1,15 @@
 const chalk = require("chalk")
 const pkg = require("../../package.json")
+const { getReleaseForExact, defaultReadmePath } = require("../../utils/readmeReleases")
+const { printReleaseNotesBlocks } = require("../../utils/formatReleaseNotes")
 
 function get() {
     console.error()
-    console.error(chalk.green(`cloudcc-cli version: ${pkg.version}`));
+    console.error(chalk.green(`cloudcc-cli version: ${pkg.version}`))
+    const rel = getReleaseForExact(defaultReadmePath(), pkg.version)
+    if (rel) {
+        printReleaseNotesBlocks([rel], console.error)
+    }
     console.error()
 }
 

package/src/version/help.js

@@ -0,0 +1,47 @@
+const chalk = require("chalk")
+const pkg = require("../../package.json")
+const { getModuleGroups, describeActionLine } = require("./listModuleCommands")
+
+function help() {
+  console.error()
+  console.error(chalk.bold.cyan("cloudcc-cli (cc)") + chalk.gray(` v${pkg.version}`))
+  console.error()
+  console.error(chalk.yellow("Usage:"))
+  console.error("  " + chalk.green("cc") + " <action> <resource> [args...]")
+  console.error()
+  console.error(chalk.yellow("Global:"))
+  console.error("  " + chalk.green("cc --help") + ", " + chalk.green("-h") + ", " + chalk.green("cc help") + "  显示本帮助")
+  console.error("  " + chalk.green("cc --version") + ", " + chalk.green("-v") + "  打印版本号")
+  console.error("  " + chalk.green("cc update") + "              升级全局 cloudcc-cli")
+  console.error("  " + chalk.green("cc uninstall") + "           卸载全局 cloudcc-cli")
+  console.error("  " + chalk.green("cc doctor") + "              环境自检（Node、配置、CLI 版本）")
+  console.error("  " + chalk.green("cc docs") + "               在浏览器打开 CloudCC 帮助中心")
+  console.error("  " + chalk.green("cc stats") + "              查看本地命令调用统计（默认开启，" + chalk.gray("CLOUDCC_CLI_STATS=0") + " 可关闭）")
+  console.error("  " + chalk.green("cc init") + " [项目名]      等同于 cc create project")
+  console.error("  " + chalk.green("cc <action> -h") + "        查看该 action 下可用的 resource")
+  console.error()
+  console.error(chalk.yellow("模块 (resource)"))
+  console.error()
+
+  const groups = getModuleGroups()
+  for (const { resources, actions } of groups) {
+    const title = resources.join(" / ")
+    console.error(chalk.bold.white("  " + title))
+    const ex = resources[0]
+    for (const a of actions) {
+      const cmd = "cc " + a + " " + ex
+      const note = describeActionLine(ex, a)
+      console.error("    " + chalk.green(cmd) + "  " + chalk.gray(note))
+    }
+    console.error()
+  }
+
+  console.error(chalk.yellow("Examples:"))
+  console.error("  " + chalk.gray("cc doc object introduction"))
+  console.error("  " + chalk.gray("cc get object Account"))
+  console.error()
+  console.error(chalk.gray("Developer docs: https://help.cloudcc.cn/"))
+  console.error()
+}
+
+module.exports = help

package/src/version/index.js

@@ -1,8 +1,15 @@
 const cc = {}
 cc.get = require("./get")
+cc.help = require("./help")
+cc.update = require("./update")
+cc.uninstall = require("./uninstall")
 
 function Version(action, argvs) {
-  cc[action](argvs)
+  const fn = cc[action]
+  if (!fn) {
+    throw new Error(`version: unsupported action ${action}`)
+  }
+  return Promise.resolve(fn(argvs))
 }
 
-module.exports = Version;
+module.exports = Version

package/src/version/initHelp.js

@@ -0,0 +1,13 @@
+const chalk = require("chalk")
+
+function initHelp() {
+  console.error()
+  console.error(chalk.bold.cyan("cc init") + chalk.gray(" — 与 ") + chalk.green("cc create project") + chalk.gray(" 相同"))
+  console.error()
+  console.error(chalk.yellow("用法："))
+  console.error("  " + chalk.green("cc init") + " [项目名]")
+  console.error(chalk.gray("  不传项目名时进入交互式创建。"))
+  console.error()
+}
+
+module.exports = initHelp