Add inPlace formatting option & array mods

Author: mbullington

src/impl/edit.ts

@@ -96,35 +96,41 @@ export function setProperty(text: string, originalPath: JSONPath, value: any, fo
 				edit = { offset: previous.offset + previous.length, length: 0, content: ',' + newProperty };
 			}
 			return withFormatting(text, edit, formattingOptions);
-		} else {
-			if (value === void 0 && parent.children.length >= 0) {
-				//Removal
-				let removalIndex = lastSegment;
-				let toRemove = parent.children[removalIndex];
-				let edit: Edit;
-				if (parent.children.length === 1) {
-					// only item
-					edit = { offset: parent.offset + 1, length: parent.length - 2, content: '' };
-				} else if (parent.children.length - 1 === removalIndex) {
-					// last item
-					let previous = parent.children[removalIndex - 1];
-					let offset = previous.offset + previous.length;
-					let parentEndOffset = parent.offset + parent.length;
-					edit = { offset, length: parentEndOffset - 2 - offset, content: '' };
-				} else {
-					edit = { offset: toRemove.offset, length: parent.children[removalIndex + 1].offset - toRemove.offset, content: '' };
-				}
-				return withFormatting(text, edit, formattingOptions);
+		} else if (value === void 0 && parent.children.length >= 0) {
+			// Removal
+			let removalIndex = lastSegment;
+			let toRemove = parent.children[removalIndex];
+			let edit: Edit;
+			if (parent.children.length === 1) {
+				// only item
+				edit = { offset: parent.offset + 1, length: parent.length - 2, content: '' };
+			} else if (parent.children.length - 1 === removalIndex) {
+				// last item
+				let previous = parent.children[removalIndex - 1];
+				let offset = previous.offset + previous.length;
+				let parentEndOffset = parent.offset + parent.length;
+				edit = { offset, length: parentEndOffset - 2 - offset, content: '' };
 			} else {
-				throw new Error('Array modification not supported yet');
+				edit = { offset: toRemove.offset, length: parent.children[removalIndex + 1].offset - toRemove.offset, content: '' };
 			}
+			return withFormatting(text, edit, formattingOptions);
+		} else if (value !== void 0 && parent.children.length > lastSegment) {
+			let modifyIndex = lastSegment;
+			let toModify = parent.children[modifyIndex];
+			let newProperty = `${JSON.stringify(value)}`;
+			return withFormatting(text, { offset: toModify.offset, length: toModify.length, content: newProperty }, formattingOptions);
+		} else {
+			throw new Error(`Can not ${value === void 0 ? 'remove' : 'modify'} Array index ${insertIndex} as length is not sufficient`);
 		}
 	} else {
 		throw new Error(`Can not add ${typeof lastSegment !== 'number' ? 'index' : 'property'} to parent of type ${parent.type}`);
 	}
 }
 
 function withFormatting(text: string, edit: Edit, formattingOptions: FormattingOptions): Edit[] {
+	if (formattingOptions.inPlace) {
+		return [{ ...edit }]
+	}
 	// apply the edit
 	let newText = applyEdit(text, edit);
 

src/main.ts

@@ -322,6 +322,11 @@ export interface FormattingOptions {
 	 * The default 'end of line' character. If not set, '\n' is used as default.
 	 */
 	eol?: string;
+	/**
+	 * If true, changes within {@function format} will not be formatted and their original formatting will be preserved.
+	 * Useful for cutting down on computational time for large files.
+	 */
+	inPlace?: boolean;
 }
 
 /**

src/test/edit.test.ts

@@ -121,6 +121,27 @@ suite('JSON - edits', () => {
 		assertEdit(content, edits, '{\n  "x": "y"\n}');
 	});
 
+	test('set item', () => {
+		let content = '{\n  "x": [1, 2, 3],\n  "y": 0\n}'
+
+		let edits = setProperty(content, ['x', 0], 6, formatterOptions);
+		assertEdit(content, edits, '{\n  "x": [6, 2, 3],\n  "y": 0\n}');
+
+		edits = setProperty(content, ['x', 1], 5, formatterOptions);
+		assertEdit(content, edits, '{\n  "x": [1, 5, 3],\n  "y": 0\n}');
+
+		edits = setProperty(content, ['x', 2], 4, formatterOptions);
+		assertEdit(content, edits, '{\n  "x": [1, 2, 4],\n  "y": 0\n}');
+
+		let message = "allowed setProperty to set array item outside of bounds";
+		try {
+			setProperty(content, ['x', 3], 3, formatterOptions)
+			throw new Error(message);
+		} catch(e) {
+			assert(e && e.message !== message);
+		}
+	});
+
 	test('insert item to empty array', () => {
 		let content = '[\n]';
 		let edits = setProperty(content, [-1], 'bar', formatterOptions);
@@ -163,4 +184,13 @@ suite('JSON - edits', () => {
 		assertEdit(content, edits, '// This is a comment\n[\n  1,\n  "foo"\n]');
 	});
 
+	test('set property w/ in-place formatting options', () => {
+		let content = '{\n  "x": [1, 2, 3],\n  "y": 0\n}'
+
+		let edits = setProperty(content, ['x', 0], { a: 1, b: 2 }, formatterOptions);
+		assertEdit(content, edits, '{\n  "x": [{\n      "a": 1,\n      "b": 2\n    }, 2, 3],\n  "y": 0\n}');
+
+		edits = setProperty(content, ['x', 0], { a: 1, b: 2 }, { ...formatterOptions, inPlace: true });
+		assertEdit(content, edits, '{\n  "x": [{"a":1,"b":2}, 2, 3],\n  "y": 0\n}');
+	});
 });