@ui5/linter/lib/linter/dotLibrary/DotLibraryLinter.js

A static code analysis tool for UI5

import { deprecatedLibraries } from "../../utils/deprecations.js";
import { SaxEventType, Tag as SaxTag } from "sax-wasm";
import { parseXml } from "../../utils/xmlParser.js";
import { MESSAGE } from "../messages.js";
export default class DotLibraryLinter {
    #contentStream;
    #resourcePath;
    #context;
    constructor(resourcePath, contentStream, context) {
        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, MESSAGE.PARSING_ERROR, { message });
        }
    }
    async #parseDotLibrary(contentStream) {
        const libs = new Set();
        const tagsStack = [];
        const libNamePath = ["library", "dependencies", "dependency"];
        await parseXml(contentStream, (event, tag) => {
            if (!(tag instanceof SaxTag)) {
                return;
            }
            const serializedTag = tag.toJSON();
            if (event === SaxEventType.OpenTag && !serializedTag.selfClosing) {
                tagsStack.push(serializedTag.name);
            }
            else if (event === SaxEventType.CloseTag && !serializedTag.selfClosing) {
                tagsStack.pop();
            }
            if (event === SaxEventType.CloseTag &&
                serializedTag.name === "libraryName") {
                const isMatchingPath = libNamePath.length === tagsStack.length &&
                    libNamePath.every((lib, index) => lib === tagsStack[index]);
                if (isMatchingPath) {
                    libs.add(serializedTag);
                }
            }
        });
        return Array.from(libs);
    }
    #analyzeDeprecatedLibs(libs) {
        // Check for deprecated libraries
        libs.forEach((lib) => {
            // textNodes is always an array, but it might be empty
            const libraryName = lib.textNodes[0]?.value;
            if (deprecatedLibraries.includes(libraryName)) {
                this.#context.addLintingMessage(this.#resourcePath, MESSAGE.DEPRECATED_LIBRARY, { libraryName }, {
                    line: lib.openStart.line + 1,
                    column: lib.openStart.character + 1,
                });
            }
        });
    }
}
//# sourceMappingURL=DotLibraryLinter.js.map