Initial release of json-2-csv-cli.

Author: mrodrig

.gitignore

@@ -0,0 +1,12 @@
+# Coverage directory used by tools like istanbul
+coverage
+.nyc_output
+
+# Dependency directory
+node_modules
+
+# Users Environment Configurations
+.idea
+
+# Debug logs
+npm-debug.log

.npmignore

@@ -0,0 +1,11 @@
+test/
+.git*
+npm-debug.log
+.travis.yml
+.eslintrc
+node_modules
+coverage
+.nyc_output
+upgrade_guides
+tslint.json
+_config.yml

README.md

@@ -0,0 +1,58 @@
+# json-2-csv-cli
+**Convert JSON to CSV _or_ CSV to JSON**
+
+This module provides the command line interface functionality for the [json-2-csv](https://www.npmjs.org/package/json-2-csv) package.
+
+[![Dependencies](https://img.shields.io/david/mrodrig/json-2-csv-cli.svg)](https://www.npmjs.org/package/json-2-csv-cli)
+[![Downloads](http://img.shields.io/npm/dm/json-2-csv-cli.svg)](https://www.npmjs.org/package/json-2-csv-cli)
+[![NPM version](https://img.shields.io/npm/v/json-2-csv-cli.svg)](https://www.npmjs.org/package/json-2-csv-cli)
+[![Known Vulnerabilities](https://snyk.io/test/npm/json-2-csv-cli/badge.svg)](https://snyk.io/test/npm/json-2-csv-cli)
+[![Package Size](https://img.shields.io/bundlephobia/min/json-2-csv-cli.svg)](https://www.npmjs.org/package/json-2-csv-cli)
+
+## Installation
+
+CLI:
+```bash
+$ npm install json-2-csv-cli
+```
+
+## Usage
+### json2csv
+```
+Usage: json2csv <jsonFile> [options]
+
+Options:
+  -V, --version                    output the version number
+  -o, --output [output]            Path of output file. If not provided, then stdout will be used
+  -f, --field <delimiter>          Optional field delimiter
+  -w, --wrap <delimiter>           Optional wrap delimiter
+  -e, --eol <delimiter>            Optional end of line delimiter
+  -b, --excel-bom                  Excel Byte Order Mark character prepended to CSV
+  -W, --without-header             Withhold the prepended header
+  -s, --sort-header                Sort the header fields
+  -H, --trim-header                Trim header fields
+  -F, --trim-fields                Trim field values
+  -S, --check-schema               Check for schema differences
+  -E, --empty-field-value <value>  Empty field value
+  -A, --expand-array-objects       Expand array objects
+  -k, --keys [keys]                Keys of documents to convert to CSV
+  -h, --help                       output usage information
+```
+
+### csv2json
+```
+Usage: csv2json <csvFile> [options]
+
+Options:
+  -V, --version            output the version number
+  -c, --csv <csv>          Path of json file to be converted
+  -o, --output [output]    Path of output file. If not provided, then stdout will be used
+  -f, --field <delimiter>  Optional field delimiter
+  -w, --wrap <delimiter>   Optional wrap delimiter
+  -e, --eol <delimiter>    Optional end of line delimiter
+  -b, --excel-bom          Excel Byte Order Mark character prepended to CSV
+  -H, --trim-header        Trim header fields
+  -F, --trim-fields        Trim field values
+  -k, --keys [keys]        Keys of documents to convert to CSV
+  -h, --help               output usage information
+```

bin/csv2json.js

@@ -0,0 +1,41 @@
+#!/usr/bin/env node
+
+'use strict';
+
+const pkg = require('json-2-csv'),
+    utils = require('./utils/utils'),
+    program = require('commander');
+
+program
+    .version(pkg.version)
+    .usage('<csvFile> [options]')
+    .option('-c, --csv <csv>', 'Path of json file to be converted', utils.readInputFile)
+    .option('-o, --output [output]', 'Path of output file. If not provided, then stdout will be used', utils.convertToAbsolutePath)
+    .option('-f, --field <delimiter>', 'Optional field delimiter')
+    .option('-w, --wrap <delimiter>', 'Optional wrap delimiter')
+    .option('-e, --eol <delimiter>', 'Optional end of line delimiter')
+    .option('-b, --excel-bom', 'Excel Byte Order Mark character prepended to CSV')
+    .option('-H, --trim-header', 'Trim header fields')
+    .option('-F, --trim-fields', 'Trim field values')
+    .option('-k, --keys [keys]', 'Keys of documents to convert to CSV', utils.constructKeysList, undefined)
+    .parse(process.argv);
+
+Promise.resolve({
+    csv: utils.readInputFile(program.args && program.args.length && program.args[0]),
+    output: program.output,
+    options: {
+        delimiter: {
+            field: program.field,
+            wrap: program.wrap,
+            eol: program.eol
+        },
+        excelBOM: Boolean(program.excelBom),
+        trimHeaderFields: Boolean(program.trimHeader),
+        trimFieldValues: Boolean(program.trimFields),
+        keys: program.keys
+    }
+})
+    .then(utils.parseInputFiles)
+    .then(utils.determineConverter)
+    .then(utils.performConversion)
+    .then(utils.processOutput);

bin/json2csv.js

@@ -0,0 +1,50 @@
+#!/usr/bin/env node
+
+'use strict';
+
+const pkg = require('json-2-csv'),
+    utils = require('./utils/utils'),
+    program = require('commander');
+
+program
+    .version(pkg.version)
+    .usage('<jsonFile> [options]')
+    .option('-o, --output [output]', 'Path of output file. If not provided, then stdout will be used', utils.convertToAbsolutePath)
+    .option('-f, --field <delimiter>', 'Optional field delimiter')
+    .option('-w, --wrap <delimiter>', 'Optional wrap delimiter')
+    .option('-e, --eol <delimiter>', 'Optional end of line delimiter')
+    .option('-b, --excel-bom', 'Excel Byte Order Mark character prepended to CSV')
+    .option('-W, --without-header', 'Withhold the prepended header')
+    .option('-s, --sort-header', 'Sort the header fields')
+    .option('-H, --trim-header', 'Trim header fields')
+    .option('-F, --trim-fields', 'Trim field values')
+    .option('-S, --check-schema', 'Check for schema differences')
+    .option('-E, --empty-field-value <value>', 'Empty field value')
+    .option('-A, --expand-array-objects', 'Expand array objects')
+    .option('-k, --keys [keys]', 'Keys of documents to convert to CSV', utils.constructKeysList, undefined)
+    .parse(process.argv);
+
+Promise.resolve({
+    json: utils.readInputFile(program.args && program.args.length && program.args[0]),
+    output: program.output,
+    options: {
+        delimiter: {
+            field: program.field,
+            wrap: program.wrap,
+            eol: program.eol
+        },
+        excelBOM: Boolean(program.excelBom),
+        prependHeader: !program.withoutHeader,
+        sortHeader: Boolean(program.sortHeader),
+        trimHeaderFields: Boolean(program.trimHeader),
+        trimFieldValues: Boolean(program.trimFields),
+        checkSchemaDifferences: Boolean(program.checkSchema),
+        expandArrayObjects: Boolean(program.expandArrayObjects),
+        emptyFieldValue: program.emptyFieldValue,
+        keys: program.keys
+    }
+})
+    .then(utils.parseInputFiles)
+    .then(utils.determineConverter)
+    .then(utils.performConversion)
+    .then(utils.processOutput);

bin/utils/utils.js

@@ -0,0 +1,93 @@
+'use strict';
+
+const path = require('path'),
+    fs = require('fs'),
+    converter = require('../../../json-2-csv');
+
+module.exports = {
+    constructKeysList,
+    readInputFile,
+    convertToAbsolutePath,
+    parseInputFiles,
+    determineConverter,
+    performConversion,
+    processOutput
+};
+
+function convertToAbsolutePath(filePath) {
+    if (filePath && !path.isAbsolute(filePath)) {
+        return path.join(process.cwd(), filePath);
+    }
+    return filePath;
+}
+
+function readInputFile(filePath) {
+    filePath = convertToAbsolutePath(filePath);
+    return fs.readFileSync(filePath).toString();
+}
+
+function parseInputFiles(params) {
+    if (params.json) {
+        params.json = JSON.parse(params.json);
+    }
+    return params;
+}
+
+function determineConverter(params) {
+    if (params.json) {
+        params.conversion = 'json2csv';
+        params.converter = converter.json2csvAsync;
+    } else if (params.csv) {
+        params.conversion = 'csv2json';
+        params.converter = converter.csv2jsonAsync;
+    } else {
+        return Promise.reject('No data provided for conversion');
+    }
+
+    return params;
+}
+
+function performConversion(params) {
+    switch (params.conversion) {
+        case 'json2csv':
+            return params.converter(params.json, params.options)
+                .then((outputData) => {
+                    params.outputData = outputData;
+                    return params;
+                });
+        case 'csv2json':
+            return params.converter(params.csv, params.options)
+                .then((outputData) => {
+                    params.outputData = outputData;
+                    return params;
+                });
+        default:
+            return Promise.reject('Invalid conversion specified.');
+    }
+}
+
+function writeToFile(filePath, data) {
+    fs.writeFileSync(filePath, data);
+}
+
+function processOutput(params) {
+    if (params.output && params.json) {
+        // Write the raw output data when converting from JSON to CSV
+        return writeToFile(params.output, params.outputData);
+    } else if (params.output) {
+        // Pretty print the output when converting from CSV to JSON
+        return writeToFile(params.output, JSON.stringify(params.outputData, null, 4));
+    }
+    // Otherwise, no output was specified so just send it to stdout via the console
+    console.log(params.outputData); // eslint-disable-line no-console
+}
+
+function constructKeysList(key, keys) {
+    // Initialize as empty array, if undefined at start
+    if (!keys) {
+        keys = [];
+    }
+
+    keys.push(key);
+    return keys;
+}

package-lock.json

@@ -0,0 +1,42 @@
+{
+    "author": {
+        "name": "Mike Rodrigues",
+        "email": "[email protected]"
+    },
+    "name": "json-2-csv-cli",
+    "description": "",
+    "version": "3.5.8",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/mrodrig/json-2-csv-cli.git"
+    },
+    "bugs": {
+        "url": "https://github.com/mrodrig/json-2-csv-cli/issues"
+    },
+    "bin": {
+        "json2csv": "./bin/json2csv.js",
+        "csv2json": "./bin/csv2json.js"
+    },
+    "keywords": [
+        "json",
+        "to",
+        "csv",
+        "converter",
+        "export",
+        "json2csv",
+        "csv2json",
+        "parse",
+        "parser",
+        "json-2-csv",
+        "csv-2-json",
+        "cli"
+    ],
+    "dependencies": {
+        "commander": "2.20.0",
+        "json-2-csv": "*"
+    },
+    "engines": {
+        "node": ">= 8"
+    },
+    "license": "MIT"
+}