# sap/ui5-linter architecture

> Architecture diagram of the GitHub repository sap/ui5-linter, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sap/ui5-linter
- Repository: https://github.com/sap/ui5-linter

## Overview

##### Project Type and Purpose
- This is an open-source, TypeScript-based CLI tool and Node.js library (“UI5 Linter”) for statically analyzing UI5 applications.
- Its purpose is to scan UI5 JavaScript, TypeScript, XML, JSON, etc., detect deprecated APIs, globals, CSP violations, manifest errors, and optionally autofix certain issues.

##### High-Level Architecture
- Container: Node.js runtime
- Entrypoint: `bin/ui5lint.js` (CLI)
- Library API: `src/index.ts` (`ui5lint` function) and `UI5LinterEngine` class
- Core Engine
- ConfigManager (loads CLI flags, config file, UI5 YAML)
- File Scanner / Glob Resolver (builds list of files based on patterns and ignore-patterns)
- Linter Orchestrator (`lintWorkspace`, `LinterContext`)
- Parsers and Transpilers
- TypeScript Compiler API (parses JS/TS after optional ESM transpilation)
- XML/HTML transpiler (converts UI5 XML views to JS AST)
- AMD → ESM transpiler (rewrites `sap.ui.require` calls)
- Rules and Analyzers
- Rule modules (`src/linter/...`): binding, dotLibrary, manifestJson, HTML, YAML, UI5 types, XML templates, etc.
- Each rule registers with the LinterContext and returns Findings
- Autofix Pipeline
- Autofix runner (`src/autofix`) applies automatic solutions for fixable rules, then triggers a second lint pass
- Formatters and Output
- Formatter modules (`src/formatter`): text, JSON, Markdown, coverage reports
- CLI logger and middlewares (`src/cli/middlewares`) handle spinner, log-level, update notifications, perf logging
- External Dependencies
- UI5 Type Definitions (`resources/types` + `api-extract.json`)
- TypeScript Compiler (npm module)
- Node.js FS/Path modules

##### Relationships and Data Flows
- The CLI invokes the Library API with parsed options → ConfigManager → File Scanner
- File Scanner outputs a stream/list of file paths → Linter Orchestrator
- For each file:
a. Optional Transpiler
b. Parser (TS or XML → TS AST)
c. LinterContext dispatches AST to rule modules → collects findings
- Autofix pipeline may transform source files on disk and re-invoke the above steps
- Findings are passed to Formatter → CLI prints to console or file

##### Architectural Patterns and Principles
- Modular pipeline architecture (scan → parse → analyze → format)
- Dependency inversion: rules implement a common linter interface and register dynamically
- Separation of concerns: CLI parsing, config, scanning, parsing, linting, formatting, autofix are all separate layers
- Caching/Reusability: `UI5LinterEngine` caches common data for repeated runs

- Inside:
– CLI Layer (Parser → Middlewares)
– ConfigManager
– File Scanner
– Transpiler Layer
– Parser & AST Generator
– Linter Engine (LinterContext + Rule Modules)
– Autofix Module
– Formatter Module
- External Services/Resources around it:
– UI5 Type Definitions & api-extract.json
– TypeScript Compiler API
– Filesystem (Input: project files; Output: reports, modified files)

## Diagram (Mermaid)

