rigjs 3.0.21 → 3.0.23
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_CN.md +57 -4
- package/built/index.js +14 -12
- package/lib/classes/cicd/Deploy/AliDeploy.ts +1 -1
- package/lib/env/index.ts +3 -0
- package/package.json +1 -1
package/README_CN.md
CHANGED
|
@@ -1,26 +1,34 @@
|
|
|
1
1
|
# rig
|
|
2
|
+
|
|
2
3
|
- [dependencies配置](./doc/dependencies_cn.md)
|
|
3
4
|
|
|
4
5
|
## 快速开始
|
|
6
|
+
|
|
5
7
|
### 0.前提准备
|
|
8
|
+
|
|
6
9
|
1. 安装yarn.
|
|
7
|
-
2. node版本高于
|
|
10
|
+
2. node版本高于16.
|
|
8
11
|
3. 依赖库必须使用git+ssh链接,不支持http/https链接.
|
|
9
12
|
4. 以下rig库统一指代在可以用rig管理的仓库.
|
|
10
13
|
|
|
11
14
|
#### 安装yarn,
|
|
15
|
+
|
|
12
16
|
```shell
|
|
13
17
|
yarn global add rigjs
|
|
14
18
|
```
|
|
19
|
+
|
|
15
20
|
rig采用yarn workspaces实现依赖晋升。[关于yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces)
|
|
16
|
-
|
|
21
|
+
|
|
22
|
+
#### NodeJS版本不低于16
|
|
23
|
+
|
|
17
24
|
使用 [n](https://github.com/tj/n) 更新NodeJS
|
|
25
|
+
|
|
18
26
|
```shell
|
|
19
27
|
yarn global add n
|
|
20
28
|
#更新到lts
|
|
21
29
|
sudo n lts
|
|
22
30
|
#或指定版本
|
|
23
|
-
sudo n
|
|
31
|
+
sudo n 16.19.1
|
|
24
32
|
```
|
|
25
33
|
|
|
26
34
|
### 1.在项目中初始化rig配置。
|
|
@@ -29,18 +37,23 @@ sudo n 14.19.1
|
|
|
29
37
|
#在你的项目根目录中（和package.json同级）执行：
|
|
30
38
|
rig init
|
|
31
39
|
```
|
|
40
|
+
|
|
32
41
|
package.rig.json5 会被添加到工程根目录。
|
|
33
42
|
|
|
34
43
|
通过yarn add新的依赖时需要增加-W参数,如:
|
|
44
|
+
|
|
35
45
|
```shell
|
|
36
46
|
yarn add axios -W
|
|
37
47
|
```
|
|
48
|
+
|
|
38
49
|
### 2.使用rig安装现有的代码库
|
|
50
|
+
|
|
39
51
|
修改package.rig.json5:
|
|
40
52
|
|
|
41
53
|
version是git的tag
|
|
42
54
|
|
|
43
55
|
如下:
|
|
56
|
+
|
|
44
57
|
```json5
|
|
45
58
|
{
|
|
46
59
|
dependencies: {
|
|
@@ -51,28 +64,65 @@ version是git的tag
|
|
|
51
64
|
}
|
|
52
65
|
}
|
|
53
66
|
```
|
|
67
|
+
|
|
54
68
|
然后执行
|
|
69
|
+
|
|
55
70
|
```shell
|
|
56
71
|
yarn install
|
|
57
72
|
```
|
|
73
|
+
|
|
58
74
|
### 3. 前端开发工具配置
|
|
75
|
+
|
|
59
76
|
#### 3.1 vite
|
|
77
|
+
|
|
78
|
+
尽量使用最新的vite,在vite.config.ts中增加代码
|
|
79
|
+
|
|
80
|
+
```typescript
|
|
81
|
+
import {viteCommonjs} from '@originjs/vite-plugin-commonjs';
|
|
82
|
+
import commonjs from '@rollup/plugin-commonjs';
|
|
83
|
+
import rigHelper from "rig-helper";
|
|
84
|
+
|
|
85
|
+
export default defineConfig((env: ConfigEnv) => {
|
|
86
|
+
//.....
|
|
87
|
+
return {
|
|
88
|
+
plugins: [//...
|
|
89
|
+
viteCommonjs({include: rig_helper.getPkgs()}),//commonjs to esm,serve时有效,
|
|
90
|
+
commonjs({include: rig_helper.getPkgs()}),//commonjs to esm,build时有效
|
|
91
|
+
//...
|
|
92
|
+
],
|
|
93
|
+
optimizeDeps: {
|
|
94
|
+
exclude: rig_helper.getPkgs(),//vite小于4时,
|
|
95
|
+
},
|
|
96
|
+
server: {
|
|
97
|
+
watch: {
|
|
98
|
+
ignored: rig_helper.getRigGlobs(),//vite小于4时,监听rig_dev下的目录文件发生变化,触发hmr
|
|
99
|
+
followSymlinks: true,//followSymlinks不能为false
|
|
100
|
+
},
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
})
|
|
104
|
+
```
|
|
105
|
+
|
|
60
106
|
#### 3.2 webpack
|
|
107
|
+
|
|
108
|
+
|
|
61
109
|
#### 3.3 vue-cli
|
|
62
110
|
|
|
63
111
|
### 4.开发一个新的rig库或改造现有仓库为rig库
|
|
112
|
+
|
|
64
113
|
rig库指在rig管理下的仓库
|
|
65
114
|
|
|
66
115
|
参考demo目录
|
|
67
116
|
|
|
68
117
|
## 关于RigJS模块化开发功能的特点:
|
|
118
|
+
|
|
69
119
|
1. RigJS功能基于yarn和git开发,无需私有npm.
|
|
70
120
|
2. 及时的将代码库分享给任何JS项目使用.
|
|
71
121
|
3. 支持快捷的rig库开发模式,支持自动npm link,可以在业务开发过程中调试rig库.
|
|
72
122
|
4. 易扩展,专注于代码库集成组装和协作,不负责transpile,和JS项目框架无关.
|
|
73
123
|
|
|
74
|
-
|
|
75
124
|
## 其他功能
|
|
125
|
+
|
|
76
126
|
| 功能 | 状态 |
|
|
77
127
|
|:-------------------|:------|
|
|
78
128
|
| 环境变量集成(减少环境变量文件数量) | 待编写文档 |
|
|
@@ -84,11 +134,14 @@ rig库指在rig管理下的仓库
|
|
|
84
134
|
## 命令清单
|
|
85
135
|
|
|
86
136
|
### rig init
|
|
137
|
+
|
|
87
138
|
初始化rig管理工具,在项目根目录执行.
|
|
88
139
|
|
|
89
140
|
### rig --env [mode]
|
|
141
|
+
|
|
90
142
|
从env.rig.json5中指定一组环境变量,并覆盖到.env.rig文件中
|
|
91
143
|
|
|
92
144
|
### rig tag
|
|
145
|
+
|
|
93
146
|
在git仓库nothing to commit后执行,可以将package.json中的版本打为tag
|
|
94
147
|
|