cloudcc-cli 2.3.3 → 2.3.5

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 列表互补，不替代 `cc 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: "权限",
+}
+
+/**
+ * 单行命令说明（替代行尾「…」），与 cc <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("cc 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/utils/checkVersion.js

@@ -5,6 +5,13 @@ const chalk = require("chalk")
 const { readCache, writeCache } = require("./cache")
 const fs = require('fs');
 const path = require('path');
+const {
+    semverCompare,
+    getReleaseForExact,
+    getReleasesBetween,
+    defaultReadmePath,
+} = require("./readmeReleases");
+const { printReleaseNotesBlocks } = require("./formatReleaseNotes");
 
 function checkNpmVersion() {
     let currentVersion = Number(config.version.replace(/\./g, ""));
@@ -31,7 +38,9 @@ function checkNpmVersion() {
     console.error('  ' + chalk.yellow('★') + ' Published At    : ' + chalk.gray(formattedTime));
     console.error('  ' + chalk.magenta('★') + ' Developer Docs  : ' + chalk.cyan('https://help.cloudcc.cn/'));
     console.error('  ' + chalk.magenta('★') + ' Changelog       : ' + chalk.cyan('https://www.npmjs.com/package/cloudcc-cli'));
-    console.error('  ' + chalk.gray('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n'));
+    console.error('  ' + chalk.gray('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━'));
+
+    printReadmeReleaseNotes(config.version, onlineVersion);
 
     if (onlineVersionNum - currentVersion > 0) {
         return onlineVersion;
@@ -39,6 +48,26 @@ function checkNpmVersion() {
     return null;
 }
 
+/**
+ * Prints README `# ReleaseV*` sections: all versions between current and latest when an update
+ * exists; otherwise the section for the current version only.
+ */
+function printReadmeReleaseNotes(currentVersion, latestVersion) {
+    const readmePath = defaultReadmePath();
+    let blocks = [];
+    if (semverCompare(latestVersion, currentVersion) > 0) {
+        blocks = getReleasesBetween(readmePath, currentVersion, latestVersion);
+    } else {
+        const one = getReleaseForExact(readmePath, currentVersion);
+        if (one) blocks = [one];
+    }
+    if (blocks.length === 0) {
+        console.error('\n');
+        return;
+    }
+    printReleaseNotesBlocks(blocks, console.error);
+}
+
 
 function askUpdate() {
     console.error();
@@ -154,4 +183,4 @@ function checkAndReplaceJar(projectPath = process.cwd()) {
     }
 }
 
-module.exports = { checkUpdate };
+module.exports = { checkUpdate, checkNpmVersion, update };

package/utils/commandStats.js

@@ -0,0 +1,94 @@
+const fs = require("fs")
+const path = require("path")
+const os = require("os")
+
+/**
+ * 默认开启：在 ~/.cloudcc-cli/command-stats.json 累计调用次数；
+ * 键为人类可读形式，如 `cc doc classes`、`cc get brief`。
+ * 设 `CLOUDCC_CLI_STATS=0` / `false` / `off` 可关闭。
+ */
+function isEnabled() {
+  const v = process.env.CLOUDCC_CLI_STATS
+  if (v == null || String(v).trim() === "") return true
+  const s = String(v).trim().toLowerCase()
+  if (s === "0" || s === "false" || s === "no" || s === "off") return false
+  return true
+}
+
+function statsFilePath() {
+  return path.join(os.homedir(), ".cloudcc-cli", "command-stats.json")
+}
+
+/**
+ * @param {string} action 第一参数（或全局标志如 -v、--help）
+ * @param {string} resource 第二参数；无第二段时用 "_"；子帮助用 "_help"；action 级 -h 用 "-h"
+ */
+function formatRecordKey(action, resource) {
+  const res = resource == null || resource === "" ? "_" : String(resource)
+  if (res === "_") {
+    if (
+      action === "-v" ||
+      action === "--v" ||
+      action === "-version" ||
+      action === "--version"
+    ) {
+      return "cc --version"
+    }
+    if (action === "-h" || action === "--h" || action === "--help") {
+      return "cc --help"
+    }
+    return `cc ${action}`
+  }
+  if (res === "_help") {
+    return `cc ${action} --help`
+  }
+  if (res === "-h" || res === "--help") {
+    return `cc ${action} -h`
+  }
+  return `cc ${action} ${res}`
+}
+
+/**
+ * @param {string} action 第一参数，如 get、doc、create
+ * @param {string} resource 第二参数；无第二段时用 "_"（全局子命令）
+ */
+function record(action, resource) {
+  if (!isEnabled()) return
+  if (!action || typeof action !== "string") return
+  const res = resource == null || resource === "" ? "_" : String(resource)
+  const key = formatRecordKey(action, res)
+  try {
+    const file = statsFilePath()
+    const dir = path.dirname(file)
+    if (!fs.existsSync(dir)) {
+      fs.mkdirSync(dir, { recursive: true })
+    }
+    let data = { version: 1, counts: {}, updatedAt: null }
+    if (fs.existsSync(file)) {
+      data = JSON.parse(fs.readFileSync(file, "utf8"))
+      if (!data.counts || typeof data.counts !== "object") data.counts = {}
+    }
+    data.counts[key] = (data.counts[key] || 0) + 1
+    data.updatedAt = new Date().toISOString()
+    fs.writeFileSync(file, JSON.stringify(data, null, 2), "utf8")
+  } catch (_e) {
+    // 统计失败不影响 CLI
+  }
+}
+
+function readStats() {
+  try {
+    const file = statsFilePath()
+    if (fs.existsSync(file)) {
+      return JSON.parse(fs.readFileSync(file, "utf8"))
+    }
+  } catch (_e) {}
+  return { version: 1, counts: {}, updatedAt: null }
+}
+
+module.exports = {
+  isEnabled,
+  record,
+  readStats,
+  statsFilePath,
+}