{"id":21611306,"url":"https://github.com/runnerty/executor-excel2csv","last_synced_at":"2025-03-18T16:04:42.752Z","repository":{"id":83643112,"uuid":"377824202","full_name":"runnerty/executor-excel2csv","owner":"runnerty","description":"Runnerty module: Excel2CSV","archived":false,"fork":false,"pushed_at":"2022-02-05T18:19:03.000Z","size":58,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-04-23T17:32:28.867Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/runnerty.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-06-17T12:32:34.000Z","updated_at":"2022-01-19T10:01:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"23964de0-4360-46a2-8e7e-c1ed051b688b","html_url":"https://github.com/runnerty/executor-excel2csv","commit_stats":{"total_commits":4,"total_committers":2,"mean_commits":2.0,"dds":0.5,"last_synced_commit":"cde823c09d0f80464a3a106b1b8efc32ffa37357"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runnerty%2Fexecutor-excel2csv","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runnerty%2Fexecutor-excel2csv/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runnerty%2Fexecutor-excel2csv/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runnerty%2Fexecutor-excel2csv/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/runnerty","download_url":"https://codeload.github.com/runnerty/executor-excel2csv/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244166707,"owners_count":20409178,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-24T21:11:55.326Z","updated_at":"2025-03-18T16:04:42.733Z","avatar_url":"https://github.com/runnerty.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"http://runnerty.io\"\u003e\n    \u003cimg height=\"257\" src=\"https://runnerty.io/assets/header/logo-stroked.png\"\u003e\n  \u003c/a\u003e\n  \u003cp align=\"center\"\u003eSmart Processes Management\u003c/p\u003e\n\u003c/p\u003e\n\n[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Dependency Status][david-badge]][david-badge-url]\n\u003ca href=\"#badge\"\u003e\n\u003cimg alt=\"code style: prettier\" src=\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg\"\u003e\n\u003c/a\u003e\n\n# Executor for [Runnerty]: Excel2CSV (xlsx to csv)\n\n### Installation:\n\nThrough NPM\n\n```bash\nnpm i @runnerty/executor-excel2csv\n```\n\nYou can also add modules to your project with [runnerty]\n\n```bash\nnpx runnerty add @runnerty/executor-excel2csv\n```\n\nThis command installs the module in your project, adds example configuration in your [config.json] and creates an example plan of use.\n\nIf you have installed [runnerty] globally you can include the module with this command:\n\n```bash\nrunnerty add @runnerty/executor-excel2csv\n```\n\n### Configuration:\n\nAdd in [config.json]:\n\n```json\n{\n  \"id\": \"excel2csv_default\",\n  \"type\": \"@runnerty-executor-excel2csv\"\n}\n```\n\n### Plan:\n\nAdd in [plan.json]:\n\n```json\n{\n  \"id\": \"excel2csv_default\",\n  \"inputPath\": \"./test.xlsx\",\n  \"outputPath\": \"./test.csv\"\n}\n```\n\n```json\n{\n  \"id\": \"excel2csv_default\",\n  \"inputPath\": \"./test.xlsx\",\n  \"outputPath\": \"./test.csv\",\n  \"options\": {\n    \"sheetName\": \"SHEET_ONE\",\n    \"dateFormat\": \"DD/MM/YYYY\",\n    \"formatterOptions\": {\n      \"quote\": \"'\",\n      \"delimiter\": \";\"\n    }\n  }\n}\n```\n\n#### Options:\n\n| Parameter        | Type    | Description                                                                         |\n| ---------------- | ------- | ----------------------------------------------------------------------------------- |\n| dateFormat       | String  | Specify the date encoding format of dayjs.                                          |\n| dateUTC          | Boolean | Specify whether ExcelJS uses `dayjs.utc ()` to convert time zone for parsing dates. |\n| encoding         | String  | Specify file encoding format. (Only applies to `.writeFile`.)                       |\n| includeEmptyRows | Boolean | Specifies whether empty rows can be written.                                        |\n| sheetName        | String  | Specify worksheet name.                                                             |\n| sheetId          | Number  | Specify worksheet ID.                                                               |\n| formatterOptions | Object  | See below.                                                                          |\n\n#### Options/formatterOptions:\n\n| Parameter              | Description                                                                                                                                |\n| :--------------------- | :----------------------------------------------------------------------------------------------------------------------------------------- |\n| headers                | Type: boolean/string[]. The headers will be auto detected from the first row or you can to provide headers array: ['h1name','h2name',...]. |\n| delimiter              | Alternate delimiter. (Default: ',')                                                                                                        |\n| quote                  | Alternate quote. (Default: '\"')                                                                                                            |\n| alwaysWriteHeaders     | Set to true if you always want headers written, even if no rows are written. (Default: false)                                              |\n| rowDelimiter           | Specify an alternate row delimiter (i.e \\r\\n). (Default: '\\n')                                                                             |\n| quoteHeaders           | If true then all headers will be quoted. (Default: quoteColumns value)                                                                     |\n| quoteColumns           | If true then columns and headers will be quoted (unless quoteHeaders is specified). (Default: false).                                      |\n| escape                 | Alternate escaping value. (Default: '\"')                                                                                                   |\n| includeEndRowDelimiter | Set to true to include a row delimiter at the end of the csv. (Default: false)                                                             |\n| writeBOM               | Set to true if you want the first character written to the stream to be a utf-8 BOM character. (Default: false)                            |\n\nMore info [here.](https://c2fo.io/fast-csv/docs/formatting/options/)\n\n[runnerty]: http://www.runnerty.io\n[downloads-image]: https://img.shields.io/npm/dm/@runnerty/executor-excel2csv.svg\n[npm-url]: https://www.npmjs.com/package/@runnerty/executor-excel2csv\n[npm-image]: https://img.shields.io/npm/v/@runnerty/executor-excel2csv.svg\n[david-badge]: https://david-dm.org/runnerty/executor-excel2csv.svg\n[david-badge-url]: https://david-dm.org/runnerty/executor-excel2csv\n[config.json]: http://docs.runnerty.io/config/\n[plan.json]: http://docs.runnerty.io/plan/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frunnerty%2Fexecutor-excel2csv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frunnerty%2Fexecutor-excel2csv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frunnerty%2Fexecutor-excel2csv/lists"}