excel2json/README.md

excel2json

• Read file excel to json
• Custom mapping with custom columns and configs
• Custom props
• Docker suppport

Install

npm i excel2json-xlsx

OR

yarn i excel2json-xlsx

OR Global Install

yarn add global excel2json-xlsx

Usage

excel2json-xlsx -i source.xlsx -o exported.json

OR

npx excel2json -i source.xlsx -o exported.json

Docker Hub

Pulling image

docker pull cubetiq/excel2json

Run container

docker run --rm -it -v /my/path/data:/app/data cubetiq/excel2json -i ./data/source.xlsx -p true

Build

bash build

OR

make build run

Example

docker run -v /my/path:/app/data --rm -it cubetiq/node-excel2json

docker run -v /home/sombochea/excel2json:/app/data -e APP_NAME="EXCEL 2 JSON" -e MAPPER_FILE="./data/mapper.json" --rm -it cubetiq/node-excel2json

Mapper Config

{
  "data": [
    {
      "dataIndex": "Name",
      "label": "Name"
    },
    {
      "dataIndex": "Age",
      "label": "Age"
    }
  ],
  "configs": {
    "outputPath": "./data/outputs/exported",
    "outputName": "my_exported_data",
    "sheetName": "Sheet1",
    "saveToOutput": true
  }
}

Custom Function Props

{
    mappings: [
        {
            "dataIndex": "Name",
            "label": "Name"
        }
    ],
    saveToOutput: false
}

Environment

APP_NAME=custom app name
INPUT_FILE=./data/mydata.xlsx
OUTPUT_PATH=./data/outputs
MAPPER_FILE=./data/mapper.json
SHEET_NAME=Sheet1
ENCODING=utf-8