# microsoft/vscode-java-dependency architecture

> Architecture diagram of the GitHub repository microsoft/vscode-java-dependency, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-11-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/microsoft/vscode-java-dependency
- Repository: https://github.com/microsoft/vscode-java-dependency

## Overview

##### Project Type and Purpose
- This is a Visual Studio Code extension (“Project Manager for Java”) written in TypeScript/JavaScript, which integrates with the Red Hat Java Language Server (jdtls) and a companion Java plugin (jdtls.ext) to provide enhanced Java-project exploration, creation, dependency management, and JAR export in VS Code.

##### Main Architectural Components
a. VS Code Client & UI Layer
- VS Code Editor (UI host)
- Java Projects Explorer view (tree view UI)
b. Extension Host & Business Logic (Node.js process)
- The TypeScript/JavaScript entry point (extension.ts → controllers → views → commands → utility modules)
- LanguageServerApiManager: manages LSP connections & modes
- Controllers (e.g., projectController, libraryController) implementing commands (create, rename, delete, export)
- Task Providers (buildTaskProvider, BuildArtifactTaskProvider): exposes VS Code tasks for building and exporting jars
- ExperimentationService / Telemetry
- Copilot integration modules
- File-system watchers / syncHandler
- Template engine (templates/invisible-project for project scaffolding)
c. Language Server & Java Plugin
- Red Hat Java Language Server (external process speaking LSP)
- jdtls.ext (a Maven-based Java plugin that is built and loaded by the language server): adds commands & model providers (com.microsoft.jdtls.ext.core)
d. File System & Build Tools
- Local disk (workspace folders, .java files, user-referenced JARs)
- Maven wrapper & pom.xml for jdtls.ext plugin build
e. Testing & CI/CD
- Mocha/TypeScript test suite under /test
- GitHub Actions & Azure Pipelines for multi-platform build & release

##### Relationships and Data Flows
- VS Code UI ←→ Extension Host via VS Code Extension API
- Extension Host ↔ Java Language Server via the Language Server Protocol (requests for project structure, symbols, diagnostics)
- Java Language Server loads the jdtls.ext plugin (Java VM loads compiled plugin JAR produced by Maven wrapper)
- Extension Host invokes VS Code Tasks API to run build/export commands (spawn processes: mvn, javac, jar)
- Controllers update the UI tree by reading the file system or by querying the language server plugin model (Trie-based package/project model)
- Telemetry and ExperimentationService collect usage/events and send to Microsoft

