项目背景
在游戏开发中,策划通常使用Excel来配置游戏数据。作为开发者,我们需要将这些Excel数据转换为TypeScript代码以供游戏使用。手动转换不仅耗时,而且容易出错。这个工具就是为了解决这个问题而开发的。
核心功能
- 类型推断
- 自动识别数字和字符串类型
- 处理可能为空的字段
- 生成符合TypeScript/JavaScript规范的代码
- 多格式支持
- 支持导出为 TypeScript (.ts) 接口和数据
- 支持导出为 JavaScript (.js) 类型注释和数据
- 实时预览生成的代码
- 界面优化
- 现代化的深色主题界面
- 代码高亮显示
- 简洁直观的操作流程
- 支持文件选择和拖拽
最新更新 (v1.0.1)
- 界面升级
- 全新深色主题:采用现代化的深色配色方案
- 代码预览优化:添加语法高亮,提升可读性
- 布局改进:优化了控件排列和间距
- 视觉反馈:增加了操作状态的即时反馈
- 功能增强
- JavaScript 支持:新增 JavaScript 格式输出
- 支持 JSDoc 类型注释
- 保持与 TypeScript 相同的类型推断
- 多工作表优化:改进了 Sheet 切换和预览功能
- 类型推断升级:提升了自动类型识别的准确性
- 安装优化
- 便携版:无需安装,解压即用
- 安装包:提供标准 Windows 安装程序
- 支持自动卸载旧版本
- 下载地址
您可以从 [GitHub Releases] 页面下载最新版本:
- 便携版:
Excel To TypeScript Converter-portable-1.0.1.exe - 安装版:
Excel To TypeScript Converter-setup-1.0.1.exe
使用说明
安装与运行
- 克隆项目
git clone https://github.com/Echoes4/excel-to-ts-converter.git
- 安装依赖
npm install
- 运行
npm start
- 打包(可选)
便捷版
npm run build:portable
[image]
安装版
npm run build:setup
[image]
Excel格式要求
Excel文件需要按以下格式组织:
| 说明行 | ||||
|---|---|---|---|---|
| id | name | type | value | enabled |
| 1001 | 商品A | 1 | null | true |
| 1002 | 商品B | 2 | 99.9 | false |
- 第一行:说明行
- 第二行:字段名称定义
- 第三行及以后:数据内容
生成结果
工具会自动生成如下格式的TypeScript代码:
export interface ItemData {
id: number | null;
name: string | null;
type: number | null;
value: number | null;
enabled: boolean | null;
}
export var items: Record<number, ItemData> = {
1001: {id:1001, name:"商品A", type:1, value:null, enabled:true},
1002: {id:1002, name:"商品B", type:2, value:99.9, enabled:false}
};
技术实现
- Electron桌面应用框架
- SheetJS处理Excel文件
- TypeScript类型生成
- 文件系统操作
开源地址
- GitHub: [[excel-to-ts-converter]
- 欢迎Star和提供建议!
开发计划
- 支持更多Excel格式
- 添加批量转换功能
- 支持自定义类型映射
- 优化类型推断
- 添加配置选项
关于作者
- GitHub: [@Echoes4]
- 欢迎交流和讨论!
许可证
本项目采用 MIT 许可证,详见 [LICENSE]。