https://github.com/runnerty/executor-excel2csv
Runnerty module: Excel2CSV
https://github.com/runnerty/executor-excel2csv
Last synced: over 1 year ago
JSON representation
Runnerty module: Excel2CSV
- Host: GitHub
- URL: https://github.com/runnerty/executor-excel2csv
- Owner: runnerty
- License: mit
- Created: 2021-06-17T12:32:34.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2022-02-05T18:19:03.000Z (over 4 years ago)
- Last Synced: 2024-04-23T17:32:28.867Z (about 2 years ago)
- Language: JavaScript
- Size: 56.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Smart Processes Management
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Dependency Status][david-badge]][david-badge-url]
# Executor for [Runnerty]: Excel2CSV (xlsx to csv)
### Installation:
Through NPM
```bash
npm i @runnerty/executor-excel2csv
```
You can also add modules to your project with [runnerty]
```bash
npx runnerty add @runnerty/executor-excel2csv
```
This command installs the module in your project, adds example configuration in your [config.json] and creates an example plan of use.
If you have installed [runnerty] globally you can include the module with this command:
```bash
runnerty add @runnerty/executor-excel2csv
```
### Configuration:
Add in [config.json]:
```json
{
"id": "excel2csv_default",
"type": "@runnerty-executor-excel2csv"
}
```
### Plan:
Add in [plan.json]:
```json
{
"id": "excel2csv_default",
"inputPath": "./test.xlsx",
"outputPath": "./test.csv"
}
```
```json
{
"id": "excel2csv_default",
"inputPath": "./test.xlsx",
"outputPath": "./test.csv",
"options": {
"sheetName": "SHEET_ONE",
"dateFormat": "DD/MM/YYYY",
"formatterOptions": {
"quote": "'",
"delimiter": ";"
}
}
}
```
#### Options:
| Parameter | Type | Description |
| ---------------- | ------- | ----------------------------------------------------------------------------------- |
| dateFormat | String | Specify the date encoding format of dayjs. |
| dateUTC | Boolean | Specify whether ExcelJS uses `dayjs.utc ()` to convert time zone for parsing dates. |
| encoding | String | Specify file encoding format. (Only applies to `.writeFile`.) |
| includeEmptyRows | Boolean | Specifies whether empty rows can be written. |
| sheetName | String | Specify worksheet name. |
| sheetId | Number | Specify worksheet ID. |
| formatterOptions | Object | See below. |
#### Options/formatterOptions:
| Parameter | Description |
| :--------------------- | :----------------------------------------------------------------------------------------------------------------------------------------- |
| headers | Type: boolean/string[]. The headers will be auto detected from the first row or you can to provide headers array: ['h1name','h2name',...]. |
| delimiter | Alternate delimiter. (Default: ',') |
| quote | Alternate quote. (Default: '"') |
| alwaysWriteHeaders | Set to true if you always want headers written, even if no rows are written. (Default: false) |
| rowDelimiter | Specify an alternate row delimiter (i.e \r\n). (Default: '\n') |
| quoteHeaders | If true then all headers will be quoted. (Default: quoteColumns value) |
| quoteColumns | If true then columns and headers will be quoted (unless quoteHeaders is specified). (Default: false). |
| escape | Alternate escaping value. (Default: '"') |
| includeEndRowDelimiter | Set to true to include a row delimiter at the end of the csv. (Default: false) |
| writeBOM | Set to true if you want the first character written to the stream to be a utf-8 BOM character. (Default: false) |
More info [here.](https://c2fo.io/fast-csv/docs/formatting/options/)
[runnerty]: http://www.runnerty.io
[downloads-image]: https://img.shields.io/npm/dm/@runnerty/executor-excel2csv.svg
[npm-url]: https://www.npmjs.com/package/@runnerty/executor-excel2csv
[npm-image]: https://img.shields.io/npm/v/@runnerty/executor-excel2csv.svg
[david-badge]: https://david-dm.org/runnerty/executor-excel2csv.svg
[david-badge-url]: https://david-dm.org/runnerty/executor-excel2csv
[config.json]: http://docs.runnerty.io/config/
[plan.json]: http://docs.runnerty.io/plan/