Respect trailing newline at the end of the file (#27)

Co-authored-by: Sindre Sorhus <[email protected]>
sindresorhus · Jul 30, 2019 · 7257ebb · 7257ebb
1 parent 5b66b0e
commit 7257ebb
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 16 deletions.
diff --git a/index.js b/index.js
@@ -10,6 +10,8 @@ const isPlainObj = require('is-plain-obj');
 
 const readFile = promisify(fs.readFile);
 
+const hasTrailingNewline = file => /\n$/.test(file);
+
 const init = (fn, filePath, data, options) => {
 	if (!filePath) {
 		throw new TypeError('Expected a filepath');
@@ -37,40 +39,48 @@ const init = (fn, filePath, data, options) => {
 
 const main = async (filePath, data, options) => {
 	let {indent} = options;
+	let trailingNewline = '\n';
+	try {
+		const file = await readFile(filePath, 'utf8');
+		if (!hasTrailingNewline(file)) {
+			trailingNewline = '';
+		}
 
-	if (options.detectIndent) {
-		try {
-			const file = await readFile(filePath, 'utf8');
+		if (options.detectIndent) {
 			indent = detectIndent(file).indent;
-		} catch (error) {
-			if (error.code !== 'ENOENT') {
-				throw error;
-			}
+		}
+	} catch (error) {
+		if (error.code !== 'ENOENT') {
+			throw error;
 		}
 	}
 
 	const json = JSON.stringify(data, options.replacer, indent);
 
-	return writeFileAtomic(filePath, `${json}\n`, {mode: options.mode});
+	return writeFileAtomic(filePath, `${json}${trailingNewline}`, {mode: options.mode});
 };
 
 const mainSync = (filePath, data, options) => {
 	let {indent} = options;
+	let trailingNewline = '\n';
+	try {
+		const file = fs.readFileSync(filePath, 'utf8');
+		if (!hasTrailingNewline(file)) {
+			trailingNewline = '';
+		}
 
-	if (options.detectIndent) {
-		try {
-			const file = fs.readFileSync(filePath, 'utf8');
+		if (options.detectIndent) {
 			indent = detectIndent(file).indent;
-		} catch (error) {
-			if (error.code !== 'ENOENT') {
-				throw error;
-			}
+		}
+	} catch (error) {
+		if (error.code !== 'ENOENT') {
+			throw error;
 		}
 	}
 
 	const json = JSON.stringify(data, options.replacer, indent);
 
-	return writeFileAtomic.sync(filePath, `${json}\n`, {mode: options.mode});
+	return writeFileAtomic.sync(filePath, `${json}${trailingNewline}`, {mode: options.mode});
 };
 
 module.exports = async (filePath, data, options) => {

diff --git a/test.js b/test.js
@@ -61,3 +61,17 @@ test('sync - `replacer` option', t => {
 	writeJsonFile.sync(tempFile, {foo: true, bar: true}, {replacer: ['foo']});
 	t.is(fs.readFileSync(tempFile, 'utf8'), '{\n\t"foo": true\n}\n');
 });
+
+test('async - respect trailing newline at the end of the file', async t => {
+	const tempFile = tempy.file();
+	fs.writeFileSync(tempFile, JSON.stringify({foo: true}));
+	await writeJsonFile(tempFile, {bar: true});
+	t.is(fs.readFileSync(tempFile, 'utf8'), '{\n\t"bar": true\n}');
+});
+
+test('sync - respect trailing newline at the end of the file', t => {
+	const tempFile = tempy.file();
+	fs.writeFileSync(tempFile, JSON.stringify({foo: true}));
+	writeJsonFile.sync(tempFile, {bar: true});
+	t.is(fs.readFileSync(tempFile, 'utf8'), '{\n\t"bar": true\n}');
+});