json-excel-converter
v1.0.1
Published
Converts JSON localization files to Excel format and vice versa
Downloads
7
Readme
JSON-Excel-Converter
JSON-Excel-Converter is an npm package that provides a convenient way to convert data between JSON and Excel formats. This tool is useful for localization of applications when you need to translate a large amount of textual data.
Installation
To install json-excel-converter, run the following command:
npm install -g json-excel-converter
Usage
JSON-Excel-Converter provides two main commands: jsonToExcel
and excelToJson
. Here's how to use each of them:
Converting from JSON to Excel
To convert data from JSON format to Excel, use the jsonToExcel
command. Specify the path to the folder containing the
JSON files you want to convert, as well as the folder where the resulting Excel file will be saved.
Example usage:
json-excel-converter jsonToExcel /path/to/json/folder /output/path
Converting from Excel to JSON
To convert data from Excel format to JSON, use the excelToJson
command. Specify the path to the Excel file you want to
convert, as well as the folder where the resulting JSON files will be saved.
Example usage:
json-excel-converter excelToJson /path/to/excel/file.xlsx /output/json/folder
Examples
JSON to Excel
Suppose we have a folder with JSON files of the following structure:
locales
│
├── en
│ ├── common.json
│ └── errors.json
├── fr
│ ├── common.json
│ └── errors.json
We want to convert these JSON files to Excel:
json-excel-converter jsonToExcel locales/ output/excel
This will create a file translations.xlsx
in the output/excel
folder.
Excel to JSON
Suppose we have an Excel file translations.xlsx
containing translations:
json-excel-converter excelToJson translations.xlsx output/json
This will create JSON files for each localization file in the output/json
folder.
Notes
- Please make sure your JSON files have a correct data format to successfully perform the conversion.
- The package supports the JSON format for localization, where each key corresponds to a text string, and the values are translations in different languages.
Local use
Run npm link
from the root. Run npm link json-excel-converter
from the project you want to include converter.
jsonToExcel
Run to use converter.
node ./node_modules/json-excel-converter/index.js jsonToExcel src/modules/lang/localization
i18n locales path src/modules/lang/localization
Output i18n json
files to { i18n locales path } /excel/
->
src/modules/lang/localization/excel/translations.xlsx
excelToJson
Run to use converter.
node ./node_modules/json-excel-converter/index.js excelToJson src/modules/lang/localization/excel/translations.xlsx
Excel file path src/modules/lang/localization/excel/translations.xlsx
Output i18n json
files to { Excel file path
} /json/
-> src/modules/lang/localization/excel/json/