refactor(csv-parse)!: rename RECORD_DONT_MATCH_COLUMNS_LENGTH

wdavidw · wdavidw · commit fb391c92fa24 · 2021-11-07T00:52:38.000+01:00
diff --git a/packages/csv-parse/ROADMAP.md b/packages/csv-parse/ROADMAP.md
@@ -10,6 +10,5 @@ We invite you to join and contribute but create an issue before engaging any wor
 * encoding: new encoding_input and encoding_output options (medium)
 * `columns_duplicates_to_array`: this is just too long but I don't have much insipiration for a better name
 * `relax_column_count`: rename INCONSISTENT_RECORD_LENGTH to RECORD_INCONSISTENT_FIELDS_LENGTH (easy)
-* `relax_column_count`: rename RECORD_DONT_MATCH_COLUMNS_LENGTH to RECORD_INCONSISTENT_COLUMNS (easy)
 * `info`: remove the `parser.info` object and move its properties to `state`
 * `info`: rename the `info` related properties and functions to `context`
diff --git a/packages/csv-parse/dist/cjs/index.cjs b/packages/csv-parse/dist/cjs/index.cjs
@@ -5889,9 +5889,7 @@ class Parser extends Transform {
           record: record,
         })
         :
-        // Todo: rename CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH to
-        // CSV_RECORD_INCONSISTENT_COLUMNS
-        new CsvError('CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH', [
+        new CsvError('CSV_RECORD_INCONSISTENT_COLUMNS', [
           'Invalid Record Length:',
           `columns length is ${columns.length},`, // rename columns
           `got ${recordLength} on line ${this.info.lines}`,
diff --git a/packages/csv-parse/dist/cjs/index.d.ts b/packages/csv-parse/dist/cjs/index.d.ts
@@ -254,7 +254,7 @@ export type CsvErrorCode =
     | 'CSV_NON_TRIMABLE_CHAR_AFTER_CLOSING_QUOTE'
     | 'CSV_QUOTE_NOT_CLOSED'
     | 'CSV_INCONSISTENT_RECORD_LENGTH'
-    | 'CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH'
+    | 'CSV_RECORD_INCONSISTENT_COLUMNS'
     | 'CSV_OPTION_COLUMNS_MISSING_NAME'
 
 export class CsvError extends Error {
diff --git a/packages/csv-parse/dist/cjs/sync.cjs b/packages/csv-parse/dist/cjs/sync.cjs
@@ -5889,9 +5889,7 @@ class Parser extends Transform {
           record: record,
         })
         :
-        // Todo: rename CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH to
-        // CSV_RECORD_INCONSISTENT_COLUMNS
-        new CsvError('CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH', [
+        new CsvError('CSV_RECORD_INCONSISTENT_COLUMNS', [
           'Invalid Record Length:',
           `columns length is ${columns.length},`, // rename columns
           `got ${recordLength} on line ${this.info.lines}`,
diff --git a/packages/csv-parse/dist/esm/index.d.ts b/packages/csv-parse/dist/esm/index.d.ts
@@ -254,7 +254,7 @@ export type CsvErrorCode =
     | 'CSV_NON_TRIMABLE_CHAR_AFTER_CLOSING_QUOTE'
     | 'CSV_QUOTE_NOT_CLOSED'
     | 'CSV_INCONSISTENT_RECORD_LENGTH'
-    | 'CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH'
+    | 'CSV_RECORD_INCONSISTENT_COLUMNS'
     | 'CSV_OPTION_COLUMNS_MISSING_NAME'
 
 export class CsvError extends Error {
diff --git a/packages/csv-parse/dist/esm/index.js b/packages/csv-parse/dist/esm/index.js
@@ -5885,9 +5885,7 @@ class Parser extends Transform {
           record: record,
         })
         :
-        // Todo: rename CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH to
-        // CSV_RECORD_INCONSISTENT_COLUMNS
-        new CsvError('CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH', [
+        new CsvError('CSV_RECORD_INCONSISTENT_COLUMNS', [
           'Invalid Record Length:',
           `columns length is ${columns.length},`, // rename columns
           `got ${recordLength} on line ${this.info.lines}`,
diff --git a/packages/csv-parse/dist/esm/sync.js b/packages/csv-parse/dist/esm/sync.js
@@ -5885,9 +5885,7 @@ class Parser extends Transform {
           record: record,
         })
         :
-        // Todo: rename CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH to
-        // CSV_RECORD_INCONSISTENT_COLUMNS
-        new CsvError('CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH', [
+        new CsvError('CSV_RECORD_INCONSISTENT_COLUMNS', [
           'Invalid Record Length:',
           `columns length is ${columns.length},`, // rename columns
           `got ${recordLength} on line ${this.info.lines}`,
diff --git a/packages/csv-parse/dist/iife/index.js b/packages/csv-parse/dist/iife/index.js
@@ -5888,9 +5888,7 @@ var csv_parse = (function (exports) {
                       record: record,
                     })
                     :
-                    // Todo: rename CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH to
-                    // CSV_RECORD_INCONSISTENT_COLUMNS
-                    new CsvError('CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH', [
+                    new CsvError('CSV_RECORD_INCONSISTENT_COLUMNS', [
                       'Invalid Record Length:',
                       `columns length is ${columns.length},`, // rename columns
                       `got ${recordLength} on line ${this.info.lines}`,
diff --git a/packages/csv-parse/dist/iife/sync.js b/packages/csv-parse/dist/iife/sync.js
@@ -5888,9 +5888,7 @@ var csv_parse_sync = (function (exports) {
                       record: record,
                     })
                     :
-                    // Todo: rename CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH to
-                    // CSV_RECORD_INCONSISTENT_COLUMNS
-                    new CsvError('CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH', [
+                    new CsvError('CSV_RECORD_INCONSISTENT_COLUMNS', [
                       'Invalid Record Length:',
                       `columns length is ${columns.length},`, // rename columns
                       `got ${recordLength} on line ${this.info.lines}`,
diff --git a/packages/csv-parse/dist/umd/index.js b/packages/csv-parse/dist/umd/index.js
@@ -5891,9 +5891,7 @@
                       record: record,
                     })
                     :
-                    // Todo: rename CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH to
-                    // CSV_RECORD_INCONSISTENT_COLUMNS
-                    new CsvError('CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH', [
+                    new CsvError('CSV_RECORD_INCONSISTENT_COLUMNS', [
                       'Invalid Record Length:',
                       `columns length is ${columns.length},`, // rename columns
                       `got ${recordLength} on line ${this.info.lines}`,
diff --git a/packages/csv-parse/dist/umd/sync.js b/packages/csv-parse/dist/umd/sync.js
@@ -5891,9 +5891,7 @@
                       record: record,
                     })
                     :
-                    // Todo: rename CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH to
-                    // CSV_RECORD_INCONSISTENT_COLUMNS
-                    new CsvError('CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH', [
+                    new CsvError('CSV_RECORD_INCONSISTENT_COLUMNS', [
                       'Invalid Record Length:',
                       `columns length is ${columns.length},`, // rename columns
                       `got ${recordLength} on line ${this.info.lines}`,
diff --git a/packages/csv-parse/lib/index.d.ts b/packages/csv-parse/lib/index.d.ts
@@ -254,7 +254,7 @@ export type CsvErrorCode =
     | 'CSV_NON_TRIMABLE_CHAR_AFTER_CLOSING_QUOTE'
     | 'CSV_QUOTE_NOT_CLOSED'
     | 'CSV_INCONSISTENT_RECORD_LENGTH'
-    | 'CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH'
+    | 'CSV_RECORD_INCONSISTENT_COLUMNS'
     | 'CSV_OPTION_COLUMNS_MISSING_NAME'
 
 export class CsvError extends Error {
diff --git a/packages/csv-parse/lib/index.js b/packages/csv-parse/lib/index.js
@@ -889,9 +889,7 @@ class Parser extends Transform {
           record: record,
         })
         :
-        // Todo: rename CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH to
-        // CSV_RECORD_INCONSISTENT_COLUMNS
-        new CsvError('CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH', [
+        new CsvError('CSV_RECORD_INCONSISTENT_COLUMNS', [
           'Invalid Record Length:',
           `columns length is ${columns.length},`, // rename columns
           `got ${recordLength} on line ${this.info.lines}`,
diff --git a/packages/csv-parse/samples/option.relax_column_count.record_inconsistent_columns.js b/packages/csv-parse/samples/option.relax_column_count.record_inconsistent_columns.js
@@ -7,7 +7,7 @@ const records = parse('1,2\nin:va:lid\n3,4', {
   relax_column_count: true,
   raw: true,
   on_record: ({raw, record}, {error}) => {
-    if(error && error.code === 'CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH'){
+    if(error && error.code === 'CSV_RECORD_INCONSISTENT_COLUMNS'){
       return raw.trim().split(':');
     } else {
       return record;
diff --git a/packages/csv-parse/test/option.columns.coffee b/packages/csv-parse/test/option.columns.coffee
@@ -179,7 +179,7 @@ describe 'Option `columns`', ->
       """, columns: ["a", "b", "c", "d"], (err) ->
         assert_error err,
           message: 'Invalid Record Length: columns length is 4, got 3 on line 1'
-          code: 'CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH'
+          code: 'CSV_RECORD_INCONSISTENT_COLUMNS'
         next()
 
     it 'validate options column length on last line', (next) ->
@@ -190,7 +190,7 @@ describe 'Option `columns`', ->
       """, columns: ["a", "b", "c", "d"], (err) ->
         assert_error err,
           message: 'Invalid Record Length: columns length is 4, got 3 on line 3'
-          code: 'CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH'
+          code: 'CSV_RECORD_INCONSISTENT_COLUMNS'
         next()
     
     it 'context column is null when cast force the context creation', (next) ->
@@ -201,15 +201,15 @@ describe 'Option `columns`', ->
       , (err) ->
         assert_error err,
           message: 'Invalid Record Length: columns length is 1, got 2 on line 2'
-          code: 'CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH'
+          code: 'CSV_RECORD_INCONSISTENT_COLUMNS'
           column: null
         next()
 
     it 'context column is null when columns number inferieur to record length, fix regression #259', (next) ->
       parse "a\nb,\n", columns: true, (err) ->
         assert_error err,
           message: 'Invalid Record Length: columns length is 1, got 2 on line 2'
-          code: 'CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH'
+          code: 'CSV_RECORD_INCONSISTENT_COLUMNS'
           column: null
         next()
     
@@ -268,14 +268,14 @@ describe 'Option `columns`', ->
     it 'last column value ignore when `null`', (next) ->
       # Trigger a bug where error is try to stringify and parse an undefined
       # value, conjointly triggered by a null column and a
-      # CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH error
+      # CSV_RECORD_INCONSISTENT_COLUMNS error
       parse """
       col_a,col_b,col_c
       foo,bar
       foo,bar,baz
       """
       , columns: ['a', 'b', null], (err) ->
-        err.code.should.eql 'CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH'
+        err.code.should.eql 'CSV_RECORD_INCONSISTENT_COLUMNS'
         next()
 
   describe 'function', ->
diff --git a/packages/csv-parse/test/option.relax_column_count.coffee b/packages/csv-parse/test/option.relax_column_count.coffee
@@ -168,7 +168,7 @@ describe 'Option `relax_column_count`', ->
         relax_column_count: true,
         raw: true,
         on_record: ({raw, record}, {error}) ->
-          if error?.code is 'CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH'
+          if error?.code is 'CSV_RECORD_INCONSISTENT_COLUMNS'
             raw.trim().split ':'
           else
             record
diff --git a/packages/csv-parse/test/option.skip_records_with_error.coffee b/packages/csv-parse/test/option.skip_records_with_error.coffee
@@ -85,7 +85,7 @@ describe 'Option `skip_records_with_error`', ->
       '''
     parser.end()
 
-  it 'handle "CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH"', (next) ->
+  it 'handle "CSV_RECORD_INCONSISTENT_COLUMNS"', (next) ->
     errors = 0
     parser = parse skip_records_with_error: true, columns: ["a", "b", "c", "d"], (err, records) ->
       records.should.eql [
@@ -97,7 +97,7 @@ describe 'Option `skip_records_with_error`', ->
     parser.on 'skip', (err) ->
       assert_error err,
         message: 'Invalid Record Length: columns length is 4, got 3 on line 1'
-        code: 'CSV_RECORD_DONT_MATCH_COLUMNS_LENGTH'
+        code: 'CSV_RECORD_INCONSISTENT_COLUMNS'
         record: ['1', '2', '3']
       errors++
     parser.write '''
