Ferret の使い方
プロジェクトと URL
プロジェクトは1つのフォルダです(たいていはリポジトリのルート)。プロジェクトごとに URL を登録しておけるので、ローカル・開発・本番をワンクリックで行き来できます。
#プロジェクトを追加する
- ファイル → プロジェクトフォルダを開く…(⌘O / CtrlO)、サイドバーの プロジェクトを追加、またはタイトルバーのプロジェクトメニューの プロジェクトを追加… を使います。
- プロジェクトをどこから持ってくるかを選びます。
- 自分の PC で開く: フォルダを選びます。
- GitHub / GitLab から取得: 自分のリポジトリ(
ghかglabのログインで一覧を出します)から選ぶか URL を貼り、置き場所の親フォルダを選ぶと、Ferret が clone して開きます。 - SSH で開く:
~/.ssh/configからホストを選びます。ターミナルとエージェントはリモートのマシンで動き、レビューはこの PC に残ります。
名前は最初はフォルダ名になります。すでに登録してあるフォルダを追加すると、追加せずにそれを開きます(macOS と Windows ではパスの大文字・小文字を区別せずに比べます)。サイドバーのメニューから、プロジェクトの 名前を変更 や 登録を外す ができます。登録を外してもフォルダは消えません。
ターミナルはプロジェクトのフォルダで開き、レビューは <project>/.ferret/ の下に保存します。
#URL を登録する
- 内蔵ブラウザでページを開きます。
- ブラウザのツールバーの +(表示中のURLを登録)を押します。いまの URL が入った状態で開きます。
- 名前 を入れて 保存 を押します。
使える URL は http:// と https:// だけです。名前を提案のまま残すと、ホストから次のように決まります。
| ホスト | 名前 |
|---|---|
localhost、127.*、::1、0.0.0.0、*.localhost | local |
dev、develop、development を含む | dev |
stg、stage、staging を含む | stg |
| それ以外 | prd |
#レビュー対象のパネル
フィードバックモードでは、右の レビュー対象 パネルに、いまのプロジェクトでレビューできるものが並びます。対象を切り替えても録画は止まりません。パネルは 表示 → レビュー対象の表示を切り替える(⌘⇧K / CtrlShiftK)か パネルを隠す で出し入れします。
- 確認先: プロジェクトに登録した URL。それぞれの下に、そのサイトで開いたページがツリーで並びます。登録していないサイトを開いた場合は、そのサイトが別のグループとして並びます。
- ファイル: プロジェクトのフォルダ。ファイルはプレビューで開く(Markdown と Mermaid は描画し、ほかのテキストは読み取り専用)ので、ドキュメントもレビューできます。鉛筆(エディタで開く)でエディタで開きます。
対象を絞り込む は、確認先・ページ・ファイルをまとめて絞り込みます。あいまい一致の仕方は ファイルを名前で開く… と同じです。一覧では ↑ ↓ Enter か 1〜9 で対象を切り替えます。URL を開く… はその場限りの URL を開き、プロジェクトの URL に登録 で残せます。
確認先は settings.json の projects[].urls から読みます(例を参照)。各項目には url、launchCommand(ターミナルで実行します。たとえばデスクトップアプリの起動)、windowMatch(録画するウインドウ)のどれかが要ります。ウインドウの対象を選ぶとそれが録画の対象になるので、録画中は選べません。開いたページはプロジェクトごとに、この端末にだけ覚えます(200件まで)。
#開く・環境を切り替える
登録した URL を押すと開きます。いまのページが別の登録 URL の下にあるときは、Ferret はパス・クエリ・ハッシュを保ったまま、オリジンだけを入れ替えます。たとえば http://localhost:3000/pricing?plan=pro で prd を押すと、https://example.com/pricing?plan=pro が開きます。
いまのページに合うチップ(前方一致が最も長いもの)が強調されます。チップを右クリックするか鉛筆のアイコンで、編集や 削除 ができます。プロジェクトを開いたときに前回の URL が無ければ、最初に登録した URL を読み込みます。