feat(csv-parse): skip_line_with_errors used with raw print current buffer (fix #292)

wdavidw · wdavidw · commit 27419908b9ce · 2021-10-21T20:40:23.000+02:00
diff --git a/packages/csv-parse/dist/cjs/index.cjs b/packages/csv-parse/dist/cjs/index.cjs
@@ -6172,11 +6172,11 @@ class Parser extends Transform {
     return 0;
   }
   __error(msg){
-    const {skip_lines_with_error} = this.options;
+    const {encoding, raw, skip_lines_with_error} = this.options;
     const err = typeof msg === 'string' ? new Error(msg) : msg;
     if(skip_lines_with_error){
       this.state.recordHasError = true;
-      this.emit('skip', err);
+      this.emit('skip', err, raw ? this.state.rawBuffer.toString(encoding) : undefined);
       return undefined;
     }else {
       return err;
@@ -6189,12 +6189,13 @@ class Parser extends Transform {
     };
   }
   __infoRecord(){
-    const {columns} = this.options;
+    const {columns, raw, encoding} = this.options;
     return {
       ...this.__infoDataSet(),
       error: this.state.error,
       header: columns === true,
       index: this.state.record.length,
+      raw: raw ? this.state.rawBuffer.toString(encoding) : undefined
     };
   }
   __infoField(){
diff --git a/packages/csv-parse/dist/cjs/sync.cjs b/packages/csv-parse/dist/cjs/sync.cjs
@@ -6172,11 +6172,11 @@ class Parser extends Transform {
     return 0;
   }
   __error(msg){
-    const {skip_lines_with_error} = this.options;
+    const {encoding, raw, skip_lines_with_error} = this.options;
     const err = typeof msg === 'string' ? new Error(msg) : msg;
     if(skip_lines_with_error){
       this.state.recordHasError = true;
-      this.emit('skip', err);
+      this.emit('skip', err, raw ? this.state.rawBuffer.toString(encoding) : undefined);
       return undefined;
     }else {
       return err;
@@ -6189,12 +6189,13 @@ class Parser extends Transform {
     };
   }
   __infoRecord(){
-    const {columns} = this.options;
+    const {columns, raw, encoding} = this.options;
     return {
       ...this.__infoDataSet(),
       error: this.state.error,
       header: columns === true,
       index: this.state.record.length,
+      raw: raw ? this.state.rawBuffer.toString(encoding) : undefined
     };
   }
   __infoField(){
diff --git a/packages/csv-parse/dist/esm/index.js b/packages/csv-parse/dist/esm/index.js
@@ -6168,11 +6168,11 @@ class Parser extends Transform {
     return 0;
   }
   __error(msg){
-    const {skip_lines_with_error} = this.options;
+    const {encoding, raw, skip_lines_with_error} = this.options;
     const err = typeof msg === 'string' ? new Error(msg) : msg;
     if(skip_lines_with_error){
       this.state.recordHasError = true;
-      this.emit('skip', err);
+      this.emit('skip', err, raw ? this.state.rawBuffer.toString(encoding) : undefined);
       return undefined;
     }else {
       return err;
@@ -6185,12 +6185,13 @@ class Parser extends Transform {
     };
   }
   __infoRecord(){
-    const {columns} = this.options;
+    const {columns, raw, encoding} = this.options;
     return {
       ...this.__infoDataSet(),
       error: this.state.error,
       header: columns === true,
       index: this.state.record.length,
+      raw: raw ? this.state.rawBuffer.toString(encoding) : undefined
     };
   }
   __infoField(){
diff --git a/packages/csv-parse/dist/esm/sync.js b/packages/csv-parse/dist/esm/sync.js
@@ -6168,11 +6168,11 @@ class Parser extends Transform {
     return 0;
   }
   __error(msg){
-    const {skip_lines_with_error} = this.options;
+    const {encoding, raw, skip_lines_with_error} = this.options;
     const err = typeof msg === 'string' ? new Error(msg) : msg;
     if(skip_lines_with_error){
       this.state.recordHasError = true;
-      this.emit('skip', err);
+      this.emit('skip', err, raw ? this.state.rawBuffer.toString(encoding) : undefined);
       return undefined;
     }else {
       return err;
@@ -6185,12 +6185,13 @@ class Parser extends Transform {
     };
   }
   __infoRecord(){
-    const {columns} = this.options;
+    const {columns, raw, encoding} = this.options;
     return {
       ...this.__infoDataSet(),
       error: this.state.error,
       header: columns === true,
       index: this.state.record.length,
+      raw: raw ? this.state.rawBuffer.toString(encoding) : undefined
     };
   }
   __infoField(){
diff --git a/packages/csv-parse/dist/iife/index.js b/packages/csv-parse/dist/iife/index.js
@@ -6171,11 +6171,11 @@ var csv_parse = (function (exports) {
                 return 0;
               }
               __error(msg){
-                const {skip_lines_with_error} = this.options;
+                const {encoding, raw, skip_lines_with_error} = this.options;
                 const err = typeof msg === 'string' ? new Error(msg) : msg;
                 if(skip_lines_with_error){
                   this.state.recordHasError = true;
-                  this.emit('skip', err);
+                  this.emit('skip', err, raw ? this.state.rawBuffer.toString(encoding) : undefined);
                   return undefined;
                 }else {
                   return err;
@@ -6188,12 +6188,13 @@ var csv_parse = (function (exports) {
                 };
               }
               __infoRecord(){
-                const {columns} = this.options;
+                const {columns, raw, encoding} = this.options;
                 return {
                   ...this.__infoDataSet(),
                   error: this.state.error,
                   header: columns === true,
                   index: this.state.record.length,
+                  raw: raw ? this.state.rawBuffer.toString(encoding) : undefined
                 };
               }
               __infoField(){
diff --git a/packages/csv-parse/dist/iife/sync.js b/packages/csv-parse/dist/iife/sync.js
@@ -6171,11 +6171,11 @@ var csv_parse_sync = (function (exports) {
                 return 0;
               }
               __error(msg){
-                const {skip_lines_with_error} = this.options;
+                const {encoding, raw, skip_lines_with_error} = this.options;
                 const err = typeof msg === 'string' ? new Error(msg) : msg;
                 if(skip_lines_with_error){
                   this.state.recordHasError = true;
-                  this.emit('skip', err);
+                  this.emit('skip', err, raw ? this.state.rawBuffer.toString(encoding) : undefined);
                   return undefined;
                 }else {
                   return err;
@@ -6188,12 +6188,13 @@ var csv_parse_sync = (function (exports) {
                 };
               }
               __infoRecord(){
-                const {columns} = this.options;
+                const {columns, raw, encoding} = this.options;
                 return {
                   ...this.__infoDataSet(),
                   error: this.state.error,
                   header: columns === true,
                   index: this.state.record.length,
+                  raw: raw ? this.state.rawBuffer.toString(encoding) : undefined
                 };
               }
               __infoField(){
diff --git a/packages/csv-parse/dist/umd/index.js b/packages/csv-parse/dist/umd/index.js
@@ -6174,11 +6174,11 @@
                 return 0;
               }
               __error(msg){
-                const {skip_lines_with_error} = this.options;
+                const {encoding, raw, skip_lines_with_error} = this.options;
                 const err = typeof msg === 'string' ? new Error(msg) : msg;
                 if(skip_lines_with_error){
                   this.state.recordHasError = true;
-                  this.emit('skip', err);
+                  this.emit('skip', err, raw ? this.state.rawBuffer.toString(encoding) : undefined);
                   return undefined;
                 }else {
                   return err;
@@ -6191,12 +6191,13 @@
                 };
               }
               __infoRecord(){
-                const {columns} = this.options;
+                const {columns, raw, encoding} = this.options;
                 return {
                   ...this.__infoDataSet(),
                   error: this.state.error,
                   header: columns === true,
                   index: this.state.record.length,
+                  raw: raw ? this.state.rawBuffer.toString(encoding) : undefined
                 };
               }
               __infoField(){
diff --git a/packages/csv-parse/dist/umd/sync.js b/packages/csv-parse/dist/umd/sync.js
@@ -6174,11 +6174,11 @@
                 return 0;
               }
               __error(msg){
-                const {skip_lines_with_error} = this.options;
+                const {encoding, raw, skip_lines_with_error} = this.options;
                 const err = typeof msg === 'string' ? new Error(msg) : msg;
                 if(skip_lines_with_error){
                   this.state.recordHasError = true;
-                  this.emit('skip', err);
+                  this.emit('skip', err, raw ? this.state.rawBuffer.toString(encoding) : undefined);
                   return undefined;
                 }else {
                   return err;
@@ -6191,12 +6191,13 @@
                 };
               }
               __infoRecord(){
-                const {columns} = this.options;
+                const {columns, raw, encoding} = this.options;
                 return {
                   ...this.__infoDataSet(),
                   error: this.state.error,
                   header: columns === true,
                   index: this.state.record.length,
+                  raw: raw ? this.state.rawBuffer.toString(encoding) : undefined
                 };
               }
               __infoField(){
diff --git a/packages/csv-parse/lib/index.js b/packages/csv-parse/lib/index.js
@@ -1167,11 +1167,11 @@ class Parser extends Transform {
     return 0;
   }
   __error(msg){
-    const {skip_lines_with_error} = this.options;
+    const {encoding, raw, skip_lines_with_error} = this.options;
     const err = typeof msg === 'string' ? new Error(msg) : msg;
     if(skip_lines_with_error){
       this.state.recordHasError = true;
-      this.emit('skip', err);
+      this.emit('skip', err, raw ? this.state.rawBuffer.toString(encoding) : undefined);
       return undefined;
     }else{
       return err;
@@ -1184,12 +1184,13 @@ class Parser extends Transform {
     };
   }
   __infoRecord(){
-    const {columns} = this.options;
+    const {columns, raw, encoding} = this.options;
     return {
       ...this.__infoDataSet(),
       error: this.state.error,
       header: columns === true,
       index: this.state.record.length,
+      raw: raw ? this.state.rawBuffer.toString(encoding) : undefined
     };
   }
   __infoField(){
diff --git a/packages/csv-parse/samples/option.cast.js b/packages/csv-parse/samples/option.cast.js
@@ -26,11 +26,11 @@ assert.deepStrictEqual(records, [
   [ '2000-01-01T05:00:00.000Z', {
     bytes: 16, comment_lines: 0, empty_lines: 0, invalid_field_length: 0,
     lines: 1, records: 0, columns: false, error: undefined, header: false,
-    index: 1, column: 1, quoting: false
+    index: 1, column: 1, quoting: false, raw: undefined
   } ],
   [ '2050-11-27T05:00:00.000Z', {
     bytes: 35, comment_lines: 0, empty_lines: 0, invalid_field_length: 0,
     lines: 2, records: 1, columns: false, error: undefined, header: false,
-    index: 1, column: 1, quoting: false
+    index: 1, column: 1, quoting: false, raw: undefined
   } ]
 ]);
diff --git a/packages/csv-parse/samples/option.info.js b/packages/csv-parse/samples/option.info.js
@@ -9,15 +9,16 @@ const records = parse(data, {
 assert.deepStrictEqual(records, [{
   info: {
     bytes: 5,
+    columns: false,
     comment_lines: 0,
     empty_lines: 0,
+    error: undefined,
+    header: false,
+    index: 3,
     invalid_field_length: 0,
     lines: 1,
+    raw: undefined,
     records: 1,
-    columns: false,
-    error: undefined,
-    header: false,
-    index: 3
   },
   record: [ 'a', 'b', 'c' ]
 }]);
diff --git a/packages/csv-parse/test/option.cast.coffee b/packages/csv-parse/test/option.cast.coffee
@@ -68,7 +68,7 @@ describe 'Option `cast`', ->
             'bytes',
             'column', 'columns', 'comment_lines', 'empty_lines', 'error',
             'header', 'index', 'invalid_field_length', 'lines', 'quoting',
-            'records'
+            'raw', 'records'
           ]]
         ] unless err
         next err
@@ -88,13 +88,13 @@ describe 'Option `cast`', ->
             bytes: 16,
             column: 1, columns: false, comment_lines: 0, empty_lines: 0, error: undefined,
             header: false, index: 1, invalid_field_length: 0, lines: 1,
-            quoting: false, records: 0
+            quoting: false, raw: undefined, records: 0
           } ]
           [ '2050-11-27T05:00:00.000Z', {
             bytes: 33,
             column: 1, columns: false, comment_lines: 0, empty_lines: 0, error: undefined,
             header: false, index: 1, invalid_field_length: 0, lines: 2,
-            quoting: false, records: 1
+            quoting: false, raw: undefined, records: 1
           } ]
         ] unless err
         next err
diff --git a/packages/csv-parse/test/option.info.coffee b/packages/csv-parse/test/option.info.coffee
@@ -31,7 +31,7 @@ describe 'Option `info`', ->
         Object.keys(info).sort().should.eql [
           'bytes',
           'columns', 'comment_lines', 'empty_lines', 'error', 'header',
-          'index', 'invalid_field_length', 'lines', 'records'
+          'index', 'invalid_field_length', 'lines', 'raw', 'records'
         ]
         next err
           
diff --git a/packages/csv-parse/test/option.on_record.coffee b/packages/csv-parse/test/option.on_record.coffee
@@ -63,7 +63,7 @@ describe 'Option `on_record`', ->
         records.should.eql [[
           'bytes',
           'columns', 'comment_lines', 'empty_lines', 'error', 'header',
-          'index', 'invalid_field_length', 'lines', 'records'
+          'index', 'invalid_field_length', 'lines', 'raw', 'records'
         ]]
         next()
           
@@ -76,10 +76,10 @@ describe 'Option `on_record`', ->
         records.should.eql [
           bytes: 4,
           columns: false, comment_lines: 0, empty_lines: 0, error: undefined, header: false
-          index: 2, invalid_field_length: 0, lines: 1, records: 1
+          index: 2, invalid_field_length: 0, lines: 1, raw: undefined, records: 1
         ,
           bytes: 7,
           columns: false, comment_lines: 0, empty_lines: 0, error: undefined, header: false
-          index: 2, invalid_field_length: 0, lines: 2, records: 2
+          index: 2, invalid_field_length: 0, lines: 2, raw: undefined, records: 2
         ]
         next()
diff --git a/packages/csv-parse/test/option.skip_lines_with_error.coffee b/packages/csv-parse/test/option.skip_lines_with_error.coffee
@@ -129,3 +129,24 @@ describe 'Option `skip_lines_with_error`', ->
     e,f,g,h
     '''
     parser.end()
+  
+  describe 'with `raw` option', ->
+    
+    it 'print raw record', (next) ->
+      errors = 0
+      parser = parse '''
+        "a","b","c"
+        "one","two","three"
+        "four"," " ","six"
+        "seven","eight","nine"
+        '''
+      ,
+        skip_lines_with_error: true
+        raw: true
+      , (err, data) ->
+        errors.should.eql 1
+        next err
+      parser.on 'skip', (err, raw) ->
+        err.raw.should.eql '"four"," "'
+        raw.should.eql '"four"," "'
+        errors++
