convert2json v1.0.1

json-convert

Latest stable version: 1.0.1

• json-convert
• Generator
  • Capabilities
  • How to use
    • Install
    • As a module
    • CLI
      • Usage:
    • Configuration File
      • Example of FIXEDLENGTH configuration file
      • Example of DELIMITER configuration file

Generator

Capabilities

• Convert fixed-length and CSV type files to JSON format
• features: ignoreLines, data type conversion
• CLI interface with convert command
• Prettified JSON output

How to use

Install

convert2json library should be used as a devDependencies

npm install convert2json --save-dev

or

yarn add convert2json -D

As a module

// Import
import { convert2Json } from 'convert2json';

// Convert
const configuration = {
  input: `${filePath}`,
  type: 'delimiter',
  separator: '|',
  fields: [{
    name: 'fields',
    type: 'string',
  }],
};

const converted = convert2Json(configuration);

CLI

json-convert offers a CLI command: convert.

Usage: yarn json-convert convert -- [options]

Commands:
  convert [options]      Converts files to JSON output

Options:
  -c, --configuration  set configuration path of your configuration file

Usage:

  yarn json-convert convert -- -c '/path/to/your/configuration/file.json'

Configuration File

• The Configuration is JSON file which accepts different parameters.
• The parameters includes:
  • type - It is type of file you wanted to convert. It accepts FIXEDLENGTH and DELIMITER
  • input - It accepts path for your source file
  • output - It accepts path to save your output JSON file
  • ignoreLines - It will skips the lines mentioned in an array
  • separator - It will accept separator parameter (| or ,)
  • fields - This is an array of objects accepting various parameters

    fields parameters

    • "name" - Expected name of the field in JSON output,
    • "type" - Data type of the field,
    • "length" - specifies length of the field specified

Example of FIXEDLENGTH configuration file

{
  "type": "FIXEDLENGTH",
  "input": "/home/Projects/json-convert-library/fixtures/ACTIVATE.148",
  "output": "/home/Projects/json-convert-library/abc.JSON",
  "ignoreLines": [1, 23, 99],
  "fields": [{
    "name": "version",
    "type": "float",
    "length": 3
  },
  {
    "name": "date",
    "type": "string",
    "length": 10
  }]
}

Example of DELIMITER configuration file

{
  "type": 'DELIMITER',
  "input": "/home/Projects/json-convert-library/fixtures/REAMUSID.148",
  "output": "/home/Projects/json-convert-library/abc.JSON",
  "separator": "|",
  "ignoreLines": [1, 23, 99],
  "fields": [{
    "name": "reamusId",
    "type": "abc",
    "length": 6
  },
  {
    "name": "locationName",
    "type": "string",
    "length": 35
  },
  {
    "name": "opUnit",
    "type": "number",
    "length": 6
  },
  {
    "name": "countryCode",
    "type": "string",
    "length": 2
  }]
}