diff --git a/dist/index.js b/dist/index.js index c8ebebb..e61484e 100644 --- a/dist/index.js +++ b/dist/index.js @@ -4634,7 +4634,7 @@ class Parser extends Transform { }else{ throw new CsvError('CSV_INVALID_OPTION_COLUMNS', [ 'Invalid option columns:', - 'expect an object, a function or true,', + 'expect an array, a function or true,', `got ${JSON.stringify(options.columns)}` ], options) } @@ -4647,6 +4647,11 @@ class Parser extends Transform { 'expect an boolean,', `got ${JSON.stringify(options.columns_duplicates_to_array)}` ], options) + }else if(options.columns === false){ + throw new CsvError('CSV_INVALID_OPTION_COLUMNS_DUPLICATES_TO_ARRAY', [ + 'Invalid option columns_duplicates_to_array:', + 'the `columns` mode must be activated.' + ], options) } // Normalize option `comment` if(options.comment === undefined || options.comment === null || options.comment === false || options.comment === ''){ @@ -4961,10 +4966,10 @@ class Parser extends Transform { escaping: false, // escapeIsQuote: options.escape === options.quote, escapeIsQuote: Buffer.isBuffer(options.escape) && Buffer.isBuffer(options.quote) && Buffer.compare(options.escape, options.quote) === 0, - expectedRecordLength: options.columns === null ? 0 : options.columns.length, + // columns can be `false`, `true`, `Array` + expectedRecordLength: Array.isArray(options.columns) ? options.columns.length : undefined, field: new ResizeableBuffer(20), firstLineToHeaders: fnFirstLineToHeaders, - info: Object.assign({}, this.info), needMoreDataSize: Math.max( // Skip if the remaining buffer smaller than comment options.comment !== null ? options.comment.length : 0, @@ -5007,7 +5012,7 @@ class Parser extends Transform { } // Central parser implementation __parse(nextBuf, end){ - const {bom, comment, escape, from_line, info, ltrim, max_record_size, quote, raw, relax, rtrim, skip_empty_lines, to, to_line} = this.options + const {bom, comment, escape, from_line, ltrim, max_record_size, quote, raw, relax, rtrim, skip_empty_lines, to, to_line} = this.options let {record_delimiter} = this.options const {bomSkipped, previousBuf, rawBuffer, escapeIsQuote} = this.state let buf @@ -5058,9 +5063,6 @@ class Parser extends Transform { } if(this.state.wasRowDelimiter === true){ this.info.lines++ - if(info === true && this.state.record.length === 0 && this.state.field.length === 0 && this.state.wasQuoting === false){ - this.state.info = Object.assign({}, this.info) - } this.state.wasRowDelimiter = false } if(to_line !== -1 && this.info.lines > to_line){ @@ -5129,7 +5131,7 @@ class Parser extends Transform { `at line ${this.info.lines}`, 'instead of delimiter, record delimiter, trimable character', '(if activated) or comment', - ], this.options, this.__context()) + ], this.options, this.__infoField()) ) if(err !== undefined) return err }else{ @@ -5146,7 +5148,7 @@ class Parser extends Transform { new CsvError('INVALID_OPENING_QUOTE', [ 'Invalid Opening Quote:', `a quote is found inside a field at line ${this.info.lines}`, - ], this.options, this.__context(), { + ], this.options, this.__infoField(), { field: this.state.field, }) ) @@ -5221,12 +5223,11 @@ class Parser extends Transform { 'record exceed the maximum number of tolerated bytes', `of ${max_record_size}`, `at line ${this.info.lines}`, - ], this.options, this.__context()) + ], this.options, this.__infoField()) ) if(err !== undefined) return err } } - const lappend = ltrim === false || this.state.quoting === true || this.state.field.length !== 0 || !this.__isCharTrimable(chr) // rtrim in non quoting is handle in __onField const rappend = rtrim === false || this.state.wasQuoting === false @@ -5238,7 +5239,7 @@ class Parser extends Transform { 'Invalid Closing Quote:', 'found non trimable byte after quote', `at line ${this.info.lines}`, - ], this.options, this.__context()) + ], this.options, this.__infoField()) ) if(err !== undefined) return err } @@ -5250,7 +5251,7 @@ class Parser extends Transform { new CsvError('CSV_QUOTE_NOT_CLOSED', [ 'Quote Not Closed:', `the parsing is finished with an opening quote at line ${this.info.lines}`, - ], this.options, this.__context()) + ], this.options, this.__infoField()) ) if(err !== undefined) return err }else{ @@ -5283,7 +5284,7 @@ class Parser extends Transform { // Convert the first line into column names const recordLength = record.length if(columns === true){ - if(isRecordEmpty(record)){ + if(skip_lines_with_empty_values === true && isRecordEmpty(record)){ this.__resetRecord() return } @@ -5300,7 +5301,7 @@ class Parser extends Transform { 'Invalid Record Length:', `expect ${this.state.expectedRecordLength},`, `got ${recordLength} on line ${this.info.lines}`, - ], this.options, this.__context(), { + ], this.options, this.__infoField(), { record: record, }) : @@ -5310,7 +5311,7 @@ class Parser extends Transform { 'Invalid Record Length:', `columns length is ${columns.length},`, // rename columns `got ${recordLength} on line ${this.info.lines}`, - ], this.options, this.__context(), { + ], this.options, this.__infoField(), { record: record, }) if(relax_column_count === true || @@ -5324,11 +5325,9 @@ class Parser extends Transform { if(finalErr) return finalErr } } - if(skip_lines_with_empty_values === true){ - if(isRecordEmpty(record)){ - this.__resetRecord() - return - } + if(skip_lines_with_empty_values === true && isRecordEmpty(record)){ + this.__resetRecord() + return } if(this.state.recordHasError === true){ this.__resetRecord() @@ -5337,6 +5336,7 @@ class Parser extends Transform { } this.info.records++ if(from === 1 || this.info.records >= from){ + // With columns, records are object if(columns !== false){ const obj = {} // Transform record array to an object @@ -5354,12 +5354,13 @@ class Parser extends Transform { } } const {objname} = this.options + // Without objname (default) if(objname === undefined){ if(raw === true || info === true){ const err = this.__push(Object.assign( {record: obj}, (raw === true ? {raw: this.state.rawBuffer.toString(encoding)}: {}), - (info === true ? {info: this.state.info}: {}) + (info === true ? {info: this.__infoRecord()}: {}) )) if(err){ return err @@ -5370,12 +5371,13 @@ class Parser extends Transform { return err } } + // With objname (default) }else{ if(raw === true || info === true){ const err = this.__push(Object.assign( {record: [obj[objname], obj]}, raw === true ? {raw: this.state.rawBuffer.toString(encoding)}: {}, - info === true ? {info: this.state.info}: {} + info === true ? {info: this.__infoRecord()}: {} )) if(err){ return err @@ -5387,12 +5389,13 @@ class Parser extends Transform { } } } + // Without columns, records are array }else{ if(raw === true || info === true){ const err = this.__push(Object.assign( {record: record}, raw === true ? {raw: this.state.rawBuffer.toString(encoding)}: {}, - info === true ? {info: this.state.info}: {} + info === true ? {info: this.__infoRecord()}: {} )) if(err){ return err @@ -5417,7 +5420,7 @@ class Parser extends Transform { 'Invalid Column Mapping:', 'expect an array from column function,', `got ${JSON.stringify(headers)}` - ], this.options, this.__context(), { + ], this.options, this.__infoField(), { headers: headers, }) ) @@ -5443,7 +5446,7 @@ class Parser extends Transform { const {cast, encoding, rtrim, max_record_size} = this.options const {enabled, wasQuoting} = this.state // Short circuit for the from_line options - if(enabled === false){ /* this.options.columns !== true && */ + if(enabled === false){ return this.__resetField() } let field = this.state.field.toString(encoding) @@ -5469,9 +5472,9 @@ class Parser extends Transform { __push(record){ const {on_record} = this.options if(on_record !== undefined){ - const context = this.__context() + const info = this.__infoRecord() try{ - record = on_record.call(null, record, context) + record = on_record.call(null, record, info) }catch(err){ return err } @@ -5489,10 +5492,10 @@ class Parser extends Transform { if( isColumns === true && relax_column_count && this.options.columns.length <= this.state.record.length ){ return [undefined, undefined] } - const context = this.__context() if(this.state.castField !== null){ try{ - return [undefined, this.state.castField.call(null, field, context)] + const info = this.__infoField() + return [undefined, this.state.castField.call(null, field, info)] }catch(err){ return [err] } @@ -5500,7 +5503,8 @@ class Parser extends Transform { if(this.__isFloat(field)){ return [undefined, parseFloat(field)] }else if(this.options.cast_date !== false){ - return [undefined, this.options.cast_date.call(null, field, context)] + const info = this.__infoField() + return [undefined, this.options.cast_date.call(null, field, info)] } return [undefined, field] } @@ -5632,24 +5636,33 @@ class Parser extends Transform { return err } } - __context(){ + __infoDataSet(){ + return { + ...this.info, + columns: this.options.columns + } + } + __infoRecord(){ + const {columns} = this.options + return { + ...this.__infoDataSet(), + error: this.state.error, + header: columns === true, + index: this.state.record.length, + } + } + __infoField(){ const {columns} = this.options const isColumns = Array.isArray(columns) return { + ...this.__infoRecord(), column: isColumns === true ? ( columns.length > this.state.record.length ? columns[this.state.record.length].name : null ) : this.state.record.length, - empty_lines: this.info.empty_lines, - error: this.state.error, - header: columns === true, - index: this.state.record.length, - invalid_field_length: this.info.invalid_field_length, quoting: this.state.wasQuoting, - lines: this.info.lines, - records: this.info.records } } } @@ -5686,10 +5699,10 @@ const parse = function(){ } }) parser.on('error', function(err){ - callback(err, undefined, parser.info) + callback(err, undefined, parser.__infoDataSet()) }) parser.on('end', function(){ - callback(undefined, records, parser.info) + callback(undefined, records, parser.__infoDataSet()) }) } if(data !== undefined){ diff --git a/package.json b/package.json index f132c2e..2e06e73 100644 --- a/package.json +++ b/package.json @@ -30,7 +30,7 @@ "dependencies": { "@actions/core": "^1.4.0", "@actions/exec": "^1.1.0", - "csv-parse": "^4.15.4", + "csv-parse": "^4.16.0", "semver": "^7.3.5" }, "devDependencies": { diff --git a/yarn.lock b/yarn.lock index d1c70e2..abc4a46 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1114,10 +1114,10 @@ cssstyle@^2.2.0: dependencies: cssom "~0.3.6" -csv-parse@^4.15.4: - version "4.15.4" - resolved "https://registry.yarnpkg.com/csv-parse/-/csv-parse-4.15.4.tgz#ad1ec62aaf71a642982dfcb81f1848184d691db5" - integrity sha512-OdBbFc0yZhOm17lSxqkirrHlFFVpKRT0wp4DAGoJelsP3LbGzV9LNr7XmM/lrr0uGkCtaqac9UhP8PDHXOAbMg== +csv-parse@^4.16.0: + version "4.16.0" + resolved "https://registry.yarnpkg.com/csv-parse/-/csv-parse-4.16.0.tgz#b4c875e288a41f7ff917cb0d7d45880d563034f6" + integrity sha512-Zb4tGPANH4SW0LgC9+s9Mnequs9aqn7N3/pCqNbVjs2XhEF6yWNU2Vm4OGl1v2Go9nw8rXt87Cm2QN/o6Vpqgg== dashdash@^1.12.0: version "1.14.1"