BSL Language Server

Реализация протокола language server protocol для языка 1C (BSL) - языка 1С:Предприятие 8 и OneScript.

Сайт проекта - https://1c-syntax.github.io/bsl-language-server

Возможности

Форматирование файла
Форматирование выбранного диапазона
Определение символов текущего файла (области, процедуры, функции, переменные, объявленные через Перем)
Определение сворачиваемых областей - #Область, #Если, процедуры и функции, блоки кода
Показ когнитивной сложности метода
Диагностики
"Быстрые исправления" (quick fixes) для ряда диагностик
Запуск движка диагностик из командной строки
Запуск форматирования файлов в каталоге из командной строки

Запуск из командной строки

Запуск jar-файлов осуществляется через java -jar path/to/file.jar.

java -jar bsl-language-server.jar --help

usage: BSL language server [-a] [-c <arg>] [-f] [-h] [-o <arg>] [-r <arg>] [-s <arg>]
 -a,--analyze               Run analysis and get diagnostic info
 -c,--configuration <arg>   Path to language server configuration file
 -f,--format                Format files in source directory
 -h,--help                  Show help.
 -o,--outputDir <arg>       Output report directory
 -r,--reporter <arg>        Reporter key
 -s,--srcDir <arg>          Source directory
 -v,--version               Version

При запуске BSL Language Server в обычном режиме будет запущен сам Language Server, взаимодействующий по протоколу LSP. Для взаимодействия используются stdin и stdout.

По умолчанию тексты диагностик выдаются на русском языке. Для переключения языка сообщений от движка диагностик необходимо настроить параметр diagnosticLanguage в конфигурационном файле или вызвав событие workspace/didChangeConfiguration:

Запуск в режиме анализатора

Для запуска в режиме анализа используется параметр --analyze (сокращенно -a). Для указания каталога расположения анализируемых исходников используется параметр --srcDir (сокращенно -s), за которым следует путь (относительный или абсолютный) к каталогу исходников.

Для формирования отчета об анализе требуется указать один или "репортеров". Для указания репортера используется параметр --reporter (сокращенно -r), за которым следует ключ репортера. Допустимо указывать несколько репортеров.

Список и описания репортеров, диагностик, конфигурационного файла доступны на сайте проекта.

Пример строки запуска анализа:

java -jar bsl-language-server.jar --analyze --srcDir ./src/cf --reporter json

При анализе больших исходников рекомендуется дополнительно указывать параметр -Xmx, отвечающий за предел оперативной памяти для java процесса. Размер выделяемой памяти зависит от размера анализируемой кодовой базы.

java -Xmx4g -jar bsl-language-server.jar ...остальные параметры

Запуск в режиме форматтера

Для запуска в режиме форматтера используется параметр --format (сокращенно -f). Для указания каталога расположения форматируемых исходников используется параметр --srcDir (сокращенно -s), за которым следует путь (относительный или абсолютный) к каталогу исходников.

Пример строки запуска анализа:

java -jar bsl-language-server.jar --format --srcDir ./src/cf

Благодарности

Огромное спасибо всем контрибьюторам проекта, всем участвовавшим в обсуждениях, помогавшим с тестированием. Вы потрясающие!

Этот продукт поддерживается YourKit, разработчиком инструментов для мониторинга и профилирования Java и .Net приложений.

ToDo

После реализации построения контекста:

Автодополнение методов текущего модуля
Автодополнение контекстных методов (конфигурация 1С и OneScript)
Сигнатура функций
Подброная всплывающая подсказка по методам
Переход к определению
Поиск мест использования
Предпросмотр определения процедуры
Поиск определения по символу

Дополнительно:

Автодополнение методов глобального контекста

fenixnow / bsl-language-server Goto Github PK