Projektek és .restorm fájlok

Egy Restorm-projekt a saját lemezen él. Nincs távoli munkaterület, nincs zárt szinkronizáció: a fájl megnyitható, elmenthető, commitolható.

Két tárolási mód

Egyetlen .restorm fájl

Ez az alapértelmezett mód (Fájl ▸ Új, majd Mentés másként). A teljes projekt egyetlen fájlba fér, alapból YAML formátumban. Két további sorosítási formátum is rendelkezésre áll: json és json5.

Mappa mód

Fájl ▸ Mappa megnyitása. A projekt fastruktúrára bomlik szét a lemezen, ami nagy projekteknél sokkal finomabb diffeket ad:

• egy restorm.conf konfigurációs fájl a gyökérben, amely csak a formátumot hordozza (format: yaml | json | json5);
• könyvtáronként egy indexfájl (index.yaml, index.json…);
• <index> - <name> néven elnevezett mappák és fájlok, ahol az index a testvérelemek számának szélességére van nullákkal feltöltve, hogy a képernyőn látott sorrend a lemezen lévő sorrend legyen. A tiltott karakterek (<>:"/\|?*) helyére _ kerül, a név pedig 100 karakternél csonkolódik.

Mappa módban a Ctrl+S csak az aktív lap részfáját írja ki; a Ctrl+Shift+S (Összes mentése) az egészet.

Amit a projekt tartalmaz

• a fát: mappák, változómappák, minden protokoll kérései, forgatókönyvek;
• a környezeteket és a változóikat, az alkörnyezetekkel együtt;
• az egyéni értéklistákat és az importált enumerációkat;
• a címkéket és a színeiket;
• a változómappákhoz csatolt API-dokumentációt;
• a „projektbe” mentett gyorsbeállításokat;
• egy projektazonosítót (_projectUuid) és egy formátumverziót.

Amit a projekt nem tartalmaz

Szándékosan, hogy a fájl megosztható maradjon:

Adat	Hol él
Titkok	A projekt mellett álló .env titokfájlban — lásd: Titkok
Válaszok előzményei	A projekt mellé helyezett <project>.responses.zip archívumban
„Felhasználói” gyorsbeállítások	A helyi beállításokban
Kedvencek	Az alkalmazás helyi tárolójában, projektazonosító szerint indexelve
A workbench elrendezése	A helyi beállításokban, projektenként indexelve
Munkaterület-beállítások	<project-folder>/.restorm/settings.json

Gyakorlati következmény: egy .restorm fájl commitolható anélkül, hogy token szivárogna ki, a kollégához pedig nem jut el a lapelrendezés.

Git-re szabott sorosítás

Két garancia, amely kizárólag azért létezik, hogy a verziókezelés használható legyen:

1. Kanonikus kulcssorrend. Az identitáskulcsok kerülnek előre (id, name, key, type, folderType, method, url), a többi rendezve követi őket. A tömbök sorrendje viszont soha nem módosul: az a felhasználó sorrendje.
2. Stabilan származtatott azonosítók. Egy entitás azonosítója a szemantikus útvonalából számítódik, nem véletlenszerűen jön. Két ember, aki ugyanazt a kérést ugyanoda adja hozzá, ugyanazt az azonosítót állítja elő, ami lehetővé teszi, hogy az összefésülés helyesen párosítsa az entitásokat.

Az eredmény: egy projekt megnyitása, majd változtatás nélküli újramentése semmilyen diffet nem eredményez. Lásd: Beépített git.

Legutóbbi projektek

A Fájl ▸ Legutóbbi fájlok felsorolja a tíz utoljára megnyitott projektet; az érvénytelenné vált útvonalak automatikusan kikerülnek belőle. Ugyanez a lista táplálja a kezdőképernyőt is.