feat: Detect legacy template:require (space-separated list)

JIRA: CPOUI5FOUNDATION-917
SAP · Feb 14, 2025 · a840e1f · a840e1f
1 parent 81d4173
commit a840e1f
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 1 deletion.
diff --git a/src/linter/messages.ts b/src/linter/messages.ts
@@ -58,6 +58,7 @@ export enum MESSAGE {
 	NO_EXPORTED_VALUES_BY_LIB,
 	NO_GLOBALS,
 	NO_ICON_POOL_RENDERER,
+	NO_LEGACY_TEMPLATE_REQUIRE_SYNTAX,
 	NO_ODATA_GLOBALS,
 	NOT_STATIC_CONTROL_RENDERER,
 	PARSING_ERROR,
@@ -368,6 +369,16 @@ export const MESSAGE_INFO = {
 		details: () => `{@link sap.ui.core.RenderManager#methods/icon RenderManager}`,
 	},
 
+	[MESSAGE.NO_LEGACY_TEMPLATE_REQUIRE_SYNTAX]: {
+		severity: LintMessageSeverity.Error,
+		ruleId: RULES["no-deprecated-api"],
+
+		message: ({moduleNames}: {moduleNames: string}) =>
+			`Usage of space-separated list '${moduleNames}' in template:require`,
+		details: () => `Use the object notation of template:require instead ` +
+			`{@link topic:263f6e5a915f430894ee290040e7e220}`,
+	},
+
 	[MESSAGE.NOT_STATIC_CONTROL_RENDERER]: {
 		severity: LintMessageSeverity.Warning,
 		ruleId: RULES["ui5-class-declaration"],

diff --git a/src/linter/xmlTemplate/Parser.ts b/src/linter/xmlTemplate/Parser.ts
@@ -426,6 +426,13 @@ export default class Parser {
 								variableName,
 							});
 						});
+						if (requireDeclarations.length) {
+							// Usage of space separated list is not recommended, as it only allows for global access
+							this.#context.addLintingMessage(this.#resourcePath,
+								MESSAGE.NO_LEGACY_TEMPLATE_REQUIRE_SYNTAX,
+								{moduleNames: attr.value}, attr.start
+							);
+						}
 					} else {
 						// Most common case: JSON-like representation
 						// e.g. core:require="{Helper: 'sap/ui/demo/todo/util/Helper'}"

diff --git a/test/lib/linter/rules/snapshots/NoDeprecatedApi.ts.md b/test/lib/linter/rules/snapshots/NoDeprecatedApi.ts.md
@@ -1896,7 +1896,7 @@ Generated by [AVA](https://avajs.dev).
     [
       {
         coverageInfo: [],
-        errorCount: 4,
+        errorCount: 5,
         fatalErrorCount: 0,
         filePath: 'XMLTemplatingRequire.view.xml',
         messages: [
@@ -1908,6 +1908,14 @@ Generated by [AVA](https://avajs.dev).
             ruleId: 'no-deprecated-api',
             severity: 2,
           },
+          {
+            column: 7,
+            line: 8,
+            message: 'Usage of space-separated list \'sap.ui.model.odata.ODataModel sap.ui.model.odata.ODataUtils\' in template:require',
+            messageDetails: 'Use the object notation of template:require instead topic:263f6e5a915f430894ee290040e7e220 (https://ui5.sap.com/#/topic/263f6e5a915f430894ee290040e7e220)',
+            ruleId: 'no-deprecated-api',
+            severity: 2,
+          },
           {
             column: 8,
             line: 9,

diff --git a/test/lib/linter/rules/snapshots/NoDeprecatedApi.ts.snap b/test/lib/linter/rules/snapshots/NoDeprecatedApi.ts.snap
diff --git a/test/lib/linter/xmlTemplate/snapshots/transpiler.ts.md b/test/lib/linter/xmlTemplate/snapshots/transpiler.ts.md
@@ -1216,6 +1216,14 @@ Generated by [AVA](https://avajs.dev).
 > messages
 
     [
+      {
+        column: 7,
+        line: 8,
+        message: 'Usage of space-separated list \'sap.ui.model.odata.ODataModel sap.ui.model.odata.ODataUtils\' in template:require',
+        messageDetails: 'Use the object notation of template:require instead topic:263f6e5a915f430894ee290040e7e220 (https://ui5.sap.com/#/topic/263f6e5a915f430894ee290040e7e220)',
+        ruleId: 'no-deprecated-api',
+        severity: 2,
+      },
       {
         column: 37,
         line: 10,

diff --git a/test/lib/linter/xmlTemplate/snapshots/transpiler.ts.snap b/test/lib/linter/xmlTemplate/snapshots/transpiler.ts.snap