37 lines
2.9 KiB
Markdown
37 lines
2.9 KiB
Markdown
# Мастер настроек GoSetup терминальная версия
|
||
|
||
Перенос [GoSetup+Fyne](https://dev.gossys.dev/XeRo/GoSetup) в терминал с использованием библиотек сообщества [charm](https://charm.sh/).
|
||
|
||
|
||
## Структура
|
||
В файле yaml есть следующие корневые поля:
|
||
- name - имя приложения для настройки
|
||
- version - версия приложения
|
||
- description - краткое описание приложения
|
||
- type - тип приложения
|
||
- variables - массив переменных, в которых будет храниться нужная информация
|
||
- sections - массив секций, форм для разделения этапов настройки
|
||
|
||
### Переменные
|
||
Переменные хранят значение для настройки, в них записываются значения полей, используются в условиях и для выполнений действий
|
||
Переменная имеет 3 поля:
|
||
- name - имя переменной, по имени идет связь со всем. Имя должно быть уникальным
|
||
- type - тип значения
|
||
- default - значение по умолчанию, если boolean, то указывайте без кавычек
|
||
|
||
### Секции
|
||
Каждая секция это отдельна форма.
|
||
Секция имеет следующие поля:
|
||
- name - имя секции
|
||
- type - тип секции, по умолчанию тип не указывается, в таком случае секция содержит поля ввода. Если type About, то мы выводим подробное описание приложения. Если type Final, то выводим таблицу переменных со всеми значениями. About ставьте первой секцией, а Final последней.
|
||
- description - описание секции, что в ней прописывается. Пишите коротко
|
||
- condition - условие при котором эта секция отображается
|
||
- parent - массив имен переменных от которых зависит условие
|
||
- paragraphs - массив строк, используется если type About. Используются следующие правила:
|
||
- '#' Заголовок первого уровня
|
||
- '##' Заголовок второго уровня
|
||
- '###' Заголовок третье уровня
|
||
- '-' элемент списка
|
||
- простой текст
|
||
- fields - массив полей для вывода
|
||
- actions - массив действий, которые должны выполнится после перехода с этой секции
|