feat: Detect usage of non exported values by library.js

src/linter/messages.ts

@@ -9,6 +9,7 @@ const RULES = {
 	"no-deprecated-library": "no-deprecated-library",
 	"no-deprecated-theme": "no-deprecated-theme",
 	"no-globals": "no-globals",
+	"no-implicit-globals": "no-implicit-globals",
 	"no-pseudo-modules": "no-pseudo-modules",
 	"parsing-error": "parsing-error",
 	"ui5-class-declaration": "ui5-class-declaration",
@@ -53,6 +54,7 @@ export enum MESSAGE {
 	NO_DEPRECATED_RENDERER,
 	NO_DIRECT_DATATYPE_ACCESS,
 	NO_DIRECT_ENUM_ACCESS,
+	NO_EXPORTED_VALUES_BY_LIB,
 	NO_GLOBALS,
 	NO_ICON_POOL_RENDERER,
 	NOT_STATIC_CONTROL_RENDERER,
@@ -570,4 +572,13 @@ export const MESSAGE_INFO = {
 		details: ({messageDetails}: {messageDetails: string}) => messageDetails,
 	},
 
+	[MESSAGE.NO_EXPORTED_VALUES_BY_LIB]: {
+		severity: LintMessageSeverity.Error,
+		ruleId: RULES["no-implicit-globals"],
+
+		message: ({module}: {module: string}) => `Access of a module (${module}) not exported by a library`,
+		details: ({namespace}: {namespace: string}) =>
+			`Please import the module itself (${namespace}) because it is no longer exported by the library`,
+	},
+
 } as const;

src/linter/ui5Types/SourceFileLinter.ts

@@ -124,6 +124,7 @@ export default class SourceFileLinter {
 				node as (ts.PropertyAccessExpression | ts.ElementAccessExpression)); // Check for global
 			this.analyzePropertyAccessExpressionForDeprecation(
 				node as (ts.PropertyAccessExpression | ts.ElementAccessExpression)); // Check for deprecation
+			this.analyzeExportedValuesByLib(node as (ts.PropertyAccessExpression | ts.ElementAccessExpression));
 		} else if (node.kind === ts.SyntaxKind.ObjectBindingPattern &&
 			node.parent?.kind === ts.SyntaxKind.VariableDeclaration) {
 			// e.g. `const { Button } = sap.m;`
@@ -1185,8 +1186,63 @@ export default class SourceFileLinter {
 		].includes(nodeType);
 	}
 
