README.md

i18n-file-converter

Generate .xlsx files from .json and back with ease

Motivation • How To Use • Credits • License

Motivation

Ever faced to a problem when sending i18n file content to a customer for getting translations for the other locales?

We all know the pain when developers like to work with .json files but the customers prefer more user-friendly ways to work with them like .xlsx

With this library you can easily convert all your .json files into .xlsx send to a customer and after getting translated file back convert it to .json file again.

How To Use

# Install the package
$ npm install i18n-file-converter

This package comes with two functions json2xlsx() and xlsx2json().

json2xlsx()

json2xlsx({
  inputPath: path.resolve(__dirname, '../locales'),
  outputPath: path.resolve(__dirname, `../${GENERATION_FOLDER_NAME}`),
  config: {
    column: { width: 80 },
  },
});

xlsx2json()

xlsx2json({
  inputPath: path.resolve(__dirname, `../${GENERATION_FOLDER_NAME}/locales.xlsx`),
  outputPath: path.resolve(__dirname, `../${GENERATION_FOLDER_NAME}/locales`),
});

API

Property	Type	Default	Description
inputPath	String	-	Specify /locales path at json2xlsx(). For xlsx2json() specify locales.xlsx file.
outputPath	String	-	Specify the output directory path.
config.column.width	Number	80	Style columns width when generating .xlsx file. NOTE: This property is accepted only at json2xlsx()

Credits

This library is created on top of xlsx package.

License

ISC

---

Fun Fact 😁 - There isn't single letter of code which is generated by ChatGPT or any kind of other LLM.

---

GitHub @alexandermirzoyan  ·  LinkedIn @alexandr-mirzoyan