@hbdlzy/ui 0.1.0 → 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.
Files changed (4) hide show
  1. package/AI-USAGE.md +67 -0
  2. package/README.md +37 -2
  3. package/package.json +4 -3
  4. package/package.manifest.json +86 -3
package/AI-USAGE.md ADDED
@@ -0,0 +1,67 @@
1
+ # AI Usage Guide
2
+
3
+ 这个文件是安装了 `@hbdlzy/ui` 的项目里，给 AI 读取组件库的唯一入口文件。
4
+
5
+ ## 你应该怎么使用这个文件
6
+
7
+ 在新项目里，不需要再让 AI 手动读取一长串文件。
8
+ 只需要让 AI 先读取这一个文件：
9
+
10
+ ```text
11
+ node_modules/@hbdlzy/ui/AI-USAGE.md
12
+ ```
13
+
14
+ 然后 AI 必须继续执行：
15
+
16
+ 1. 读取同目录下的 `package.manifest.json`
17
+ 2. 按 `package.manifest.json` 里的 `aiReadOrder` 继续读取其他文档
18
+ 3. 建立当前公共组件、工具和导入方式清单
19
+ 4. 后续实现时优先复用现有组件，不要重复实现相同能力
20
+
21
+ ## 单文件入口规则
22
+
23
+ 以后无论组件库新增多少组件，你给 AI 的外部指令都尽量保持不变。
24
+ 只保留这句就够了：
25
+
26
+ ```text
27
+ 本项目使用 @hbdlzy/ui 组件库。开始实现前，请先读取 node_modules/@hbdlzy/ui/AI-USAGE.md，并按其中规则建立组件清单。后续优先复用已有公共组件和工具，新增页面默认从 @hbdlzy/ui 导入。
28
+ ```
29
+
30
+ ## 读取完成后的工作方式
31
+
32
+ - 先建立“已存在组件/工具”清单
33
+ - 新增页面或功能时，优先判断是否可以使用：
34
+ - `BaseTable`
35
+ - `BaseCard`
36
+ - `BaseEChart`
37
+ - `BaseExportButton`
38
+ - `echarts`
39
+ - `exportExcel`
40
+ - `companyTokens`
41
+ - 只有当现有组件无法满足需求时，才考虑新增公共组件
42
+
43
+ ## 导入约定
44
+
45
+ 优先统一从 `@hbdlzy/ui` 导入：
46
+
47
+ ```ts
48
+ import { BaseTable, BaseCard, BaseEChart, BaseExportButton, companyTokens, echarts } from '@hbdlzy/ui'
49
+ ```
50
+
51
+ ## 复用规则
52
+
53
+ - 不要在页面里重复写通用表格的分页、操作列、远程请求承接和勾选暴露逻辑，优先使用 `BaseTable`
54
+ - 不要在页面里重复写 ECharts 初始化、resize、dispose 逻辑，优先使用 `BaseEChart`
55
+ - 不要在页面里重复写卡片外层容器、标题区、右侧时间和导出触发区，优先使用 `BaseCard`
56
+ - 不要在页面里重复写导出按钮 loading、成功失败提示和文件下载逻辑，优先使用 `BaseExportButton`
57
+ - 需要渐变色、图形工具时，优先使用统一导出的 `echarts`
58
+ - 需要主题变量时，优先使用 `companyTokens`
59
+
60
+ ## 维护组件库时
61
+
62
+ 如果当前任务不是用组件，而是新增组件或维护组件库，请继续读取：
63
+
64
+ - `../docs/component-authoring-guide.md`
65
+ - `../templates/component-authoring/README.template.md`
66
+ - `../templates/component-authoring/component-manifest-item.template.json`
67
+ - `../templates/component-authoring/component-checklist.md`
package/README.md CHANGED
@@ -17,10 +17,45 @@ npm install @hbdlzy/ui
17
17
  ## 使用方式
18
18
 
19
19
  ```ts
20
- import { BaseExportButton, companyTokens } from '@hbdlzy/ui'
20
+ import { BaseTable, BaseCard, BaseEChart, BaseExportButton, companyTokens, echarts } from '@hbdlzy/ui'
21
+ ```
22
+
23
+ ## 当前汇总
24
+
25
+ - 设计令牌：`@hbdlzy/tokens`
26
+ - 基础组件：`@hbdlzy/ui-core`
27
+ - 业务域组件：`@hbdlzy/ui-energy`
28
+
29
+ ## 当前可直接使用的组件与工具
30
+
31
+ - `BaseTable`
32
+ - `BaseEChart`
33
+ - `BaseExportButton`
34
+ - `BaseCard`
35
+ - `echarts`
36
+ - `exportExcel`
37
+ - `companyTokens`
38
+
39
+ ## 详细文档入口
40
+
41
+ - 统一 AI 读取说明：[AI-USAGE.md](./AI-USAGE.md)
42
+ - 统一清单：[package.manifest.json](./package.manifest.json)
43
+ - `ui-core` 文档：[../ui-core/README.md](../ui-core/README.md)
44
+ - `BaseTable` 文档：[../ui-core/src/components/BaseTable/README.md](../ui-core/src/components/BaseTable/README.md)
45
+ - `BaseEChart` 文档：[../ui-core/src/components/BaseEChart/README.md](../ui-core/src/components/BaseEChart/README.md)
46
+ - `BaseExportButton` 文档：[../ui-core/src/components/BaseExportButton/README.md](../ui-core/src/components/BaseExportButton/README.md)
47
+ - `BaseCard` 文档：[../ui-core/src/components/BaseCard/README.md](../ui-core/src/components/BaseCard/README.md)
48
+
49
+ ## AI 使用指令
50
+
51
+ 在新项目中，可以直接对 AI 使用这句固定指令：
52
+
53
+ ```text
54
+ 本项目使用 @hbdlzy/ui 组件库。开始实现前，请先读取 node_modules/@hbdlzy/ui/AI-USAGE.md，并按其中规则建立组件清单。后续优先复用已有公共组件和工具，新增页面默认从 @hbdlzy/ui 导入。
21
55
  ```
