This note records the module boundaries for LeanLsp. In v0.1.0, the runtime layer is the supported preview surface and the full LSP client layer is roadmap work.
For the v0.1.0 public contract and compatibility policy, see Release scope and stability.
Architecture flow
Application code -> LeanLsp -> LeanLsp.Session -> LeanLsp.Protocol -> LeanLsp.Transport -> LeanLsp.Runtime -> LeanLsp.Runtime.Docker -> Lean language serverLeanLsp.Runtime owns process and container execution. LeanLsp.Session, LeanLsp.Transport, and LeanLsp.Protocol are the intended LSP client-layer boundaries, but they should not be presented as production-ready public APIs in v0.1.0.
Responsibility map
| Module | Owns | Does not own | v0.1.0 status |
|---|---|---|---|
LeanLsp | Public entry point for application code. It validates user options, selects or configures a runtime, and starts runtimes. | Docker internals, JSON-RPC framing, transport loops, or low-level protocol parsing. | Public preview. |
LeanLsp.Runtime | The runtime contract for starting, stopping, and executing commands in a Lean-capable runtime. It defines runtime options and normalizes runtime results. | LSP request identifiers, document state, protocol payloads, or Docker command details. | Public preview. |
LeanLsp.Runtime.Docker | The Docker implementation of the runtime contract: image selection, container setup, file system mounts, working directory and environment options, command execution, and cleanup. | Public LSP API functions, JSON-RPC framing, protocol payloads, or session state. | Public preview. |
LeanLsp.Session | Future LSP conversation state: initialization state, request identifiers, pending requests, open documents, diagnostics cache, and coordination between protocol and transport. | Starting containers, selecting Docker images, building Docker commands, or cleaning up container resources. | Roadmap. |
LeanLsp.Transport | Future byte-level LSP transport over a runtime process: Content-Length framing, reads and writes, JSON message handoff, and transport error reporting. | Request lifecycle state, document state, protocol payload construction, or runtime selection. | Roadmap. |
LeanLsp.Protocol | Future LSP and JSON-RPC data shapes: request, response, and notification payload construction and parsing. It should remain free of IO and process concerns. | Reads, writes, timers, process management, container management, or public API option validation. | Roadmap. |
Boundary rules
- Docker-specific code belongs only in
LeanLsp.Runtime.Docker, or in runtime tests that explicitly exercise that module. - The LSP client layer is planned as
LeanLsp,LeanLsp.Session,LeanLsp.Transport, andLeanLsp.Protocol. - Future LSP client modules must not contain Docker CLI strings, image names, container identifiers, mount rules, or container cleanup logic.
LeanLsp.Sessionmay askLeanLsp.Runtimefor a server process and may pass messages throughLeanLsp.Transport, but it must not know which runtime implementation supplied the process.LeanLsp.Transportmoves framed messages. It should be reusable for any runtime that exposes a process-like read and write channel.LeanLsp.Protocolbuilds and parses protocol data. Keep side effects, retries, timers, and process supervision outside it.LeanLspis the public entry point. Prefer adding user-facing functions there and keeping internal modules behind that API unless a lower-level function is intentionally documented.
Where future code belongs
| Change | Add it under |
|---|---|
| Runtime selection, process execution, server commands, Docker startup, image names, file system mounts, or cleanup | LeanLsp.Runtime or LeanLsp.Runtime.Docker |
Content-Length framing, read and write loops, message buffering, or transport errors | LeanLsp.Transport |
| Request identifier allocation, pending request registry, initialization state, document state, or diagnostics state | LeanLsp.Session |
| LSP method payloads, JSON-RPC requests, responses, notifications, or protocol parsing | LeanLsp.Protocol |
User-facing functions such as start_link/1, query helpers, option validation, and examples | LeanLsp |