Collagraph LSP Server

A Language Server Protocol (LSP) implementation for Collagraph .cgx files with integrated ruff linting.

Collagraph is a Python port of Vue.js, supporting single-file components in .cgx files. This LSP server provides real-time linting and formatting for Python code within these files.

Features

• Linting with ruff: Uses ruff to lint the Python code within the script tag
• Formatting with ruff: Uses ruff to format the python code within the script tag and template expressions
• Python autocompletion: Provides intelligent code completion for Python code in <script> sections using Jedi with full component context
• Go to Definition: Jump to the definition of variables, functions, classes, and imports defined in <script> blocks

Installation

Install from PyPi:

uv tool install collagraph-lsp
# or with pip
pip install collagraph-lsp

Install from source

# Clone the repository
git clone https://github.com/fork-tongue/collagraph-lsp.git
cd collagraph-lsp
uv tool install .

Usage

Running the Server

The LSP server communicates over stdin/stdout. To start it:

# Using uv
uv run collagraph-lsp

# Or run directly
uv run python -m collagraph_lsp.server

Configuration

The server works with default Ruff settings, although it should pick up on your configuration in your project root.

Editor Integration

Coming soon:

• Sublime Text
• VS Code
• Zed

LSP settings

Configure which command to use for ruff:

{
	"ruff_command": "/path/to/ruff"
}

Development

Running Tests

# Install (development) dependencies
uv sync

# Run tests
uv run pytest

# Run tests with coverage
uv run pytest --cov=collagraph_lsp

# Lint and format
uv run ruff check --fix
uv run ruff format

Related Projects

• collagraph - Python port of Vue.js
• ruff-cgx - Linter and formatter for cgx files