ex-json-cli
,由excel
、json
、cli
三个单词拼接组成。
我们有时为了省去了后端的开发成本,会把一些数据直接用json
存在本地,然后再用这些数据来做渲染。但是:
- 如果需要数据的页面或模块多了,会导致对应的json文件也增多。文件多了,数据太过碎片化,管理那么多文件也变得麻烦
- 数据量很大的时候,数据会变得很冗长,想直接找到特定的某条数据,是很困难的
- 有时我们的数据想共享给其他非开发人员时,
json
不是一个很好的传播方式
- 更方便的操作。Excel是专业的办公软件,在Excel中对数据进行增删改查,当然要比在我们的编辑器内修改要方便太多
- 更可视化。每一个表(sheet)可以当做我们某个页面或某个模块的数据;每个表(sheet)的名字,就是我们json的名字;表里每一行数据,就是我们
json
每一条的数据 - 更方便的管理。数据都集成在一个Excel文件中,更加方便我们管理所有模块或页面的数据
- 更适合传播。json不适合在非开发人员中传播,但是Excel适用于所有人员。不但非开发人员可以对这个Excel进行修改,如果你发现Excel里面有问题,你也一样可以修改,然后再同步给其他人。
因此,为了解决上述问题,并且结合 Excel 的功能全面的优势,ex-json-cli
孕育而生,这样你只需要专注管理好 Excel 这个文件就好了。s
npm i ex-json-cli -g
你不需要自己做一个excel表格,这里已经做好了一个模板excel文件,你只需要执行:
ex-json-cli gt
或者将模板文件保存到目录:
ex-json-cli gt './xlsx_template/'
这样我们就能获取到一个excel模板文件了,然后把里面的数据换成你想要的就好了,对就这么简单。
你可以去 Explanation 模块更好的了解
-k
、-s
ex-json-cli -i './xlsx_template/template.xlsx' -s 3 -r all
在使用过程中,这里有以下注意事项:
- 生成
json
数据时,请确保-s
的值是否正确。-s
代表的是,数据从每个sheet
第几行开始读取,默认是第3行
Usage: ex-json-cli [options] [command]
=> Manage your json data better with visual excel sheets
Options:
-v View current version
-i, --input [path] Path of excel to be converted
-s, --start-row [number] Read data from what row of sheet
-r, --range [string] Select the table you want to read
-h, --help View help
Commands:
gt [path] Get the excel template file
参数 | 是否必须 | 默认值 | 说明 | 补充 |
---|---|---|---|---|
-v |
否 | 查看当前版本 | ||
-i |
是 | 要转换的excel表格所在路径 | ||
-s |
否 | 3 |
从excel表格中哪一行开始读取数据 | 默认从第三行读取数据 |
-r |
否 | all |
从excel表格中读取那个sheet | 默认读取全部sheet |
-h |
否 | 查看帮助 |
语句 | 参数 | 说明 |
---|---|---|
gt |
path |
path 为获取的模板excel文件保存目录。当 path 为空时,获取的模板excel文件默认保存在当前目录的xlsx_template 文件夹下 |
表格的总体结构一般分三块(top
,middle
,bottom
):
- 第一块,我们称它为(
T
),指整个表格的大标题 - 第二块,我们称它为(
M
),对表格每列信息的概述 - 第三块,我们称它为(
B
),它所在的行数,就是程序要开始读取数据的行数(-s 3
)
因为每个人的制作的excel都不一样,所以我们强烈建议你使用我们模板excel文件(template.xlsx
)来管理数据,但是这个文件也许样式不一定能满足你。
所以如果你想DIY
表格的样式,根据 Explanation 模块的分析,DIY
你的表格时需要遵循以下规则:
T
跟M
模块是非必须的,但是,请保证你的excel文件里的数据,与上图的B
模块结构相同- 请确保你的
-s
值是正确的