Skip to content

Commit a9776d3

Browse files
committed
docs: update README to match actual code
- Update container image paths from ghcr.io/observerw/lsp-client/* to ghcr.io/lsp-client/*:latest - Add missing Ty and Gopls language servers to supported clients table - Fix example filename from pyright_docker.py to pyright_container.py - Fix containerized example to use correct PyrightContainerServer() syntax - Remove obsolete container/gopls/ContainerFile and container/registry.toml
1 parent c4c103f commit a9776d3

File tree

3 files changed

+10
-65
lines changed

3 files changed

+10
-65
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ anyio.run(main)
5656
async def main():
5757
workspace = Path.cwd()
5858
async with PyrightClient(
59-
server=PyrightContainerServer(mounts=[workspace]),
59+
server=PyrightContainerServer(),
6060
workspace=workspace
6161
) as client:
6262
# Find definition of a symbol
@@ -74,15 +74,15 @@ anyio.run(main)
7474

7575
The `examples/` directory contains comprehensive usage examples:
7676

77-
- `pyright_docker.py` - Using Pyright in Docker for Python analysis
77+
- `pyright_container.py` - Using Pyright in Docker for Python analysis
7878
- `rust_analyzer.py` - Rust code intelligence with Rust-Analyzer
7979
- `pyrefly.py` - Python linting and analysis with Pyrefly
8080
- `protocol.py` - Direct LSP protocol usage
8181

8282
Run examples with:
8383

8484
```bash
85-
uv run examples/pyright_docker.py
85+
uv run examples/pyright_container.py
8686
```
8787

8888
## Client Definition
@@ -118,11 +118,13 @@ class MyPythonClient(
118118

119119
| Language Server | Module Path | Language | Container Image |
120120
| -------------------------- | ---------------------------------- | --------------------- | -------------------------------------------- |
121-
| Pyright | `lsp_client.clients.pyright` | Python | `ghcr.io/observerw/lsp-client/pyright` |
122-
| Pyrefly | `lsp_client.clients.pyrefly` | Python | `ghcr.io/observerw/lsp-client/pyrefly` |
123-
| Rust Analyzer | `lsp_client.clients.rust_analyzer` | Rust | `ghcr.io/observerw/lsp-client/rust-analyzer` |
124-
| Deno | `lsp_client.clients.deno` | TypeScript/JavaScript | `ghcr.io/observerw/lsp-client/deno` |
125-
| TypeScript Language Server | `lsp_client.clients.typescript` | TypeScript/JavaScript | `ghcr.io/observerw/lsp-client/typescript` |
121+
| Pyright | `lsp_client.clients.pyright` | Python | `ghcr.io/lsp-client/pyright:latest` |
122+
| Pyrefly | `lsp_client.clients.pyrefly` | Python | `ghcr.io/lsp-client/pyrefly:latest` |
123+
| Ty | `lsp_client.clients.ty` | Python | `ghcr.io/lsp-client/ty:latest` |
124+
| Rust Analyzer | `lsp_client.clients.rust_analyzer` | Rust | `ghcr.io/lsp-client/rust-analyzer:latest` |
125+
| Deno | `lsp_client.clients.deno` | TypeScript/JavaScript | `ghcr.io/lsp-client/deno:latest` |
126+
| TypeScript Language Server | `lsp_client.clients.typescript` | TypeScript/JavaScript | `ghcr.io/lsp-client/typescript:latest` |
127+
| Gopls | `lsp_client.clients.gopls` | Go | `ghcr.io/lsp-client/gopls:latest` |
126128

127129
Container images are automatically updated weekly to ensure access to the latest language server versions.
128130

container/gopls/ContainerFile

Lines changed: 0 additions & 24 deletions
This file was deleted.

container/registry.toml

Lines changed: 0 additions & 33 deletions
This file was deleted.

0 commit comments

Comments
 (0)