Работа с Ferret

Проекты и URL

Проект — это папка (обычно корень репозитория). У каждого проекта свои сохранённые URL, поэтому между локальной, dev- и продакшен-средой — один щелчок.

#Добавление проекта

  1. Файл → Открыть папку проекта… (⌘O / CtrlO), Добавить проект на боковой панели или Добавить проект… в меню проекта в заголовке окна.
  2. Выберите, откуда взять проект:
    • На этом компьютере: выберите папку.
    • Клонировать с GitHub / GitLab: выберите один из своих репозиториев (список берётся через ваш вход в gh или glab) или вставьте URL, укажите родительскую папку, и Ferret склонирует и откроет его.
    • Открыть по SSH: выберите хост из ~/.ssh/config. Терминал и агенты работают на удалённой машине, а ревью остаются на этом компьютере.

По умолчанию имя проекта совпадает с именем папки. Если добавить уже зарегистрированную папку, она просто откроется (на macOS и Windows пути сравниваются без учёта регистра). В меню на боковой панели проект можно Переименовать или Убрать из списка. Удаление из списка никогда не удаляет саму папку.

Терминалы открываются в папке проекта, а ревью сохраняются в <project>/.ferret/.

#Сохранение URL

  1. Откройте страницу во встроенном браузере.
  2. Нажмите + (Сохранить текущий URL) на панели браузера. Текущий URL подставится автоматически.
  3. Введите Название и нажмите Сохранить.

Принимаются только URL http:// и https://. Если оставить предложенное название, оно определяется по хосту:

ХостНазвание
localhost, 127.*, ::1, 0.0.0.0, *.localhostlocal
содержит dev, develop, developmentdev
содержит stg, stage, stagingstg
всё остальноеprd
Сохранённые URL на панели браузера

#Панель целей ревью

Переключение целей ревью и страниц без остановки записи.

В режиме фидбэка панель Цели ревью справа показывает всё, что можно проверить в текущем проекте. Переключение целей не останавливает запись. Показать или скрыть панель можно через Вид → Цели ревью (⌘⇧K / CtrlShiftK) или кнопкой Скрыть панель.

  • Цели: сохранённые URL проекта. Под каждым — дерево страниц, которые вы посетили на этом сайте. Посещённые сайты, которые не сохранены, выводятся отдельными группами.
  • Файлы: папка проекта. Файл открывается в предпросмотре (Markdown и Mermaid отображаются, прочий текст — только для чтения), так что проверять можно и документацию. Карандаш (Открыть в редакторе) открывает файл в редакторе.

Фильтр целей фильтрует цели, страницы и файлы одновременно, с тем же нечётким поиском, что и Перейти к файлу…. В списке цели переключаются клавишами ↑ ↓ Enter или 1–9. Открыть URL… открывает разовый URL, а Сохранить в URL проекта сохраняет его.

Цели берутся из projects[].urls в settings.json (см. пример). Каждой записи нужен url, launchCommand (запускается в терминале, например чтобы открыть настольное приложение) или windowMatch (окно для записи). Выбор цели-окна делает его источником записи, поэтому во время записи это невозможно. Посещённые страницы запоминаются для каждого проекта, только на этом компьютере (не более 200).

#Открытие и переключение сред

Щёлкните сохранённый URL, чтобы открыть его. Если текущая страница относится к другому сохранённому URL, Ferret сохраняет путь, параметры запроса и хеш и меняет только origin. Например, на странице http://localhost:3000/pricing?plan=pro щелчок по prd откроет https://example.com/pricing?plan=pro.

Подсвечивается чип, соответствующий текущей странице (по самому длинному префиксу). Чтобы изменить чип или Удалить его, щёлкните по нему правой кнопкой мыши или нажмите значок карандаша. Если при открытии проекта предыдущего URL нет, загружается первый сохранённый URL.

Помочь с переводом этой страницы на GitHub (откроется в новой вкладке)