i18n-excel-converter CLI

CLI tool to convert i18n JSON files to EXCEL(xlsx) and the other way

Features

• Support converting to single sheet Excel and backward
• Support converting to multi sheet Excel and backward
• Select manualy what files you need to include
• Using from terminal

See Examples

Usage

There are 2 ways of using library:

1. Install to your project locally

npm install -D i18n-excel-converter

Then run command

i18n-excel-converter -t type-of-converter -i "path-to-json-or-xlsx" -d "output-folder"

2. Use globally from anywhere in your PC

npx i18n-excel-converter -t type-of-converter -i "path-to-json-or-xlsx" -d "output-folder"

Options

Options:
      --help     Show help                                             [boolean]
      --version  Show version number                                   [boolean]
  -t, --type     Type of convertor [json-xlsx] or [xlsx-json][string] [required]
  -i, --input    Path to files separated by comma for .json or path to only
                 one file for .xlsx                                     [string]
  -g, --group    Path to .json file of group                            [string]
  -d, --dist     Output files path                                      [string]

Examples

JSON to single sheet Excel(xlsx)

Let's consider that translations:

.
├── src
├── i18n/
│   ├── ru.json
│   ├── en.json
│   └── es.json
└── package.json

I want to create single sheet Excel(xlsx) with key, ru, en, es columns. To do so i need to run command from the root folder:

npx i18n-excel-converter -t json-xlsx -i "i18n/ru.json,i18n/en.json,i18n/es.json" -d "output-folder"

JSON to multi sheet Excel(xlsx)

I want to create multi sheet Excel(xlsx) where each sheet contains separate translations. To do so i need to create group .json file that describes my future Excel(xlsx) document:

.
├── src
├── i18n-frontend/
│   ├── ru.json
│   ├── en.json
│   └── es.json
├── i18n-backend/
│   ├── ru.json
│   └── en.json
├── package.json
└── any-name-you-want.json

//any-name-you-want.json
[
  {
    "sheetName": "frontend",
    "localesPath": [
      "i18n-frontend/ru.json",
      "i18n-frontend/en.json",
      "i18n-frontend/es.json"
    ]
  },
  {
    "sheetName": "backend",
    "localesPath": ["i18n-backend/ru.json", "i18n-backend/en.json"]
  }
]

Then i need to run command

npx i18n-excel-converter -t json-xlsx -g "any-name-you-want.json" -d "output-folder"

Excel(xlsx) to JSON

I want to create i18n json files from single/multi sheet Excel(xlsx). To do so i need to run command:

npx i18n-excel-converter -t xlsx-json -i "paht-to-xlsx-file.xlsx" -d "output-folder"