json-csv - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "json-csv",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Export a richly structured, JSON array to CSV",
-  "homepage": "http://cynaptik.net/npm/json-csv",
+  "homepage": "https://github.com/cynaptik/json-csv",
   "author": "Nathan Bridgewater <[e-mail]> (http://integratedwebsystems.com/)",
@@ -14,3 +14,3 @@ "keywords": [
     "type": "git",
-    "url": "[e-mail]:Cynaptik/json-csv.git"
+    "url": "https://github.com/Cynaptik/json-csv.git"
   },
@@ -37,3 +37,2 @@ "licenses": [
   "dependencies": {
-    "should": "~1.2.2"
   },
@@ -40,0 +39,0 @@ "scripts": {

README.md

@@ -5,1 +5,121 @@ json-csv
 Simple CSV export module that can export a rich JSON array of objects to CSV. 
+
+
+Example
+-------
+Simple structure with basic CSV conversion. 
+
+```
+var csv = require('json-csv')
+var items = [
+  {
+    name : 'fred',
+    email : 'fred@somewhere',
+    amount : 1.02
+  },
+  {
+    name : 'jo',
+    email : 'jo@somewhere',
+    amount : 1.02
+  },
+  {
+    name : 'jo with a comma,',
+    email : 'jo@somewhere',
+    amount : 1.02
+  }]
+
+csv.toCSV({
+  data : items,
+  fields : [ 
+    {
+        name : 'name',
+        label : 'Name'
+    },
+    {
+        name : 'email',
+        label : 'Email'
+    }
+  ]},
+  function(err,csv) {
+    console.log(csv);
+  });
+```
+
+``` output
+Name,Email
+fred,fred@somewhere
+jo,jo@somewhere
+"jo with a comma,",jo@somewhere
+```
+
+Here's a little more advanced sample that uses sub-structures and a filter for manipulating output for individual columns. 
+
+```
+var csv = require('json-csv')
+var items = [
+  {
+    contact : {
+      company : 'Widgets, LLC',
+      name : 'John Doe',
+      email : '[e-mail]'
+    },
+    registration : {
+      year : 2013,
+      level : 3
+    }
+  },
+  {
+    contact : {
+      company : 'Sprockets, LLC',
+      name : 'Jane Doe',
+      email : '[e-mail]'
+    },
+    registration : {
+      year : 2013,
+      level : 2
+    }
+  }
+];
+
+csv.toCSV({
+  data : items,
+  fields : [ 
+    {
+      name : 'contact.company',
+      label : 'Company'
+    },
+    {
+      name : 'contact.name',
+      label : 'Name'
+    },
+    {
+      name : 'contact.email',
+      label : 'Email'
+    },
+    {
+      name : 'registration.year',
+      label : 'Year'
+    },
+    { 
+      name : 'registration.level',
+      label : 'Level',
+      filter : function(value) {
+        switch(value) {
+          case 1 : return 'Test 1'
+          case 2 : return 'Test 2'
+          default : return 'Unknown'
+        }
+      }
+    }]
+  },
+  function(err,csv) {
+    console.log(csv);
+  });
+
+```
+
+``` output
+Company,Name,Email,Year,Level
+"Widgets, LLC",John Doe,[e-mail],2013,Unknown
+"Sprockets, LLC",Jane Doe,[e-mail],2013,Test 2
+```

Fixed alerts

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8346

increased by75.59%

Dependency count

0

decreased by-100%

Number of package files

8

increased by33.33%

Lines of code

140

increased by185.71%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

124

increased by2380%

Dependency changes

• - Removedshould@~1.2.2

• - Removedshould@1.2.2(transitive)