Проєкти та файли .restorm
Проєкт Restorm живе на вашому диску. Немає ні віддаленого робочого простору, ні власницької синхронізації: ви відкриваєте файл, зберігаєте його, комітите його.
Два режими зберігання
Section titled “Два режими зберігання”Єдиний файл .restorm
Section titled “Єдиний файл .restorm”Типовий режим (Файл ▸ Створити, потім Зберегти як). Увесь проєкт
уміщується в одному файлі, типово в YAML. Доступні ще два формати
серіалізації: json і json5.
Режим теки
Section titled “Режим теки”Файл ▸ Відкрити теку. Проєкт розкладається на диску в дерево, що дає значно точніші діфи у великих проєктах:
- файл конфігурації
restorm.confу корені, який містить лише формат (format: yaml | json | json5); - файл покажчика в кожному каталозі (
index.yaml,index.json…); - теки й файли з іменами
<index> - <назва>, де індекс доповнюється нулями до ширини, потрібної для всіх однорівневих елементів, щоб порядок на екрані збігався з порядком на диску. Заборонені символи (<>:"/\|?*) замінюються на_, а ім’я обрізається до 100 символів.
У режимі теки Ctrl+S записує лише піддерево активної вкладки;
Ctrl+Shift+S (Зберегти все) записує все.
Що містить проєкт
Section titled “Що містить проєкт”- дерево: теки, теки середовищ, запити всіх протоколів, сценарії;
- середовища та їхні змінні, включно з підсередовищами;
- власні списки значень та імпортовані переліки;
- теги та їхні кольори;
- документацію API, прикріплену до тек середовищ;
- швидкі параметри, збережені «у проєкті»;
- ідентифікатор проєкту (
_projectUuid) і версію формату.
Чого проєкт не містить
Section titled “Чого проєкт не містить”Свідомо — щоб файлом можна було ділитися:
| Дані | Де вони живуть |
|---|---|
| Секрети | Файл секретів .env поряд із проєктом — див. Секрети |
| Історія відповідей | Архів <проєкт>.responses.zip, покладений поряд із проєктом |
| Швидкі параметри рівня «користувач» | Ваші локальні налаштування |
| Обране | Локальне сховище застосунку, індексоване за ідентифікатором проєкту |
| Розташування workbench | Ваші локальні налаштування, індексовані за проєктом |
| Налаштування робочого простору | <тека-проєкту>/.restorm/settings.json |
Практичний наслідок: ви можете закомітити .restorm, не витягуючи назовні
токен, а ваш колега не отримає ваше розташування вкладок.
Серіалізація, зроблена для git
Section titled “Серіалізація, зроблена для git”Дві гарантії, які існують лише заради того, щоб контроль версій був придатним до використання:
- Канонічний порядок ключів. Ключі ідентичності йдуть попереду (
id,name,key,type,folderType,method,url), решта сортується. Порядок елементів у масивах при цьому ніколи не змінюється: це ваш порядок. - Стабільно похідні ідентифікатори. Ідентифікатор сутності обчислюється з її семантичного шляху, а не береться навмання. Двоє людей, що додають той самий запит у те саме місце, отримають той самий ідентифікатор, і це дає злиттю змогу правильно зіставити сутності.
Результат: відкрити й перезберегти проєкт без жодних змін — і жодного діфу не виникне. Див. Вбудований git.
Останні проєкти
Section titled “Останні проєкти”Файл ▸ Останні файли перелічує десять останніх відкритих проєктів; шляхи, що стали недійсними, вилучаються автоматично. Той самий список живить екран привітання.