csv-to-ndjson 1.0.0 → 2.0.0

package/README.md

@@ -1,10 +1,12 @@
-# csv-to-ndjson [![Build Status](https://travis-ci.org/SimonJang/csv-to-ndjson.svg?branch=master)](https://travis-ci.org/SimonJang/csv-to-ndjson)
+# csv-to-ndjson [![CI](https://github.com/SimonJang/csv-to-ndjson/actions/workflows/ci.yml/badge.svg?branch=master&event=push)](https://github.com/SimonJang/csv-to-ndjson/actions/workflows/ci.yml?query=branch%3Amaster+event%3Apush)
 
 > Convert a CSV file to [ndjson](http://ndjson.org/) format stream or file.
 
 
 ## Install
 
+Requires Node.js 26 or later.
+
 ```
 $ npm install csv-to-ndjson
 ```
@@ -15,20 +17,35 @@ $ npm install csv-to-ndjson
 ```js
 const csvToNdjson = require('csv-to-ndjson');
 
-csvToNdjson('financialdata.csv', {
-	delimiter: ';'
+const ndjsonStream = csvToNdjson('financialdata.csv', {
+	delimiter: ';',
 	header: ['Q1', 'Q2', 'Q3', 'Q4']
-}).pipe(// Some pipe operation);
+});
+ndjsonStream.pipe(process.stdout);
 // => Returns a readable stream of ndjson
 
 csvToNdjson('financialdata.csv', {
 	delimiter: ';',
 	destination: 'financialdata.json',
 	header: ['Q1', 'Q2', 'Q3', 'Q4']
-}).then(succes => // do something on success)
+}).then(() => {
+	// The destination file has been written.
+});
 // => Returns a promise when the file is written
 ```
 
+Both the returned stream and destination file contain one JSON object per line.
+Each record ends with LF (`\n`) on every platform, including Windows.
+
+## Migrating to 2.0.0
+
+- Node.js 26 or later is required. Earlier Node.js versions are no longer supported.
+- On Windows, output now uses LF (`\n`) instead of CRLF (`\r\n`). Update consumers
+  that compare exact bytes or split records using the platform's line ending.
+- CSV parsing errors now follow csv-parse 7. If you inspect error codes or messages,
+  update those checks; inconsistent field counts use
+  `CSV_RECORD_INCONSISTENT_FIELDS_LENGTH`.
+
 ## API
 
 ### csvToNdjson(input, [options])
@@ -37,7 +54,7 @@ csvToNdjson('financialdata.csv', {
 
 Type: `string`
 
-Path of the CSV file to be read. The file has to end with the `.csv` file extenstion.
+Path of the CSV file to be read. The file has to end with the `.csv` file extension.
 
 #### options
 

package/index.js

@@ -1,13 +1,36 @@
 'use strict';
-const fs = require('fs');
-const eol = require('os').EOL;
-const csv = require('csv');
+const fs = require('node:fs');
+const Transform = require('node:stream').Transform;
 const isValidPath = require('is-valid-path');
-const pify = require('pify');
+const {parse} = require('csv-parse');
 
-const validateHeader = header => header.filter(x => typeof x !== 'string').length === 0;
+const validateHeader = header => {
+	for (let index = 0; index < header.length; index++) {
+		if (typeof header[index] !== 'string') {
+			return false;
+		}
+	}
+
+	return true;
+};
 const delimiters = [',', ';'];
-const pattern = /(.*?)\.(csv)/i;
+const pattern = /\.csv$/i;
+
+const teardown = streams => {
+	for (const stream of streams) {
+		if (typeof stream.unpipe === 'function') {
+			stream.unpipe();
+		}
+	}
+
+	for (const stream of streams) {
+		if (typeof stream.destroy === 'function') {
+			stream.destroy();
+		} else if (typeof stream.end === 'function') {
+			stream.end();
+		}
+	}
+};
 
 module.exports = (path, options) => {
 	let getHeader = false;
@@ -46,32 +69,98 @@ module.exports = (path, options) => {
 		}
 	}
 
-	try {
-		const stream = fs.createReadStream(path)
-			.pipe(csv.parse({delimiter: options && options.delimiter ? options.delimiter : ','}))
-			.pipe(csv.transform(record => {
-				const result = {};
+	const source = fs.createReadStream(path);
+	const parser = parse({
+		bom: true,
+		delimiter: options && options.delimiter ? options.delimiter : ',',
+		relax_column_count_less: true,
+		on_record(record, {error}) {
+			// Preserve the legacy parser's exception for a single empty field.
+			if (error && !(record.length === 1 && record[0] === '')) {
+				throw error;
+			}
+			return record;
+		}
+	});
+	const stream = new Transform({objectMode: true});
+	stream._transform = (record, encoding, callback) => {
+		try {
+			const result = Object.create(null);
 
-				if (!getHeader) {
-					getHeader = true;
-					csvHeader = record.map(item => item.toLowerCase());
-					return;
-				}
+			if (!getHeader) {
+				getHeader = true;
+				csvHeader = record.map(item => item.toLowerCase());
+				callback();
+				return;
+			}
+
+			for (const attribute of csvHeader) {
+				result[attribute] = record[csvHeader.indexOf(attribute)];
+			}
+			callback(null, JSON.stringify(result) + '\n');
+		} catch (error) {
+			callback(error);
+		}
+	};
 
-				for (const attribute of csvHeader) {
-					result[attribute] = record[csvHeader.indexOf(attribute)];
+	if (options && options.destination) {
+		const destination = fs.createWriteStream(options.destination);
+		const completion = new Promise((resolve, reject) => {
+			let settled = false;
+			const fail = error => {
+				if (!settled) {
+					settled = true;
+					teardown([source, parser, stream, destination]);
+					reject(error);
+				}
+			};
+			const finish = () => {
+				if (!settled) {
+					settled = true;
+					resolve();
 				}
-				return JSON.stringify(result) + eol;
-			}));
+			};
 
-		if (options && options.destination) {
-			stream.pipe(fs.createWriteStream(options.destination));
-			return pify(stream).on('end');
-		}
+			source.on('error', fail);
+			parser.on('error', fail);
+			stream.on('error', fail);
+			destination.on('error', fail);
+			destination.on('finish', finish);
+		});
 
-		return stream;
-	} catch (err) {
-		console.error(err);
-		throw new Error('Tranforming CSV to ndjson failed');
+		source.pipe(parser).pipe(stream).pipe(destination);
+		return completion;
 	}
+
+	let completed = false;
+	let failed = false;
+	const forwardFailure = error => {
+		if (!failed) {
+			failed = true;
+			teardown([source, parser, stream]);
+			stream.emit('error', error);
+		}
+	};
+	const closeOnTransformFailure = () => {
+		if (!failed) {
+			failed = true;
+			teardown([source, parser, stream]);
+		}
+	};
+	const closeUpstreamOnCancellation = () => {
+		if (!completed && !failed) {
+			failed = true;
+			teardown([source, parser]);
+		}
+	};
+
+	source.on('error', forwardFailure);
+	parser.on('error', forwardFailure);
+	stream.on('end', () => {
+		completed = true;
+	});
+	stream.on('error', closeOnTransformFailure);
+	stream.on('close', closeUpstreamOnCancellation);
+	source.pipe(parser).pipe(stream);
+	return stream;
 };

package/package.json

@@ -1,19 +1,24 @@
 {
   "name": "csv-to-ndjson",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Convert a CSV file to ndjson format stream",
   "license": "MIT",
-  "repository": "SimonJang/csv-to-ndjson",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SimonJang/csv-to-ndjson.git"
+  },
+  "packageManager": "npm@12.0.1",
   "author": {
     "name": "Simon",
     "email": "simon.jang.contact@gmail.com",
     "url": "github.com/SimonJang"
   },
   "engines": {
-    "node": ">=4"
+    "node": ">=26"
   },
   "scripts": {
-    "test": "xo && ava"
+    "test": "node --test",
+    "prepublishOnly": "npm test"
   },
   "files": [
     "index.js"
@@ -26,14 +31,7 @@
     "file"
   ],
   "dependencies": {
-    "csv": "^1.1.1",
-    "is-valid-path": "^0.1.1",
-    "pify": "^3.0.0"
-  },
-  "devDependencies": {
-    "ava": "^0.20.0",
-    "get-stream": "^3.0.0",
-    "tempy": "^0.1.0",
-    "xo": "^0.18.2"
+    "csv-parse": "^7.0.2",
+    "is-valid-path": "^0.1.1"
   }
 }