neo-cmp-cli 1.3.1 → 1.3.3
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 +16 -14
- package/package.json +1 -1
- package/src/template/antd-custom-cmp-template/package.json +1 -1
- package/src/template/echarts-custom-cmp-template/package.json +1 -1
- package/src/template/neo-custom-cmp-template/package.json +1 -1
- package/src/template/react-custom-cmp-template/package.json +1 -1
- package/src/template/react-ts-custom-cmp-template/package.json +1 -1
- package/src/template/vue2-custom-cmp-template/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,7 +10,8 @@ neo-cmp-cli 是 Neo 自定义组件开发工具，基于 [AKFun](https://github.
|
|
|
10
10
|
- **参数替换**: 支持基于 [params-replace-loader](https://www.npmjs.com/package/params-replace-loader) 的环境变量批量替换；
|
|
11
11
|
- **一键发布**: 内置发布到 OSS 的能力，并支持自定义对象存储配置。
|
|
12
12
|
|
|
13
|
-
###
|
|
13
|
+
### 内置的自定义组件模板
|
|
14
|
+
创建自定义组件时（执行初始化命令 neo init）可选。
|
|
14
15
|
- **React 模板**: [react-custom-cmp-template](https://github.com/wibetter/react-custom-cmp-template)
|
|
15
16
|
- **React + TS 模板**: [react-ts-custom-cmp-template](https://github.com/wibetter/react-ts-custom-cmp-template)
|
|
16
17
|
- **Antd 模板**: [antd-custom-cmp-template](https://github.com/wibetter/antd-custom-cmp-template) Antd 自定义组件
|
|
@@ -46,23 +47,24 @@ neo publish2oss
|
|
|
46
47
|
### 方法二：在现有业务项目中使用自定义组件开发工具
|
|
47
48
|
此方式可用于将现有业务组件发布成平台可用自定义组件。
|
|
48
49
|
|
|
49
|
-
1)
|
|
50
|
+
##### 1) 安装到当前项目，并添加开发依赖
|
|
51
|
+
使用以下安装命令时会自动将 neo-cmp-cli 添加成当前项目开发依赖
|
|
50
52
|
```bash
|
|
51
53
|
yarn add neo-cmp-cli --dev
|
|
52
54
|
# 或
|
|
53
55
|
npm i neo-cmp-cli --save-dev
|
|
54
56
|
```
|
|
55
|
-
2) 在 package.json
|
|
57
|
+
##### 2) 在 package.json 添加可用执行脚本
|
|
56
58
|
```bash
|
|
57
59
|
"preview": "neo preview",
|
|
58
60
|
"linkDebug": "neo linkDebug",
|
|
59
61
|
"publish2oss": "neo publish2oss"
|
|
60
62
|
```
|
|
61
|
-
3) 初始化配置文件
|
|
63
|
+
##### 3) 初始化配置文件
|
|
62
64
|
```bash
|
|
63
65
|
neo config init
|
|
64
66
|
```
|
|
65
|
-
4)
|
|
67
|
+
##### 4) 开发调试和发布
|
|
66
68
|
```bash
|
|
67
69
|
npm run preview
|
|
68
70
|
npm run linkDebug
|
|
@@ -76,18 +78,18 @@ npm run publish2oss
|
|
|
76
78
|
- **neo publish2oss**: 构建并上传到对象存储（可自定义配置对象存储）。
|
|
77
79
|
|
|
78
80
|
## 开发须知
|
|
79
|
-
#### 1
|
|
81
|
+
#### 1）默认自动识别自定义组件
|
|
80
82
|
- **自动生成入口配置**: 当 `entry` 未配置时，自动从 `src/components` 目录下扫描并识别自定义组件，`src/components` 下的子目录名称作为自定义组件的 cmpType，并以其目录下的 `index.ts/.tsx/.js/.jsx` 文件作为组件内容文件，model.[tj]s 作为模型内容文件；
|
|
81
83
|
- **自动注册自定义组件**: 当 `entry` 未配置时，自动生成自定义组件注册文件和模型注册文件，并注入到构建脚本中，无需用户手动编写注册文件（[neo-register](https://www.npmjs.com/package/neo-register)）。
|
|
82
84
|
|
|
83
|
-
#### 2
|
|
85
|
+
#### 2）设置自定义组件属性配置项
|
|
84
86
|
通过 neo init 初始化的自定义组件，默认自带组件模型文件，所有和页面设计器关联的信息均在此文件中定义（详细见 model 文件中的注释说明）。
|
|
85
87
|
其中 propsSchema 用于添加自定义组件的属性配置面板，当前可用的配置项类型请见 [neo-register 使用文档](https://www.npmjs.com/package/neo-register)。
|
|
86
88
|
|
|
87
|
-
#### 3
|
|
89
|
+
#### 3）在自定义组件使用平台实体数据源
|
|
88
90
|
可使用 OpenAPI SDK 对接平台实体数据源，详细使用方法见 [neo-open-api](https://www.npmjs.com/package/neo-open-api)。
|
|
89
91
|
|
|
90
|
-
#### 4
|
|
92
|
+
#### 4）默认复用平台第三方依赖
|
|
91
93
|
自定义组件构建过程中默认会剔除掉平台已有依赖模块（比如 antd、echarts、axios、lodash 等），确保自定义组件构建后的资源体积较小。
|
|
92
94
|
|
|
93
95
|
##### 自定义组件可直接使用的第三方依赖包（NeoCRM 平台预置）：
|
|
@@ -112,7 +114,7 @@ npm run publish2oss
|
|
|
112
114
|
|
|
113
115
|
备注：自定义组件中请使用依赖包支持的版本，如版本不匹配运行时可能出现异常。
|
|
114
116
|
|
|
115
|
-
#### 5
|
|
117
|
+
#### 5）本地调试自定义组件
|
|
116
118
|
|
|
117
119
|
##### 1. 启动 外链调试模式
|
|
118
120
|
```
|
|
@@ -126,7 +128,7 @@ neo linkDebug
|
|
|
126
128
|
##### 3. 页面设计器开启 debug 模式后，左侧会展示 外部链接 管理面板
|
|
127
129
|
将第 1 步生成的「外链脚本地址」添加进来，即可在此页面设计器 / 组件物料面板中看到对应自定义组件。
|
|
128
130
|
|
|
129
|
-
#### 6
|
|
131
|
+
#### 6）发布自定义组件
|
|
130
132
|
执行 `neo publish2oss` 即可构建对应自定义组件，并自动将构建后资源上传到对象存储（OSS）中。
|
|
131
133
|
|
|
132
134
|
##### 发布前请确保
|
|
@@ -163,7 +165,7 @@ neo-cmp-cli 默认提供完整配置；
|
|
|
163
165
|
|
|
164
166
|
以下为常用配置示例（片段可自由组合）。
|
|
165
167
|
|
|
166
|
-
### 1)
|
|
168
|
+
### 1) 代码规范与检查相关配置
|
|
167
169
|
```javascript
|
|
168
170
|
module.exports = {
|
|
169
171
|
settings: {
|
|
@@ -175,7 +177,7 @@ module.exports = {
|
|
|
175
177
|
}
|
|
176
178
|
```
|
|
177
179
|
|
|
178
|
-
### 2)
|
|
180
|
+
### 2) 构建入口配置（优先级：linkDebug/build2lib/publish2oss.entry > webpack.entry）
|
|
179
181
|
【提示】当未配置 entry 时，cli 默认从 `src/components` 目录下扫描并识别自定义组件，并自动生成对应的 entry 构建入口配置。
|
|
180
182
|
|
|
181
183
|
如需自定义构建入口配置，请按如下结构调整项目工程配置文件（neo.config.js）：
|
|
@@ -205,7 +207,7 @@ module.exports = {
|
|
|
205
207
|
备注1: extensions 的详细配置方法请查看Webpack官网 ([关于resolve-extensions的配置方法](https://www.webpackjs.com/configuration/resolve/#resolve-extensions))；
|
|
206
208
|
备注2: alias 的详细配置方法请查看 Webpack 官网 ([关于resolve-alias的配置方法](https://www.webpackjs.com/configuration/resolve/#resolve-alias))。
|
|
207
209
|
|
|
208
|
-
### 4)
|
|
210
|
+
### 4) 页面模板与公共样式资源
|
|
209
211
|
```javascript
|
|
210
212
|
module.exports = {
|
|
211
213
|
webpack: {
|
package/package.json
CHANGED