https://github.com/yeyan1996/excel-code-generator

A tool that can extract specified data from xlsx and generate code into any file
https://github.com/yeyan1996/excel-code-generator

excel node typescript

Last synced: 3 months ago
JSON representation

A tool that can extract specified data from xlsx and generate code into any file

• Host: GitHub
• URL: https://github.com/yeyan1996/excel-code-generator
• Owner: yeyan1996
• License: mit
• Created: 2018-12-03T10:05:33.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-09-28T09:21:54.000Z (over 1 year ago)
• Last Synced: 2024-10-05T20:32:48.439Z (4 months ago)
• Topics: excel, node, typescript
• Language: TypeScript
• Homepage:
• Size: 241 KB
• Stars: 21
• Watchers: 1
• Forks: 5
• Open Issues: 8
• Metadata Files:
  • Readme: README-zh_CN.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# excel-code-generator

[English](./README.md) | 中文

一个能够读取 excel 文件的指定单元格并生成指定代码到文件中的工具

在后台管理系统中，往往需要输入很多字段名，手动输入会造成很多隐藏的错误

`如果数据字段的文档是用 excel 写的话`，使用这款工具，用户只需配置生成的代码的模版，即可自动生成代码片段并写入指定文件中，提高工作效率，减少误差

## 使用

```

npm i excel-code-generator -D

```

```javascript

const { gen, excel } = require("excel-code-generator");

gen({

  target: "./example/index.vue",

  reg: /table>/g,

  template: excel`

     

      

    `

});

```

## Api

|      Name      |     类型     | Description | 是否必填 |

|:--------------:|:----------:|:------------|------|

| **`template`** | `{string}` | `生成的代码模版`   | 是    |

|  **`target`**  | `{string}` | `写入文件路径`    | 否    |

|   **`reg`**    | `{RegExp}` | `写入文件的具体位置` | 否    |

其中 excel-code-generator 为 template 提供了特殊的标签模版 `excel`，标签模版提供了一些自定义语法帮助更好的填入 excel 的值

```javascript

excel`

     

      

    `

```

在 `${}` 中传入一个对象，类型如下，最后生成以下模版

Option

|       参数        |     Type     | Description                                        | 是否必填 |

|:---------------:|:------------:|:---------------------------------------------------|------|

|  **`source`**   |  `{string}`  | `读取的 excel 路径`                                     | 是    |

|   **`line`**    | `{string[]}` | `读取 excel 的位置，第一个元素为 excel 的列（英文索引），第二，三个元素为列的起止行` | 是    |

| **`camelcase`** | `{boolean}`  | `是否将该字段转为驼峰，默认 true`                               | 否    |

```vue

  

  

  

  

  

```