```mermaid
graph TB
    title["UI5 Linter System Architecture"]

    subgraph "Node.js Process"
        direction TB

        CLIEntrypoint["CLI Entrypoint\nbin/ui5lint.js"]:::core
        LibraryAPI["Library API\nsrc/index.ts"]:::core
        subgraph "CLI Layer"
            direction TB
            CLIParser["CLI Argument Parser"]:::core
            Middlewares["CLI Middlewares"]:::core
        end

        ConfigManager["ConfigManager"]:::core
        FileScanner["File Scanner / Glob Resolver"]:::core

        subgraph "Parsing & Transpiling"
            direction TB
            subgraph "TypeScript Integration"
                direction TB
                TSHostProxy["LanguageServiceHostProxy"]:::core
                SharedLS["SharedLanguageService"]:::core
            end
            XMLTranspiler["XML/HTML Transpiler"]:::core
            HTMLParser["HTML Parser"]:::core
            AMDTranspiler["AMD→ESM Transpiler"]:::core
        end

        subgraph "Analysis"
            direction TB
            LinterContext["LinterContext"]:::core
            subgraph "Rule Modules"
                direction TB
                BindingRule["Binding Linter"]:::core
                DotLibRule["DotLibrary Linter"]:::core
                ManifestRule["Manifest JSON Linter"]:::core
                FileTypesRule["File Types Linter"]:::core
                YAMLRule["YAML Linter"]:::core
                XMLTempRule["XML Template Linter"]:::core
                TypeRule["UI5 Types Linter"]:::core
            end
        end

        subgraph "Autofix Pipeline"
            direction TB
            AutofixRunner["Autofix Runner"]:::core
            NoGlobalsSol["NoGlobals Solution"]:::core
            AmdImportsSol["AMD Imports Solution"]:::core
        end

        subgraph "Formatters & Output"
            direction TB
            TextFmt["Text Formatter"]:::core
            JSONFmt["JSON Formatter"]:::core
            MDfmt["Markdown Formatter"]:::core
            CovFmt["Coverage Report Formatter"]:::core
        end
    end

    subgraph "External Dependencies"
        direction TB
        TSCompilerAPI["TypeScript Compiler API"]:::ext
        UI5TypesJSON["api-extract.json"]:::ext
        UI5TypesFolder["UI5 Type Definitions"]:::ext
    end

    Filesystem["Filesystem (Project Files & Reports)"]:::io

    %% Connections
    CLIEntrypoint -->|invokes| LibraryAPI
    LibraryAPI -->|parses options| CLIParser
    CLIParser --> Middlewares
    Middlewares --> ConfigManager
    ConfigManager --> FileScanner
    FileScanner --> XMLTranspiler
    FileScanner --> TSHostProxy
    FileScanner --> SharedLS
    XMLTranspiler --> HTMLParser
    HTMLParser -->|AST| LinterContext
    TSHostProxy -->|AST| LinterContext
    SharedLS -->|AST| LinterContext
    AMDTranspiler -->|rewrites modules| LinterContext
    LinterContext --> BindingRule
    LinterContext --> DotLibRule
    LinterContext --> ManifestRule
    LinterContext --> FileTypesRule
    LinterContext --> YAMLRule
    LinterContext --> XMLTempRule
    LinterContext --> TypeRule
    LinterContext --> AutofixRunner
    AutofixRunner --> NoGlobalsSol
    AutofixRunner --> AmdImportsSol
    AutofixRunner -->|re-run lint| LinterContext
    LinterContext --> TextFmt
    LinterContext --> JSONFmt
    LinterContext --> MDfmt
    LinterContext --> CovFmt
    TextFmt --> Filesystem
    JSONFmt --> Filesystem
    MDfmt --> Filesystem
    CovFmt --> Filesystem

    TSCompilerAPI --> TSHostProxy
    UI5TypesJSON --> SharedLS
    UI5TypesFolder --> SharedLS
    Filesystem --> FileScanner

    %% Click Events
    click CLIEntrypoint "https://github.com/sap/ui5-linter/blob/main/bin/ui5lint.js"
    click LibraryAPI "https://github.com/sap/ui5-linter/blob/main/src/index.ts"
    click ConfigManager "https://github.com/sap/ui5-linter/blob/main/src/utils/ConfigManager.ts"
    click FileScanner "https://github.com/sap/ui5-linter/blob/main/src/linter/lintWorkspace.ts"
    click LinterContext "https://github.com/sap/ui5-linter/blob/main/src/linter/LinterContext.ts"
    click TSHostProxy "https://github.com/sap/ui5-linter/blob/main/src/linter/ui5Types/LanguageServiceHostProxy.ts"
    click SharedLS "https://github.com/sap/ui5-linter/blob/main/src/linter/ui5Types/SharedLanguageService.ts"
    click XMLTranspiler "https://github.com/sap/ui5-linter/blob/main/src/linter/html/transpiler.ts"
    click HTMLParser "https://github.com/sap/ui5-linter/blob/main/src/linter/html/parser.ts"
    click AMDTranspiler "https://github.com/sap/ui5-linter/blob/main/src/linter/ui5Types/amdTranspiler/transpiler.ts"
    click BindingRule "https://github.com/sap/ui5-linter/blob/main/src/linter/binding/BindingLinter.ts"
    click DotLibRule "https://github.com/sap/ui5-linter/blob/main/src/linter/dotLibrary/DotLibraryLinter.ts"
    click ManifestRule "https://github.com/sap/ui5-linter/blob/main/src/linter/manifestJson/ManifestLinter.ts"
    click FileTypesRule "https://github.com/sap/ui5-linter/blob/main/src/linter/fileTypes/linter.ts"
    click YAMLRule "https://github.com/sap/ui5-linter/blob/main/src/linter/yaml/YamlLinter.ts"
    click XMLTempRule "https://github.com/sap/ui5-linter/blob/main/src/linter/xmlTemplate/linter.ts"
    click TypeRule "https://github.com/sap/ui5-linter/blob/main/src/linter/ui5Types/TypeLinter.ts"
    click AutofixRunner "https://github.com/sap/ui5-linter/blob/main/src/autofix/autofix.ts"
    click NoGlobalsSol "https://github.com/sap/ui5-linter/blob/main/src/autofix/solutions/noGlobals.ts"
    click AmdImportsSol "https://github.com/sap/ui5-linter/blob/main/src/autofix/solutions/amdImports.ts"
    click TextFmt "https://github.com/sap/ui5-linter/blob/main/src/formatter/text.ts"
    click JSONFmt "https://github.com/sap/ui5-linter/blob/main/src/formatter/json.ts"
    click MDfmt "https://github.com/sap/ui5-linter/blob/main/src/formatter/markdown.ts"
    click CovFmt "https://github.com/sap/ui5-linter/blob/main/src/formatter/coverage.ts"
    click Middlewares "https://github.com/sap/ui5-linter/blob/main/src/cli/middlewares/logger.ts"
    click Middlewares "https://github.com/sap/ui5-linter/blob/main/src/cli/middlewares/updateNotifier.ts"
    click UI5TypesJSON "https://github.com/sap/ui5-linter/blob/main/resources/api-extract.json"
    click UI5TypesFolder "https://github.com/sap/ui5-linter/tree/main/resources/types"

    %% Styles
    classDef core fill:#D6E6FF,stroke:#4D79FF
    classDef ext fill:#D5E8D4,stroke:#82B366
    classDef io fill:#FFE6CC,stroke:#FF9900
```
