Merge pull request #805 from telerik/milanov/keep-indentation-in-json-files

Keep the current indentation of json files

Author: TsvetanMilanov

file-system.ts

@@ -9,6 +9,9 @@ import * as shelljs from "shelljs";
 
 @injector.register("fs")
 export class FileSystem implements IFileSystem {
+	private static DEFAULT_INDENTATION_CHARACTER = "\t";
+	private static JSON_OBJECT_REGEXP = new RegExp(`{\\r*\\n*(\\W*)"`, "m");
+
 	constructor(private $injector: IInjector) { }
 
 	//TODO: try 'archiver' module for zipping
@@ -269,7 +272,11 @@ export class FileSystem implements IFileSystem {
 		return future;
 	}
 
-	public writeJson(filename: string, data: any, space: string = "\t", encoding?: string): IFuture<void> {
+	public writeJson(filename: string, data: any, space?: string, encoding?: string): IFuture<void> {
+		if (!space) {
+			space = this.getIndentationCharacter(filename).wait();
+		}
+
 		return this.writeFile(filename, JSON.stringify(data, null, space), encoding);
 	}
 
@@ -523,4 +530,23 @@ export class FileSystem implements IFileSystem {
 			}
 		}).future<void>()();
 	}
+
+	private getIndentationCharacter(filePath: string): IFuture<string> {
+		return ((): string => {
+			if (!this.exists(filePath).wait()) {
+				return FileSystem.DEFAULT_INDENTATION_CHARACTER;
+			}
+
+			let fileContent = this.readText(filePath).wait().trim();
+			let matches = fileContent.match(FileSystem.JSON_OBJECT_REGEXP);
+
+			if (!matches || !matches[1]) {
+				return FileSystem.DEFAULT_INDENTATION_CHARACTER;
+			}
+
+			let indentation = matches[1];
+
+			return indentation[0] === " " ? indentation : FileSystem.DEFAULT_INDENTATION_CHARACTER;
+		}).future<string>()();
+	}
 }

services/user-settings-service.ts

@@ -41,7 +41,7 @@ export class UserSettingsServiceBase implements IUserSettingsService {
 					this.userSettingsData[propertyName] = data[propertyName];
 				});
 
-			this.$fs.writeJson(this.userSettingsFilePath, this.userSettingsData, "\t").wait();
+			this.$fs.writeJson(this.userSettingsFilePath, this.userSettingsData).wait();
 		}).future<void>()();
 	}
 

test/unit-tests/file-system.ts

@@ -18,6 +18,57 @@ function isOsCaseSensitive(testInjector: IInjector): boolean {
 };
 temp.track();
 
+function createWriteJsonTestCases(): { exists: boolean, text: string, testCondition: string, expectedIndentation: string }[] {
+	return [
+		{
+			exists: true,
+			text: `{\n\t"a" : 5 }`,
+			testCondition: "when the indentation is tab",
+			expectedIndentation: "\t"
+		}, {
+			exists: true,
+			text: `{\n "a" : 5 }`,
+			testCondition: "when the indentation is space",
+			expectedIndentation: " "
+		}, {
+			exists: true,
+			text: `{\n  "a" : 5 }`,
+			testCondition: "when the indentation is two spaces",
+			expectedIndentation: "  "
+		}, {
+			exists: false,
+			text: `{\n "a" : 5 }`,
+			testCondition: "when the file does not exist",
+			expectedIndentation: "\t"
+		}, {
+			exists: true,
+			text: `"just-string"`,
+			testCondition: "when the the content is string",
+			expectedIndentation: "\t"
+		}, {
+			exists: true,
+			text: `{ "a" : 5 }`,
+			testCondition: "when the content does not have new line after the {",
+			expectedIndentation: " "
+		}, {
+			exists: true,
+			text: `{"a" : 5 }`,
+			testCondition: "when the content is not correctly formatted",
+			expectedIndentation: "\t"
+		}, {
+			exists: true,
+			text: `{\r\n "a" : 5 }`,
+			testCondition: "when the new line is in Windows format",
+			expectedIndentation: " "
+		}, {
+			exists: true,
+			text: `{\r\n\t"a" : 5 }`,
+			testCondition: "when the new line is in Windows format",
+			expectedIndentation: "\t"
+		}
+	];
+}
+
 function createTestInjector(): IInjector {
 	let testInjector = new Yok();
 
@@ -226,4 +277,37 @@ describe("FileSystem", () => {
 			assert.deepEqual(emptyDirectories, _.reverse(removedDirectories));
 		});
 	});
+
+	describe("writeJson", () => {
+		let testCases = createWriteJsonTestCases(),
+			testInjector: IInjector,
+			fs: IFileSystem;
+
+		beforeEach(() => {
+			testInjector = createTestInjector();
+
+			fs = testInjector.resolve("fs");
+		});
+
+		_.each(testCases, (testCase) => {
+			it(`should use the correct indentation ${testCase.testCondition}.`, () => {
+				fs.readText = () => Future.fromResult(testCase.text);
+				fs.exists = () => Future.fromResult(testCase.exists);
+				fs.writeFile = () => Future.fromResult();
+
+				let actualIndentation: string;
+				let originalJsonStringify = JSON.stringify;
+
+				(<any>JSON).stringify = (value: any, replacer: any[], space: string | number) => {
+					actualIndentation = <string>space;
+				};
+
+				fs.writeJson("", testCase.text).wait();
+
+				JSON.stringify = originalJsonStringify;
+
+				assert.deepEqual(actualIndentation, testCase.expectedIndentation);
+			});
+		});
+	});
 });

test/unit-tests/mobile/android-device-file-system.ts

@@ -146,6 +146,7 @@ describe("Android device file system tests", () => {
 				isDirectory: () => false,
 				isFile: () => true
 			});
+			fs.readText = () => Future.fromResult("");
 
 			let androidDeviceFileSystem = createAndroidDeviceFileSystem(injector);
 			androidDeviceFileSystem.transferFile = (localPath: string, devicePath: string) => {
@@ -173,6 +174,7 @@ describe("Android device file system tests", () => {
 				isDirectory: () => false,
 				isFile: () => true
 			});
+			fs.readText = () => Future.fromResult("");
 
 			let androidDeviceFileSystem = createAndroidDeviceFileSystem(injector);
 			let transferedFilesOnDevice: string[] = [];
@@ -206,6 +208,7 @@ describe("Android device file system tests", () => {
 				isDirectory: () => false,
 				isFile: () => true
 			});
+			fs.readText = () => Future.fromResult("");
 
 			let androidDeviceFileSystem = createAndroidDeviceFileSystem(injector);
 			androidDeviceFileSystem.transferFile = (localPath: string, devicePath: string) => {
@@ -233,6 +236,7 @@ describe("Android device file system tests", () => {
 				isDirectory: () => false,
 				isFile: () => true
 			});
+			fs.readText = () => Future.fromResult("");
 
 			let androidDeviceFileSystem = createAndroidDeviceFileSystem(injector);
 			androidDeviceFileSystem.transferFile = (localPath: string, devicePath: string) => {