refactor: Provide details for data-sap-ui-areas

SAP · Dec 11, 2024 · f22175f · f22175f
1 parent 3344c0b
commit f22175f
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 2 deletions.
diff --git a/src/linter/html/transpiler.ts b/src/linter/html/transpiler.ts
@@ -158,12 +158,17 @@ function lintBootstrapAttributes(tag: Tag, report: HtmlReporter) {
 				}, attr.name);
 				break;
 			case "data-sap-ui-xx-no-less":
-			case "data-sap-ui-areas":
 			case "data-sap-ui-trace":
 				report.addMessage(MESSAGE.ABANDONED_BOOTSTRAP_PARAM, {
 					name: attr.name.value,
 				}, attr.name);
 				break;
+			case "data-sap-ui-areas":
+				report.addMessage(MESSAGE.ABANDONED_BOOTSTRAP_PARAM, {
+					name: attr.name.value,
+					messageDetails: "No longer supported. UI areas are created on request by calling Control.placeAt",
+				}, attr.name);
+				break;
 			case "data-sap-ui-animation":
 				report.addMessage(MESSAGE.REPLACED_BOOTSTRAP_PARAM, {
 					name: attr.name.value,

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

diff --git a/test/lib/linter/rules/snapshots/NoDeprecatedApi.ts.md b/test/lib/linter/rules/snapshots/NoDeprecatedApi.ts.md
@@ -65,6 +65,7 @@ Generated by [AVA](https://avajs.dev).
             column: 3,
             line: 17,
             message: 'Abandoned bootstrap parameter \'data-sap-ui-areas\' should be removed',
+            messageDetails: 'No longer supported. UI areas are created on request by calling Control.placeAt',
             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