refactor: Provide details for binding-syntax

SAP · Dec 11, 2024 · 4187a51 · 4187a51
1 parent 2df3150
commit 4187a51
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 1 deletion.
diff --git a/src/linter/html/transpiler.ts b/src/linter/html/transpiler.ts
@@ -222,10 +222,15 @@ function checkBindingSyntaxAttr(attr: Attribute, report: HtmlReporter) {
 	if (attr.value.value.toLowerCase() === "complex") {
 		report.addMessage(MESSAGE.REDUNDANT_BOOTSTRAP_PARAM, {
 			name: attr.name.value,
+			messageDetails: "Only 'complex' is supported with UI5 2.X and automatically" +
+				" enforced by the UI5 runtime. Complex binding parser supports simple binding syntax per default.",
 		}, attr.name);
 	} else {
 		report.addMessage(MESSAGE.REDUNDANT_BOOTSTRAP_PARAM_ERROR, {
 			name: attr.name.value,
+			messageDetails: "Only 'complex' is supported with UI5 2.X and automatically" +
+				" enforced by the UI5 runtime. Check all bindings whether they will be " +
+				"misinterpreted in 2.0 with binding syntax 'complex'.",
 		}, attr.name);
 	}
 }

diff --git a/src/linter/messages.ts b/src/linter/messages.ts
@@ -486,7 +486,7 @@ export const MESSAGE_INFO = {
 
 		message: ({name}: {name: string}) =>
 			`Redundant bootstrap parameter '${name}' should be removed`,
-		details: () => undefined,
+		details: ({messageDetails}: {messageDetails?: string}) => messageDetails,
 	},
 
 	[MESSAGE.REDUNDANT_BOOTSTRAP_PARAM_ERROR]: {

diff --git a/test/lib/linter/rules/snapshots/NoDeprecatedApi.ts.md b/test/lib/linter/rules/snapshots/NoDeprecatedApi.ts.md
@@ -80,6 +80,7 @@ Generated by [AVA](https://avajs.dev).
             column: 3,
             line: 19,
             message: 'Redundant bootstrap parameter \'data-sap-ui-binding-syntax\' should be removed',
+            messageDetails: 'Only \'complex\' is supported with UI5 2.X and automatically enforced by the UI5 runtime. Check all bindings whether they will be misinterpreted in 2.0 with binding syntax \'complex\'.',
             ruleId: 'no-deprecated-api',
             severity: 2,
           },
@@ -94,6 +95,7 @@ Generated by [AVA](https://avajs.dev).
             column: 3,
             line: 20,
             message: 'Redundant bootstrap parameter \'data-sap-ui-binding-syntax\' should be removed',
+            messageDetails: 'Only \'complex\' is supported with UI5 2.X and automatically enforced by the UI5 runtime. Complex binding parser supports simple binding syntax per default.',
             ruleId: 'no-deprecated-api',
             severity: 1,
           },
@@ -460,6 +462,7 @@ Generated by [AVA](https://avajs.dev).
             column: 3,
             line: 18,
             message: 'Redundant bootstrap parameter \'data-sap-ui-bindingsyntax\' should be removed',
+            messageDetails: 'Only \'complex\' is supported with UI5 2.X and automatically enforced by the UI5 runtime. Complex binding parser supports simple binding syntax per default.',
             ruleId: 'no-deprecated-api',
             severity: 1,
           },
@@ -474,6 +477,7 @@ Generated by [AVA](https://avajs.dev).
             column: 3,
             line: 19,
             message: 'Redundant bootstrap parameter \'data-sap-ui-xx-bindingsyntax\' should be removed',
+            messageDetails: 'Only \'complex\' is supported with UI5 2.X and automatically enforced by the UI5 runtime. Complex binding parser supports simple binding syntax per default.',
             ruleId: 'no-deprecated-api',
             severity: 1,
           },
@@ -488,6 +492,7 @@ Generated by [AVA](https://avajs.dev).
             column: 3,
             line: 20,
             message: 'Redundant bootstrap parameter \'data-sap-ui-xx-binding-syntax\' should be removed',
+            messageDetails: 'Only \'complex\' is supported with UI5 2.X and automatically enforced by the UI5 runtime. Complex binding parser supports simple binding syntax per default.',
             ruleId: 'no-deprecated-api',
             severity: 1,
           },

diff --git a/test/lib/linter/rules/snapshots/NoDeprecatedApi.ts.snap b/test/lib/linter/rules/snapshots/NoDeprecatedApi.ts.snap