Стан

Pitmaster обчислює стан робочого дерева, порівнюючи три стани: дерево коміту HEAD, індекс (область підготовки) і робоче дерево (фактичні файли на диску). CLI виводить зведення у стилі git status, а statusPorcelainV2() виводить формат porcelain v2 від git.

Базове використання

$entries = $repo->status();

foreach ($entries as $entry) {
    echo $entry->shortFormat() . "\n";
}

shortFormat() виводить короткий формат git:

M  src/Modified.php          (staged modification)
 M src/WorktreeModified.php  (unstaged modification)
A  src/NewFile.php           (staged new file)
 D src/Deleted.php           (deleted in worktree)
?? untracked.txt             (untracked file)

StatusEntry

Стан кожного файлу представлений StatusEntry:

use Pitmaster\Status\StatusEntry;

$entry->path;       // File path relative to repo root
$entry->index;      // FileStatus: HEAD-to-index state
$entry->worktree;   // FileStatus: index-to-worktree state
$entry->origPath;   // Original path for renamed entries, otherwise null
$entry->renameScore; // Similarity score for renamed entries, otherwise null
$entry->shortFormat(); // "XY path", "?? path", or "R  old -> new"

Перелік FileStatus

use Pitmaster\Status\FileStatus;

FileStatus::Added;      // 'A' - new file
FileStatus::Modified;   // 'M' - content changed
FileStatus::Deleted;    // 'D' - file removed
FileStatus::Renamed;    // 'R' - file renamed
FileStatus::Copied;     // 'C' - file copied
FileStatus::Unmerged;   // 'U' - unresolved merge conflict
FileStatus::Untracked;  // '?' - not in index
FileStatus::Ignored;    // '!' - matched by .gitignore
FileStatus::Unmodified; // ' ' - no change

status() не повідомляє про ігноровані файли, тому Ignored не з’являється в його результаті.

Вивід у форматі porcelain v2

Щоб отримати машинозчитуваний вивід стану, сумісний із git status --porcelain=v2:

echo $repo->statusPorcelainV2();

Вивід:

1 .M N... 100644 100644 100644 ce013625030ba8dba906f756967f9e9ca394464a ce013625030ba8dba906f756967f9e9ca394464a modified-file.txt
? untracked-file.txt

Спочатку йдуть відстежувані записи, потім невідстежувані. Для перейменувань використовуються рядки 2, а для конфліктів — рядки u. Заголовки # branch у git status --porcelain=v2 --branch не виводяться, а ігноровані файли не перелічуються.

Як обчислюється стан

Клас WorkingTreeStatus виконує тристороннє порівняння:

use Pitmaster\Status\WorkingTreeStatus;

$status = new WorkingTreeStatus($repo->objectDatabase(), $repo->workDir(), $repo->gitDir());
$entries = $status->compute($repo->index(), $repo->resolve('HEAD'));

Крок 1: побудова карти дерева HEAD

Розгортає дерево коміту HEAD у карту path => blob hash. Вона представляє останній зафіксований стан.

Крок 2: порівняння HEAD з індексом

Для кожного файлу в дереві HEAD та індексі:

• Є в HEAD, але немає в індексі: Deleted у стовпці індексу
• Є в індексі, але немає в HEAD: Added у стовпці індексу
• Є в обох, але хеші різні: Modified у стовпці індексу
• Є в обох і мають однаковий хеш: Unmodified у стовпці індексу

Крок 3: порівняння індексу з робочим деревом

Для кожного файлу в індексі та робочому дереві:

• Є в індексі, але немає на диску: Deleted у стовпці робочого дерева
• Є в обох, але вміст відрізняється: Modified у стовпці робочого дерева
• Є в обох і вміст збігається: Unmodified у стовпці робочого дерева

Крок 4: виявлення невідстежуваних файлів

Переглядає каталог робочого дерева, пропускає .git/ та ігноровані шляхи й повідомляє про файли, яких немає в індексі, як про Untracked в обох стовпцях.

Підтримка .gitignore

Pitmaster розбирає файли .gitignore, щоб визначити, які невідстежувані файли слід позначити як ігноровані, а які — як невідстежувані.

use Pitmaster\Status\GitIgnore;

Клас GitIgnore розбирає шаблони gitignore з таких джерел:

• .gitignore у корені репозиторію
• .gitignore у підкаталогах
• .git/info/exclude

Підтримуваний синтаксис шаблонів:

• Шаблони glob (*.log, build/)
• Заперечення (!important.log)
• Шаблони лише для каталогів (кінцевий /)
• Початковий / для шаблонів відносно кореня
• ** для рекурсивної відповідності

Категоризація записів стану

Типовий шаблон для відображення UI:

$staged = [];
$unstaged = [];
$untracked = [];

foreach ($repo->status() as $entry) {
    if ($entry->index === FileStatus::Untracked) {
        $untracked[] = $entry;
    } elseif ($entry->index !== FileStatus::Unmodified) {
        $staged[] = $entry;
    }

    if ($entry->worktree !== FileStatus::Unmodified
        && $entry->index !== FileStatus::Untracked
    ) {
        $unstaged[] = $entry;
    }
}

Використання CLI

./vendor/bin/pitmaster status

Вивід:

On branch main

Changes to be committed:
	new file:   src/Feature.php

Changes not staged for commit:
	modified:   src/Existing.php

Untracked files:
	notes.txt

Моніторинг файлової системи

Pitmaster містить допоміжний засіб для протоколу fsmonitor від git:

use Pitmaster\Status\Fsmonitor;

Клас Fsmonitor може запитувати перехоплювач core.fsmonitor (а за його відсутності сканувати час модифікації), щоб визначити, які файли змінилися після певного маркера. Він вимикається для дескрипторів, відкритих із ['processes' => false]. Наразі status() не викликає його: натомість він безпосередньо порівнює дані stat і вміст.