Skip to content

Commit 4b936a1

Browse files
committed
feat: Remove property generate_mode, we will always use depends_on
1 parent caafa5d commit 4b936a1

39 files changed

+76
-482
lines changed

README.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ npx iconfont-init
3232
"symbol_url": "请参考README.md,复制官网提供的JS链接",
3333
"use_typescript": false,
3434
"save_dir": "./src/components/iconfont",
35-
"generate_mode": "all-in-one",
3635
"trim_icon_prefix": "icon",
3736
"unit": "px",
3837
"default_icon_size": 18,
@@ -52,17 +51,6 @@ npx iconfont-init
5251

5352
当该值为false时,我们会为您的图标生成`.js``.d.ts`两个文件,以便您能享受到最好的开发体验。
5453

55-
### generate_mode
56-
生成组件的方式:
57-
##### 1、all-in-one
58-
只生成一个`<Icon name="xxx" />` 组件,里面包含了所有图标信息。所以这个组件会比较大。
59-
##### 2、depends-on
60-
每个图标都会生成一个组件`<IconXXX />`。这种模式也会生成一个`Icon`组件,但和all-in-one不同的是,这个Icon组件总是import其他的图标组件,它相当于一个门面。
61-
62-
------
63-
64-
现在,你可以参考[snapshots目录](https://github.com/fwh1990/react-iconfont-cli/tree/master/snapshots)的快照文件,以区分不同模式下的图标结构。
65-
6654
### save_dir
6755
根据iconfont图标生成的组件存放的位置。每次生成组件之前,该文件夹都会被清空。
6856

@@ -86,7 +74,8 @@ npx iconfont-init
8674
```bash
8775
npx iconfont-h5
8876
```
89-
生成后查看您设置的保存目录中是否含有所有的图标
77+
78+
生成后查看您设置的保存目录中是否含有所有的图标,你可以参考[snapshots目录](https://github.com/fwh1990/react-iconfont-cli/tree/master/snapshots)的快照文件,以区分不同模式下的图标结构。
9079

9180
# 使用
9281

@@ -107,7 +96,7 @@ export const App = () => {
10796
};
10897
```
10998

110-
2、当您配置的`generate_mode=depends-on`时,您可以使用单个图标。这样可以避免没用到的图标也打包进App:
99+
2、使用单个图标。这样可以避免没用到的图标也打包进App:
111100

112101
```typescript jsx
113102
import React from 'react';
@@ -156,7 +145,7 @@ export const App = () => {
156145
<div style={{ display: 'flex', flexDirection: 'row', alignItems: 'center' }}>
157146
<span>Hello</span>
158147
<Icon name="alipay" />
159-
</div>
148+
</div>
160149
```
161150

162151
# 更新图标
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
{
22
"symbol_url": "http://at.alicdn.com/t/font_1373348_ghk94ooopqr.js",
33
"use_typescript": false,
4-
"generate_mode": "all-in-one",
5-
"save_dir": "./snapshots/all-in-one-js",
4+
"save_dir": "./snapshots/demo-js",
65
"trim_icon_prefix": "icon",
76
"unit": "px",
87
"default_icon_size": 14,
9-
"summary_component_name": "Icon"
8+
"summary_component_name": "Custom_Icon"
109
}
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
{
22
"symbol_url": "http://at.alicdn.com/t/font_1373348_ghk94ooopqr.js",
33
"use_typescript": true,
4-
"generate_mode": "all-in-one",
5-
"save_dir": "./snapshots/all-in-one-ts",
4+
"save_dir": "./snapshots/demo-ts",
65
"trim_icon_prefix": "icon",
76
"unit": "rem",
87
"default_icon_size": 16,
9-
"summary_component_name": "Icon"
8+
"summary_component_name": "IconFont"
109
}

scripts/config/depends-on-js.json

Lines changed: 0 additions & 10 deletions
This file was deleted.

scripts/config/depends-on-ts.json

Lines changed: 0 additions & 10 deletions
This file was deleted.

scripts/update-snapshot.sh

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
11
#!/usr/bin/env bash
22

3-
cp -f ./scripts/config/all-in-one-js.json ./iconfont.json
4-
npx ts-node src/commands/createIcon.ts
5-
6-
cp -f ./scripts/config/all-in-one-ts.json ./iconfont.json
7-
npx ts-node src/commands/createIcon.ts
3+
rm -rf snapshots/*
84

9-
cp -f ./scripts/config/depends-on-js.json ./iconfont.json
5+
cp -f ./scripts/config/demo-js.json ./iconfont.json
106
npx ts-node src/commands/createIcon.ts
117

12-
cp -f ./scripts/config/depends-on-ts.json ./iconfont.json
8+
cp -f ./scripts/config/demo-ts.json ./iconfont.json
139
npx ts-node src/commands/createIcon.ts

snapshots/README.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

snapshots/all-in-one-js/Icon.js

Lines changed: 0 additions & 115 deletions
This file was deleted.

0 commit comments

Comments
 (0)