cloudcc-cli 2.2.8 → 2.2.9

package/.cursor/skills/cloudcc-cli-dev/VUE_CUSTOM_COMPONENT.md

@@ -0,0 +1,151 @@
+## 覆盖范围
+
+本篇聚焦 CloudCC Vue2.x 自定义组件（Custom Component）：
+
+- 创建组件骨架
+- 编辑与最佳实践入口
+- 编译与发布到服务器
+
+---
+
+## 创建自定义组件
+
+### CLI 命令
+
+```bash
+# 创建组件必须使用这个命令，在项目根目录执行（会生成到 plugins/<pluginName>/）
+cc create plugin <pluginName>
+```
+
+创建完成后通常会生成以下结构（以 `create1` 的骨架为准）：
+
+- `plugins/<pluginName>/<pluginName>.vue`：组件入口文件（包含
+  `componentInfo`，并默认引入一个 `HelloWorld` 子组件）
+- `plugins/<pluginName>/components/HelloWorld.vue`：示例子组件
+- `plugins/<pluginName>/config.json`：组件元数据（至少包含 `component` /
+  `compName` / `compDesc`）
+
+> 组件入口文件里的 `componentInfo.component`
+> 需要全局唯一（用于平台识别/装载组件）。
+
+---
+
+## 发布组件
+
+```bash
+cc publish plugin <pluginName>
+```
+
+> 发布会执行编译/打包/上传；如果组件依赖复杂，注意依赖收集与发布策略。
+
+### 打包/注册策略（publish1：v1 / v2）
+
+`publish1` 支持两种打包/注册方式，会根据组件里的 `componentInfo.buildVersion`
+选择：
+
+- 默认（v1，`buildVersion` 不写或不等于 `"v2"`）
+  - 使用 `vue-custom-element` 将组件注册为 Web Component/custom element
+  - 注册名来自 `componentInfo.component`
+- v2（设置 `componentInfo.buildVersion = "v2"`）
+  - 使用 `Vue.component` 的方式注册组件
+
+示例（在组件入口 `.vue` 的 `data()` 里配置）：
+
+```js
+componentInfo: {
+  component: "component-<pluginName>",
+  compName: "compName-<pluginName>",
+  compDesc: "Component description information",
+  // 选填：不填默认 v1；填 "v2" 则走 Vue.component 注册
+  buildVersion: "v2"
+}
+```
+
+### 加载模式（loadModel：lazy / start）
+
+`publish1` 会读取 `componentInfo.loadModel` 来决定组件加载时机：
+
+- `lazy`：默认，进入对应页面/区域后再加载
+- `start`：启动加载，在应用启动时即加载
+
+你可以在 `componentInfo` 中按需设置，例如：
+
+```js
+componentInfo: {
+  // ...
+  loadModel: "start";
+}
+```
+
+---
+## 同步（从云端拉取）
+
+> “同步”在本仓库中对应 `pull`：把云端的自定义组件代码/配置拉到本地 `plugins/<pluginName>/`。
+
+### CLI 命令
+
+```bash
+# 同步插件到本地（可传组件名或 id）
+cc pull plugin <pluginNameOrId> [projectPath]
+```
+
+说明：
+
+- `projectPath` 可选；不传则默认当前工作目录。
+- 传组件名时：如果本地 `plugins/<pluginName>/config.json` 存在 `id`，会用 `id` 拉取；否则会把入参当作 `id` 处理。
+- 拉取后会生成/更新 `plugins/<归一化后的pluginName>/config.json` 与相关文件（包含依赖文件）。
+---
+
+## 删除组件（云端）
+
+> 删除只影响**云端**记录，本地 `plugins/<pluginName>/` 目录不会被删除。
+
+### CLI 命令
+
+```bash
+# 传组件名（自动从本地 plugins/<pluginName>/config.json 读取 id）
+cc delete plugin <pluginName> [projectPath]
+
+# 直接传云端 ID
+cc delete plugin <pluginId> [projectPath]
+```
+
+说明：
+
+- 传组件名时：如果本地 `plugins/<pluginName>/config.json` 存在 `id`，会用 `id`
+  删除；否则把入参当作 `id` 直接请求。
+- `projectPath` 可选，不传则默认当前工作目录。
+- 删除成功后控制台会打印 `Success! Plugin (ID: xxx) deleted from server.`
+
+---
+## 批量拉取
+
+> 当前仓库没有直接提供 `cc pullList plugin ...` 这种“内置批量拉取”命令。
+
+推荐方式：先用 `get plugin` 获取线上列表（包含 `id`），再用循环批量执行 `pull plugin <id>`。
+
+### 步骤 1：获取线上列表
+
+```bash
+cc get plugin <projectPath>
+```
+
+### 步骤 2：循环拉取（示例）
+
+```bash
+# 批量拉取前 N 个线上组件（示例 N=5）
+N=5
+ids=$(cc get plugin . | node -e "const a=JSON.parse(require('fs').readFileSync(0,'utf8')); console.log(a.slice(0,${N}).map(x=>x.id).filter(Boolean).join(' '))")
+for id in $ids; do
+  cc pull plugin "$id" .
+done
+```
+---
+
+## 编辑要点（CLI 项目约束）
+
+- 组件目录通常为 `plugins/<pluginName>/`
+- 确保所有 `<style>` 标签带 `scoped`，避免全局样式污染
+- 发布通过 `cc publish plugin <pluginName>` 执行编译与上传
+
+---

package/README.md

@@ -22,6 +22,17 @@ sudo npm i -g cloudcc-cli
 }
 ```
 
+# ReleaseV2.2.9
+
+#### Release Date: 2026-3-25
+
+#### Release Scope: Full
+
+#### Release Content
+
+- Optimization
+  - 添加删除组件命令
+
 # ReleaseV2.2.8
 
 #### Release Date: 2026-3-24

package/bin/index.js

@@ -34,4 +34,6 @@ cc.menu = require("../src/menu/index")
 
 cc.application = require("../src/application/index")
 
+
+
 module.exports = cc;