Preserve new lines in cells with option preserveNewLinesInCells (#91)

README.md

@@ -46,6 +46,7 @@ try {
 - Supports optional custom quotation marks
 - Not create CSV column title by passing hasCSVColumnTitle: false, into params.
 - If field is not exist in object then the field value in CSV will be empty.
+- Preserve new lines in cells. Should be used we \r\n line ending for full compatibility with Excel.
 
 ## Use as a module
 
@@ -67,6 +68,7 @@ try {
   - `unwindPath` - String, creates multiple rows from a single JSON document similar to MongoDB's $unwind
   - `excelStrings` - Boolean, converts string data into normalized Excel style data.
   - `includeEmptyRows` - Boolean, includes empty rows. Defaults to `false`.
+  - `preserveNewLinesInCells` - Boolean, preserve \r and \n in cells. Defaults to `false`.
 - `callback` - `function (error, csvString) {}`. If provided, will callback asynchronously. Only supported for compatibility reasons.
 
 #### Example `fields` option

lib/json2csv.js

@@ -224,8 +224,20 @@ function createColumnContent(params, str) {
         }
 
         if (val !== undefined) {
+          if (params.preserveNewLinesInCells && typeof val === 'string') {
+            val = val
+              .replace(/\n/g, '\u2028')
+              .replace(/\r/g, '\u2029');
+          }
+
           var stringifiedElement = JSON.stringify(val);
 
+          if (params.preserveNewLinesInCells && typeof val === 'string') {
+            stringifiedElement = stringifiedElement
+              .replace(/\u2028/g, '\n')
+              .replace(/\u2029/g, '\r');
+          }
+
           if (typeof val === 'object') stringifiedElement = JSON.stringify(stringifiedElement);
 
           if (params.quotes !== '"') {

test/fixtures/json/newLine.json

@@ -0,0 +1,4 @@
+[
+  {"a string": "with a \u2028description\\n and\na new line"},
+  {"a string": "with a \u2029\u2028description and\r\nanother new line"}
+]

test/index.js

@@ -14,6 +14,7 @@ var jsonTrailingBackslash = require('./fixtures/json/trailingBackslash');
 var jsonOverriddenDefaultValue = require('./fixtures/json/overridenDefaultValue');
 var jsonEmptyRow = require('./fixtures/json/emptyRow');
 var jsonUnwind = require('./fixtures/json/unwind');
+var jsonNewLine = require('./fixtures/json/newLine');
 var csvFixtures = {};
 
 async.parallel(loadFixtures(csvFixtures), function (err) {
@@ -616,4 +617,37 @@ async.parallel(loadFixtures(csvFixtures), function (err) {
       t.end()
     })
   });
+
+  test('should not preserve new lines in cells by default', function(t) {
+    json2csv({
+      data: jsonNewLine,
+      fields: ['a string'],
+      newLine: '\r\n',
+    }, function(error, csv) {
+      t.error(error);
+      t.equal(csv, [
+        '"a string"',
+        '"with a \u2028description\\n and\\na new line"',
+        '"with a \u2029\u2028description and\\r\\nanother new line"'
+      ].join('\r\n'));
+      t.end();
+    });
+  });
+
+  test('should preserve new lines in cells when options.preserveNewLinesInCell is true', function(t) {
+    json2csv({
+      data: jsonNewLine,
+      fields: ['a string'],
+      newLine: '\r\n',
+      preserveNewLinesInCells: true,
+    }, function(error, csv) {
+      t.error(error);
+      t.equal(csv, [
+        '"a string"',
+        '"with a \ndescription\\n and\na new line"',
+        '"with a \r\ndescription and\r\nanother new line"'
+      ].join('\r\n'));
+      t.end();
+    });
+  });
 });