Перейти к основному содержимому
Версия: Latest

HelpList

Хелплист — это структура, содержащая информацию о командах, возможностях и прочей информации о модуле. Хелплист включает описание каждого модуля, каждой возможности или команды, их аргументы, примеры использования и пояснения. Это инструмент, который помогает юзеру ориентироваться в командах и возможностях модуля и правильно использовать его функционал.

Хелплист с версии 2.2 прописывается в файле manifest.yaml

sections​

Хелплист модуля. Содержит описание всех команд и возможностей, разбитых по секциям. Обязательное поле.

Формат:

manifest.yaml
sections:
  <секция_1>:
    description: <описание секции> # можно опустить
    commands:                      # список команд (можно опустить, если есть только features)
      - names: [<алиас_1>, <алиас_2>] # алиасы команд. То, что ты должен написать чтобы сработала команда. Указывается без префикса
        description: <описание команды>
        arguments:
          - {text: <описание аргумента>, req: Yes|No} # список аргументов, если есть
    features:                     # список возможностей (можно опустить)
      - title: <заголовок>
        description: <описание>

Секция _​

Если модуль содержит только одну секцию, она указывается под _. Это главная секция и всегда отображается первой.

commands​

Список всех доступных команд в секции.

Формат команды:

  • names — список алиасов команды
  • description — краткое описание
  • arguments (необязательно) — список аргументов

Аргументы:

  • text — описание аргумента (как он выглядит в использовании)
  • req — Yes если аргумент обязателен, No если нет

Пример:

commands:
  - names: [mdelay, md]
    arguments:
      - {text: задержка, req: No}
    description: Установить/посмотреть задержку

features​

Опциональный список возможностей модуля. Показывается после команд.

Формат:

features:
  - title: Заголовок
    description: Описание

Несколько секций​

Можно добавить дополнительные секции с описанием и собственными командами. Например:

sections:
  _: # главная
    commands: [...]
  logging: # дополнительная
    description: Команды для логирования
    commands: [...]