@finedesign/cli 0.3.1 → 0.5.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/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # 更新日志
2
2
 
3
+ ## 0.5.0
4
+
5
+ 2026-11-05
6
+
7
+ - 明确已有 React 工程、无构建 HTML 和只查询资料时,各自使用的组件包、UMD 资源或公开 CLI。
8
+ - CLI `diff --component <name>` 和 MCP `diff_catalogs` 的 `component` 参数支持按组件对比版本。结果补充被移除的章节、示例和别名,并识别同名章节和示例的内容变更。
9
+ - CLI `example <component>` 和 MCP `get_component_example` 省略示例 ID 时列出可用 ID 和标题,指定 ID 后读取源码和资源。
10
+
11
+ ## 0.4.0
12
+
13
+ 2026-11-05
14
+
15
+ - MCP 新增组件概览、Design Token、版本对比和代码检查,支持省略可选的工具参数。
16
+ - CLI 和 MCP 按扫描目标检测 Fine Design 版本,仅在执行 `lint` 时加载语法解析器。代码检查支持传统装饰器和 SVG 图标类型导入。
17
+ - 补齐 `1.24.9` 的 `Combo.Check`、图标示例和组件别名,更新 `1.25.0` 示例中的 Dialog 回调与图标导入。日期示例导出时移除站点专用样式前缀。
18
+
3
19
  ## 0.3.1
4
20
 
5
21
  2026-11-05
package/README.md CHANGED
@@ -48,10 +48,11 @@ npx -y @finedesign/cli lint src/ # 检查代码
48
48
  CLI 内置 `skills/fine-design/SKILL.md`。将以下指令发给 AI 编码助手,或写入项目的 `AGENTS.md` / `CLAUDE.md`:
49
49
 
50
50
  ```text
51
- 开发、修复或评审 Fine Design 页面时:
52
- 1. 运行 npx -y @finedesign/cli doctor,读取输出路径中的 SKILL.md。
53
- 2. 按检测到的组件版本,通过 info、doc、token、example 查询 API 和真实示例;结构化结果使用 --format json。
54
- 3. 完成后运行 npx -y @finedesign/cli lint <文件或目录>,并执行项目现有构建、测试和关键交互验证。
51
+ 开发或修改 Fine Design 页面时,在目标项目目录运行 CLI。项目已安装 CLI 时用 `npx fine-design`,否则用 `npx -y @finedesign/cli`。
52
+
53
+ 1. 运行 `doctor --format json`,读取 `bundledSkillPath` 指向的 Skill,按项目实际组件版本查资料。
54
+ 2. 按目标版本用 `info` 查组件 API,按需用 `example` 读示例源码。
55
+ 3. 对改动文件运行 `lint <改动文件>`,执行项目已有检查,验证受影响的交互。
55
56
  ```
56
57
 
57
58
  ### MCP
@@ -69,7 +70,7 @@ CLI 内置 `skills/fine-design/SKILL.md`。将以下指令发给 AI 编码助手
69
70
  }
70
71
  ```
71
72
 
72
- MCP 提供组件搜索、文档、示例和浏览器运行时查询;工具输入结构由客户端自动发现。组件查询需传入精确的 `version`,运行时查询需要联网。
73
+ MCP 提供组件搜索、API、Design Token、示例、版本对比、代码检查和浏览器运行时查询。客户端可自动发现工具参数。组件查询需传入精确的 `version`,代码检查可以从目标工程检测版本,运行时查询需要联网。
73
74
 
74
75
  ## 命令
75
76
 
@@ -84,7 +85,7 @@ MCP 提供组件搜索、文档、示例和浏览器运行时查询;工具输
84
85
  | `info <component>` | 查看组件概览与 API |
85
86
  | `doc <component>` | 阅读文档;`--toc` 查看目录,`--section` 选择章节 |
86
87
  | `token [component] [query]` | 查询与筛选全局或组件 Token |
87
- | `example <component> <id>` | 读取示例源码及资源信息 |
88
+ | `example <component> [id]` | 列出示例 ID 和标题,或按 ID 读取源码及资源信息 |
88
89
 
89
90
  ### 工程检查
90
91
 
@@ -92,7 +93,7 @@ MCP 提供组件搜索、文档、示例和浏览器运行时查询;工具输
92
93
  | --- | --- |
93
94
  | `doctor` | 检查组件版本、可用资料及 Skill 路径 |
94
95
  | `lint [files-or-dirs...]` | 扫描常见 API 陷阱与非法导入 |
95
- | `diff [fromVer] [toVer]` | 对比版本间的资料与迁移建议 |
96
+ | `diff [fromVer] [toVer]` | 对比版本间的文档、示例和迁移建议,支持 `--component <name>` |
96
97
 
97
98
  ### 集成与预览
98
99
 
@@ -103,13 +104,13 @@ MCP 提供组件搜索、文档、示例和浏览器运行时查询;工具输
103
104
 
104
105
  ## 版本与输出
105
106
 
106
- - **组件版本**:`--fd-version` 优先;否则从当前工程或 `--project <目录>` 检测实际安装版本。未收录的版本明确报错,不降级或猜测。
107
+ - **组件版本**:`--fd-version` 优先,其次使用 `--project <目录>` 指定的工程。未指定时,`lint` 从扫描目标检测版本,其他组件查询从当前工程检测。未收录的版本会报错。
107
108
  - **输出格式**:默认文本;`--format json` 适合 Agent。`doc`、`info`、`token` 支持 Markdown;`runtime` 支持 HTML。
108
109
  - **结果与错误**:结果写入 stdout,错误写入 stderr。退出码 `0` 表示成功,`1` 表示检查未通过或运行错误,`2` 为参数问题,`3` 为版本问题,`4` 为资料未找到。
109
110
 
110
111
  ## 浏览器预览
111
112
 
112
- 独立 HTML 和原型可使用公开 UMD 运行时,无需安装组件包或配置构建工具。
113
+ 已有构建流程的 React 应用使用私有组件包 `@fx-ui/fine-design`。独立 HTML、无构建嵌入页和原型可使用公开 UMD 运行时,浏览器无需安装组件包。
113
114
 
114
115
  ```sh
115
116
  npx -y @finedesign/cli runtime list