FileTree YAML (FTY)
Обзор
FileTree YAML (FTY) — это легкочитаемый иерархический формат данных, предназначенный для представления файловых систем. Он использует стандартные структуры YAML для описания файлов и директорий, что позволяет легко сериализовать и десериализовать целые структуры проектов или отдельных папок.
Основные принципы
Каждый элемент в файловой системе (будь то файл или папка) представляется как YAML-объект (эквивалент JSON-объекта) с двумя обязательными полями:
name
(строка): Имя файла или папки.data
(строка или массив):
* Если элемент является файлом, полеdata
содержит строку с полным содержимым этого файла.
* Если элемент является папкой (директорией), полеdata
содержит массив YAML-объектов. Каждый объект в этом массиве представляет собой вложенный файл или папку, следуя той же структуре FTY.
Пример структуры
Особенности и рекомендации
- Кодировка: Рекомендуется использовать UTF-8 для содержимого файлов и имен.
- Пустые папки: Пустые папки представляются массивом
data
с нулевым количеством элементов ([]
). - Многострочное содержимое: Для файлов с многострочным содержимым рекомендуется использовать блочные индикаторы стиля YAML (например,
|
для буквального блока,>
для сложенного блока) для улучшения читаемости. - Корневой элемент: Корневым элементом FTY-документа обычно является массив, содержащий один или несколько объектов верхнего уровня, представляющих корневые папки или файлы.