Skip to content

Commit 2b9f6e3

Browse files
mrodrigmrodrig
authored
Merge pull request #268 from mrodrig/fix-265
Fix 265
2 parents 9551140 + 2155500 commit 2b9f6e3

File tree

8 files changed

+113
-63
lines changed

8 files changed

+113
-63
lines changed

‎package-lock.json‎

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
"compile": "tsc -p tsconfig.build.json",
2222
"coverage": "nyc npm run test",
2323
"lint": "eslint --ext .js,.ts src test",
24+
"lint:fix": "eslint --fix --ext .js,.ts src test",
2425
"prepublishOnly": "npm run build",
2526
"test": "mocha -r ts-node/register test/index.ts"
2627
},
@@ -59,4 +60,4 @@
5960
"node": ">= 16"
6061
},
6162
"license": "MIT"
62-
}
63+
}

‎src/csv2json.ts‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { excelBOM } from './constants';
55
import type { Csv2JsonParams, FullCsv2JsonOptions, HeaderField } from './types';
66
import * as utils from './utils';
77

8-
export const Csv2Json = function(options: FullCsv2JsonOptions) {
8+
export const Csv2Json = function (options: FullCsv2JsonOptions) {
99
const escapedWrapDelimiterRegex = new RegExp(options.delimiter.wrap + options.delimiter.wrap, 'g'),
1010
excelBOMRegex = new RegExp('^' + excelBOM),
1111
valueParserFn = options.parseValue && typeof options.parseValue === 'function' ? options.parseValue : JSON.parse;
@@ -166,9 +166,18 @@ export const Csv2Json = function(options: FullCsv2JsonOptions) {
166166
if (utils.getNCharacters(csv, index + 1, eolDelimiterLength) === options.delimiter.eol) {
167167
index += options.delimiter.eol.length + 1; // Skip past EOL
168168
}
169-
}
170-
171-
else if ((charBefore !== options.delimiter.wrap || stateVariables.justParsedDoubleQuote && charBefore === options.delimiter.wrap) &&
169+
} else if (charBefore === options.delimiter.field && character === options.delimiter.wrap && charAfter === options.delimiter.eol) {
170+
// We reached the start of a wrapped new field that begins with an EOL delimiter
171+
172+
// Retrieve the remaining value and add it to the split line list of values
173+
splitLine.push(csv.substring(stateVariables.startIndex, index - 1));
174+
175+
stateVariables.startIndex = index;
176+
stateVariables.parsingValue = true;
177+
stateVariables.insideWrapDelimiter = true;
178+
stateVariables.justParsedDoubleQuote = true;
179+
index += 1;
180+
} else if ((charBefore !== options.delimiter.wrap || stateVariables.justParsedDoubleQuote && charBefore === options.delimiter.wrap) &&
172181
character === options.delimiter.wrap && utils.getNCharacters(csv, index + 1, eolDelimiterLength) === options.delimiter.eol) {
173182
// If we reach a wrap which is not preceded by a wrap delim and the next character is an EOL delim (ie. *"\n)
174183

‎test/config/testCsvFilesList.ts‎

Lines changed: 55 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -2,60 +2,61 @@ import { readFileSync } from 'fs';
22
import path from 'path';
33

44
const csvFileConfig = [
5-
{key: 'noData', file: '../data/csv/noData.csv'},
6-
{key: 'singleDocument', file: '../data/csv/singleDocument.csv'},
7-
{key: 'array', file: '../data/csv/array.csv'},
8-
{key: 'arrayObjects', file: '../data/csv/arrayObjects.csv'},
9-
{key: 'arrayMixedObjNonObj', file: '../data/csv/arrayMixedObjNonObj.csv'},
10-
{key: 'arraySingleArray', file: '../data/csv/arraySingleArray.csv'},
11-
{key: 'date', file: '../data/csv/date.csv'},
12-
{key: 'null', file: '../data/csv/null.csv'},
13-
{key: 'undefined', file: '../data/csv/undefined.csv'},
14-
{key: 'nested', file: '../data/csv/nested.csv'},
15-
{key: 'nestedMissingField', file: '../data/csv/nestedMissingField.csv'},
16-
{key: 'comma', file: '../data/csv/comma.csv'},
17-
{key: 'quotes', file: '../data/csv/quotes.csv'},
18-
{key: 'quotesHeader', file: '../data/csv/quotesHeader.csv'},
19-
{key: 'quotesAndCommas', file: '../data/csv/quotesAndCommas.csv'},
20-
{key: 'eol', file: '../data/csv/eol.csv'},
21-
{key: 'assortedValues', file: '../data/csv/assortedValues.csv'},
22-
{key: 'trimFields', file: '../data/csv/trimFields.csv'},
23-
{key: 'trimmedFields', file: '../data/csv/trimmedFields.csv'},
24-
{key: 'trimHeader', file: '../data/csv/trimHeader.csv'},
25-
{key: 'trimmedHeader', file: '../data/csv/trimmedHeader.csv'},
26-
{key: 'excelBOM', file: '../data/csv/excelBOM.csv'},
27-
{key: 'specifiedKeys', file: '../data/csv/specifiedKeys.csv'},
28-
{key: 'specifiedKeysNoData', file: '../data/csv/specifiedKeysNoData.csv'},
29-
{key: 'extraLine', file: '../data/csv/extraLine.csv'},
30-
{key: 'noHeader', file: '../data/csv/noHeader.csv'},
31-
{key: 'sortedHeader', file: '../data/csv/sortedHeader.csv'},
32-
{key: 'sortedHeaderCustom', file: '../data/csv/sortedHeaderCustom.csv'},
33-
{key: 'emptyFieldValues', file: '../data/csv/emptyFieldValues.csv'},
34-
{key: 'quotedEmptyFieldValue', file: '../data/csv/quotedEmptyFieldValue.csv'},
35-
{key: 'csvEmptyLastValue', file: '../data/csv/csvEmptyLastValue.csv'},
36-
{key: 'unwind', file: '../data/csv/unwind.csv'},
37-
{key: 'unwindEmptyArray', file: '../data/csv/unwindEmptyArray.csv'},
38-
{key: 'unwindWithSpecifiedKeys', file: '../data/csv/unwindWithSpecifiedKeys.csv'},
39-
{key: 'withSpecifiedKeys', file: '../data/csv/withSpecifiedKeys.csv'},
40-
{key: 'localeFormat', file: '../data/csv/localeFormat.csv'},
41-
{key: 'invalidParsedValues', file: '../data/csv/invalidParsedValues.csv'},
42-
{key: 'firstColumnWrapCRLF', file: '../data/csv/firstColumnWrapCRLF.csv'},
43-
{key: 'emptyLastFieldValue', file: '../data/csv/emptyLastFieldValue.csv'},
44-
{key: 'emptyLastFieldValueNoEol', file: '../data/csv/emptyLastFieldValueNoEol.csv'},
45-
{key: 'lastCharFieldDelimiter', file: '../data/csv/lastCharFieldDelimiter.csv'},
46-
{key: 'nativeMapMethod', file: '../data/csv/nativeMapMethod.csv'},
47-
{key: 'nestedDotKeys', file: '../data/csv/nestedDotKeys.csv'},
48-
{key: 'nestedDotKeysWithArray', file: '../data/csv/nestedDotKeysWithArray.csv'},
49-
{key: 'nestedDotKeysWithArrayExpandedUnwound', file: '../data/csv/nestedDotKeysWithArrayExpandedUnwound.csv'},
50-
{key: 'emptyColumns', file: '../data/csv/emptyColumns.csv'},
51-
{key: 'quotedFieldWithNewline', file: '../data/csv/quotedFieldWithNewline.csv'},
52-
{key: 'falsyValues', file: '../data/csv/falsyValues.csv'},
53-
{key: 'nestedNotUnwoundObjects', file: '../data/csv/nestedNotUnwoundObjects.csv'},
54-
{key: 'newlineWithWrapDelimiters', file: '../data/csv/newlineWithWrapDelimiters.csv'},
55-
{key: 'excludeKeyPattern', file: '../data/csv/excludeKeyPattern.csv'},
56-
{key: 'wildcardMatch', file: '../data/csv/wildcardMatch.csv'},
57-
{key: 'arrayIndexesAsKeys', file: '../data/csv/arrayIndexesAsKeys.csv'},
58-
{key: 'keyWithEndingDot', file:'../data/csv/keyWithEndingDot.csv'},
5+
{ key: 'noData', file: '../data/csv/noData.csv' },
6+
{ key: 'singleDocument', file: '../data/csv/singleDocument.csv' },
7+
{ key: 'array', file: '../data/csv/array.csv' },
8+
{ key: 'arrayObjects', file: '../data/csv/arrayObjects.csv' },
9+
{ key: 'arrayMixedObjNonObj', file: '../data/csv/arrayMixedObjNonObj.csv' },
10+
{ key: 'arraySingleArray', file: '../data/csv/arraySingleArray.csv' },
11+
{ key: 'date', file: '../data/csv/date.csv' },
12+
{ key: 'null', file: '../data/csv/null.csv' },
13+
{ key: 'undefined', file: '../data/csv/undefined.csv' },
14+
{ key: 'nested', file: '../data/csv/nested.csv' },
15+
{ key: 'nestedMissingField', file: '../data/csv/nestedMissingField.csv' },
16+
{ key: 'comma', file: '../data/csv/comma.csv' },
17+
{ key: 'quotes', file: '../data/csv/quotes.csv' },
18+
{ key: 'quotesHeader', file: '../data/csv/quotesHeader.csv' },
19+
{ key: 'quotesAndCommas', file: '../data/csv/quotesAndCommas.csv' },
20+
{ key: 'eol', file: '../data/csv/eol.csv' },
21+
{ key: 'assortedValues', file: '../data/csv/assortedValues.csv' },
22+
{ key: 'trimFields', file: '../data/csv/trimFields.csv' },
23+
{ key: 'trimmedFields', file: '../data/csv/trimmedFields.csv' },
24+
{ key: 'trimHeader', file: '../data/csv/trimHeader.csv' },
25+
{ key: 'trimmedHeader', file: '../data/csv/trimmedHeader.csv' },
26+
{ key: 'excelBOM', file: '../data/csv/excelBOM.csv' },
27+
{ key: 'specifiedKeys', file: '../data/csv/specifiedKeys.csv' },
28+
{ key: 'specifiedKeysNoData', file: '../data/csv/specifiedKeysNoData.csv' },
29+
{ key: 'extraLine', file: '../data/csv/extraLine.csv' },
30+
{ key: 'noHeader', file: '../data/csv/noHeader.csv' },
31+
{ key: 'sortedHeader', file: '../data/csv/sortedHeader.csv' },
32+
{ key: 'sortedHeaderCustom', file: '../data/csv/sortedHeaderCustom.csv' },
33+
{ key: 'emptyFieldValues', file: '../data/csv/emptyFieldValues.csv' },
34+
{ key: 'quotedEmptyFieldValue', file: '../data/csv/quotedEmptyFieldValue.csv' },
35+
{ key: 'csvEmptyLastValue', file: '../data/csv/csvEmptyLastValue.csv' },
36+
{ key: 'unwind', file: '../data/csv/unwind.csv' },
37+
{ key: 'unwindEmptyArray', file: '../data/csv/unwindEmptyArray.csv' },
38+
{ key: 'unwindWithSpecifiedKeys', file: '../data/csv/unwindWithSpecifiedKeys.csv' },
39+
{ key: 'withSpecifiedKeys', file: '../data/csv/withSpecifiedKeys.csv' },
40+
{ key: 'localeFormat', file: '../data/csv/localeFormat.csv' },
41+
{ key: 'invalidParsedValues', file: '../data/csv/invalidParsedValues.csv' },
42+
{ key: 'firstColumnWrapCRLF', file: '../data/csv/firstColumnWrapCRLF.csv' },
43+
{ key: 'emptyLastFieldValue', file: '../data/csv/emptyLastFieldValue.csv' },
44+
{ key: 'emptyLastFieldValueNoEol', file: '../data/csv/emptyLastFieldValueNoEol.csv' },
45+
{ key: 'lastCharFieldDelimiter', file: '../data/csv/lastCharFieldDelimiter.csv' },
46+
{ key: 'nativeMapMethod', file: '../data/csv/nativeMapMethod.csv' },
47+
{ key: 'nestedDotKeys', file: '../data/csv/nestedDotKeys.csv' },
48+
{ key: 'nestedDotKeysWithArray', file: '../data/csv/nestedDotKeysWithArray.csv' },
49+
{ key: 'nestedDotKeysWithArrayExpandedUnwound', file: '../data/csv/nestedDotKeysWithArrayExpandedUnwound.csv' },
50+
{ key: 'emptyColumns', file: '../data/csv/emptyColumns.csv' },
51+
{ key: 'quotedFieldWithNewline', file: '../data/csv/quotedFieldWithNewline.csv' },
52+
{ key: 'falsyValues', file: '../data/csv/falsyValues.csv' },
53+
{ key: 'nestedNotUnwoundObjects', file: '../data/csv/nestedNotUnwoundObjects.csv' },
54+
{ key: 'newlineWithWrapDelimiters', file: '../data/csv/newlineWithWrapDelimiters.csv' },
55+
{ key: 'excludeKeyPattern', file: '../data/csv/excludeKeyPattern.csv' },
56+
{ key: 'wildcardMatch', file: '../data/csv/wildcardMatch.csv' },
57+
{ key: 'arrayIndexesAsKeys', file: '../data/csv/arrayIndexesAsKeys.csv' },
58+
{ key: 'keyWithEndingDot', file: '../data/csv/keyWithEndingDot.csv' },
59+
{ key: 'fieldEolAtStart', file: '../data/csv/fieldEolAtStart.csv' },
5960
];
6061

6162
function readCsvFile(filePath: string) {

‎test/config/testJsonFilesList.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,5 @@ export default {
4848
wildcardMatch: require('../data/json/wildcardMatch.json'),
4949
arrayIndexesAsKeys: require('../data/json/arrayIndexesAsKeys.json'),
5050
keyWithEndingDot: require('../data/json/keyWithEndingDot.json'),
51+
fieldEolAtStart: require('../data/json/fieldEolAtStart.json'),
5152
};

‎test/csv2json.ts‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ export function runTests() {
6262

6363
it('should convert csv representing nested json with a missing field to the correct json structure', () => {
6464
const json = csv2json(csvTestData.nestedMissingField);
65-
jsonTestData.nestedMissingField[0].level1.level2.level3 = {level: null};
65+
jsonTestData.nestedMissingField[0].level1.level2.level3 = { level: null };
6666
assert.deepEqual(json, jsonTestData.nestedMissingField);
6767
});
6868

@@ -177,6 +177,12 @@ export function runTests() {
177177
const json = csv2json(csvTestData.keyWithEndingDot);
178178
assert.deepEqual(json, jsonTestData.keyWithEndingDot);
179179
});
180+
181+
// Test case for #265
182+
it('should handle fields starting with an EOL delimiter', () => {
183+
const json = csv2json(csvTestData.fieldEolAtStart);
184+
assert.deepEqual(json, jsonTestData.fieldEolAtStart);
185+
});
180186
});
181187

182188
describe('Error Handling', () => {

‎test/data/csv/fieldEolAtStart.csv‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
id,name,age,city
2+
1,John Doe,29,New York
3+
2,Jane Smith,34,"
4+
Los Angeles"
5+
3,Emily Davis,22,Chicago
6+
4,Michael Brown,40,Houston

‎test/data/json/fieldEolAtStart.json‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
[
2+
{
3+
"id": 1,
4+
"name": "John Doe",
5+
"age": 29,
6+
"city": "New York"
7+
},
8+
{
9+
"id": 2,
10+
"name": "Jane Smith",
11+
"age": 34,
12+
"city": "\n Los Angeles"
13+
},
14+
{
15+
"id": 3,
16+
"name": "Emily Davis",
17+
"age": 22,
18+
"city": "Chicago"
19+
},
20+
{
21+
"id": 4,
22+
"name": "Michael Brown",
23+
"age": 40,
24+
"city": "Houston"
25+
}
26+
]

0 commit comments

Comments
 (0)