@dp-bohrium/widget-cli 0.1.0 → 0.3.0
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/AGENTS.md +144 -8
- package/CHANGELOG.md +73 -0
- package/README.md +60 -97
- package/assets/licenses/ajv@8.20.0/LICENSE +22 -0
- package/assets/licenses/fast-deep-equal@3.1.3/LICENSE +21 -0
- package/assets/licenses/fast-uri@3.1.6/LICENSE +30 -0
- package/assets/licenses/json-schema-traverse@1.0.0/LICENSE +21 -0
- package/assets/licenses/require-from-string@2.0.2/license +21 -0
- package/assets/licenses/widget-contracts.LICENSE +21 -0
- package/assets/licenses/widget-sdk.LICENSE +21 -0
- package/assets/schemas/host-runtime-config.schema.json +305 -0
- package/assets/schemas/widget-manifest.schema.json +361 -0
- package/assets/schemas/widget-plugin-manifest.schema.json +162 -0
- package/assets/schemas/widget-runtime-contracts.schema.json +2870 -0
- package/assets/toolchain.json +24 -0
- package/dist/cli.mjs +1066 -143
- package/dist/core.mjs +1 -1
- package/dist/{dsh-DgkNH7L-.mjs → dsh-DbOeoKFJ.mjs} +554 -88
- package/llms.txt +55 -4
- package/package.json +13 -12
package/llms.txt
CHANGED
|
@@ -2,24 +2,75 @@
|
|
|
2
2
|
|
|
3
3
|
> Widget 工程的本地创建、校验、开发、构建和打包工具;可由 Bohr CLI 桥接或调度。
|
|
4
4
|
|
|
5
|
+
要求 Node.js >=20。CLI 发布包固定 SDK/compiler、contracts/Schema、校验器和模板,
|
|
6
|
+
提供文档站地址,不再内置 skills。生成工程仍安装自己的精确版本依赖。
|
|
7
|
+
|
|
8
|
+
先看全局帮助,再按命令查看参数、默认值、示例和必要提示:
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
pnpm exec bohr-widget --help
|
|
12
|
+
pnpm exec bohr-widget create --help
|
|
13
|
+
pnpm exec bohr-widget help migrate dsh scaffold
|
|
14
|
+
pnpm exec bohr-widget --version --json
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
无参数、`-h`、`--help`、`help` 显示全局帮助,包含版本、命令、选项、开发流程,
|
|
18
|
+
以及文档站、快速开始、命令行指南和 `llms.txt` 链接。
|
|
19
|
+
`<命令路径> --help` 与 `help <命令路径>` 查看对应层级;例如 `dev -h`、`pack --help` 或
|
|
20
|
+
`migrate dsh --help`。`-v` / `--version` 等价于 `version`,`--version --json` 等价于 `version --json`。
|
|
21
|
+
帮助仅输出本地文本,不执行所选命令或联网获取文档。npm 的全局帮助用
|
|
22
|
+
`npx --no-install bohr-widget --help`,其他命令同样替换前缀;未安装时可用
|
|
23
|
+
`pnpm dlx @dp-bohrium/widget-cli --help` 查看入口。
|
|
24
|
+
|
|
5
25
|
## Agent 入口
|
|
6
26
|
|
|
7
27
|
- [Agent 使用说明](./AGENTS.md): 命令参数、执行顺序、错误恢复和安全边界。
|
|
8
28
|
- [README](./README.md): 安装、模板和公开 core 出口。
|
|
29
|
+
- [更新记录](./CHANGELOG.md): 当前 CLI 的使用者可感知变化;配套包职责与 npm 链接见 README。
|
|
30
|
+
- [文档站索引](https://dev.dp.tech/bohrium-widget-sdk/llms.txt): 先按任务选择教程或参考。
|
|
31
|
+
- [完整文档](https://dev.dp.tech/bohrium-widget-sdk/llms-full.txt): 文档站自动生成的全文。
|
|
9
32
|
- 自闭环范围:本包负责本地工程闭环;上传、平台预览、版本发布和 Agent 绑定不在本包内执行。
|
|
10
33
|
|
|
11
34
|
## 本地闭环
|
|
12
35
|
|
|
13
|
-
- `
|
|
36
|
+
- `integration --json`: `interfaceVersion=2`,返回固定 profile、执行器位置、
|
|
37
|
+
`toolchain.formatVersion=2` 和 `documentation { url, quickStart, cli, llms, llmsFull }`,
|
|
38
|
+
不返回 `skills`。已有工程加 `--project <目录>` 核对锁定,再读取对应参考。
|
|
39
|
+
- `create`: 创建 vanilla 或 React 工程并写 `widget-toolchain.json`;工作区文件面板使用
|
|
40
|
+
`--panel-id workspace-files`。
|
|
41
|
+
- `adopt`: 为旧工程显式写入工具链锁,先核对精确依赖、实际 SDK/contracts、Manifest 和 samples。
|
|
42
|
+
- SDK 0.5.0 的任务 Panel 在 Manifest 声明 `capabilities.tasks.list`;需要观察单个任务时再声明
|
|
43
|
+
`tasks.watch`。列表刷新遵守 grant 的 `minPollMs`,面板不可见后停止轮询;CLI 校验通过不代表
|
|
44
|
+
目标 Host 已签发 grant,详见 AGENTS.md。
|
|
45
|
+
- SDK 0.5.0 文件读写按需在 Manifest 声明 `capabilities.files.read/write`,再实现
|
|
46
|
+
`context.files.read/write`;创建命令和模板保持原样。保存使用读取回执的内容版本与 mutationId,
|
|
47
|
+
缺授权、版本或完整性证据时只读;冲突/未知结果保留草稿且不自动重试,详见 AGENTS.md。
|
|
14
48
|
- `check` / `validate`: 校验作者清单、Manifest、entry、samples 和 fixtures;`check all` 以
|
|
15
49
|
当前工作目录为根,找不到工程时返回 `WIDGET_CLI_NO_WIDGET_PROJECT`,不会静默通过。
|
|
16
|
-
- `dev`: 启动本地开发服务器和 Host Bridge
|
|
17
|
-
- `build`: 委托工程自己的构建命令,并拒绝“退出 0
|
|
50
|
+
- `dev`: 启动本地开发服务器和 Host Bridge 连接;每轮重建检查锁定信息和实际依赖,失败时保留上一轮。
|
|
51
|
+
- `build`: 委托工程自己的构建命令,并拒绝“退出 0 但仍有未解析依赖”的结果,写入构建 receipt。
|
|
18
52
|
- `pack`: 生成可交给平台的 ZIP,并输出 SHA-256 digest、Manifest 摘要和 CLI/SDK/Contracts 版本。
|
|
19
|
-
-
|
|
53
|
+
`--no-build` 要求 `.widget-build-receipt.json` 的工具链、实际依赖、输入和产物摘要全部匹配。
|
|
54
|
+
执行摘要仅含 `compiler`、`validators`、`schemas`、`templates`;文档站正文更新不影响
|
|
55
|
+
receipt,也不要求 CLI 发版。
|
|
56
|
+
- `doctor`: 输出 Node、固定 profile 和工程状态;始终核对候选 profile 的精确依赖,已有锁定时再核对
|
|
57
|
+
profile,`ready` 还要求锁定、依赖和入口。
|
|
20
58
|
- `schema`: 输出插件 Manifest Schema 路径。
|
|
21
59
|
|
|
60
|
+
工程命令检查工程锁、package.json 精确版本与自身 node_modules 实际安装版本;升级 CLI 不会
|
|
61
|
+
静默迁移工程。`/core` 是底层构建块,调用方自行承担锁定、实际依赖与宿主兼容预检。
|
|
62
|
+
|
|
63
|
+
## 宿主兼容
|
|
64
|
+
|
|
65
|
+
`--host-compat <文件>` 接受平台 statement 与调用方 observation。状态 `unknown` 表示无声明,
|
|
66
|
+
`snapshot` 表示匹配的快照或过期声明,`confirmed` 表示调用方报告在线取得、仍有效且匹配当前
|
|
67
|
+
profile;它不代表发布成功。无效声明或不匹配 profile 会报错。当前完成 A、B 本地能力,平台在线
|
|
68
|
+
发现接口和 Bohr 获取声明仍需后续接入。
|
|
69
|
+
|
|
22
70
|
## 平台侧动作
|
|
23
71
|
|
|
24
72
|
upload、preview、commit、Widget version publish 和 Agent binding 由 Bohr CLI 或平台服务
|
|
25
73
|
负责,Widget CLI 不提供这些动作。
|
|
74
|
+
|
|
75
|
+
当前开发宿主仍提供只读文件能力。sample grant、本地 build/check/pack 不代表目标 Host 已授权写入
|
|
76
|
+
或完成文件持久化;真实保存需 Host 适配。
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dp-bohrium/widget-cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
4
4
|
"description": "Bohrium Widget 插件工程的创建、校验、开发和打包工具。",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
"cli"
|
|
16
16
|
],
|
|
17
17
|
"author": "Bohrium",
|
|
18
|
-
"homepage": "https://
|
|
18
|
+
"homepage": "https://dev.dp.tech/bohrium-widget-sdk/",
|
|
19
19
|
"bin": {
|
|
20
20
|
"bohr-widget": "./dist/cli.mjs"
|
|
21
21
|
},
|
|
@@ -34,6 +34,7 @@
|
|
|
34
34
|
},
|
|
35
35
|
"files": [
|
|
36
36
|
"dist",
|
|
37
|
+
"assets",
|
|
37
38
|
"src/core.d.mts",
|
|
38
39
|
"src/development-host.d.mts",
|
|
39
40
|
"README.md",
|
|
@@ -45,24 +46,24 @@
|
|
|
45
46
|
"publishConfig": {
|
|
46
47
|
"access": "public"
|
|
47
48
|
},
|
|
48
|
-
"dependencies": {
|
|
49
|
-
"@dp-bohrium/widget-contracts": "0.3.0",
|
|
50
|
-
"@dp-bohrium/widget-sdk": "0.3.0"
|
|
51
|
-
},
|
|
52
49
|
"devDependencies": {
|
|
53
50
|
"@biomejs/biome": "^2.2.0",
|
|
54
51
|
"@types/node": "^22.15.0",
|
|
55
52
|
"tsdown": "0.22.14",
|
|
56
53
|
"typescript": "5.9.3",
|
|
57
|
-
"@dp-bohrium/widget-contract-testing": "0.1.0-alpha.0"
|
|
54
|
+
"@dp-bohrium/widget-contract-testing": "0.1.0-alpha.0",
|
|
55
|
+
"@dp-bohrium/widget-contracts": "0.5.0",
|
|
56
|
+
"@dp-bohrium/widget-sdk": "0.5.0"
|
|
58
57
|
},
|
|
59
58
|
"sideEffects": false,
|
|
60
59
|
"scripts": {
|
|
61
|
-
"build": "
|
|
62
|
-
"
|
|
63
|
-
"
|
|
64
|
-
"
|
|
65
|
-
"
|
|
60
|
+
"build:assets": "node scripts/build-assets.mjs",
|
|
61
|
+
"build:inputs": "pnpm --filter @dp-bohrium/widget-sdk... run build && pnpm --filter @dp-bohrium/widget-contract-testing run build",
|
|
62
|
+
"build": "pnpm build:inputs && pnpm build:assets && tsdown && node --check dist/cli.mjs",
|
|
63
|
+
"typecheck": "node --check src/cli.mjs && node --check src/help.mjs && node --check src/core.mjs && node --check src/templates.mjs && node --check src/toolchain.mjs && node --check src/project-executor.mjs && node --check scripts/build-assets.mjs",
|
|
64
|
+
"test": "pnpm build:inputs && pnpm build:assets && node --test test/*.test.mjs",
|
|
65
|
+
"lint": "biome check src test scripts",
|
|
66
|
+
"format:check": "biome check --linter-enabled=false src test scripts",
|
|
66
67
|
"package:contents": "node ../../scripts/quality/check-widget-cli-package-contents.mjs ../../.artifacts/dp-bohrium-widget-cli-*.tgz",
|
|
67
68
|
"check": "pnpm --filter @dp-bohrium/widget-contracts build && pnpm --filter @dp-bohrium/widget-contract-testing build && pnpm --filter widget-project build && pnpm typecheck && pnpm test && pnpm lint && pnpm format:check && pnpm build"
|
|
68
69
|
}
|