comp-hub 0.0.117 → 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 CHANGED
@@ -0,0 +1,94 @@
1
+ # comp-hub
2
+
3
+ 所见即所得的组件预览与共享平台,让组件的使用变得更加简单高效。
4
+
5
+ ## 📖 项目简介
6
+
7
+ comp-hub 是一个专为前端开发者设计的组件管理平台,致力于解决组件复用、文档缺失、标准化程度低等开发痛点。通过提供实时预览、依赖管理、版本控制等功能,让组件的共享和使用变得更加简单高效。
8
+
9
+ ## 🚀 核心功能
10
+
11
+ - **实时预览与依赖管理**:组件在线实时预览,自动匹配依赖版本,确保下载后所见即所得
12
+ - **轻量组件架构**:组件仅包含最小运行单元,运行时无缝集成到现有工程环境
13
+ - **简易上传流程**:三步完成组件发布,支持预览配置、文档编写与版本管理
14
+ - **完善文档支持**:支持标准 Markdown 文档,自动生成目录结构
15
+ - **版本管理系统**:支持语义化版本规范,多版本并存与切换
16
+ - **跨项目复用**:标准化的组件结构确保在不同项目间的高兼容性与可移植性
17
+
18
+ ## 📦 平台支持
19
+
20
+ 目前 comp-hub 支持以下前端框架:
21
+
22
+ - ✅ Vue 2
23
+ - ✅ Vue 3
24
+ - ❌ React(暂不支持)
25
+
26
+ ## 💻 安装与使用
27
+
28
+ ### 安装
29
+
30
+ ```bash
31
+ npm install comp-hub@latest
32
+ ```
33
+
34
+ ### 运行
35
+
36
+ ```bash
37
+ npx comphub
38
+ ```
39
+
40
+ 启动成功后,访问以下地址进入平台:
41
+
42
+ ```
43
+ http://localhost:3000
44
+ ```
45
+
46
+ ### 配置文件
47
+
48
+ 在项目根目录创建 `comphub.json` 文件自定义客户端行为:
49
+
50
+ ```json
51
+ {
52
+ "port": 3000,
53
+ "srcPath": "/src"
54
+ }
55
+ ```
56
+
57
+ 配置项说明:
58
+ - `port`:指定运行端口(默认:3000)
59
+ - `srcPath`:指定组件代码所在基础目录(推荐:"/src")
60
+
61
+ ## 📚 详细文档
62
+
63
+ 完整的使用指南和API文档请访问我们的官方文档:
64
+
65
+ [comp-hub 官方文档](https://docs.comphub.cn/)
66
+
67
+ ## 🔧 组件规范
68
+
69
+ - 组件必须以**文件夹**形式上传,文件夹名称即为组件名称
70
+ - 组件文件夹下必须包含 `index.vue` 作为入口文件
71
+ - 建议提供 `README.md` 详细描述组件功能和使用方法
72
+ - 支持 `comphub.json` 文件配置组件元数据
73
+
74
+ ## 🎯 版本管理
75
+
76
+ comp-hub 支持语义化版本规范:
77
+ - `X.Y.Z` 格式(如 1.2.3)
78
+ - `X`:主版本,不兼容的API变更
79
+ - `Y`:次版本,向下兼容的功能性新增
80
+ - `Z`:修订号,向下兼容的问题修正
81
+
82
+ ## 🤝 贡献指南
83
+
84
+ 欢迎贡献代码或提出建议!请参考我们的贡献指南了解更多信息。
85
+
86
+ ## 👥 社区支持
87
+
88
+ 加入我们的QQ群获取更多帮助和交流:
89
+
90
+ **官方QQ群**: 1049663501
91
+
92
+ ## 📝 许可证
93
+
94
+ [MIT License](LICENSE)
@@ -1,20 +1,20 @@
1
- ## ⚠️ 组件重复提示
2
-
3
- ### 检测结果
4
-
5
- 您的组件与平台已有组件在**核心功能、代码结构或 UI 交互**上高度相似。
6
- 为避免生态同质化,**不建议继续上传**。
7
-
8
- ### 仍坚持上传的后果
9
-
10
- - 该组件**不会进入**「推荐」「热门」「最新」等任何公共列表;
11
- - 用户仅可通过**组件全名绝对匹配**搜索到;
12
- - 平台会在其他组件的**「相似组件」栏目**中展示本品,作为替代选项之一;
13
- - 后续版本同样**不享受推荐权重**,直至差异性重新评估通过。
14
-
15
- ### 如何解除限制
16
-
17
- 1. 提供**显著差异化功能**或**独创性交互**的更新版本;
18
-
19
- > 大量上传相似组件可能被视为「设计垃圾邮件」,情节严重者将被暂停上架权限。
20
- > 请珍惜社区环境,尽量提交原创或深度改进作品。
1
+ ## ⚠️ 组件重复提示
2
+
3
+ ### 检测结果
4
+
5
+ 您的组件与平台已有组件在**核心功能、代码结构或 UI 交互**上高度相似。
6
+ 为避免生态同质化,**不建议继续上传**。
7
+
8
+ ### 仍坚持上传的后果
9
+
10
+ - 该组件**不会进入**「推荐」「热门」「最新」等任何公共列表;
11
+ - 用户仅可通过**组件全名绝对匹配**搜索到;
12
+ - 平台会在其他组件的**「相似组件」栏目**中展示本品,作为替代选项之一;
13
+ - 后续版本同样**不享受推荐权重**,直至差异性重新评估通过。
14
+
15
+ ### 如何解除限制
16
+
17
+ 1. 提供**显著差异化功能**或**独创性交互**的更新版本;
18
+
19
+ > 大量上传相似组件可能被视为「设计垃圾邮件」,情节严重者将被暂停上架权限。
20
+ > 请珍惜社区环境,尽量提交原创或深度改进作品。
@@ -1,68 +1,68 @@
1
- # 组件发布协议
2
-
3
- 欢迎您在本平台发布组件,为确保平台生态合规、安全及用户权益,您需严格遵守以下条款,**提交发布即视为已阅读并同意本协议**。
4
-
5
- ---
6
-
7
- ## 一、合法性与合规性要求
8
-
9
- - **不得发布任何违反国家法律法规、行业监管标准及公序良俗的组件内容**。
10
- - **禁止包含政治敏感、暴力血腥、色情低俗、仇恨歧视、封建迷信等违规信息**。
11
- - **不得发布涉及赌博、诈骗、传销、非法金融等违法用途的组件**。
12
- - 组件功能及内容需符合平台定位,**不得超出平台允许的服务范围**。
13
-
14
- ---
15
-
16
- ## 二、知识产权与授权规范
17
-
18
- - **您需确保对发布的组件(含代码、界面设计、素材等)拥有完整、合法的知识产权,无第三方权属争议**。
19
- - 若组件中使用开源代码、第三方库或素材(如图片、图标、字体),**需严格遵守对应开源协议(如 MIT、GPL、Apache 等)或授权条款**,**明确标注来源及版权信息**。
20
- - **禁止盗用、抄袭他人已发布的组件内容**,或未经授权使用他人享有知识产权的成果。
21
- - 若组件涉及他人肖像、姓名、商标等权益,**需提前获得相关方书面授权**,并在组件说明中**公示授权信息**。
22
-
23
- ---
24
-
25
- ## 三、内容真实性与质量承诺
26
-
27
- - **组件需具备基本可用性,无导致系统崩溃、数据丢失等严重问题的已知漏洞**。
28
- - 若组件依赖第三方服务(如 API 接口、云存储等),**需在说明中明确标注依赖项、适用环境及第三方服务的风险提示**。
29
- - **禁止发布空白、测试性质、广告导流(无实际功能仅用于推广)或与平台无关的无效组件**。
30
-
31
- ---
32
-
33
- ## 四、安全与隐私保护义务
34
-
35
- - **组件不得包含恶意代码(如病毒、木马、蠕虫)、后门程序或可能窃取用户数据的功能**。
36
- - 若组件需收集用户数据(如账号信息、设备信息、使用记录等),**需满足以下要求**:
37
- - **明确告知用户数据收集的范围、目的及使用方式**;
38
- - **获得用户主动授权(如弹窗同意)**,且提供数据删除、撤回授权的途径;
39
- - **不得超范围收集数据**,**不得将用户数据用于协议外用途或泄露给第三方**(法律法规要求除外);
40
- - **组件需具备基础的数据安全防护能力**,避免因自身漏洞导致用户数据泄露、篡改。
41
-
42
- ---
43
-
44
- ## 五、维护与更新责任
45
-
46
- - **建议您定期维护组件**,及时修复功能漏洞、适配平台版本更新及兼容主流运行环境。
47
- - 若组件出现重大安全问题(如数据泄露风险、恶意代码注入等),**需在 24 小时内提交修复版本**,并配合平台进行应急处理。
48
- - 若您计划停止组件维护或下架组件,**需提前 7 天在组件详情页公示通知**,为已使用该组件的用户预留迁移时间。
49
- - 组件更新时,**需清晰标注更新内容**(如功能新增、bug 修复、兼容性调整),**不得在更新中添加未经说明的新权限或违规功能**。
50
-
51
- ---
52
-
53
- ## 六、平台审核与违规处理
54
-
55
- - **平台有权对您提交的组件进行审核**,审核标准以本协议及平台规则为准,审核结果(**通过 / 驳回 / 整改**)将通过系统通知告知。
56
- - 若组件存在违反本协议的情况,**平台有权采取以下措施**:
57
- - **要求限期整改,整改期间暂停组件展示**;
58
- - **直接驳回发布申请,且不退还已产生的审核成本(若有)**;
59
- - **下架已发布的违规组件,清除相关展示数据**;
60
- - **若您多次违反本协议(累计 3 次及以上)**,平台有权**永久封禁您的发布账号**,且保留追究法律责任的权利。
61
-
62
- ---
63
-
64
- ## 七、免责声明
65
-
66
- - **您需自行承担因组件违规、侵权或质量问题导致的法律责任**(包括但不限于第三方索赔、行政机关处罚),平台不承担相关连带责任。
67
- - 因组件使用不当、环境适配问题或第三方服务故障导致的用户损失,**平台不承担赔偿责任**。
68
- - **平台有权根据法律法规更新、行业变化及平台发展需求,调整本协议条款**,更新后将通过平台公告告知,**您继续发布组件即视为同意更新后的协议**。
1
+ # 组件发布协议
2
+
3
+ 欢迎您在本平台发布组件,为确保平台生态合规、安全及用户权益,您需严格遵守以下条款,**提交发布即视为已阅读并同意本协议**。
4
+
5
+ ---
6
+
7
+ ## 一、合法性与合规性要求
8
+
9
+ - **不得发布任何违反国家法律法规、行业监管标准及公序良俗的组件内容**。
10
+ - **禁止包含政治敏感、暴力血腥、色情低俗、仇恨歧视、封建迷信等违规信息**。
11
+ - **不得发布涉及赌博、诈骗、传销、非法金融等违法用途的组件**。
12
+ - 组件功能及内容需符合平台定位,**不得超出平台允许的服务范围**。
13
+
14
+ ---
15
+
16
+ ## 二、知识产权与授权规范
17
+
18
+ - **您需确保对发布的组件(含代码、界面设计、素材等)拥有完整、合法的知识产权,无第三方权属争议**。
19
+ - 若组件中使用开源代码、第三方库或素材(如图片、图标、字体),**需严格遵守对应开源协议(如 MIT、GPL、Apache 等)或授权条款**,**明确标注来源及版权信息**。
20
+ - **禁止盗用、抄袭他人已发布的组件内容**,或未经授权使用他人享有知识产权的成果。
21
+ - 若组件涉及他人肖像、姓名、商标等权益,**需提前获得相关方书面授权**,并在组件说明中**公示授权信息**。
22
+
23
+ ---
24
+
25
+ ## 三、内容真实性与质量承诺
26
+
27
+ - **组件需具备基本可用性,无导致系统崩溃、数据丢失等严重问题的已知漏洞**。
28
+ - 若组件依赖第三方服务(如 API 接口、云存储等),**需在说明中明确标注依赖项、适用环境及第三方服务的风险提示**。
29
+ - **禁止发布空白、测试性质、广告导流(无实际功能仅用于推广)或与平台无关的无效组件**。
30
+
31
+ ---
32
+
33
+ ## 四、安全与隐私保护义务
34
+
35
+ - **组件不得包含恶意代码(如病毒、木马、蠕虫)、后门程序或可能窃取用户数据的功能**。
36
+ - 若组件需收集用户数据(如账号信息、设备信息、使用记录等),**需满足以下要求**:
37
+ - **明确告知用户数据收集的范围、目的及使用方式**;
38
+ - **获得用户主动授权(如弹窗同意)**,且提供数据删除、撤回授权的途径;
39
+ - **不得超范围收集数据**,**不得将用户数据用于协议外用途或泄露给第三方**(法律法规要求除外);
40
+ - **组件需具备基础的数据安全防护能力**,避免因自身漏洞导致用户数据泄露、篡改。
41
+
42
+ ---
43
+
44
+ ## 五、维护与更新责任
45
+
46
+ - **建议您定期维护组件**,及时修复功能漏洞、适配平台版本更新及兼容主流运行环境。
47
+ - 若组件出现重大安全问题(如数据泄露风险、恶意代码注入等),**需在 24 小时内提交修复版本**,并配合平台进行应急处理。
48
+ - 若您计划停止组件维护或下架组件,**需提前 7 天在组件详情页公示通知**,为已使用该组件的用户预留迁移时间。
49
+ - 组件更新时,**需清晰标注更新内容**(如功能新增、bug 修复、兼容性调整),**不得在更新中添加未经说明的新权限或违规功能**。
50
+
51
+ ---
52
+
53
+ ## 六、平台审核与违规处理
54
+
55
+ - **平台有权对您提交的组件进行审核**,审核标准以本协议及平台规则为准,审核结果(**通过 / 驳回 / 整改**)将通过系统通知告知。
56
+ - 若组件存在违反本协议的情况,**平台有权采取以下措施**:
57
+ - **要求限期整改,整改期间暂停组件展示**;
58
+ - **直接驳回发布申请,且不退还已产生的审核成本(若有)**;
59
+ - **下架已发布的违规组件,清除相关展示数据**;
60
+ - **若您多次违反本协议(累计 3 次及以上)**,平台有权**永久封禁您的发布账号**,且保留追究法律责任的权利。
61
+
62
+ ---
63
+
64
+ ## 七、免责声明
65
+
66
+ - **您需自行承担因组件违规、侵权或质量问题导致的法律责任**(包括但不限于第三方索赔、行政机关处罚),平台不承担相关连带责任。
67
+ - 因组件使用不当、环境适配问题或第三方服务故障导致的用户损失,**平台不承担赔偿责任**。
68
+ - **平台有权根据法律法规更新、行业变化及平台发展需求,调整本协议条款**,更新后将通过平台公告告知,**您继续发布组件即视为同意更新后的协议**。
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "comp-hub",
3
- "version": "0.0.117",
3
+ "version": "0.1.1",
4
4
  "main": "dist/index.js",
5
5
  "bin": {
6
6
  "comphub": "bin/cli.js"