Status

Pitmaster oblicza stan drzewa roboczego, porównując trzy stany: drzewo commitu HEAD, indeks (obszar przejściowy) i drzewo robocze (rzeczywiste pliki na dysku). CLI wyświetla na tej podstawie podsumowanie w stylu git status, a statusPorcelainV2() wyświetla format porcelain v2 narzędzia git.

Podstawowe użycie

$entries = $repo->status();

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

shortFormat() wyświetla krótki format 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

Status każdego pliku jest reprezentowany przez 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"

Wyliczenie 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() nie zgłasza ignorowanych plików, dlatego Ignored nie pojawia się w jego wyniku.

Wynik porcelain v2

Aby uzyskać czytelny maszynowo wynik statusu zgodny z git status --porcelain=v2:

echo $repo->statusPorcelainV2();

Wynik:

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

Najpierw pojawiają się śledzone wpisy, a potem nieśledzone. Zmiany nazw używają wierszy 2, a konflikty wierszy u. Nagłówki # branch w git status --porcelain=v2 --branch nie są wyświetlane, a ignorowane pliki nie są wymieniane.

Sposób obliczania statusu

Klasa WorkingTreeStatus wykonuje porównanie trzech stanów:

use Pitmaster\Status\WorkingTreeStatus;

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

Krok 1: Utworzenie mapy drzewa HEAD

Spłaszcza drzewo commita HEAD do mapy path => blob hash. Reprezentuje ona ostatni zatwierdzony stan.

Krok 2: Porównanie HEAD z indeksem

Dla każdego pliku w drzewie HEAD i indeksie:

• W HEAD, ale nie w indeksie: Deleted w kolumnie indeksu
• W indeksie, ale nie w HEAD: Added w kolumnie indeksu
• W obu, ale z innym hashem: Modified w kolumnie indeksu
• W obu z tym samym hashem: Unmodified w kolumnie indeksu

Krok 3: Porównanie indeksu z drzewem roboczym

Dla każdego pliku w indeksie i drzewie roboczym:

• W indeksie, ale nie na dysku: Deleted w kolumnie drzewa roboczego
• W obu, ale z różną zawartością: Modified w kolumnie drzewa roboczego
• W obu z taką samą zawartością: Unmodified w kolumnie drzewa roboczego

Krok 4: Wykrywanie nieśledzonych plików

Przegląda katalog drzewa roboczego, pomija .git/ i ignorowane ścieżki, a pliki nieobecne w indeksie zgłasza jako Untracked w obu kolumnach.

Obsługa .gitignore

Pitmaster analizuje pliki .gitignore, aby określić, które nieśledzone pliki należy zgłosić jako ignorowane, a które jako nieśledzone.

use Pitmaster\Status\GitIgnore;

Klasa GitIgnore analizuje wzorce gitignore z:

• .gitignore w katalogu głównym repozytorium
• .gitignore w podkatalogach
• .git/info/exclude

Obsługiwana składnia wzorców:

• Wzorce glob (*.log, build/)
• Negacja (!important.log)
• Wzorce dotyczące tylko katalogów (końcowe /)
• Początkowe / dla wzorców względem katalogu głównego
• ** do dopasowywania rekurencyjnego

Kategoryzowanie wpisów statusu

Częsty wzorzec wyświetlania 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;
    }
}

Użycie CLI

./vendor/bin/pitmaster status

Wynik:

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

Fsmonitor

Pitmaster zawiera pomocnika obsługującego protokół fsmonitor git:

use Pitmaster\Status\Fsmonitor;

Klasa Fsmonitor może odpytać hook core.fsmonitor (w razie potrzeby przechodząc na skanowanie czasu modyfikacji), aby ustalić, które pliki zmieniły się od podanego tokenu. Wyłącza się dla uchwytów otwartych z ['processes' => false]. status() obecnie go nie wywołuje; porównuje bezpośrednio dane stat i zawartość.