+	analyzeExportedValuesByLib(node: ts.PropertyAccessExpression | ts.ElementAccessExpression) {
+		if (!ts.isElementAccessExpression(node) &&
+			node.name?.kind !== ts.SyntaxKind.Identifier) {
+			return;
+		}
+
+		const extractVarName = (node: ts.PropertyAccessExpression | ts.ElementAccessExpression) => {
+			const nodeName = ts.isPropertyAccessExpression(node) ?
+					node.name.getText() :
+					node.argumentExpression.getText();
+
+			return nodeName.replaceAll("\"", "");
+		};
+
+		let exprNode = node.expression;
+		const namespace: string[] = [];
+		while (ts.isPropertyAccessExpression(exprNode) ||
+			ts.isElementAccessExpression(exprNode)) {
+			namespace.unshift(extractVarName(exprNode));
+			exprNode = exprNode.expression;
+		}
+		const exprType = this.checker.getTypeAtLocation(exprNode);
+		const potentialLibImport = exprType.symbol?.getName().replaceAll("\"", "") ?? "";
+
+		// Checks if the left hand side is a library import.
+		// It's sufficient just to check for "/library" at the end of the string by convention
+		if (!potentialLibImport.endsWith("/library")) {
+			return;
+		}
+
+		const moduleName = [
+			potentialLibImport.replace("/library", ""),
+			...namespace,
+			extractVarName(node),
+		].join("/");
+
+		// Check if the module is registered within ambient modules
+		const ambientModules = this.checker.getAmbientModules();
+		const isRegisteredAsUi5Module = ambientModules.some((module) =>
+			module.name === `"${moduleName}"`);
+
+		if (isRegisteredAsUi5Module) {
+			this.#reporter.addMessage(MESSAGE.NO_EXPORTED_VALUES_BY_LIB, {
+				module: [
+					exprNode?.getText(),
+					...namespace,
+					extractVarName(node),
+				].join("/"),
+				namespace: moduleName,
+			},
+			(ts.isPropertyAccessExpression(node) ? node.name : node.argumentExpression));
+		}
+	}
+
 	analyzePropertyAccessExpression(node: ts.AccessExpression | ts.CallExpression) {
 		const exprNode = node.expression;
+
 		if (ts.isIdentifier(exprNode)) {
 			// The expression being an identifier indicates that this is the first access
 			// in a possible chain. E.g. the "sap" in "sap.ui.getCore()"

test/fixtures/linter/rules/NoGlobals/NoExportedLibValues.js

@@ -0,0 +1,12 @@
+sap.ui.define(["sap/ui/unified/library", "sap/ui/core/library"],
+	function (unifiedLibrary, coreLibrary) {
+	"use strict";
+
+	var CalendarDayType = unifiedLibrary.CalendarDayType,
+		DateRange = unifiedLibrary["DateRange"],
+		DateTypeRange = unifiedLibrary.DateTypeRange,
+		DOMAttribute = coreLibrary.tmpl.DOMAttribute,
+		DOMAttribute2 = coreLibrary["tmpl"].DOMAttribute,
+		DOMAttribute3 = coreLibrary["tmpl"]["DOMAttribute"],
+		DOMAttribute4 = coreLibrary.tmpl["DOMAttribute"];
+});

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

@@ -11,7 +11,7 @@ Generated by [AVA](https://avajs.dev).
     [
       {
         coverageInfo: [],
-        errorCount: 9,
+        errorCount: 13,
         fatalErrorCount: 0,
         filePath: 'Directives.js',
         messages: [
@@ -47,6 +47,14 @@ Generated by [AVA](https://avajs.dev).
             ruleId: 'no-deprecated-api',
             severity: 2,
           },
+          {
+            column: 10,
+            line: 65,
+            message: 'Access of a module (coreLib/MessageType) not exported by a library',
+            messageDetails: 'Please import the module itself (sap/ui/core/MessageType) because it is no longer exported by the library',
+            ruleId: 'no-implicit-globals',
+            severity: 2,
+          },
           {
             column: 2,
             line: 68,
@@ -55,6 +63,14 @@ Generated by [AVA](https://avajs.dev).
             ruleId: 'no-deprecated-api',
             severity: 2,
           },
+          {
+            column: 10,
+            line: 68,
+            message: 'Access of a module (coreLib/MessageType) not exported by a library',
+            messageDetails: 'Please import the module itself (sap/ui/core/MessageType) because it is no longer exported by the library',
+            ruleId: 'no-implicit-globals',
+            severity: 2,
+          },
           {
             column: 2,
             line: 72,
@@ -63,6 +79,22 @@ Generated by [AVA](https://avajs.dev).
             ruleId: 'no-deprecated-api',
             severity: 2,
           },
+          {
+            column: 10,
+            line: 72,
+            message: 'Access of a module (coreLib/MessageType) not exported by a library',
+            messageDetails: 'Please import the module itself (sap/ui/core/MessageType) because it is no longer exported by the library',
+            ruleId: 'no-implicit-globals',
+            severity: 2,
+          },
+          {
+            column: 12,
+            line: 93,
+            message: 'Access of a module (mobileLib/InputType) not exported by a library',
+            messageDetails: 'Please import the module itself (sap/m/InputType) because it is no longer exported by the library',
+            ruleId: 'no-implicit-globals',
+            severity: 2,
+          },
           {
             column: 6,
             line: 108,
@@ -99,7 +131,7 @@ Generated by [AVA](https://avajs.dev).
     [
       {
         coverageInfo: [],
-        errorCount: 9,
+        errorCount: 13,
         fatalErrorCount: 0,
         filePath: 'Directives.ts',
         messages: [
@@ -135,6 +167,14 @@ Generated by [AVA](https://avajs.dev).
             ruleId: 'no-deprecated-api',
             severity: 2,
           },
+          {
+            column: 9,
+            line: 73,
+            message: 'Access of a module (coreLib/MessageType) not exported by a library',
+            messageDetails: 'Please import the module itself (sap/ui/core/MessageType) because it is no longer exported by the library',
+            ruleId: 'no-implicit-globals',
+            severity: 2,
+          },
           {
             column: 1,
             line: 76,
@@ -143,6 +183,14 @@ Generated by [AVA](https://avajs.dev).
             ruleId: 'no-deprecated-api',
             severity: 2,
           },
+          {
+            column: 9,
+            line: 76,
+            message: 'Access of a module (coreLib/MessageType) not exported by a library',
+            messageDetails: 'Please import the module itself (sap/ui/core/MessageType) because it is no longer exported by the library',
+            ruleId: 'no-implicit-globals',
+            severity: 2,
+          },
           {
             column: 1,
             line: 80,
@@ -151,6 +199,22 @@ Generated by [AVA](https://avajs.dev).
             ruleId: 'no-deprecated-api',
             severity: 2,
           },
+          {
+            column: 9,
+            line: 80,
+            message: 'Access of a module (coreLib/MessageType) not exported by a library',
+            messageDetails: 'Please import the module itself (sap/ui/core/MessageType) because it is no longer exported by the library',
+            ruleId: 'no-implicit-globals',
+            severity: 2,
+          },
+          {
+            column: 11,
+            line: 101,
+            message: 'Access of a module (mobileLib/InputType) not exported by a library',
+            messageDetails: 'Please import the module itself (sap/m/InputType) because it is no longer exported by the library',
+            ruleId: 'no-implicit-globals',
+            severity: 2,
+          },
           {
             column: 5,
             line: 115,

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

@@ -588,7 +588,7 @@ Generated by [AVA](https://avajs.dev).
     [
       {
         coverageInfo: [],
-        errorCount: 18,
+        errorCount: 20,
         fatalErrorCount: 0,
         filePath: 'Control_ManagedObject.js',
         messages: [
@@ -600,6 +600,22 @@ Generated by [AVA](https://avajs.dev).
             ruleId: 'no-deprecated-api',
             severity: 2,
           },
+          {
+            column: 34,
+            line: 3,
+            message: 'Access of a module (library/DateTimeInputType) not exported by a library',
+            messageDetails: 'Please import the module itself (sap/m/DateTimeInputType) because it is no longer exported by the library',
+            ruleId: 'no-implicit-globals',
+            severity: 2,
+          },
+          {
+            column: 26,
+            line: 4,
+            message: 'Access of a module (library/FrameType) not exported by a library',
+            messageDetails: 'Please import the module itself (sap/m/FrameType) because it is no longer exported by the library',
+            ruleId: 'no-implicit-globals',
+            severity: 2,
+          },
           {
             column: 17,
             line: 8,
@@ -804,7 +820,7 @@ Generated by [AVA](https://avajs.dev).
     [
       {
         coverageInfo: [],
-        errorCount: 18,
+        errorCount: 20,
         fatalErrorCount: 0,
         filePath: 'ManagedObject.js',
         messages: [
@@ -816,6 +832,22 @@ Generated by [AVA](https://avajs.dev).
             ruleId: 'no-deprecated-api',
             severity: 2,
           },
+          {
+            column: 34,
+            line: 3,
+            message: 'Access of a module (library/DateTimeInputType) not exported by a library',
+            messageDetails: 'Please import the module itself (sap/m/DateTimeInputType) because it is no longer exported by the library',
+            ruleId: 'no-implicit-globals',
+            severity: 2,
+          },
+          {
+            column: 26,
+            line: 4,
+            message: 'Access of a module (library/FrameType) not exported by a library',
+            messageDetails: 'Please import the module itself (sap/m/FrameType) because it is no longer exported by the library',
+            ruleId: 'no-implicit-globals',
+            severity: 2,
+          },
           {
             column: 17,
             line: 8,
@@ -988,7 +1020,7 @@ Generated by [AVA](https://avajs.dev).
     [
       {
         coverageInfo: [],
-        errorCount: 25,
+        errorCount: 27,
         fatalErrorCount: 0,
         filePath: 'NoDeprecatedApi.js',
         messages: [
@@ -1128,6 +1160,14 @@ Generated by [AVA](https://avajs.dev).
             ruleId: 'no-deprecated-api',
             severity: 2,
           },
+          {
+            column: 10,
+            line: 37,
+            message: 'Access of a module (coreLib/MessageType) not exported by a library',
+            messageDetails: 'Please import the module itself (sap/ui/core/MessageType) because it is no longer exported by the library',
+            ruleId: 'no-implicit-globals',
+            severity: 2,
+          },
           {
             column: 17,
             line: 39,
@@ -1168,6 +1208,14 @@ Generated by [AVA](https://avajs.dev).
             ruleId: 'no-deprecated-api',
             severity: 2,
           },
+          {
+            column: 12,
+            line: 47,
+            message: 'Access of a module (mobileLib/InputType) not exported by a library',
+            messageDetails: 'Please import the module itself (sap/m/InputType) because it is no longer exported by the library',
+            ruleId: 'no-implicit-globals',
+            severity: 2,
+          },
           {
             column: 20,
             line: 50,
@@ -1380,10 +1428,19 @@ Generated by [AVA](https://avajs.dev).
     [
       {
         coverageInfo: [],
-        errorCount: 0,
+        errorCount: 1,
         fatalErrorCount: 0,
         filePath: 'NoDeprecatedApi_negative.js',
-        messages: [],
+        messages: [
+          {
+            column: 12,
+            line: 16,
+            message: 'Access of a module (mobileLib/InputType) not exported by a library',
+            messageDetails: 'Please import the module itself (sap/m/InputType) because it is no longer exported by the library',
+            ruleId: 'no-implicit-globals',
+            severity: 2,
+          },
+        ],
         warningCount: 0,
       },
     ]