跳到內容

專案與 Restorm 檔案

Restorm 專案就活在您的磁碟上。沒有遠端工作區,也沒有專屬的同步機制:您開啟一個 檔案、把它儲存起來、然後 commit 它。

這是預設模式(檔案 ▸ 新增,接著另存新檔)。整個專案裝在一個檔案裡,預設為 YAML。另外還有兩種序列化格式可選:jsonjson5

檔案 ▸ 開啟資料夾。專案會被拆成磁碟上的一整棵目錄樹,在大型專案上能得到細緻許多 的 diff:

  • 根目錄下一個 restorm.conf 設定檔,裡面只記錄格式 (format: yaml | json | json5);
  • 每個目錄一個索引檔(index.yamlindex.json…);
  • 資料夾與檔案命名為 <index> - <name>,其中索引會依同層項目的數量補零對齊,讓畫 面上的順序就是磁碟上的順序。不允許的字元(<>:"/\|?*)會被換成 _,名稱則會 截斷到 100 個字元。

在資料夾模式下,Ctrl+S 只會寫入作用中分頁所屬的子樹;Ctrl+Shift+S全部儲存)則會寫入全部內容。

以資料夾模式開啟的專案:左邊的樹狀結構對應資料夾的階層,而狀態列指向的是一個資料夾——不是 .restorm 檔案。

  • 樹狀結構:資料夾、環境資料夾、所有協定的請求、情境;
  • 環境及其變數,包含子環境;
  • 自訂值清單與匯入的列舉;
  • 標籤及其顏色;
  • 附加在環境資料夾上的 API 文件;
  • 儲存為「在專案中」的快速設定
  • 一個專案識別碼(_projectUuid)與一個格式版本號。

這是刻意的,為了讓檔案能被分享:

資料它存放在哪裡
密鑰專案旁邊的一個 .env 密鑰檔案——請參閱密鑰
回應歷史記錄放在專案旁邊的 <project>.responses.zip 壓縮檔
「使用者」快速設定您的本機設定
我的最愛應用程式的本機儲存空間,以專案識別碼建立索引
workbench 版面配置您的本機設定,依專案建立索引
工作區設定<project-folder>/.restorm/settings.json

實際的好處是:您可以 commit 一個 .restorm 而不會外洩任何權杖,而您的同事也不會 收到您的分頁版面配置。

有兩項保證,它們存在的唯一理由就是讓版本控制真的能用:

  1. 標準化的鍵順序。 身分相關的鍵排在最前面(idnamekeytypefolderTypemethodurl),其餘則排序。至於陣列的順序,永遠不會被改動: 那是您自己的順序。
  2. 以穩定方式衍生的識別碼。 實體的識別碼是由它的語意路徑計算出來的,不是隨機 抽出來的。兩個人在同一個位置加入同一個請求,會產生同一個識別碼,這讓合併能夠 正確地配對實體。

結果就是:開啟一個專案再重新儲存、什麼都沒改,不會產生任何 diff。請參閱 內建 Git

檔案 ▸ 最近開啟的檔案會列出最近開啟的十個專案;已失效的路徑會被自動移除。同一 份清單也供歡迎畫面使用。