Команды

Справочник команд и опций xbsl: проверка исходников, серверы LSP и MCP, веб-панель, шаблоны кода.

Справочник собран из самого инструмента – это то же, что показывает xbsl --help, только на одной странице и целиком.

Без команды xbsl проверяет указанные пути: это режим по умолчанию, и опции проверки перечислены в первом блоке. Остальные команды адресуют другие части инструментария – серверы для редактора и агента, веб-панель, шаблоны.

Язык вывода переключается переменной XBSLLINT_LANG (ru или en).

Без команды: проверка исходников

usage: xbsl [пути] [опции]        (без команды: проверка исходников)
       xbsl <команда> [опции]

Линтер исходников 1С:Элемент (пары .yaml/.xbsl).

Без команды проверяет указанные пути – это режим по умолчанию.
Команды ниже адресуют остальные части инструментария.

positional arguments:
  paths                 файлы или каталоги для проверки

options:
  -h, --help            show this help message and exit
  --select ID/ГРУППА/ТИР
                        проверять только эти правила (через запятую или повтором
                        флага: id, группа – часть id до '/' (напр. style) – или буква
                        тира A/B/C/D)
  --ignore ID/ГРУППА/ТИР
                        исключить эти правила (через запятую или повтором флага: id,
                        группа или буква тира)
  --enable ID/ГРУППА/ТИР
                        добавить выключенные по умолчанию правила ПОВЕРХ стандартного
                        набора (--select набор заменяет); формы значений те же
  --baseline ФАЙЛ       гасить находки, замороженные в файле базлайна (создаётся
                        --write-baseline); новые находки выводятся как обычно
  --write-baseline ФАЙЛ
                        вместо отчёта записать все текущие находки в файл базлайна
                        (заморозить долг; пути в файле – относительно его каталога)
  --fix                 исправить механические находки на месте (хвостовые пробелы,
                        типографские символы, переводы строк) и вывести оставшиеся;
                        правит только однозначно
  --jobs N              процессов для файловых правил: 0 – авто (включается на больших
                        прогонах), 1 – последовательно, N – явное число воркеров
  --list-rules          вывести список правил и выйти
  --where               показать корень данных Элемента (путь, источник, версии) и
                        выйти
  --element-version ВЕРСИЯ
                        версия данных Элемента (по умолчанию – последняя из бандла)
  --data-dir КАТАЛОГ    корень данных Элемента (каталог с index.json); также env
                        XBSL_DATA_DIR
  --lang {ru,en}        язык вывода линтера (по умолчанию: env XBSL_LANG / локаль
                        системы / ru)
  --format {text,json,codeclimate}
                        формат вывода: text (по умолчанию), json (машиночитаемый:
                        diagnostics + summary) или codeclimate (отчёт GitLab Code
                        Quality – виджет в merge request)
  --stdin               проверить один буфер из stdin (для интеграции с редактором);
                        вид файла и путь в позициях задаёт --filename
  --index               вместо проверки вывести JSON-индекс проекта (объекты, методы,
                        компоненты форм) для навигации в редакторе; путь – корень
                        проекта
  --filename ИМЯ        имя проверяемого буфера при --stdin (напр. Форма.xbsl);
                        расширение задаёт вид файла
  --version             show program's version number and exit

команды:
  lint <пути>     проверить исходники – то же, что без команды
  lsp             сервер LSP для редактора
  mcp             сервер MCP для агента
  web             веб-панель
  templates       шаблоны кода: list, export, import, save
  self-update     обновить xbsl распаковкой колеса с PyPI

  скаффолдинг метаданных (создание и правка исходников):
    new-project, new-object, add-field, add-route, add-method, add-form,
    add-subsystem, add-dependency, rename-object, set-access, object-info,
    project-info, form-tree, form-edit, form-handlers

Опции команды: xbsl <команда> --help. Опции выше относятся к режиму проверки.

xbsl lint

usage: xbsl [пути] [опции]        (без команды: проверка исходников)
       xbsl <команда> [опции]

Линтер исходников 1С:Элемент (пары .yaml/.xbsl).

Без команды проверяет указанные пути – это режим по умолчанию.
Команды ниже адресуют остальные части инструментария.

positional arguments:
  paths                 файлы или каталоги для проверки

