Support JSON 5 with new --json5 flag (thanks @dwilsonmsft)

Author: T-Hugs

app/exec/extension/_lib/interfaces.ts

@@ -164,6 +164,12 @@ export interface MergeSettings {
 	 * Path to the root of localized resource files
 	 */
 	locRoot: string;
+
+	/**
+	 * If true, treat JSON files as "Json 5" or "extended JSON",
+	 * which supports comments, unquoted keys, etc.
+	 */
+	json5: boolean;
 }
 
 export interface PackageSettings {

app/exec/extension/_lib/merger.ts

@@ -14,6 +14,7 @@ import { forwardSlashesPath, toZipItemName } from "./utils";
 import _ = require("lodash");
 import fs = require("fs");
 import glob = require("glob");
+import jju = require("jju");
 import jsonInPlace = require("json-in-place");
 import loc = require("./loc");
 import path = require("path");
@@ -112,7 +113,7 @@ export class Merger {
 					promisify(readFile)(file, "utf8").then(data => {
 						const jsonData = data.replace(/^\uFEFF/, "");
 						try {
-							const result = JSON.parse(jsonData);
+							const result = this.settings.json5 ? jju.parse(jsonData) : JSON.parse(jsonData);
 							result.__origin = file; // save the origin in order to resolve relative paths later.
 							return result;
 						} catch (err) {
@@ -153,7 +154,14 @@ export class Merger {
 
 								updateVersionPromise = promisify(readFile)(partial.__origin, "utf8").then(versionPartial => {
 									try {
-										const newPartial = jsonInPlace(versionPartial).set("version", newVersionString);
+										let newPartial: any;
+										if (this.settings.json5) {
+											const parsed = jju.parse(versionPartial);
+											parsed["version"] = newVersionString;
+											newPartial = jju.update(versionPartial, parsed);
+										} else {
+											newPartial = jsonInPlace(versionPartial).set("version", newVersionString);
+										}
 										return promisify(writeFile)(partial.__origin, newPartial);
 									} catch (e) {
 										trace.warn(

app/exec/extension/create.ts

@@ -49,6 +49,7 @@ export class ExtensionCreate extends extBase.ExtensionBase<CreationResult> {
 			"root",
 			"manifests",
 			"manifestGlobs",
+			"json5",
 			"override",
 			"overridesFile",
 			"revVersion",

app/exec/extension/default.ts

@@ -25,8 +25,9 @@ export interface ExtensionArguments extends CoreArguments {
 	bypassValidation: args.BooleanArgument;
 	description: args.StringArgument;
 	displayName: args.StringArgument;
-	extensionName: args.StringArgument;
 	extensionId: args.StringArgument;
+	extensionName: args.StringArgument;
+	json5: args.BooleanArgument;
 	locRoot: args.ExistingDirectoriesArgument;
 	manifestGlobs: args.ArrayArgument;
 	manifests: args.ArrayArgument;
@@ -88,6 +89,13 @@ export class ExtensionBase<T> extends TfCommand<ExtensionArguments, T> {
 			args.ArrayArgument,
 			null,
 		);
+		this.registerCommandArgument(
+			"json5",
+			"Extended JSON",
+			"Support extended JSON (aka JSON 5) for comments, unquoted strings, dangling commas, etc.",
+			args.BooleanArgument,
+			"false"
+		);
 		this.registerCommandArgument("outputPath", "Output path", "Path to write the VSIX.", args.StringArgument, "{auto}");
 		this.registerCommandArgument(
 			"override",
@@ -169,6 +177,7 @@ export class ExtensionBase<T> extends TfCommand<ExtensionArguments, T> {
 			this.commandArgs.bypassValidation.val(),
 			this.commandArgs.publisher.val(true),
 			this.commandArgs.extensionId.val(true),
+			this.commandArgs.json5.val(true),
 		]).then<MergeSettings>(values => {
 			const [
 				root,
@@ -181,6 +190,7 @@ export class ExtensionBase<T> extends TfCommand<ExtensionArguments, T> {
 				bypassValidation,
 				publisher,
 				extensionId,
+				json5,
 			] = values;
 			if (publisher) {
 				_.set(override, "publisher", publisher);
@@ -217,6 +227,7 @@ export class ExtensionBase<T> extends TfCommand<ExtensionArguments, T> {
 					overrides: mergedOverrides,
 					bypassValidation: bypassValidation,
 					revVersion: revVersion,
+					json5: json5,
 				};
 			});
 		});

app/exec/extension/init.ts

@@ -400,6 +400,7 @@ export class ExtensionInit extends extBase.ExtensionBase<InitResult> {
 				manifests: null,
 				overrides: {},
 				root: initPath,
+				json5: false,
 			},
 			{
 				locRoot: null,

package-lock.json

@@ -25,6 +25,7 @@
     "clipboardy": "~1.2.3",
     "colors": "~1.3.0",
     "glob": "7.1.2",
+    "jju": "^1.4.0",
     "json-in-place": "^1.0.1",
     "jszip": "~3.1.5",
     "lodash": "~4.17.11",
@@ -46,6 +47,7 @@
   "devDependencies": {
     "@types/clipboardy": "~1.1.0",
     "@types/glob": "^5.0.29",
+    "@types/jju": "^1.4.1",
     "@types/jszip": "~3.1.2",
     "@types/lodash": "~4.14.110",
     "@types/mkdirp": "^0.3.28",