LSP-сервер для диагностики ошибок #
Это задание только для тех, кто выбрал 🔴 красную дорожку.
Нужно реализовать минимальный LSP-сервер, который анализирует документы на синтаксические ошибки и публикует их клиенту.
Что такое LSP-сервер #
LSP-сервер или language server — это сервис, который реализует Language Server Protocol (LSP) и предоставляет возможности IDE для какого-либо формального языка:
- Обычно для каждого языка программирования разрабатывается свой LSP-сервер
- Обычно LSP-сервер пишут на том же языке программирования, на котором написан компилятор/интерпретатор
- Обычно LSP-сервер запускается самим клиентом — IDE или ИИ-агентом
- LSP-сервер запускается как отдельный процесс — это обеспечивает изоляцию и устойчивость IDE при проблемах в LSP-сервере
- LSP основан на JSON-RPC 2.0
Для LSP можно использовать несколько транспортных протоколов, в том числе:
- Взаимодействие через пайпы (unix pipes) — LSP-сервер читает входящие сообщения из stdio и пишет исходящие в stdout
- Взаимодействие через TCP-сокет — LSP-сервер запускается как TCP-сервер
Требования к реализации LSP-сервера #
- На данном этапе LSP-сервер должен поддерживать только публикацию ошибок синтаксического разбора:
- сервер должен обрабатывать уведомления
textDocument/didOpen,textDocument/didChange,textDocument/didClose - сервер должен отправлять
textDocument/publishDiagnostics - обработчик сообщения
capabilitiesдолжен сообщать клиенту, что сервер поддерживает только режимTextDocumentSyncKind.Full
- сервер должен обрабатывать уведомления
- LSP-сервер должен быть реализован на том же языке, что и парсер
- Рекомендуется выбрать библиотеку для реализации LSP-сервера, а не создавать сервер самостоятельно
- Для Go рекомендуется github.com/tliron/glsp
- Для C++ рекомендуется github.com/leon-bckl/lsp-framework
- Для C# рекомендуется OmniSharp.Extensions.LanguageServer
- LSP-сервер может поддерживать любой транспортный протокол, совместимый с VSCode, при этом рекомендуется поддерживать два транспортных протокола:
- stdio для взаимодействия с VSCode-плагином
- TCP для интеграционных тестов LSP-сервера
Требования к диагностике ошибок #
- Лексический анализатор должен записывать в каждый токен его начало и конец — рекомендуется завести структуру
SourceLocation(line, column: int)и добавлять в структуруTokenполяstart, end: SourceLocation - Парсер может разбирать код до первой ошибки либо иметь восстановление после ошибок — например, при ошибке разбора инструкции токены пропускаются до конца инструкции/блока
- Парсер должен так или иначе передавать LSP-серверу ошибку либо список ошибок разбора документа
- LSP-сервер должен конвертировать позиции кода в формат LSP, где отсчёт line и column начинается с 0
В LSP номера колонок считаются по UTF-16 codepoint, а не по байтам и не по символам Unicode. В вашей реализации LSP-сервера допускается считать номера колонок либо по UTF-16 codepoints, либо по символам Unicode — то есть неправильная обработка Unicode-символов за пределами Basic Multilingual Planе не считается замечанием.
Интеграционные тесты LSP-сервера #
Для LSP-сервера должно быть как минимум два интеграционных теста:
- Тест на разбор корректной програмы
- Тест на разбор некорректной програмы, код которой не дописан до конца
Интеграционные тесты можно реализовать любым удобным способом:
- Можно запускать TCP-сервер в памяти процессе с тестами и писать тесты на том же языке, что и LSP-сервер
- Можно запускать LSP-сервер как отдельный процесс и писать тесты на скриптовом языке — например, на Python 3