22
56
 
23
57
  ## 说明
24
58
 
25
59
  - 该包内部依赖 `@hbdlzy/tokens`、`@hbdlzy/ui-core`、`@hbdlzy/ui-energy`
26
- - 导入 `@hbdlzy/ui` 时会自动加载设计变量样式
60
+ - 导入 `@hbdlzy/ui` 时会自动加载设计变量样式
61
+ - 新项目中如果希望 AI 能稳定复用组件，优先让它先读 `package.manifest.json` 和 `AI-USAGE.md`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hbdlzy/ui",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Company unified UI entry package.",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -23,12 +23,13 @@
23
23
  "dist",
24
24
  "src",
25
25
  "README.md",
26
+ "AI-USAGE.md",
26
27
  "package.manifest.json"
27
28
  ],
28
29
  "dependencies": {
29
30
  "@hbdlzy/tokens": "0.1.0",
30
- "@hbdlzy/ui-core": "0.1.0",
31
- "@hbdlzy/ui-energy": "0.1.0"
31
+ "@hbdlzy/ui-energy": "0.1.0",
32
+ "@hbdlzy/ui-core": "0.1.1"
32
33
  },
33
34
  "peerDependencies": {
34
35
  "element-plus": "^2.13.7",
package/package.manifest.json CHANGED
@@ -1,11 +1,94 @@
1
1
  {
2
2
  "name": "@hbdlzy/ui",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "entry": "@hbdlzy/ui",
5
+ "readme": "README.md",
6
+ "aiGuide": "AI-USAGE.md",
7
+ "singleAiEntry": "AI-USAGE.md",
5
8
  "installs": [
6
9
  "@hbdlzy/tokens",
7
10
  "@hbdlzy/ui-core",
8
11
  "@hbdlzy/ui-energy"
9
12
  ],
10
- "description": "Unified install entry for company UI packages."
11
- }
13
+ "description": "Unified install entry for company UI packages.",
14
+ "exports": {
15
+ "components": [
16
+ {
17
+ "name": "BaseTable",
18
+ "from": "@hbdlzy/ui-core",
19
+ "importName": "BaseTable",
20
+ "docs": "../ui-core/src/components/BaseTable/README.md"
21
+ },
22
+ {
23
+ "name": "BaseCard",
24
+ "from": "@hbdlzy/ui-core",
25
+ "importName": "BaseCard",
26
+ "docs": "../ui-core/src/components/BaseCard/README.md"
27
+ },
28
+ {
29
+ "name": "BaseEChart",
30
+ "from": "@hbdlzy/ui-core",
31
+ "importName": "BaseEChart",
32
+ "docs": "../ui-core/src/components/BaseEChart/README.md"
33
+ },
34
+ {
35
+ "name": "BaseExportButton",
36
+ "from": "@hbdlzy/ui-core",
37
+ "importName": "BaseExportButton",
38
+ "docs": "../ui-core/src/components/BaseExportButton/README.md"
39
+ }
40
+ ],
41
+ "utilities": [
42
+ {
43
+ "name": "echarts",
44
+ "from": "@hbdlzy/ui-core",
45
+ "importName": "echarts",
46
+ "docs": "../ui-core/src/components/BaseEChart/README.md"
47
+ },
48
+ {
49
+ "name": "exportExcel",
50
+ "from": "@hbdlzy/ui-core",
51
+ "importName": "exportExcel",
52
+ "docs": "../ui-core/src/components/BaseExportButton/README.md"
53
+ },
54
+ {
55
+ "name": "companyTokens",
56
+ "from": "@hbdlzy/tokens",
57
+ "importName": "companyTokens",
58
+ "docs": "../tokens/README.md"
59
+ }
60
+ ]
61
+ },
62
+ "packages": [
63
+ {
64
+ "name": "@hbdlzy/tokens",
65
+ "docs": "../tokens/README.md",
66
+ "manifest": "../tokens/package.manifest.json"
67
+ },
68
+ {
69
+ "name": "@hbdlzy/ui-core",
70
+ "docs": "../ui-core/README.md",
71
+ "manifest": "../ui-core/components.manifest.json"
72
+ },
73
+ {
74
+ "name": "@hbdlzy/ui-energy",
75
+ "docs": "../ui-energy/README.md",
76
+ "manifest": "../ui-energy/components.manifest.json"
77
+ }
78
+ ],
79
+ "aiReadOrder": [
80
+ "package.manifest.json",
81
+ "README.md",
82
+ "AI-USAGE.md",
83
+ "../ui-core/components.manifest.json",
84
+ "../ui-core/README.md",
85
+ "../ui-core/src/components/BaseTable/README.md",
86
+ "../ui-core/src/components/BaseCard/README.md",
87
+ "../ui-core/src/components/BaseEChart/README.md",
88
+ "../ui-core/src/components/BaseExportButton/README.md",
89
+ "../tokens/package.manifest.json",
90
+ "../tokens/README.md",
91
+ "../ui-energy/components.manifest.json",
92
+ "../ui-energy/README.md"
93
+ ]
94
+ }