Skip to content

LSP_Client.md

Latest commit

 

History

History
122 lines (78 loc) · 8.34 KB

LSP_Client.md

File metadata and controls

122 lines (78 loc) · 8.34 KB
graph LR
    LSP_Client["LSP Client"]
    LSP_Request_Handlers["LSP Request Handlers"]
    Document_State_Manager["Document State Manager"]
    Configuration_Manager["Configuration Manager"]
    Ruff_Process_Adapter["Ruff Process Adapter"]
    Diagnostic_Processor["Diagnostic Processor"]
    Code_Action_Fixing_Engine["Code Action/Fixing Engine"]
    Formatting_Engine["Formatting Engine"]
    LSP_Client -- "initiates requests to" --> LSP_Request_Handlers
    LSP_Request_Handlers -- "returns responses to" --> LSP_Client
    LSP_Request_Handlers -- "updates" --> Configuration_Manager
    LSP_Request_Handlers -- "queries" --> Configuration_Manager
    LSP_Request_Handlers -- "informs" --> Document_State_Manager
    LSP_Request_Handlers -- "requests from" --> Document_State_Manager
    LSP_Request_Handlers -- "triggers" --> Diagnostic_Processor
    LSP_Request_Handlers -- "requests from" --> Code_Action_Fixing_Engine
    LSP_Request_Handlers -- "initiates" --> Formatting_Engine
    Document_State_Manager -- "provides document content to" --> Diagnostic_Processor
    Document_State_Manager -- "provides document content to" --> Code_Action_Fixing_Engine
    Document_State_Manager -- "provides document content to" --> Formatting_Engine
    Configuration_Manager -- "provides settings to" --> Ruff_Process_Adapter
    Diagnostic_Processor -- "invokes" --> Ruff_Process_Adapter
    Code_Action_Fixing_Engine -- "invokes" --> Ruff_Process_Adapter
    Formatting_Engine -- "invokes" --> Ruff_Process_Adapter
    Diagnostic_Processor -- "returns diagnostics to" --> LSP_Request_Handlers
    Code_Action_Fixing_Engine -- "provides edits to" --> LSP_Request_Handlers
    Formatting_Engine -- "returns edits to" --> LSP_Request_Handlers
    click LSP_Client href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/ruff-lsp/LSP_Client.md" "Details"
    click Configuration_Manager href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/ruff-lsp/Configuration_Manager.md" "Details"
Loading

CodeBoardingDemoContact

Details

The ruff_lsp subsystem acts as an intermediary between an external Language Server Protocol (LSP) client and the ruff command-line tool. At its core, the LSP Request Handlers component receives and dispatches all incoming LSP messages, coordinating with the Document State Manager to maintain an up-to-date view of open files and the Configuration Manager for user-defined settings. For linting, fixing, and formatting operations, these handlers delegate to specialized engines: the Diagnostic Processor, Code Action/Fixing Engine, and Formatting Engine. Each of these engines, in turn, relies on the Ruff Process Adapter to execute ruff commands and interpret their output, effectively bridging the LSP server's functionality with Ruff's capabilities. This modular design ensures efficient processing of LSP requests and seamless integration with the underlying ruff tool.

LSP Client [Expand]

An external Language Server Protocol client (e.g., a code editor like VS Code, Neovim, etc.) that initiates requests to and receives notifications/responses from the ruff_lsp server.

Related Classes/Methods: None

LSP Request Handlers

The primary entry points for all incoming LSP messages from the client. They orchestrate the processing of requests by delegating to other internal components and formulating LSP-compliant responses.

Related Classes/Methods:

Document State Manager

Responsible for maintaining the current state (content, URI, file path) of all open text and notebook documents. It provides a consistent and up-to-date view of documents to other processing components.

Related Classes/Methods:

Configuration Manager [Expand]

Manages workspace and document-specific settings, including Ruff's configuration. It ensures that operations like linting and formatting respect user-defined preferences.

Related Classes/Methods:

Ruff Process Adapter

An essential abstraction layer for interacting with the external ruff command-line tool. It handles the execution of ruff subcommands (lint, fix, format, etc.) and manages their input/output, acting as the bridge to Ruff's core functionality.

Related Classes/Methods:

Diagnostic Processor

Executes linting operations using the Ruff Process Adapter, processes the raw output from Ruff, and translates it into structured LSP diagnostic messages (errors, warnings) for the client.

Related Classes/Methods:

Code Action/Fixing Engine

Identifies and generates available code actions (e.g., quick fixes, autofixes) based on diagnostics. It also applies these fixes by generating and returning LSP workspace edits.

Related Classes/Methods:

Formatting Engine

Handles code formatting requests for documents or ranges. It leverages Ruff's formatting capabilities via the Ruff Process Adapter and converts the resulting changes into LSP text edits.

Related Classes/Methods:

FAQ