kn-cli 1.0.3 → 1.0.4
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/package.json +1 -1
- package/readme.md +10 -32
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -1,38 +1,16 @@
|
|
|
1
1
|
# kn-cli
|
|
2
|
+
项目脚手架
|
|
2
3
|
|
|
4
|
+
# 快速开始
|
|
5
|
+
1. 安装: npm i kn-cli -g
|
|
6
|
+
2. 创建项目: kn-cli --create
|
|
7
|
+
3. 调试项目: kn-cli --dev
|
|
8
|
+
4. 编译项目: kn-cli --build
|
|
9
|
+
5. 当项目中需要添加第三方npm包时，务必使用--save参数`npm i 包名 --save`
|
|
3
10
|
|
|
4
|
-
# 本地链接cli的方法
|
|
5
|
-
1. 在本工程目录外任意新建一个文件夹,如:`/Users/myProject`
|
|
6
|
-
2. 在终端内定位文件夹位置`cd /Users/myProject`
|
|
7
|
-
3. nvm use v16.8.0
|
|
8
|
-
4. 链接当前kn-cli目录：`npm link /Users/kingnet-cli`
|
|
9
|
-
5. 接下来查看是否链接成功: `kn-cli -v` 如果能正常打印版本号则代表成功
|
|
10
11
|
|
|
11
|
-
|
|
12
|
-
1. 查看版本号： `kn-cli -v`
|
|
13
|
-
2. 创建项目: `kn-cli --create`
|
|
14
|
-
3. 启动调试: `kn-cli --dev`
|
|
15
|
-
3. 打包编译: `kn-cli --build`
|
|
12
|
+
> 项目创建后，记得执行sh init.sh 以激活git分支提交日志
|
|
16
13
|
|
|
14
|
+
# cli 其它常用方法
|
|
15
|
+
1. 查看版本号： `kn-cli -v`
|
|
17
16
|
|
|
18
|
-
# cli 扩展功能
|
|
19
|
-
## iconfont
|
|
20
|
-
1. 将制作好的svg图标放入项目根目录`tools/iconfont/svg` 文件夹内
|
|
21
|
-
2. 执行 `kn-cli --iconfont`
|
|
22
|
-
3. 编译后的文件在 `tools/iconfont/dist/`文件夹下
|
|
23
|
-
## tinypnt 图片压缩
|
|
24
|
-
执行 `kn-cli --tinypng`,工具将自动扫描项目根目录下`src/assets/`内的所有图片，对可压缩的进行压缩并替换原有文件
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
# 目录说明
|
|
28
|
-
build: 编译相关的配置文件
|
|
29
|
-
temp: 每次项目调试、编译时的临时缓存文件夹,可完全删除
|
|
30
|
-
templates: 存放`kn-cli -i`创建的各类项目模板
|
|
31
|
-
|
|
32
|
-
# CICD构建流程
|
|
33
|
-
1. sh frontend_build.sh 其中其实执行了
|
|
34
|
-
a. npm i
|
|
35
|
-
b. kn-cli --build
|
|
36
|
-
c. mv dist ../release/
|
|
37
|
-
|
|
38
|
-
|