refactor(autofix): Correctly remove trailing comma if property assignment is deleted

Author: RandomByte

src/linter/ui5Types/fix/PropertyAssignmentBaseFix.ts

@@ -13,6 +13,7 @@ export default abstract class PropertyAssignmentBaseFix extends XmlEnabledFix {
 	protected sourcePosition: PositionInfo | undefined;
 	protected startPos: number | undefined;
 	protected endPos: number | undefined;
+	protected trailingCommaPos: number | undefined;
 
 	constructor() {
 		super();
@@ -44,6 +45,22 @@ export default abstract class PropertyAssignmentBaseFix extends XmlEnabledFix {
 		}
 		this.startPos = node.getStart();
 		this.endPos = node.getEnd();
+
+		if (ts.isObjectLiteralExpression(node.parent)) {
+			const syntaxList = node.parent.getChildren().find((child) => child.kind === ts.SyntaxKind.SyntaxList);
+			if (syntaxList?.kind === ts.SyntaxKind.SyntaxList) {
+				// Check if the last child is a comma
+				const children = syntaxList.getChildren();
+				const propAssIdx = children.findIndex((child) => child === node);
+				if (propAssIdx === -1) {
+					throw new Error("Unexpected: Property assignment not found in syntax list");
+				}
+				const commaToken = children[propAssIdx + 1];
+				if (commaToken?.kind === ts.SyntaxKind.CommaToken) {
+					this.trailingCommaPos = commaToken.getEnd();
+				}
+			}
+		}
 		return true;
 	}
 

src/linter/ui5Types/fix/PropertyAssignmentFix.ts

@@ -62,7 +62,7 @@ export default class PropertyAssignmentFix extends PropertyAssignmentBaseFix {
 			return {
 				action: ChangeAction.DELETE,
 				start: this.startPos,
-				end: this.endPos,
+				end: this.trailingCommaPos ?? this.endPos,
 			};
 		}
 	}

src/linter/ui5Types/fix/PropertyAssignmentGeneratorFix.ts

@@ -73,7 +73,6 @@ export default class PropertyAssignmentGeneratorFix<GeneratorContext extends obj
 
 		this.propertyName = node.name.getFullText();
 		this.propertyInitializer = node.initializer.getFullText();
-
 		return true;
 	}
 
@@ -97,11 +96,19 @@ export default class PropertyAssignmentGeneratorFix<GeneratorContext extends obj
 		if (value === undefined) {
 			return;
 		}
-		return {
-			action: ChangeAction.REPLACE,
-			start: this.startPos,
-			end: this.endPos,
-			value,
-		};
+		if (value !== "") {
+			return {
+				action: ChangeAction.REPLACE,
+				start: this.startPos,
+				end: this.endPos,
+				value,
+			};
+		} else {
+			return {
+				action: ChangeAction.DELETE,
+				start: this.startPos,
+				end: this.trailingCommaPos ?? this.endPos,
+			};
+		}
 	}
 }

test/fixtures/autofix/DeprecatedApi.js

@@ -0,0 +1,18 @@
+sap.ui.define(["sap/m/Label", "sap/ui/layout/form/SimpleForm",], function(Label, SimpleForm) {
+	const oLabel = new Label({
+		text: "Form Label"
+	})
+	const oForm = new SimpleForm("my-form", {
+		minWidth : 1000,
+		editable : true,
+		layout :"ResponsiveGridLayout",
+		labelSpanL : 12,
+		labelSpanM : 12,
+		columnsL : 1,
+		columnsM : 1,
+		emptySpanL : 0,
+		content : [
+			oLabel
+		]
+	});
+});

test/lib/autofix/snapshots/autofix.fixtures.ts.md

@@ -164,6 +164,43 @@ Generated by [AVA](https://avajs.dev).
       },
     ]
 
+## General: DeprecatedApi.js
+
+> AutofixResult iteration #0: /DeprecatedApi.js
+
+    `sap.ui.define(["sap/m/Label", "sap/ui/layout/form/SimpleForm",], function(Label, SimpleForm) {␊
+    	const oLabel = new Label({␊
+    		text: "Form Label"␊
+    	})␊
+    	const oForm = new SimpleForm("my-form", {␊
+    		␊
+    		editable : true,␊
+    		layout :"ResponsiveGridLayout",␊
+    		labelSpanL : 12,␊
+    		labelSpanM : 12,␊
+    		columnsL : 1,␊
+    		columnsM : 1,␊
+    		emptySpanL : 0,␊
+    		content : [␊
+    			oLabel␊
+    		]␊
+    	});␊
+    });␊
+    `
+
+> LintResult: DeprecatedApi.js
+
+    [
+      {
+        coverageInfo: [],
+        errorCount: 0,
+        fatalErrorCount: 0,
+        filePath: 'DeprecatedApi.js',
+        messages: [],
+        warningCount: 0,
+      },
+    ]
+
 ## General: DeprecatedApi.view.xml
 
 > AutofixResult iteration #0: /DeprecatedApi.view.xml