Visual Studio Code не может работать с Git, если GIT_DIR и GIT_WORK_TREE находятся в отдельных папках.

Содержание

Вопрос или проблема
Контекст (можно пропустить):
Способы воспроизведения этой проблемы:
Ответ или решение
Проблема работы Visual Studio Code с Git при использовании GIT_DIR и GIT_WORK_TREE в разных папках
Введение
Суть проблемы
Техническая реализация
Причины проблемы
Рекомендации по устранению проблемы
Заключение

Вопрос или проблема

Контекст (можно пропустить):

Во многих сценариях я хочу контролировать версии своих файлов на iCloud Drive, таких как мои бухгалтерские книги, заметки или дневники.

Однако если я просто инициализирую папку .git в своей папке iCloud, есть вероятность, что синхронизация сломается и файлы окажутся частично синхронизированными. Похоже, что папка .git каким-то образом сбивает с толку механизм синхронизации iCloud. (И почему?)

Я пытался разместить папку .git на своем локальном диске и использовать переменную окружения GIT_WORK_TREE, чтобы заставить git управлять папками на моем iCloud Drive, и это удалось в терминале. git diff работает прекрасно.

Способы воспроизведения этой проблемы:

локальная папка: ~/GitTest, для хранения .git
удаленная папка: /Users/someone/Library/Mobile Documents/com~apple~CloudDocs/GitTest, для файлов, которые нужно контролировать по версиям

создайте папку по локальному пути ~/GitTest
cd ~/GitTest; git init
откройте ~/GitTest/.git/config и добавьте work-tree = /Users/someone/Library/Mobile Documents/com~apple~CloudDocs/GitTest
откройте vscode на ~/GitTest или /Users/someone/Library/Mobile Documents/com~apple~CloudDocs/GitTest, и ничего не происходит. Плагин VCS не распознает ничего.
touch /Users/someone/Library/Mobile Documents/com~apple~CloudDocs/GitTest/a.txt; cd ~/GitTest; git add /Users/someone/Library/Mobile Documents/com~apple~CloudDocs/GitTest/a.txt
git status: он показывает, что файл уже готов к коммиту, что означает, что командный инструмент git его распознает.

Однако инструменты управления Git с графическим интерфейсом, такие как Visual Studio Code или IntelliJ IDEA, не могут распознать папку .git.

Кажется, что эти современные инструменты управления Git никогда не ожидали, что пользователь разместит папку .git и GIT_WORK_TREE в разных местах?

Ответ или решение

Проблема работы Visual Studio Code с Git при использовании GIT_DIR и GIT_WORK_TREE в разных папках

Введение

Работа с системами контроля версий, такими как Git, часто сопряжена с различными вызовами, особенно когда речь идет о настройках каталогов для репозиториев и рабочей области. В данной статье мы рассмотрим специфику использования переменных окружения GIT_DIR и GIT_WORK_TREE, а также проблемы, с которыми сталкиваются пользователи, особенно в контексте интеграции с Visual Studio Code.

Суть проблемы

Проблема заключается в том, что при настройке отдельного каталога для .git и рабочего дерева, Visual Studio Code не может корректно распознать репозиторий Git. Пользователь, предпринявший попытку разделить эти два компонента, успешно использует командную строку Git, но GUI-инструменты, такие как Visual Studio Code и IntelliJ IDEA, не отображают статус репозитория.

Техническая реализация

Пользователь настроил систему следующим образом:

Локальный каталог: ~/GitTest, содержащий каталог .git.
Удаленный каталог: Папка iCloud для хранения отслеживаемых файлов по адресу /Users/someone/Library/Mobile Documents/com~apple~CloudDocs/GitTest.

Порядок действий был следующим:

Создан каталог ~/GitTest.
Выполнена команда git init для инициализации репозитория.
Вручную изменен файл ~/GitTest/.git/config, добавлено определение рабочего дерева.
Попытка открыть проект в Visual Studio Code не привела к ожидаемому результату — VCS-плагин не распознал текущую конфигурацию.

Причины проблемы

Основные причины, по которым такие GUI-инструменты, как Visual Studio Code, не распознают .git, включают:

Расположение каталога .git: Многие инструменты обсуждают только стандартную структуру каталогов, где .git находится непосредственно в корне проектируемого дерева. Разделение этих компонентов не является распространенной практикой и может не поддерживаться различными интерфейсами.
Необходимость загрузки конфигурации: Visual Studio Code при загрузке проверяет только определенные директории на наличие .git. Если каталог .git находится в другом месте, эти инструменты не смогут автоматически загрузить его конфигурацию.
Отсутствие поддержки для переменных окружения: Visual Studio Code не учитывает переменные окружения, такие как GIT_DIR и GIT_WORK_TREE, что важно для корректного функционирования с отдельными путями.

Заключение

Разделение каталога .git и рабочего дерева может быть полезным в некоторых сценариях, однако это также может вызвать проблемы с инструментами, которые предполагают стандартные конфигурации. Соблюдение рекомендованных практик в использовании Git и управление версиями поможет избежать множества трудностей, связанных с интеграцией GUI и терминала.