Přejít k obsahu

Stav

Zobrazit jako Markdown Upravit na GitHub Dokumentace na bfe242f

Pitmaster vypočítává stav pracovního stromu porovnáním tří stavů: stromu potvrzení HEAD, indexu (přípravné oblasti) a pracovního stromu (skutečných souborů na disku). CLI z něj vypisuje souhrn ve stylu git status a statusPorcelainV2() vypisuje git ve formátu porcelain v2.

Základní použití

PHP
$entries = $repo->status();

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

shortFormat() vypisuje krátký formát systému git:

Kód
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

Stav každého souboru označuje StatusEntry:

PHP
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"

Výčet FileStatus

PHP
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() neuvádí ignorované soubory, takže se Ignored ve výsledku neobjeví.

Výstup porcelain v2

Pro výstup stavu ve strojově čitelném formátu odpovídajícím git status --porcelain=v2:

PHP
echo $repo->statusPorcelainV2();

Výstup:

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

Nejprve se uvádějí sledované položky, potom nesledované. Přejmenování používají řádky 2 a konflikty řádky u. Záhlaví # branch v git status --porcelain=v2 --branch se nevypisují a ignorované soubory nejsou uvedeny.

Jak se počítá stav

Třída WorkingTreeStatus provádí trojí porovnání:

PHP
use Pitmaster\Status\WorkingTreeStatus;

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

Krok 1: Vytvoření mapy stromu HEAD

Převeďte strom potvrzení HEAD na mapu path => blob hash. Ta představuje poslední potvrzený stav.

Krok 2: Porovnání HEAD s indexem

U každého souboru ve stromu HEAD a v indexu:

  • V HEAD, ale ne v indexu: Deleted ve sloupci indexu
  • V indexu, ale ne v HEAD: Added ve sloupci indexu
  • V obou, ale s odlišným hashem: Modified ve sloupci indexu
  • V obou se stejným hashem: Unmodified ve sloupci indexu

Krok 3: Porovnání indexu s pracovním stromem

U každého souboru v indexu a pracovním stromu:

  • V indexu, ale ne na disku: Deleted ve sloupci pracovního stromu
  • V obou, ale s odlišným obsahem: Modified ve sloupci pracovního stromu
  • V obou se shodným obsahem: Unmodified ve sloupci pracovního stromu

Krok 4: Rozpoznání nesledovaných souborů

Projde adresář pracovního stromu, přeskočí .git/ a ignorované cesty a nahlásí soubory, které nejsou v indexu, jako Untracked v obou sloupcích.

Podpora .gitignore

Pitmaster parsuje soubory .gitignore a určuje, které nesledované soubory se mají označit jako ignorované a které jako nesledované.

PHP
use Pitmaster\Status\GitIgnore;

Třída GitIgnore parsuje vzory gitignore z těchto souborů:

  • .gitignore v kořenovém adresáři repozitáře
  • .gitignore v podadresářích
  • .git/info/exclude

Podporovaná syntaxe vzorů:

  • Vzory glob (*.log, build/)
  • Negace (!important.log)
  • Vzory pouze pro adresáře (koncové /)
  • Úvodní / pro vzory vztažené ke kořenovému adresáři
  • ** pro rekurzivní shody

Zařazování položek podle stavu

Běžný způsob zobrazení UI:

PHP
$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;
    }
}

Použití CLI

Shell
./vendor/bin/pitmaster status

Výstup:

Kód
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 obsahuje pomocnou funkci pro protokol fsmonitor systému git:

PHP
use Pitmaster\Status\Fsmonitor;

Třída Fsmonitor může dotazovat hook core.fsmonitor (při jeho nedostupnosti prohledá soubory podle času změny) a zjistit, které soubory se od daného tokenu změnily. U úchytů otevřených pomocí ['processes' => false] ji vypne. status() ji momentálně nevolá; porovnává přímo údaje stat a obsah.