eljson

# eljson ## 介绍为了避免手动复制产生的各种问题，以及提高业务转化能力。`eljson` 实现了快速将 `xlsx` 文件转化为 `json` 格式，可通过搭配 `i18n` 实现国际化的一种解决方案。此外，`eljson` 还提供了埋点数据结构的能力，为埋点上报工程一体化的实现添砖加瓦。 ## 命令 ### 安装通过 `npm` 全局安装 `eljson` 脚手架 ```bash npm install eljson -g 或 yarn add eljson -g ``` ## 基本使用 ### 1.创建空目录 ``` mkdir myapp && cd myapp ``` ### 2.创建 input 目录，里面存放 `***.xlsx` 翻译文档文件或者埋点文档文件 ```bash # 移动 `**.xlsx` 文件到此目录里 mkdir input && mv ***.xlsx ./input ``` ### 3.初始化手脚架 ``` eljson ``` ### 4.选择处理类型（文档翻译、神策上报、V4 上报） ``` ? 请选择处理类型？-> 文档翻译 ``` ### 5.1 `文档翻译`（完成以下步骤填写）工作表名： ``` ? 请输入工作表名称 -> xxxxxx ``` 中文翻译列位置： ``` ? 请输入中文翻译列位置（默认值：B 列） -> B ``` 泰文翻译列位置： ``` ? 请输入泰文翻译列位置（默认值：C 列） -> C ``` 英文翻译列位置： ``` ? 请输入英文翻译列位置（默认值：D 列） -> D ``` #### 以上命令：首先选取一个工作表作为翻译主体内容，然后根据输入的中文、英文、泰文对应的列位置作为过滤条件，只对这三列数据做数据格式化处理，并生成对应的 `zh.json`、`en.json`、`th.json` 文件 ### 5.2 `神策上报`（完成以下步骤填写）工作表名： ``` ? 请输入工作表名称 -> xxxxxx ``` 选择上报平台： ``` ? 请选择上报平台？ -> Web ``` 上报平台列位置： ``` ? 请输入上报平台列位置（默认值：C 列） -> C ``` 上报事件列位置： ``` ? 请输入上报事件列位置（默认值：D 列） -> D ``` 元素 ID 列位置： ``` ? 请输入元素ID列位置（默认值：F 列） -> F ``` 元素名称列位置： ``` ? 请输入元素名称列位置（默认值：G 列） -> G ``` 页面 ID 列位置： ``` ? 请输入页面ID列位置（默认值：H 列） -> H ``` 页面名称列位置： ``` ? 请输入页面名称列位置（默认值：I 列） -> I ``` #### 以上命令：首先选取一个工作表作为埋点上报主体内容。然后通过 `上报平台` 类型实现数据过滤，只针对已选取的类型数据做处理。埋点数据结构根据 `元素 ID`、`元素名称`、`页面 ID`、`页面名称` 四个字端结合 `上报类型` 进行数据格式化处理，并生成对应的 `sensor.json` 文件 ### 5.3 `V4 上报`（完成以下步骤填写）工作表名： ``` ? 请输入工作表名称 -> xxxxxx ``` 上报事件列位置： ``` ? 请输入上报事件列位置（默认值：E 列） -> E ``` 坑位编号列位置： ``` ? 请输入坑位编号列位置（默认值：J 列） -> J ``` 页面编号列位置： ``` ? 请输入页面编号列位置（默认值：K 列） -> K ``` #### 以上命令：首先选取一个工作表作为埋点上报主体内容。然后只针对 `上报事件`、`坑位编号`、`页面编号` 这三个字端进行数据格式化处理，并生成对应的 `v4.json` 文件 ## 编译完成 ### 1.文档翻译编译完成后会依次生成 `zh.json`、`en.json` 、`th.json` 四个翻译文件输出到 `output` 目录里，你可以直接复制对应 `json` 文件到项目工程里配合`i18n`实现国际化。 ### 2.埋点上报如果你选择 `神策上报`，编译完成后会生成 `sensor.json` 埋点文件输出到 `output` 目录里；反之选择 `V4上报` 则会生成`v4.json`文件。你可以直接复制对应 `json` 文件到项目工程里做数据埋点上报了。