@gtomato-web/xlsx2json v1.2.2

XLSX2JSON

Cover XLSX to JSON

Table of Contents

• Installation
• Usage
• CLI Arguments
• Config file
• Example
  • How auto parent lookup works
  • How fallback value works
  • How overriding duplicate works

Installation

Install the package as a dev dependency:

NPM

$ npm install -D @gtomato-web/xlsx2json

Yarn

$ yarn add -D @gtomato-web/xlsx2json

Usage

See CLI Arguments for more information.

NPM

Add script to package.json

{
  ...,
  "scripts": {
    ...,
    "xlsx2json": "xlsx2json -c <path-to-config-file>"
  }
  ...
}

$ npm run xlsx2json -c <path-to-config-file>

Yarn

$ yarn xlsx2json -c <path-to-config-file> 

CLI Arguments

Config file

Create a config file in JSON format(suggest: xlsx2json.config.json) with the following structure:

type Dir = string;
type SheetName = string;
type ColName = string;
type RowNumber = number;

interface Config {
  src: Dir;
  dist: Dir;
  targets: Array<ColName>;
  keys: Array<ColName>;
  ignore?: {
    rows?: Array<RowNumber> | Record<SheetName, Array<RowNumber>>;
    sheets?: Array<SheetName>;
  },
  options?: {
    autoLookupParent?: boolean,
    fallbackValue?: string | false,
    stringTransformation?: 'camelCase' | 'constantCase' | 'headerCase' | 'paramCase' | 'pascalCase' | 'snakeCase' | false
    overridingDuplicate?: boolean
  }
}

Example

How auto parent lookup works

Say this is the source file:

Config will be like...

// xlsx2json.config.json
{
  "src": "path/to/source/file.xlsx",
  "dist": "path/to/destination/directory",
  "targets": [
    "en_us",
    "zh_cn",
    "zh_hk"
  ],
  "keys": [
    "section",
    "key"
  ],
  "options": {
    "autoLookupParent": true,
    "fallbackValue": "",
    "overridingDuplicate": false
  }
}

And output will be like... (we only show en_us output in example, actual output will be 3 files)

// en_us.json
{
  "home": {
    "title": "title in en",
    "description": "description in en"
  },
  "contact": "contact in en",
  "setting": {
    "title": "title in en",
    "description": "description in en"
  }
}

How fallback value works

Say this is the source file:

Config will be like...

// xlsx2json.config.json
{
  "src": "path/to/source/file.xlsx",
  "dist": "path/to/destination/directory",
  "targets": [
    "en_us",
    "zh_cn",
    "zh_hk"
  ],
  "keys": [
    "section",
    "key"
  ],
  "options": {
    "autoLookupParent": true,
    "fallbackValue": "Let's fallback",
    "overridingDuplicate": false
  }
}

And output will be like... (we only show en_us output in example, actual output will be 3 files)

// en_us.json
{
  "home": {
    "title": "title in en",
    "description": "Let's fallback"
  },
  "contact": "contact in en",
  "setting": {
    "title": "Let's fallback",
    "description": "description in en"
  }
}

How overriding duplicate works

Say this is the source file:

Config will be like...

// xlsx2json.config.json
{
  "src": "path/to/source/file.xlsx",
  "dist": "path/to/destination/directory",
  "targets": [
    "en_us",
    "zh_cn",
    "zh_hk"
  ],
  "keys": [
    "section",
    "key"
  ],
  "options": {
    "autoLookupParent": true,
    "fallbackValue": "",
    "overridingDuplicate": true
  }
}

And output will be like... (we only show en_us output in example, actual output will be 3 files)

// en_us.json
{
  "home": {
    "title": "let's crash in en",
    "description": "description in en"
  },
  "contact": "contact in en",
  "setting": {
    "title": "title in en",
    "description": "let's crash in en"
  }
}