feat: Add detection for deprecated dependencies in .library

src/linter/dotLibrary/DotLibraryLinter.ts

@@ -0,0 +1,65 @@
+import {LintMessageSeverity} from "../LinterContext.js";
+import LinterContext from "../LinterContext.js";
+import {deprecatedLibraries} from "../../utils/deprecations.js";
+import {SaxEventType, Tag as SaxTag} from "sax-wasm";
+import {parseXML} from "../../utils/xmlParser.js";
+import {ReadStream} from "node:fs";
+
+export default class DotLibraryLinter {
+	#contentStream;
+	#resourcePath;
+	#context: LinterContext;
+
+	constructor(resourcePath: string, contentStream: ReadStream, context: LinterContext) {
+		this.#contentStream = contentStream;
+		this.#resourcePath = resourcePath;
+		this.#context = context;
+	}
+
+	async lint() {
+		try {
+			const dotLibraryDependencyTags = await this.#parseDotLibrary(this.#contentStream);
+			this.#analyzeDeprecatedLibs(dotLibraryDependencyTags);
+		} catch (err) {
+			const message = err instanceof Error ? err.message : String(err);
+			this.#context.addLintingMessage(this.#resourcePath, {
+				severity: LintMessageSeverity.Error,
+				message,
+				ruleId: "ui5-linter-parsing-error",
+				fatal: true,
+			});
+		}
+	}
+
+	async #parseDotLibrary(contentStream: ReadStream): Promise<SaxTag[]> {
+		const libs = new Set();
+		await parseXML(contentStream, (event, tag) => {
+			if (tag instanceof SaxTag &&
+				event === SaxEventType.CloseTag &&
+				tag.value === "libraryName") {
+				libs.add(tag);
+			}
+		});
+
+		return Array.from(libs) as SaxTag[];
+	}
+
+	#analyzeDeprecatedLibs(libs: SaxTag[]) {
+		// Check for deprecated libraries
+		libs.forEach((lib) => {
+			const libName = lib.textNodes[0].value;
+			const {line, character: column} = lib.openStart;
+
+			if (deprecatedLibraries.includes(libName)) {
+				this.#context.addLintingMessage(this.#resourcePath, {
+					ruleId: "ui5-linter-no-deprecated-api",
+					severity: LintMessageSeverity.Error,
+					fatal: undefined,
+					line: line + 1,
+					column: column + 1,
+					message: `Use of deprecated library '${libName}'`,
+				});
+			}
+		});
+	}
+}

src/linter/dotLibrary/linter.ts

@@ -0,0 +1,29 @@
+import {LinterParameters} from "../LinterContext.js";
+import DotLibraryLinter from "./DotLibraryLinter.js";
+import {Resource} from "@ui5/fs";
+
+export default async function lintDotLibrary({context}: LinterParameters) {
+	let dotLibraryResources: Resource[];
+	const pathsToLint = context.getPathsToLint();
+	const reader = context.getRootReader();
+	if (pathsToLint?.length) {
+		dotLibraryResources = [];
+		await Promise.all(pathsToLint.map(async (resourcePath) => {
+			if (!resourcePath.endsWith(".library")) {
+				return;
+			}
+			const resource = await reader.byPath(resourcePath);
+			if (!resource) {
+				throw new Error(`Resource not found: ${resourcePath}`);
+			}
+			dotLibraryResources.push(resource);
+		}));
+	} else {
+		dotLibraryResources = await reader.byGlob("/src/**/.library");
+	}
+
+	await Promise.all(dotLibraryResources.map(async (resource: Resource) => {
+		const linter = new DotLibraryLinter(resource.getPath(), resource.getStream(), context);
+		await linter.lint();
+	}));
+}

src/linter/html/parser.ts

@@ -1,54 +1,11 @@
 import type {ReadStream} from "node:fs";
