csv-tools - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "csv-tools",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Convert CSV to JSON and JSON to CSV.",
@@ -20,3 +20,3 @@ "main": "index.js",
   ],
-  "author": "Beñat Lizarazu",
+  "author": "Beñat Lizarazu <[e-mail]>",
   "license": "MIT",
@@ -23,0 +23,0 @@ "bugs": {

README.md

@@ -1,4 +0,174 @@
-# csv-tools
+# CSV Tools
 Node module to convert CSV to JSON and JSON to CSV.
 
 [![Build Status](https://travis-ci.org/blizarazu/csv-tools.svg?branch=master)](https://travis-ci.org/blizarazu/csv-tools)
+
+CSV Tools does a great job exporting and importing data. Javascript objects can easily be exported to CSV, a format that non-programmers can easily understand and modify. On the other hand, CSV data can be imported into your appliation using CSV Tools and easily use that data as JSON objects.
+
+This libraries provides 3 methods:
+- [__toJSON(csvData)__](#convert-csv-string-to-json): Converts csvData to JSON.
+- [__fileToJSON(csvFilePath, cb)__](#convert-csv-file-to-json): Converts the content of the file in csvFilePath and calls the cb callback function and passes the resulting JSON as an argument of the callback.
+- [__fromCSV(json)__](#convert-json-to-csv): Converts json to CSV.
+
+## CSV to JSON
+CSV Tools can parse any CSV file or string to an array of JSONs. The CVS's first row must contain the headers and the JSON properties will be named as the header for the corresponding column.
+
+For example, the following CSV:
+```
+first_name,last_name,gender
+Dennis,Anderson,Male
+Peter,Hicks,Male
+```
+will be converted into:
+```
+[
+  {
+    "first_name": "Dennis",
+    "last_name": "Anderson",
+    "gender": "Male"
+  },
+  {
+    "first_name": "Peter",
+    "last_name": "Hicks",
+    "gender": "Male"
+  }
+]
+
+```
+
+A dot (.) in a header will create a subdocument. For example:
+```
+device,owner.name.first,owner.name.last,owner.gender
+94-0B-05-0E-E9-35,Pamela,Hart,Female
+69-71-86-FD-B1-24,Karen,Pierce,Female
+```
+will be converted into:
+```
+[
+  {
+    "device": "94-0B-05-0E-E9-35",
+    "owner": {
+      "name": {
+        "first": "Pamela",
+        "last": "Hart"
+      },
+      "gender": "Female"
+    }
+  },
+  {
+    "device": "69-71-86-FD-B1-24",
+    "owner": {
+      "name": {
+        "first": "Karen",
+        "last": "Pierce"
+      },
+      "gender": "Female"
+    }
+  }
+]
+```
+
+## JSON to CSV
+In the same way, JSONs can be converted into CSV. The properties will be stored as headers in the first row of the CSV. If the JSON has subdocuments, its properties will be attached to the corresponding header with a dot between the parent property and its children. For example:
+```
+[
+  {
+    "age": 21,
+    "name": {
+      "first": "Sylvia",
+      "last": "Mcfarland"
+    },
+    "company": "AMRIL",
+    "phone": "[phone]"
+  },
+  {
+    "age": 21,
+    "name": {
+      "first": "Adkins",
+      "last": "Becker"
+    },
+    "company": "COMTREK",
+    "phone": "[phone]"
+  }
+]
+```
+will be converted into:
+```
+age,name.first,name.last,company,phone
+21,"Sylvia","Mcfarland","AMRIL","[phone]"
+21,"Adkins","Becker","COMTREK","[phone]"
+```
+
+If any of the objects in the array does not have a property, that value will be empty in the resulting CSV.
+
+Input:
+```
+[
+  {
+    "age": 21,
+    "phone": "[phone]",
+    "name": "Sylvia Mcfarland"
+  },
+  {
+    "age": 34,
+    "name": "Adkins Becker",
+  }
+]
+```
+
+Output:
+```
+age,phone,name
+21,"[phone]","Sylvia Mcfarland"
+34,,"Adkins Becker"
+```
+
+## Install
+
+```
+$ npm install csv-tools
+```
+
+## Usage
+#### Convert CSV string to JSON
+```
+var csv = require('csv-tools');
+
+var csvData = "first_name,last_name,gender\nDennis,Anderson,Male\nPeter,Hicks,Male";
+
+var json = csv.toJSON(csvData);
+
+console.log(JSON.stringify(json, null, 2));
+```
+#### Convert CSV file to JSON
+```
+var csv = require('csv-tools');
+
+var file = "data.csv";
+
+csv.fileToJSON(file, function(json) {
+  console.log(JSON.stringify(json,null,2));
+});
+```
+
+#### Convert JSON to CSV
+```
+var csv = require('csv-tools');
+
+var jsonArray = [
+  {
+    "first_name": "Dennis",
+    "last_name": "Anderson",
+    "gender": "Male"
+  },
+  {
+    "first_name": "Peter",
+    "last_name": "Hicks",
+    "gender": "Male"
+  }
+];
+
+var csvData = csv.fromJSON(jsonArray);
+
+console.log(csvData);
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

20293

increased by32.13%

Number of package files

15

increased by50%

Lines of code

343

increased by12.46%

Number of lines in readme file

175

increased by3400%

No dependency changes