https://github.com/wesscoby/csv-json-convertor

A simple csv-json convertor
https://github.com/wesscoby/csv-json-convertor

bash csv-converter csv-json-convertor javascript json nodejs npm wsl

Last synced: about 1 month ago
JSON representation

A simple csv-json convertor

• Host: GitHub
• URL: https://github.com/wesscoby/csv-json-convertor
• Owner: wesscoby
• License: mit
• Created: 2019-06-22T00:30:59.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T10:03:17.000Z (almost 2 years ago)
• Last Synced: 2024-10-11T10:38:21.309Z (about 1 month ago)
• Topics: bash, csv-converter, csv-json-convertor, javascript, json, nodejs, npm, wsl
• Language: TypeScript
• Homepage:
• Size: 1.18 MB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Converter banner](./images/banner.png)

![npm (tag)](https://img.shields.io/npm/v/csv-json-convertor/latest?style=plastic)

![npm](https://img.shields.io/npm/dt/csv-json-convertor?style=plastic)

![GitHub last commit](https://img.shields.io/github/last-commit/wesscoby/csv-json-convertor?style=plastic)

![licence](https://img.shields.io/npm/l/csv-json-convertor.svg?style=plastic)

# Overview

Csv-json-convertor, as its name implies, is a simple *csv-json* conversion tool. You can use it to easily convert csv files to json objects and/or files, as well as the other way around (convert json files to csv).

# Installation

**Install via npm**: `npm install csv-json-convertor` 


[![NPM](https://img.shields.io/badge/install-npm%20install%20csv--json--convertor-blue)](https://npmjs.org/package/csv-json-convertor)

# Usage

After installing, import and use in your project as follows:

### CSV to JSON

```js

// require destructured toJSON function

const { toJSON } = require('csv-json-convertor');

// convert csv file

toJSON('path/to/csvFile.csv', api => {

    // log or use object (result from the conversion)

    console.log(api.data); 

    // save new .json file (./csvFile.json by default) to current directory

    api.save() 

});

```

You can specify save options such as `filename`, `prettify` and `spaces` as in the following examples 


By default: 


`filename`: name of the csv file 


`prettify`: false 


`spaces`: 1

```js

// filename

toJSON('path/to/csvFile.csv', api => {

    const options = {

        filename: newJsonFile

    };

    api.save(options); 

    // Output: newJsonfile.json, not prettified

}); 

// filename, prettify 

toJSON('path/to/csvFile.csv', api => {

    const options = {

        filename: newJsonFile,

        prettify: true

    };

    api.save(options); 

    // Output: newJsonFile.json, prettified using a spacing of 1

}); 

// filename, prettify, spaces

toJSON('path/to/csvFile.csv', api => {

    const options = {

        filename: `newJsonFile`,

        prettify: true,

        spaces: 2

    };

    api.save(options); 

    // Output: ./newJsonFile.json, prettified using a spacing of 2

}); 

```

![Preview of conversion to json](./images/toJsonPreview.png)

### JSON to CSV

The `toCSV` method is quite the opposite of `toJSON`

```js

// require destructured toCSV function

const { toCSV } = require('csv-json-convertor');

// convert csv file

toCSV('path/to/jsonFile.json', api => {

    // log or use string (result from the conversion)

    console.log(api.data);

    // save new .csv file (./jsonFile.csv by default) to current directory 

    api.save();

});

```

The save method accepts an `options` object which currently contains just one property, `filename`, with which you can specify the name of the new file to be saved.

```js

// filename

toJSON('path/to/jsonFile.json', api => {

    const options = {

        filename: `newCsvFile`

    };

    api.save(options); 

    // Output: ./newCsvFile.csv

}); 

```

# Contributing

I need help with writing a good documentation for this project. Also, any ideas or suggestions on new features, enhancements and performance improvement are very welcome. 


Feel free to contribute in anyway you can.