-import {Detail, SaxEventType, SAXParser, Tag as SaxTag} from "sax-wasm";
-import {finished} from "node:stream/promises";
-import fs from "node:fs/promises";
-import {createRequire} from "node:module";
-const require = createRequire(import.meta.url);
-
-let saxWasmBuffer: Buffer;
-async function initSaxWasm() {
-	if (!saxWasmBuffer) {
-		const saxPath = require.resolve("sax-wasm/lib/sax-wasm.wasm");
-		saxWasmBuffer = await fs.readFile(saxPath);
-	}
-
-	return saxWasmBuffer;
-}
-
-async function parseHtml(contentStream: ReadStream, parseHandler: (type: SaxEventType, tag: Detail) => void) {
-	const options = {highWaterMark: 32 * 1024}; // 32k chunks
-	const saxWasmBuffer = await initSaxWasm();
-	const saxParser = new SAXParser(SaxEventType.CloseTag, options);
-
-	saxParser.eventHandler = parseHandler;
-
-	// Instantiate and prepare the wasm for parsing
-	if (!await saxParser.prepareWasm(saxWasmBuffer)) {
-		throw new Error("Unknown error during WASM Initialization");
-	}
-
-	// stream from a file in the current directory
-	contentStream.on("data", (chunk: Uint8Array) => {
-		try {
-			saxParser.write(chunk);
-		} catch (err) {
-			if (err instanceof Error) {
-				// In case of an error, destroy the content stream to make the
-				// error bubble up to our callers
-				contentStream.destroy(err);
-			} else {
-				throw err;
-			}
-		}
-	});
-	await finished(contentStream);
-	saxParser.end();
-}
+import {SaxEventType, Tag as SaxTag} from "sax-wasm";
+import {parseXML} from "../../utils/xmlParser.js";
 
 export async function extractJSScriptTags(contentStream: ReadStream) {
 	const scriptTags: SaxTag[] = [];
 
-	await parseHtml(contentStream, (event, tag) => {
+	await parseXML(contentStream, (event, tag) => {
 		if (tag instanceof SaxTag &&
 			event === SaxEventType.CloseTag &&
 			tag.value === "script") {

src/linter/lintWorkspace.ts

@@ -3,6 +3,7 @@ import lintXml from "./xmlTemplate/linter.js";
 import lintJson from "./manifestJson/linter.js";
 import lintHtml from "./html/linter.js";
 import lintUI5Yaml from "./yaml/linter.js";
+import lintDotLibrary from "./dotLibrary/linter.js";
 import {taskStart} from "../utils/perf.js";
 import TypeLinter from "./ui5Types/TypeLinter.js";
 import LinterContext, {LintResult, LinterParameters, LinterOptions} from "./LinterContext.js";
@@ -22,6 +23,7 @@ export default async function lintWorkspace(
 		lintJson(params),
 		lintHtml(params),
 		lintUI5Yaml(params),
+		lintDotLibrary(params),
 	]);
 
 	const typeLinter = new TypeLinter(params);

src/utils/xmlParser.ts

@@ -0,0 +1,46 @@
+import type {ReadStream} from "node:fs";
+import {Detail, SaxEventType, SAXParser} from "sax-wasm";
+import {finished} from "node:stream/promises";
+import fs from "node:fs/promises";
+import {createRequire} from "node:module";
+const require = createRequire(import.meta.url);
+
+let saxWasmBuffer: Buffer;
+async function initSaxWasm() {
+	if (!saxWasmBuffer) {
+		const saxPath = require.resolve("sax-wasm/lib/sax-wasm.wasm");
+		saxWasmBuffer = await fs.readFile(saxPath);
+	}
+
+	return saxWasmBuffer;
+}
+
+export async function parseXML(contentStream: ReadStream, parseHandler: (type: SaxEventType, tag: Detail) => void) {
+	const options = {highWaterMark: 32 * 1024}; // 32k chunks
+	const saxWasmBuffer = await initSaxWasm();
+	const saxParser = new SAXParser(SaxEventType.CloseTag, options);
+
+	saxParser.eventHandler = parseHandler;
+
+	// Instantiate and prepare the wasm for parsing
+	if (!await saxParser.prepareWasm(saxWasmBuffer)) {
+		throw new Error("Unknown error during WASM Initialization");
+	}
+
+	// stream from a file in the current directory
+	contentStream.on("data", (chunk: Uint8Array) => {
+		try {
+			saxParser.write(chunk);
+		} catch (err) {
+			if (err instanceof Error) {
+				// In case of an error, destroy the content stream to make the
+				// error bubble up to our callers
+				contentStream.destroy(err);
+			} else {
+				throw err;
+			}
+		}
+	});
+	await finished(contentStream);
+	saxParser.end();
+}

test/fixtures/linter/projects/library.with.custom.paths/src/main/js/.library

@@ -8,5 +8,14 @@
 		<dependency>
 			<libraryName>sap.ui.core</libraryName>
 		</dependency>
+		<dependency>
+			<libraryName>sap.ca.scfld.md</libraryName>
+		</dependency>
+		<dependency>
+			<libraryName>sap.ca.scfld.md</libraryName>
+		</dependency>
+		<dependency>
+			<libraryName>sap.ca.ui</libraryName>
+		</dependency>
 	</dependencies>
 </library>

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

@@ -845,6 +845,39 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     [
+      {
+        coverageInfo: [],
+        errorCount: 3,
+        fatalErrorCount: 0,
+        filePath: 'src/main/js/.library',
+        messages: [
+          {
+            column: 4,
+            fatal: undefined,
+            line: 12,
+            message: 'Use of deprecated library \'sap.ca.scfld.md\'',
+            ruleId: 'ui5-linter-no-deprecated-api',
+            severity: 2,
+          },
+          {
+            column: 4,
+            fatal: undefined,
+            line: 15,
+            message: 'Use of deprecated library \'sap.ca.scfld.md\'',
+            ruleId: 'ui5-linter-no-deprecated-api',
+            severity: 2,
+          },
+          {
+            column: 4,
+            fatal: undefined,
+            line: 18,
+            message: 'Use of deprecated library \'sap.ca.ui\'',
+            ruleId: 'ui5-linter-no-deprecated-api',
+            severity: 2,
+          },
+        ],
+        warningCount: 0,
+      },
       {
         coverageInfo: [],
         errorCount: 0,

test/lib/utils/xmlParser.ts

@@ -0,0 +1,50 @@
+import test from "ava";
+import {parseXML} from "../../../src/utils/xmlParser.js";
+import {ReadStream} from "node:fs";
+import {Readable} from "node:stream";
+import {SaxEventType, Tag as SaxTag} from "sax-wasm";
+
+test("Test xmlParser with .library", async (t) => {
+	const sampleDotLibrary = `<?xml version="1.0" ?>
+<library xmlns="http://www.sap.com/sap.ui.library.xsd">
+	<name>library.with.custom.paths</name>
+	<vendor>SAP SE</vendor>
+	<version>1.0</version>
+	<copyright>any</copyright>
+	<dependencies>
+		<dependency>
+			<libraryName>sap.ui.core</libraryName>
+		</dependency>
+		<dependency>
+			<libraryName>sap.ca.scfld.md</libraryName>
+		</dependency>
+		<dependency>
+			<libraryName>sap.ca.scfld.md</libraryName>
+		</dependency>
+		<dependency>
+			<libraryName>sap.ca.ui</libraryName>
+		</dependency>
+	</dependencies>
+</library>`;
+
+	// Convert raw .library content into stream
+	const contentStream = new Readable() as ReadStream;
+	// eslint-disable-next-line @typescript-eslint/no-empty-function
+	contentStream._read = () => {};
+	contentStream.push(sampleDotLibrary);
+	contentStream.push(null);
+
+	// Call SAXParser with the contentStream
+	const libs: SaxTag[] = [];
+	await parseXML(contentStream, (event, tag) => {
+		if (tag instanceof SaxTag &&
+			event === SaxEventType.CloseTag &&
+			tag.value === "libraryName") {
+			libs.push(tag);
+		}
+	});
+
+	// Test parsed results
+	t.is(libs.length, 4, "Parsed .library XML should contain 4 libraries");
+	t.is(libs[0].textNodes[0].value, "sap.ui.core", "First library should be 'sap.ui.core'");
+});