Skip to content

将EXCEL配表转换为JSON、TS、JS。Transform excel to JSON/JS/TS.

Notifications You must be signed in to change notification settings

microJ/Excel-Transformer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Excel-Transformer

目的:

将固定格式的 Excel 文件转换为 JSON 或者 TS 或者 JS 文件,并输出到指定位置。

输出位置:

transformConfig.json 中配置表名对应的规则; 否则默认输出到 outputs 文件夹。

解决场景:

  • 游戏数据配表: 产品只需要将 EXCEL 配表之后,运行 CMD 脚本,此时程序员就可以拿到自己需要的格式的配表文件。而无需关心配表工作。

  • 多语言 不同的字段对应唯一 id,数据中包含多种语言的文本,可实现热切换。

  • 自动输出为 JS/TS 文件 此时按照定义好的方法名即可直接获取到 id 对应的数据。

使用

首次使用请运行 npm install 安装依赖。

  1. 将需要转换格式的 Excel 放入 excel_need_transform 文件夹。 注意:请按照 excel-demo.xlsx 的格式编辑。

  2. 双击 transform.cmdexcel_need_transform 文件夹中所有的 Excel 文件会转换成 JSON 之后输出到指定位置或 outputs 文件夹。

EXCEL 格式

前两行固定格式:第一行为字段,第二行为自定义字段类型。

字段 说明
id 必须。行的唯一标识符,用来获取当前行。
必须为int类型
tsVariable TS 文件中的静态成员名。
desc 注释,生成 TS 文件时会为属性添加注释。
自定义 自定义的字段会直接设置为对象成员。

示例:

id tsVariable zh_cn zh_tw en_us th desc
int string string string string string string
10000 你好 你好 Hello สวัสดี 欢迎语
10001 dragon มังกร 物种:龙

Q & A

  1. 为什么配置中的路径中的目录必须存在?

工具服务于具体项目而项目又真实存在,此举不会随意增加项目的目录结构。

TODO

[ ] 增加配置,Excel 只有一张表时是否按照 Excel 名进行输出

[ ] 生成 TS

[ ] 生成 JS

About

将EXCEL配表转换为JSON、TS、JS。Transform excel to JSON/JS/TS.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published