feat: Detect UI5 project specific globals (#1042)

Detects global access to project-namespace modules which bypass
sap.ui.define/sap.ui.require. These were silently ignored by no-globals
since app namespaces have no type definitions.
This new detection generates linter messages with `ruleId`s
"no-project-globals".

JIRA: CPOUI5FOUNDATION-1242

---------

Co-authored-by: Max Reichmann <max.reichmann@sap.com>

Author: stopcoder

docs/Rules.md

@@ -10,6 +10,7 @@
 	- [no-deprecated-library](#no-deprecated-library)
 	- [no-deprecated-theme](#no-deprecated-theme)
 	- [no-globals](#no-globals)
+	- [no-project-globals](#no-project-globals)
 	- [no-implicit-globals](#no-implicit-globals)
 	- [no-pseudo-modules](#no-pseudo-modules)
 	- [parsing-error](#parsing-error)
@@ -83,6 +84,13 @@ Checks for the usage of global variables in the code.
 **Related information**
 - [Best Practices for Developers](https://ui5.sap.com/#/topic/28fcd55b04654977b63dacbee0552712)
 
+## no-project-globals
+
+Checks for the usage of global variables for project-namespace modules in the code.
+
+**Related information**
+- [Best Practices for Developers](https://ui5.sap.com/#/topic/28fcd55b04654977b63dacbee0552712)
+
 ## no-implicit-globals
 
 Checks whether:

src/linter/messages.ts

@@ -11,6 +11,7 @@ export const RULES = {
 	"no-deprecated-library": "no-deprecated-library",
 	"no-deprecated-theme": "no-deprecated-theme",
 	"no-globals": "no-globals",
+	"no-project-globals": "no-project-globals",
 	"no-implicit-globals": "no-implicit-globals",
 	"no-pseudo-modules": "no-pseudo-modules",
 	"parsing-error": "parsing-error",
@@ -66,6 +67,7 @@ export enum MESSAGE {
 	NO_DIRECT_ENUM_ACCESS,
 	NO_EXPORTED_VALUES_BY_LIB,
 	NO_GLOBALS,
+	NO_PROJECT_GLOBALS,
 	NO_ICON_POOL_RENDERER,
 	NO_LEGACY_TEMPLATE_REQUIRE_SYNTAX,
 	NO_LEGACY_UI5_VERSION_IN_MANIFEST,
@@ -468,6 +470,18 @@ export const MESSAGE_INFO = {
 			`{@link topic:28fcd55b04654977b63dacbee0552712 See Best Practices for Developers}`,
 	},
 
+	[MESSAGE.NO_PROJECT_GLOBALS]: {
+		severity: LintMessageSeverity.Error,
+		ruleId: RULES["no-project-globals"],
+
+		message: ({variableName, namespace}: {variableName: string; namespace: string}) =>
+			`Access of global variable '${variableName}' (${namespace})`,
+		details: () =>
+			`Do not use global variables to access UI5 projects. ` +
+			`It might be necessary to modify the provider and consumer of this global variable. ` +
+			`{@link topic:28fcd55b04654977b63dacbee0552712 See Best Practices for Developers}`,
+	},
+
 	[MESSAGE.PARSING_ERROR]: {
 		severity: LintMessageSeverity.Error,
 		ruleId: RULES["parsing-error"],

src/linter/ui5Types/SourceFileLinter.ts

@@ -81,6 +81,8 @@ export default class SourceFileLinter {
 	#hasTestStarterFindings: boolean;
 	#metadata: LintMetadata;
 	#xmlContents: {xml: string; pos: ts.LineAndCharacter; documentKind: "fragment" | "view"}[];
+	#projectNamespaceFirstSegment: string | undefined;
+	#projectNamespaceDots: string | undefined;
 
 	private fixHelpers: FixHelpers;
 	private resourcePath: ResourcePath;
@@ -113,6 +115,12 @@ export default class SourceFileLinter {
 			manifestContent: this.manifestContent,
 			libraryDependencies: this.libraryDependencies,
 		};
+
+		const namespace = this.typeLinter.getContext().getNamespace();
+		if (namespace) {
+			this.#projectNamespaceDots = namespace.replace(/\//g, ".");
+			this.#projectNamespaceFirstSegment = this.#projectNamespaceDots.split(".")[0];
+		}
 	}
 
 	async lint() {
@@ -1623,7 +1631,8 @@ export default class SourceFileLinter {
 
 			// Get the NodeType in order to check whether this is indirect global access via Window
 			const nodeType = this.checker.getTypeAtLocation(exprNode);
-			if (isGlobalThis(this.checker.typeToString(nodeType))) {
+			const isGlobalThisAccess = isGlobalThis(this.checker.typeToString(nodeType));
+			if (isGlobalThisAccess) {
 				// In case of Indirect global access we need to check for
 				// a global UI5 variable on the right side of the expression instead of left
 				if (ts.isPropertyAccessExpression(node)) {
@@ -1652,6 +1661,33 @@ export default class SourceFileLinter {
 					node,
 					fix: this.getGlobalFix(node),
 				});
+			} else if (this.#projectNamespaceFirstSegment &&
+				exprNode.text === this.#projectNamespaceFirstSegment) {
+				const fullNamespace = extractNamespace(node as ts.PropertyAccessExpression);
+				if (fullNamespace.startsWith(this.#projectNamespaceDots + ".")) {
+					if (!symbol || this.#isProjectGlobalNotLocal(symbol)) {
+						this.#reporter.addMessage(MESSAGE.NO_PROJECT_GLOBALS, {
+							variableName: exprNode.text,
+							namespace: fullNamespace,
+						}, {node});
+					}
+				}
+			} else if (isGlobalThisAccess && this.#projectNamespaceFirstSegment &&
+				ts.isPropertyAccessExpression(node) && ts.isIdentifier(node.name) &&
+				node.name.text === this.#projectNamespaceFirstSegment &&
+				(!symbol || this.#isProjectGlobalNotLocal(symbol))) {
+				// Indirect global access via globalThis/window: e.g. window.com.example.app.utils.Helper
+				// node is "window.com" here — walk up to find the full PropertyAccessExpression chain
+				let topNode: ts.Node = node;
+				while (ts.isPropertyAccessExpression(topNode.parent) &&
+					topNode.parent.expression === topNode) {
+					topNode = topNode.parent;
+				}
+				const fullChain = extractNamespace(topNode as ts.PropertyAccessExpression);
+				this.#reporter.addMessage(MESSAGE.NO_PROJECT_GLOBALS, {
+					variableName: node.name.text,
+					namespace: fullChain,
+				}, {node: topNode});
 			}
 		}
 	}
@@ -1799,6 +1835,23 @@ export default class SourceFileLinter {
 			declarations.some((declaration) => checkFunction(declaration.getSourceFile()));
 	}
 
+	// TypeScript creates implicit Identifier-kind declarations for undeclared globals (e.g. "com").
+	// To avoid false positives when a local variable shadows the namespace first segment
+	// (e.g. "const com = {}"), check whether the symbol has an explicit user-code declaration.
+	#isProjectGlobalNotLocal(symbol: ts.Symbol): boolean {
+		const declarations = symbol.getDeclarations();
+		if (!declarations || declarations.length === 0) return true;
+		for (const decl of declarations) {
+			const sf = decl.getSourceFile();
+			if (!isSourceFileOfUi5Type(sf) && !isSourceFileOfTypeScriptLib(sf) &&
+				(ts.isVariableDeclaration(decl) || ts.isFunctionDeclaration(decl) ||
+					ts.isParameter(decl) || ts.isClassDeclaration(decl))) {
+				return false;
+			}
+		}
+		return true;
+	}
+
 	analyzeTestsuiteThemeProperty(node: ts.PropertyAssignment) {
 		// Check if the node is part of a testsuite config file by its file name.
 		if (!VALID_TESTSUITE.test(node.getSourceFile().fileName)) return;

test/fixtures/linter/rules/NoProjectGlobals/NoProjectGlobals.js

@@ -0,0 +1,15 @@
+sap.ui.define([], function() {
+	"use strict";
+
+	// ERROR: App-namespace global access
+	com.example.app.utils.Formatter.format();
+	var x = com.example.app.model.Config;
+	com.example.app.utils.DataService = {};
+
+	// ERROR: Indirect global access via window
+	window.com.example.app.utils.Helper.doSomething();
+	var y = window.com.example.app.model.Settings;
+	window.com.example.app.utils.Registry = {};
+
+	return com.example.app.utils.TestScripts;
+});

test/fixtures/linter/rules/NoProjectGlobals/NoProjectGlobals_Negative.js

@@ -0,0 +1,13 @@
+sap.ui.define(["com/example/app/utils/Helper"], function(Helper) {
+	"use strict";
+
+	// OK: String literals are not property access expressions
+	Controller.extend("com.example.app.controller.Main", {});
+
+	// OK: Local variable shadows namespace first segment
+	var com = {};
+	com.example.app.whatever;
+
+	// OK: Properly imported module
+	Helper.doSomething();
+});

test/lib/linter/_linterHelper.ts

@@ -121,6 +121,16 @@ export function createTestsForFixtures(fixturesPath: string, fix = false) {
 				filePaths: testFiles,
 				fix,
 			});
+		} else if (fixturesPath.includes("NoProjectGlobals")) {
+			const dirName = path.basename(fixturesPath);
+			testDefinition({
+				testName: dirName,
+				namespace: "com/example/app",
+				fileName: dirName,
+				fixturesPath,
+				filePaths: testFiles,
+				fix,
+			});
 		} else {
 			for (const fileName of testFiles) {
 				if (!fileName.endsWith(".js") &&

test/lib/linter/rules/NoProjectGlobals.ts

@@ -0,0 +1,5 @@
+import {fileURLToPath} from "node:url";
+import {runLintRulesTests} from "../_linterHelper.js";
+
+const filePath = fileURLToPath(import.meta.url);
+runLintRulesTests(filePath);

test/lib/linter/rules/snapshots/NoProjectGlobals.ts.md

@@ -0,0 +1,112 @@
+# Snapshot report for `test/lib/linter/rules/NoProjectGlobals.ts`
+
+The actual snapshot is saved in `NoProjectGlobals.ts.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## General: NoProjectGlobals
+
+> LintResult: NoProjectGlobals
+
+    [
+      {
+        coverageInfo: [
+          {
+            category: 1,
+            column: 2,
+            line: 12,
+            message: 'Unable to analyze this method call because the type of identifier "doSomething" in "Helper.doSomething()" could not be determined',
+          },
+        ],
+        errorCount: 0,
+        fatalErrorCount: 0,
+        filePath: 'NoProjectGlobals_Negative.js',
+        messages: [],
+        warningCount: 0,
+      },
+      {
+        coverageInfo: [
+          {
+            category: 1,
+            column: 2,
+            line: 5,
+            message: 'Unable to analyze this method call because the type of identifier "format" in "com.example.app.utils.Formatter.format()" could not be determined',
+          },
+          {
+            category: 1,
+            column: 2,
+            line: 10,
+            message: 'Unable to analyze this method call because the type of identifier "doSomething" in "window.com.example.app.utils.Helper.doSomething()" could not be determined',
+          },
+        ],
+        errorCount: 7,
+        fatalErrorCount: 0,
+        filePath: 'NoProjectGlobals.js',
+        messages: [
+          {
+            column: 2,
+            line: 5,
+            message: 'Access of global variable \'com\' (com.example.app.utils.Formatter.format)',
+            messageDetails: 'Do not use global variables to access UI5 projects. It might be necessary to modify the provider and consumer of this global variable. See Best Practices for Developers (https://ui5.sap.com/#/topic/28fcd55b04654977b63dacbee0552712)',
+            ruleId: 'no-project-globals',
+            severity: 2,
+            ui5TypeInfo: undefined,
+          },
+          {
+            column: 10,
+            line: 6,
+            message: 'Access of global variable \'com\' (com.example.app.model.Config)',
+            messageDetails: 'Do not use global variables to access UI5 projects. It might be necessary to modify the provider and consumer of this global variable. See Best Practices for Developers (https://ui5.sap.com/#/topic/28fcd55b04654977b63dacbee0552712)',
+            ruleId: 'no-project-globals',
+            severity: 2,
+            ui5TypeInfo: undefined,
+          },
+          {
+            column: 2,
+            line: 7,
+            message: 'Access of global variable \'com\' (com.example.app.utils.DataService)',
+            messageDetails: 'Do not use global variables to access UI5 projects. It might be necessary to modify the provider and consumer of this global variable. See Best Practices for Developers (https://ui5.sap.com/#/topic/28fcd55b04654977b63dacbee0552712)',
+            ruleId: 'no-project-globals',
+            severity: 2,
+            ui5TypeInfo: undefined,
+          },
+          {
+            column: 2,
+            line: 10,
+            message: 'Access of global variable \'com\' (window.com.example.app.utils.Helper.doSomething)',
+            messageDetails: 'Do not use global variables to access UI5 projects. It might be necessary to modify the provider and consumer of this global variable. See Best Practices for Developers (https://ui5.sap.com/#/topic/28fcd55b04654977b63dacbee0552712)',
+            ruleId: 'no-project-globals',
+            severity: 2,
+            ui5TypeInfo: undefined,
+          },
+          {
+            column: 10,
+            line: 11,
+            message: 'Access of global variable \'com\' (window.com.example.app.model.Settings)',
+            messageDetails: 'Do not use global variables to access UI5 projects. It might be necessary to modify the provider and consumer of this global variable. See Best Practices for Developers (https://ui5.sap.com/#/topic/28fcd55b04654977b63dacbee0552712)',
+            ruleId: 'no-project-globals',
+            severity: 2,
+            ui5TypeInfo: undefined,
+          },
+          {
+            column: 2,
+            line: 12,
+            message: 'Access of global variable \'com\' (window.com.example.app.utils.Registry)',
+            messageDetails: 'Do not use global variables to access UI5 projects. It might be necessary to modify the provider and consumer of this global variable. See Best Practices for Developers (https://ui5.sap.com/#/topic/28fcd55b04654977b63dacbee0552712)',
+            ruleId: 'no-project-globals',
+            severity: 2,
+            ui5TypeInfo: undefined,
+          },
+          {
+            column: 9,
+            line: 14,
+            message: 'Access of global variable \'com\' (com.example.app.utils.TestScripts)',
+            messageDetails: 'Do not use global variables to access UI5 projects. It might be necessary to modify the provider and consumer of this global variable. See Best Practices for Developers (https://ui5.sap.com/#/topic/28fcd55b04654977b63dacbee0552712)',
+            ruleId: 'no-project-globals',
+            severity: 2,
+            ui5TypeInfo: undefined,
+          },
+        ],
+        warningCount: 0,
+      },
+    ]