cloudcc-cli 2.3.4 → 2.3.6

package/src/validationRule/docs/devguide.md

@@ -13,7 +13,7 @@
 ### 创建验证规则
 
 ```bash
-cc create validationRule <path> <objectPrefix> [ruleName] [ruleContent] [errorMessage]
+cloudcc create validationRule <path> <objectPrefix> [ruleName] [ruleContent] [errorMessage]
 ```
 
 **参数说明：**
@@ -30,16 +30,16 @@ cc create validationRule <path> <objectPrefix> [ruleName] [ruleContent] [errorMe
 
 ```bash
 # 交互式输入所有信息
-cc create validationRule . "b00"
+cloudcc create validationRule . "b00"
 
 # 非交互式创建
-cc create validationRule . "b00" "规则1" "Batch_Size__c__f==5" "数量必须是5"
+cloudcc create validationRule . "b00" "规则1" "Batch_Size__c__f==5" "数量必须是5"
 ```
 
 ### 查询验证规则列表
 
 ```bash
-cc get validationRule <projectPath> <objectPrefix>
+cloudcc get validationRule <projectPath> <objectPrefix>
 ```
 
 **参数说明：**
@@ -53,13 +53,13 @@ cc get validationRule <projectPath> <objectPrefix>
 
 ```bash
 # 获取对象 b00 的所有验证规则
-cc get validationRule . "b00"
+cloudcc get validationRule . "b00"
 ```
 
 ### 删除验证规则
 
 ```bash
-cc delete validationRule <projectPath> <ruleId>
+cloudcc delete validationRule <projectPath> <ruleId>
 ```
 
 **参数说明：**
@@ -72,5 +72,5 @@ cc delete validationRule <projectPath> <ruleId>
 **示例：**
 
 ```bash
-cc delete validationRule . 202689E55795D38oAQlN
+cloudcc delete validationRule . 202689E55795D38oAQlN
 ```

package/src/validationRule/docs/introduction.md

@@ -23,7 +23,7 @@
 创建一个新的 CloudCC 验证规则。
 
 ```bash
-cc create validationRule <path> <objectPrefix> [ruleName] [ruleContent] [errorMessage]
+cloudcc create validationRule <path> <objectPrefix> [ruleName] [ruleContent] [errorMessage]
 ```
 
 **参数说明：**
@@ -40,10 +40,10 @@ cc create validationRule <path> <objectPrefix> [ruleName] [ruleContent] [errorMe
 
 ```bash
 # 交互式输入所有信息
-cc create validationRule . "b00"
+cloudcc create validationRule . "b00"
 
 # 非交互式创建
-cc create validationRule . "b00" "规则1" "Batch_Size__c__f==5" "数量必须是5"
+cloudcc create validationRule . "b00" "规则1" "Batch_Size__c__f==5" "数量必须是5"
 ```
 
 ---
@@ -53,7 +53,7 @@ cc create validationRule . "b00" "规则1" "Batch_Size__c__f==5" "数量必须
 获取指定对象的所有验证规则列表。
 
 ```bash
-cc get validationRule <projectPath> <objectPrefix>
+cloudcc get validationRule <projectPath> <objectPrefix>
 ```
 
 **参数说明：**
@@ -67,7 +67,7 @@ cc get validationRule <projectPath> <objectPrefix>
 
 ```bash
 # 获取对象 b00 的所有验证规则
-cc get validationRule . "b00"
+cloudcc get validationRule . "b00"
 ```
 
 ---
@@ -77,7 +77,7 @@ cc get validationRule . "b00"
 删除指定的验证规则。
 
 ```bash
-cc delete validationRule <projectPath> <ruleId>
+cloudcc delete validationRule <projectPath> <ruleId>
 ```
 
 **参数说明：**
@@ -91,7 +91,7 @@ cc delete validationRule <projectPath> <ruleId>
 
 ```bash
 # 删除指定规则
-cc delete validationRule . 202689E55795D38oAQlN
+cloudcc delete validationRule . 202689E55795D38oAQlN
 ```
 
 ---
@@ -105,16 +105,16 @@ cc delete validationRule . 202689E55795D38oAQlN
 cat cloudcc-cli.config.js
 
 # 2. 查询对象现有的验证规则
-cc get validationRule . "b00"
+cloudcc get validationRule . "b00"
 
 # 3. 创建新验证规则
-cc create validationRule . "b00"
+cloudcc create validationRule . "b00"
 
 # 4. 验证规则创建成功
-cc get validationRule . "b00"
+cloudcc get validationRule . "b00"
 
 # 5. 如需删除
-# cc delete validationRule . <ruleId>
+# cloudcc delete validationRule . <ruleId>
 ```
 
 ---

package/src/validationRule/get.js

@@ -3,7 +3,7 @@ const { getPackageJson } = require("../../utils/config");
 
 /**
  * 查询验证规则列表
- * 用法：cc get validationRule <projectPath> <objectPrefix>
+ * 用法：cloudcc get validationRule <projectPath> <objectPrefix>
  * 接口：POST /api/validateRule/queryByPrefix
  * 参数：{ prefix: "b00" }
  */

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("cloudcc --help") + chalk.gray(" 查看全部命令。"))
+    console.error()
+    return
+  }
+  console.error(chalk.bold.cyan(`cloudcc ${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(`cloudcc ${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("cloudcc 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

@@ -3,7 +3,7 @@ const pkg = require("../../package.json")
 
 function get() {
     console.error()
-    console.error(chalk.green(`cloudcc-cli version: ${pkg.version}`));
+    console.error(chalk.green(`cloudcc-cli version: ${pkg.version}`))
     console.error()
 }
 

package/src/version/help.js

@@ -0,0 +1,48 @@
+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 / cloudcc)") + chalk.gray(` v${pkg.version}`))
+  console.error(chalk.dim("  与系统 C 编译器 cc 冲突时请使用 cloudcc"))
+  console.error()
+  console.error(chalk.yellow("Usage:"))
+  console.error("  " + chalk.green("cc") + " / " + chalk.green("cloudcc") + " <action> <resource> [args...]")
+  console.error()
+  console.error(chalk.yellow("Global:"))
+  console.error("  " + chalk.green("cloudcc --help") + ", " + chalk.green("-h") + ", " + chalk.green("cloudcc help") + "  显示本帮助")
+  console.error("  " + chalk.green("cloudcc --version") + ", " + chalk.green("-v") + "  打印版本号")
+  console.error("  " + chalk.green("cloudcc update") + "              升级全局 cloudcc-cli")
+  console.error("  " + chalk.green("cloudcc uninstall") + "           卸载全局 cloudcc-cli")
+  console.error("  " + chalk.green("cloudcc doctor") + "              环境自检（Node、配置、CLI 版本）")
+  console.error("  " + chalk.green("cloudcc docs") + "               在浏览器打开 CloudCC 帮助中心")
+  console.error("  " + chalk.green("cloudcc stats") + "              查看本地命令调用统计（默认开启，" + chalk.gray("CLOUDCC_CLI_STATS=0") + " 可关闭）")
+  console.error("  " + chalk.green("cloudcc init") + " [项目名]      等同于 cloudcc create project")
+  console.error("  " + chalk.green("cloudcc <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 = "cloudcc " + 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("cloudcc doc object introduction"))
+  console.error("  " + chalk.gray("cloudcc 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("cloudcc init") + chalk.gray(" — 与 ") + chalk.green("cloudcc create project") + chalk.gray(" 相同"))
+  console.error()
+  console.error(chalk.yellow("用法："))
+  console.error("  " + chalk.green("cloudcc init") + " [项目名]")
+  console.error(chalk.gray("  不传项目名时进入交互式创建。"))
+  console.error()
+}
+
+module.exports = initHelp

package/src/version/listModuleCommands.js

@@ -0,0 +1,241 @@
+const fs = require("fs")
+const path = require("path")
+
+/**
+ * 与 bin/index.js 中 modules 的 key 顺序、以及各 require 路径一致。
+ * schedule 与 timer 均指向 src/timer。
+ */
+const MODULE_KEYS_ORDER = [
+  "project",
+  "plugin",
+  "classes",
+  "customSetting",
+  "globalSelectList",
+  "button",
+  "staticResource",
+  "customPage",
+  "schedule",
+  "triggers",
+  "timer",
+  "script",
+  "token",
+  "object",
+  "recordType",
+  "config",
+  "version",
+  "brief",
+  "fields",
+  "menu",
+  "application",
+  "scheduleJob",
+  "profile",
+  "user",
+  "role",
+  "identityProvider",
+  "singleSignOn",
+  "pagelayout",
+  "validationRule",
+  "permission",
+]
+
+/**
+ * 各 resource 一句话说明（供 --help 展示）。与自动解析的 action 列表互补，不替代 `cloudcc doc <resource> introduction`。
+ */
+const MODULE_HINT = {
+  project: "创建/初始化 CloudCC 开发项目。",
+  plugin: "自定义组件：创建、发布、拉取、删除与文档。",
+  classes: "自定义类：服务端 Java 业务逻辑，与平台同步，可供按钮、触发器、定时类等调用。",
+  customSetting: "自定义设置：查询、创建、字段维护等。",
+  globalSelectList: "全局选项列表。",
+  button: "自定义按钮。",
+  staticResource: "静态资源上传与管理。",
+  customPage: "自定义页面。",
+  schedule: "定时类（Scheduled Class）：与平台同步 Java 与配置（resource 亦可用 timer）。",
+  triggers: "触发器：本地 Java 与平台同步。",
+  script: "客户端脚本：创建、发布、拉取等。",
+  token: "访问令牌/凭证。",
+  object: "标准对象与自定义对象。",
+  recordType: "记录类型。",
+  config: "配置与切换。",
+  version: "版本信息、帮助与全局安装维护（非业务资源）。",
+  brief: "摘要/概要信息。",
+  fields: "对象字段。",
+  menu: "菜单。",
+  application: "应用。",
+  scheduleJob: "计划任务（平台侧任务）。",
+  profile: "简档。",
+  user: "用户。",
+  role: "角色。",
+  identityProvider: "身份提供商（IdP）。",
+  singleSignOn: "单点登录（SSO）配置。",
+  pagelayout: "页面布局。",
+  validationRule: "验证规则。",
+  permission: "权限：分配、查询、增删等。",
+}
+
+const MODULE_FOLDER = {
+  project: "project",
+  plugin: "plugin",
+  classes: "classes",
+  customSetting: "customSetting",
+  globalSelectList: "globalSelectList",
+  button: "button",
+  staticResource: "staticResource",
+  customPage: "customPage",
+  schedule: "timer",
+  triggers: "triggers",
+  timer: "timer",
+  script: "script",
+  token: "token",
+  object: "object",
+  recordType: "recordType",
+  config: "config",
+  version: "version",
+  brief: "brief",
+  fields: "fields",
+  menu: "menu",
+  application: "application",
+  scheduleJob: "scheduleJob",
+  profile: "profile",
+  user: "user",
+  role: "role",
+  identityProvider: "identityProvider",
+  singleSignOn: "singleSignOn",
+  pagelayout: "pagelayout",
+  validationRule: "validationRule",
+  permission: "permission",
+}
+
+function extractActions(indexFilePath) {
+  const src = fs.readFileSync(indexFilePath, "utf8")
+  const actions = new Set()
+  const re = /^\s*cc\.(\w+)\s*=/gm
+  let m
+  while ((m = re.exec(src))) {
+    actions.add(m[1])
+  }
+  return Array.from(actions).sort()
+}
+
+/**
+ * 按 index.js 文件合并资源名（如 timer 与 schedule），顺序与 MODULE_KEYS_ORDER 一致。
+ */
+function getModuleGroups() {
+  const seen = new Map()
+  for (const key of MODULE_KEYS_ORDER) {
+    const folder = MODULE_FOLDER[key]
+    const abs = path.join(__dirname, "..", folder, "index.js")
+    if (!seen.has(abs)) {
+      seen.set(abs, { resources: [], indexPath: abs })
+    }
+    seen.get(abs).resources.push(key)
+  }
+  return Array.from(seen.values()).map((g) => ({
+    resources: g.resources,
+    actions: extractActions(g.indexPath),
+    hint: describeModuleGroup(g.resources),
+  }))
+}
+
+function describeModuleGroup(resources) {
+  const sorted = [...resources].sort()
+  if (sorted.length === 2 && sorted[0] === "schedule" && sorted[1] === "timer") {
+    return "定时类（Scheduled Class）：与平台同步 Java 与配置（resource 可用 schedule 或 timer）。"
+  }
+  const r0 = resources[0]
+  return MODULE_HINT[r0] || ""
+}
+
+/** resource 中文名，用于拼「创建 xxx」等行内说明 */
+const RESOURCE_CN = {
+  project: "项目",
+  plugin: "自定义组件",
+  classes: "自定义类",
+  customSetting: "自定义设置",
+  globalSelectList: "全局选项列表",
+  button: "自定义按钮",
+  staticResource: "静态资源",
+  customPage: "自定义页面",
+  schedule: "定时类",
+  timer: "定时类",
+  triggers: "触发器",
+  script: "客户端脚本",
+  token: "访问令牌",
+  object: "对象",
+  recordType: "记录类型",
+  config: "配置",
+  version: "版本",
+  brief: "摘要",
+  fields: "字段",
+  menu: "菜单",
+  application: "应用",
+  scheduleJob: "计划任务",
+  profile: "简档",
+  user: "用户",
+  role: "角色",
+  identityProvider: "身份提供商",
+  singleSignOn: "单点登录",
+  pagelayout: "页面布局",
+  validationRule: "验证规则",
+  permission: "权限",
+}
+
+/**
+ * 单行命令说明（替代行尾「…」），与 cloudcc <action> <resource> 对应。
+ */
+function describeActionLine(resource, action) {
+  const n = RESOURCE_CN[resource] || resource
+  const line = {
+    create: () => `创建${n}`,
+    get: () => `查询${n}`,
+    delete: () => `删除${n}`,
+    doc: () => `查看${n}文档（子命令如 introduction、devguide）`,
+    publish: () => `将本地${n}发布到平台`,
+    pull: () => `从平台拉取${n}到本地`,
+    pullList: () => `按列表批量拉取${n}`,
+    detail: () => `查看${n}详情`,
+    assign: () => `分配${n}`,
+    add: () => `添加${n}`,
+    remove: () => `移除${n}`,
+    update: () => (resource === "version" ? "升级全局 cloudcc-cli" : `更新${n}`),
+    view: () => `查看${n}信息`,
+    use: () => `切换使用的${n}`,
+    count: () => `统计${n}数量`,
+    modify: () => `修改${n}`,
+    download: () => `下载${n}相关文件`,
+    getList: () => `获取${n}列表`,
+    newInfo: () => `获取新建${n}所需信息`,
+    editInfo: () => `获取编辑${n}前信息`,
+    editSave: () => `保存${n}编辑`,
+    validDelete: () => `校验${n}是否可删除`,
+    deleteCustomSettingField: () => `删除自定义设置中的字段`,
+    editCustomSettingField: () => `编辑自定义设置字段`,
+    saveCustomSettingField: () => `保存自定义设置字段`,
+    help: () => (resource === "version" ? "（内部）帮助" : `查看 ${n} 帮助`),
+    uninstall: () => (resource === "version" ? "卸载全局 cloudcc-cli" : `卸载 ${n}`),
+  }
+  if (line[action]) {
+    return line[action]()
+  }
+  return `${action} · ${n}`
+}
+
+/**
+ * 返回支持给定 action 的所有 resource 名（去重、排序）。
+ */
+function getResourcesForAction(actionName) {
+  const groups = getModuleGroups()
+  const out = new Set()
+  for (const g of groups) {
+    if (g.actions.includes(actionName)) {
+      g.resources.forEach((r) => out.add(r))
+    }
+  }
+  return Array.from(out).sort((a, b) => a.localeCompare(b))
+}
+
+module.exports = {
+  getModuleGroups,
+  describeActionLine,
+  getResourcesForAction,
+}

package/src/version/stats.js

@@ -0,0 +1,44 @@
+const chalk = require("chalk")
+const {
+  readStats,
+  isEnabled,
+  statsFilePath,
+} = require("../../utils/commandStats")
+
+function stats() {
+  const data = readStats()
+  const entries = Object.entries(data.counts || {}).sort((a, b) => b[1] - a[1])
+
+  console.error()
+  console.error(chalk.bold.cyan("cloudcc command statistics"))
+  console.error(chalk.gray("File: ") + chalk.dim(statsFilePath()))
+  console.error(
+    chalk.gray("Recording: ") +
+      (isEnabled()
+        ? chalk.green("ON")
+        : chalk.yellow("OFF — remove CLOUDCC_CLI_STATS or set 1/true to record again"))
+  )
+  if (data.updatedAt) {
+    console.error(chalk.gray("Last update: ") + chalk.dim(data.updatedAt))
+  }
+  console.error()
+
+  if (entries.length === 0) {
+    console.error(chalk.dim("  (no data yet)"))
+    console.error()
+    return
+  }
+
+  console.error(chalk.gray("  command → count"))
+  for (const [key, n] of entries) {
+    console.error(
+      "  " +
+        chalk.green(key) +
+        chalk.gray(" → ") +
+        chalk.bold.white(String(n))
+    )
+  }
+  console.error()
+}
+
+module.exports = stats

package/src/version/uninstall.js

@@ -0,0 +1,30 @@
+const chalk = require("chalk")
+const inquirer = require("inquirer")
+const exec = require("child_process").execSync
+
+async function uninstall() {
+  const { confirm } = await inquirer.prompt([
+    {
+      type: "confirm",
+      name: "confirm",
+      default: false,
+      message: "Uninstall global package cloudcc-cli?",
+    },
+  ])
+  if (!confirm) {
+    console.error(chalk.yellow("Cancelled."))
+    return
+  }
+  const os = process.platform
+  const prefix = os === "darwin" ? "sudo " : ""
+  try {
+    console.error(chalk.green("Uninstalling..."))
+    exec(`${prefix}npm uninstall -g cloudcc-cli`, { stdio: "inherit" })
+    console.error(chalk.green("Done."))
+  } catch (e) {
+    console.error(chalk.red("Uninstall failed."), e.message || e)
+    process.exitCode = 1
+  }
+}
+
+module.exports = uninstall

package/src/version/update.js

@@ -0,0 +1,13 @@
+const chalk = require("chalk")
+const { checkNpmVersion, update } = require("../../utils/checkVersion")
+
+function runUpdate() {
+  const onlineVersion = checkNpmVersion()
+  if (!onlineVersion) {
+    console.error(chalk.green("\ncloudcc-cli is already up to date.\n"))
+    return
+  }
+  update(onlineVersion)
+}
+
+module.exports = runUpdate

package/test/application.cli.test.js

@@ -12,7 +12,7 @@ function quoteArg(value) {
 }
 
 async function runCc(args) {
-  const cmd = `npx --prefix "${repoRoot}" cc ${args.map(quoteArg).join(" ")}`;
+  const cmd = `npx --prefix "${repoRoot}" cloudcc ${args.map(quoteArg).join(" ")}`;
   return execAsync(cmd, { cwd: repoRoot });
 }
 

package/test/classes.cli.test.js

@@ -13,7 +13,7 @@ function quoteArg(value) {
 }
 
 async function runCc(args) {
-  const cmd = `npx --prefix "${repoRoot}" cc ${args.map(quoteArg).join(" ")}`;
+  const cmd = `npx --prefix "${repoRoot}" cloudcc ${args.map(quoteArg).join(" ")}`;
   return execAsync(cmd, { cwd: repoRoot });
 }
 

package/test/customSetting.cli.test.js

@@ -12,7 +12,7 @@ function quoteArg(value) {
 }
 
 async function runCc(args) {
-  const cmd = `npx --prefix "${repoRoot}" cc ${args.map(quoteArg).join(" ")}`;
+  const cmd = `npx --prefix "${repoRoot}" cloudcc ${args.map(quoteArg).join(" ")}`;
   return execAsync(cmd, { cwd: repoRoot });
 }