##### Key Architectural Patterns & Principles
- Modular MVC-style separation:
- Views (src/views) generate the UI nodes
- Controllers (src/controllers) mediate commands and user actions
- Models (src/java/*, jdtls.ext/* model packages) represent project/package trees
- Command Pattern: each user action (new, delete, rename, export) is encapsulated in its own command module
- Provider Pattern: TreeDataProvider for explorer, TaskProvider for build tasks, CodeActionProviders for migration
- LSP Integration: wraps language server interactions in a manager class (LanguageServerApiManager)
- Template-driven scaffolding: uses project templates for “invisible-project” creation

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% VS Code Client/UI
    subgraph "VS Code Client/UI"
        direction TB
        UI["VS Code Editor (UI host)"]:::ui
        ExplorerView["Java Projects Explorer View"]:::ui
    end

    %% Extension Host
    subgraph "Extension Host (Node.js TS/JS)"
        direction TB
        ExtensionEntry["Extension Entry Point"]:::host
        CommandsReg["Commands Registration"]:::host
        Controllers["Controllers"]:::host
        Views["Views / TreeDataProviders"]:::host
        LSPManager["LanguageServerApiManager"]:::host
        Tasks["Task Providers"]:::host
        SyncHandler["File-system Watcher / SyncHandler"]:::host
        TemplateEngine["Template Engine (invisible-project)"]:::host
        Telemetry["ExperimentationService / Telemetry"]:::external
        Copilot["Copilot Integration Modules"]:::host
    end

    %% Language Server & Plugin
    subgraph "Java Language Server (Eclipse JDT LS)"
        direction TB
        LS["Red Hat Java Language Server"]:::ls
    end

    subgraph "jdtls.ext Java Plugin"
        direction TB
        PluginCore["com.microsoft.jdtls.ext.core"]:::plugin
    end

    %% File System & Build Tools
    subgraph "File System & Build Tools"
        direction TB
        Disk["Local Disk (workspace, .java, JARs)"]:::fs
        MavenWrapper["Maven Wrapper & pom.xml"]:::fs
    end

    %% CI/CD & Tests
    subgraph "CI/CD & Tests"
        direction TB
        Tests["Mocha/TS Test Suite"]:::ci
        GHActions["GitHub Actions"]:::ci
        AzurePipelines["Azure Pipelines"]:::ci
    end

    %% Connections
    UI -->|"TreeDataProvider API"| ExplorerView
    ExplorerView -->|"VS Code API call"| ExtensionEntry
    ExtensionEntry -->|"imports src/commands.ts"| CommandsReg
    CommandsReg -->|"registerCommand"| Controllers
    Controllers -->|"invoke"| Views
    Controllers -->|"calls"| Tasks
    Controllers -->|"uses"| LSPManager
    Controllers -->|"reads/writes"| Disk
    Views -->|"reads model"| LSPManager
    Views -->|"reads FS"| Disk
    LSPManager -->|"LSP JSON-RPC"| LS
    LS -->|"loads plugin JAR"| PluginCore
    Tasks -->|"spawn mvn/javac/jar"| MavenWrapper
    Tasks -->|"spawn"| Disk
    ExtensionEntry -->|"listen FS events"| SyncHandler
    ExtensionEntry -->|"scaffold via"| TemplateEngine
    ExtensionEntry -->|"send events"| Telemetry
    ExtensionEntry -->|"use"| Copilot
    Tests -->|"validate"| ExtensionEntry
    Tests -->|"validate"| PluginCore
    GHActions -->|"CI"| ExtensionEntry
    AzurePipelines -->|"CI"| PluginCore

    %% Click Events
    click ExtensionEntry "https://github.com/microsoft/vscode-java-dependency/blob/main/src/extension.ts"
    click CommandsReg "https://github.com/microsoft/vscode-java-dependency/blob/main/src/commands.ts"
    click Controllers "https://github.com/microsoft/vscode-java-dependency/blob/main/src/controllers/projectController.ts"
    click Controllers "https://github.com/microsoft/vscode-java-dependency/blob/main/src/controllers/libraryController.ts"
    click Views "https://github.com/microsoft/vscode-java-dependency/blob/main/src/views/nodeFactory.ts"
    click Views "https://github.com/microsoft/vscode-java-dependency/blob/main/src/views/nodeCache/Trie.ts"
    click Views "https://github.com/microsoft/vscode-java-dependency/blob/main/src/views/nodeCache/explorerNodeCache.ts"
    click LSPManager "https://github.com/microsoft/vscode-java-dependency/blob/main/src/languageServerApi/languageServerApiManager.ts"
    click LSPManager "https://github.com/microsoft/vscode-java-dependency/blob/main/src/languageServerApi/LanguageServerMode.ts"
    click Tasks "https://github.com/microsoft/vscode-java-dependency/blob/main/src/tasks/build/buildTaskProvider.ts"
    click Tasks "https://github.com/microsoft/vscode-java-dependency/blob/main/src/tasks/buildArtifact/BuildArtifactTaskProvider.ts"
    click Tasks "https://github.com/microsoft/vscode-java-dependency/blob/main/src/tasks/buildArtifact/GenerateJarExecutor.ts"
    click Tasks "https://github.com/microsoft/vscode-java-dependency/blob/main/src/tasks/buildArtifact/ResolveJavaProjectExecutor.ts"
    click Tasks "https://github.com/microsoft/vscode-java-dependency/blob/main/src/tasks/buildArtifact/ResolveMainClassExecutor.ts"
    click TemplateEngine "https://github.com/microsoft/vscode-java-dependency/tree/main/templates/invisible-project"
    click PluginCore "https://github.com/microsoft/vscode-java-dependency/tree/main/jdtls.ext/com.microsoft.jdtls.ext.core/src"
    click MavenWrapper "https://github.com/microsoft/vscode-java-dependency/blob/main/jdtls.ext/pom.xml"
    click MavenWrapper "https://github.com/microsoft/vscode-java-dependency/blob/main/jdtls.ext/.mvn"
    click Tests "https://github.com/microsoft/vscode-java-dependency/tree/main/test/"
    click GHActions "https://github.com/microsoft/vscode-java-dependency/tree/main/.github/workflows/"
    click AzurePipelines "https://github.com/microsoft/vscode-java-dependency/tree/main/.azure-pipelines/"

    %% Styles
    classDef ui fill:#DAE8FC,stroke:#6C8EBF,color:#000
    classDef host fill:#E1F5A9,stroke:#7FB347,color:#000
    classDef ls fill:#F8CECC,stroke:#B85450,color:#000
    classDef plugin fill:#F5B041,stroke:#A04000,color:#000
    classDef fs fill:#EDEDED,stroke:#CCCCCC,color:#000
    classDef external fill:#D7BDE2,stroke:#7D3C98,color:#000
    classDef ci fill:#F2F2F2,stroke:#999999,color:#000
```
