@easyv/screen-cli 0.0.0-stage → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +283 -2
- package/bin/easyv-screen.js +2 -0
- package/dist/analyzer.js +130 -0
- package/dist/client.js +168 -0
- package/dist/commands/auth.js +285 -0
- package/dist/commands/component.js +197 -0
- package/dist/commands/data.js +147 -0
- package/dist/commands/debug.js +31 -0
- package/dist/commands/screen.js +199 -0
- package/dist/commands/skills.js +53 -0
- package/dist/config.js +421 -0
- package/dist/debug-query.js +224 -0
- package/dist/index.js +25 -0
- package/dist/output.js +7 -0
- package/package.json +36 -4
- package/skills/easyv-component-dev/SKILL.md +50 -0
- package/skills/easyv-component-dev/references/component-spec.md +123 -0
- package/skills/easyv-screen-build/SKILL.md +40 -0
- package/skills/easyv-screen-data/SKILL.md +53 -0
- package/skills/easyv-screen-debug/SKILL.md +49 -0
- package/skills/easyv-screen-edit/SKILL.md +59 -0
- package/skills/easyv-screen-shared/SKILL.md +32 -0
- package/spec/openapi.v1.yaml +2850 -0
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: easyv-screen-edit
|
|
3
|
+
description: 修改已经搭好的 EasyV 大屏:改组件配置、批量改配置、配置交互事件、调整显隐和图层、升级组件版本。当用户要改大屏、改某个组件、加点击联动或调整布局时使用。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 修改大屏
|
|
7
|
+
|
|
8
|
+
先读再写。`easyv-screen screen document get <id> -o doc.json --json` 拿到当前文档和 `revision`。
|
|
9
|
+
|
|
10
|
+
## 用原子操作做局部修改
|
|
11
|
+
|
|
12
|
+
把操作写进 `ops.json`,格式 `{ "operations": [ ... ] }`,然后:
|
|
13
|
+
|
|
14
|
+
```
|
|
15
|
+
easyv-screen screen apply <id> -f ops.json --if-match <revision> --json
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
支持的操作(元素和图层都用文档 key):
|
|
19
|
+
|
|
20
|
+
| 操作 | 作用 | 关键字段 |
|
|
21
|
+
| --- | --- | --- |
|
|
22
|
+
| `addComponent` | 新增组件,其余用组件默认配置 | `key` `module` `version` `name` `layout` `configPatches` `data` `parentKey` `index` |
|
|
23
|
+
| `removeComponent` | 删除组件 | `key` |
|
|
24
|
+
| `setComponentConfig` | 按路径改配置 | `key` `configPatches`(`[{ path, value }]`) |
|
|
25
|
+
| `setComponentLayout` | 改位置尺寸 | `key` `layout`(`left` `top` `width` `height`) |
|
|
26
|
+
| `element.update` | 改名称或整棵配置树 | `key` `name` `config` |
|
|
27
|
+
| `addComponentEvent` | 新增交互事件 | `key` `event` |
|
|
28
|
+
| `updateComponentEvent` | 替换一个事件 | `key` `eventId` `event` |
|
|
29
|
+
| `deleteComponentEvent` | 删除一个事件 | `key` `eventId` |
|
|
30
|
+
| `setComponentStaticData` | 设置静态数据 | `key` `data` `fields` |
|
|
31
|
+
| `element.bindData` | 绑定数据源 | `key` `dataType` `data`(含 `data_id`) |
|
|
32
|
+
| `element.unbindData` | 改回静态数据 | `key` |
|
|
33
|
+
| `setLayerVisible` | 显隐 | `key` `visible` |
|
|
34
|
+
| `moveLayer` | 移动图层 | `key` `parentKey` `index` |
|
|
35
|
+
| `groupLayers` | 成组 | `keys` `groupKey`(`g-` 开头) `name` |
|
|
36
|
+
| `ungroupLayer` | 解散分组 | `key` |
|
|
37
|
+
| `upgradeComponentVersion` | 升级组件版本 | `key` `version` |
|
|
38
|
+
| `screen.updateMeta` | 改大屏名称 | `name` |
|
|
39
|
+
|
|
40
|
+
改完跑 `screen validate <id> --json`。
|
|
41
|
+
|
|
42
|
+
## 交互事件
|
|
43
|
+
|
|
44
|
+
`event` 的结构与编辑器一致:`trigger` 是触发方式(`click`、`mouseEnter`),`actions` 里每一项的
|
|
45
|
+
`action` 是动作类型,`component` 用 `$component(<组件数字id>)` 指向目标。组件数字 id 就是 key 里 `c-` 后面的数字。
|
|
46
|
+
目标组件的动作要它的 `actions` 声明里支持。
|
|
47
|
+
|
|
48
|
+
## 改配置
|
|
49
|
+
|
|
50
|
+
`configPatches` 的 `path` 用 `easyv-screen component fields <module> --keyword "<意图>"` 查,例如
|
|
51
|
+
`--keyword "图例"`、`--keyword "坐标轴 字号"`。返回的 `labelPath` 是中文标签链,按它判断字段含义,`path` 原样填进补丁。
|
|
52
|
+
不传 `--keyword` 只看分组,再按分组名搜。不要猜路径:路径不存在时整批会被拒绝。
|
|
53
|
+
|
|
54
|
+
优先用 `setComponentConfig` 和 `setComponentLayout`。`element.update` 的 `config` 是整棵属性树替换,
|
|
55
|
+
只有确实要重写整棵树时才用,并且先从文档里取出当前 `config` 再改。
|
|
56
|
+
|
|
57
|
+
## 批量修改
|
|
58
|
+
|
|
59
|
+
多个组件的修改放进同一个 `operations` 数组一次提交,任何一条不通过整批都不落库。
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: easyv-screen-shared
|
|
3
|
+
description: 使用 easyv-screen 命令操作 EasyV 大屏时的共用规则:登录、--json 输出、revision 乐观锁、写入前确认。任何搭建、修改、排查或组件开发任务都先遵守这里。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# EasyV 大屏 CLI 共用规则
|
|
7
|
+
|
|
8
|
+
命令是 `easyv-screen`。输出默认就是 JSON,不需要再加 `--json`。
|
|
9
|
+
|
|
10
|
+
## 开始之前
|
|
11
|
+
|
|
12
|
+
1. 先看工作台地址:`easyv-screen config list`。
|
|
13
|
+
- `baseUrl` 为 null,且没有 `environments`:还没配置。运行 `easyv-screen config set --base-url <工作台地址>`。
|
|
14
|
+
- 没有 `environments`:只有这一个工作台,直接用 `baseUrl`。
|
|
15
|
+
- 有 `environments`:有多个工作台。`current` 是当前环境名。要换另一个工作台时,`easyv-screen config add --name <名称> --base-url <地址> --use`,或 `easyv-screen config use <名称>`。
|
|
16
|
+
baseURL 是工作台的域名地址,例如 `https://workspace.example.com` 或 `http://127.0.0.1:3000`。本地开发填前端 dev server 的地址。
|
|
17
|
+
2. 每个工作台各自保存登录。有多个工作台时不共用,换地址要先 `config use`。先 `easyv-screen auth status` 看当前是否已登录。
|
|
18
|
+
未登录时运行 `easyv-screen auth login`,把输出的授权地址交给用户,等用户在浏览器确认。
|
|
19
|
+
同一个工作台要登录另一个空间或团队时,用 `easyv-screen auth login --name <名称>`,再用 `auth use <名称>` 切换。
|
|
20
|
+
3. 一次登录只绑定一个空间和一个团队。`easyv-screen auth status` 会返回当前登录绑定的空间名称、空间 ID、团队名称和团队 ID。要操作别的团队,在同一个 baseURL 下换一个登录。
|
|
21
|
+
|
|
22
|
+
## 写入规则
|
|
23
|
+
|
|
24
|
+
- 读文档拿到的 `revision` 要在写回时带上:`document put` 和 `apply` 都支持 `--if-match <revision>`。
|
|
25
|
+
返回 `REVISION_CONFLICT`(退出码 4)时,重新 `document get` 再合并,不要原样重试。
|
|
26
|
+
- 写完跑 `screen validate`。有 `error` 先修再继续;`warn` 告知用户即可。
|
|
27
|
+
- 发布、删除、上传组件会生效到用户的空间。执行前用一句话向用户确认。
|
|
28
|
+
- 不要编造组件的配置字段。用 `component fields <module> --keyword` 查路径;用自己开发的组件时也可以对照 `main.json` 的 `configuration`。
|
|
29
|
+
|
|
30
|
+
## 退出码
|
|
31
|
+
|
|
32
|
+
`0` 成功,`1` 业务错误,`2` 参数错误,`3` 未登录或凭证失效,`4` 版本冲突。
|