options:
  -h, --help            show this help message and exit
  --select ID/ГРУППА/ТИР
                        проверять только эти правила (через запятую или повтором
                        флага: id, группа – часть id до '/' (напр. style) – или буква
                        тира A/B/C/D)
  --ignore ID/ГРУППА/ТИР
                        исключить эти правила (через запятую или повтором флага: id,
                        группа или буква тира)
  --enable ID/ГРУППА/ТИР
                        добавить выключенные по умолчанию правила ПОВЕРХ стандартного
                        набора (--select набор заменяет); формы значений те же
  --baseline ФАЙЛ       гасить находки, замороженные в файле базлайна (создаётся
                        --write-baseline); новые находки выводятся как обычно
  --write-baseline ФАЙЛ
                        вместо отчёта записать все текущие находки в файл базлайна
                        (заморозить долг; пути в файле – относительно его каталога)
  --fix                 исправить механические находки на месте (хвостовые пробелы,
                        типографские символы, переводы строк) и вывести оставшиеся;
                        правит только однозначно
  --jobs N              процессов для файловых правил: 0 – авто (включается на больших
                        прогонах), 1 – последовательно, N – явное число воркеров
  --list-rules          вывести список правил и выйти
  --where               показать корень данных Элемента (путь, источник, версии) и
                        выйти
  --element-version ВЕРСИЯ
                        версия данных Элемента (по умолчанию – последняя из бандла)
  --data-dir КАТАЛОГ    корень данных Элемента (каталог с index.json); также env
                        XBSL_DATA_DIR
  --lang {ru,en}        язык вывода линтера (по умолчанию: env XBSL_LANG / локаль
                        системы / ru)
  --format {text,json,codeclimate}
                        формат вывода: text (по умолчанию), json (машиночитаемый:
                        diagnostics + summary) или codeclimate (отчёт GitLab Code
                        Quality – виджет в merge request)
  --stdin               проверить один буфер из stdin (для интеграции с редактором);
                        вид файла и путь в позициях задаёт --filename
  --index               вместо проверки вывести JSON-индекс проекта (объекты, методы,
                        компоненты форм) для навигации в редакторе; путь – корень
                        проекта
  --filename ИМЯ        имя проверяемого буфера при --stdin (напр. Форма.xbsl);
                        расширение задаёт вид файла
  --version             show program's version number and exit

команды:
  lint <пути>     проверить исходники – то же, что без команды
  lsp             сервер LSP для редактора
  mcp             сервер MCP для агента
  web             веб-панель
  templates       шаблоны кода: list, export, import, save
  self-update     обновить xbsl распаковкой колеса с PyPI

  скаффолдинг метаданных (создание и правка исходников):
    new-project, new-object, add-field, add-route, add-method, add-form,
    add-subsystem, add-dependency, rename-object, set-access, object-info,
    project-info, form-tree, form-edit, form-handlers

Опции команды: xbsl <команда> --help. Опции выше относятся к режиму проверки.

xbsl lsp

usage: xbsl-lsp [-h] [--project-root PROJECT_ROOT] [--select SELECT] [--ignore IGNORE]
                [--enable ENABLE] [--baseline BASELINE] [--templates TEMPLATES]
                [--data-dir DATA_DIR] [--lang {ru,en}]

LSP-сервер xbsl (stdio)

options:
  -h, --help            show this help message and exit
  --project-root PROJECT_ROOT
                        корень исходников (абсолютный или относительно папки
                        воркспейса)
  --select SELECT       только эти правила (через запятую)
  --ignore IGNORE       исключить правила (через запятую)
  --enable ENABLE       включить правила поверх набора по умолчанию
  --baseline BASELINE   файл базлайна (абсолютный или относительно папки воркспейса) –
                        исключённые находки гасятся; отсутствующий файл не ошибка, он
                        появится с первым исключением
  --templates TEMPLATES
                        файл шаблонов кода (абсолютный или относительно папки
                        воркспейса) – дополняет встроенный набор, одноимённые шаблоны
                        замещает
  --data-dir DATA_DIR   корень данных Элемента (папка с index.json)
  --lang {ru,en}        язык текста замечаний

xbsl mcp

xbsl web

usage: xbsl-web [-h] [--host HOST] [--port PORT]

Веб-интерфейс линтера XBSL

options:
  -h, --help   show this help message and exit
  --host HOST  адрес (по умолчанию 127.0.0.1)
  --port PORT  порт (по умолчанию 8771)

xbsl templates

usage: xbsl templates [-h] {list,export,import,save} ...

шаблоны кода: встроенный набор и файл пользователя (формат выгрузки EDT)

positional arguments:
  {list,export,import,save}
    list                перечислить шаблоны (встроенные и пользовательские)
    export              выгрузить шаблоны в файл формата EDT
    import              влить выгрузку в файл шаблонов пользователя
    save                заменить файл шаблонов пользователя (конверт JSON из stdin)

options:
  -h, --help            show this help message and exit

xbsl self-update

usage: xbsl self-update [-h] [--version VERSION]

обновить xbsl распаковкой колеса с PyPI

options:
  -h, --help         show this help message and exit
  --version VERSION  целевая версия (по умолчанию – последняя с PyPI)